@blezgo/api-sdk 0.1.2 → 0.1.3
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 +64 -64
- 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 +120 -120
- package/dist/admin/generated.d.ts.map +1 -1
- package/dist/affiliate/generated.d.ts +84 -85
- 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 +100 -100
- package/dist/announcements/generated.d.ts.map +1 -1
- package/dist/apikeys/generated.d.ts +100 -100
- package/dist/apikeys/generated.d.ts.map +1 -1
- package/dist/assistance/generated.d.ts +12 -12
- package/dist/assistance/generated.d.ts.map +1 -1
- package/dist/authentication/generated.d.ts +95 -95
- package/dist/authentication/generated.d.ts.map +1 -1
- package/dist/blog/generated.d.ts +169 -169
- package/dist/blog/generated.d.ts.map +1 -1
- package/dist/bundle/generated.d.ts +168 -168
- package/dist/bundle/generated.d.ts.map +1 -1
- package/dist/cache/generated.d.ts +38 -38
- package/dist/cache/generated.d.ts.map +1 -1
- package/dist/calendar/generated.d.ts +38 -38
- package/dist/calendar/generated.d.ts.map +1 -1
- package/dist/campaigns/generated.d.ts +196 -196
- package/dist/campaigns/generated.d.ts.map +1 -1
- package/dist/cart/generated.d.ts +9 -9
- package/dist/cart/generated.d.ts.map +1 -1
- package/dist/changelog/generated.d.ts +88 -88
- package/dist/changelog/generated.d.ts.map +1 -1
- package/dist/channel/generated.d.ts +252 -252
- package/dist/channel/generated.d.ts.map +1 -1
- package/dist/company/generated.d.ts +58 -58
- package/dist/company/generated.d.ts.map +1 -1
- package/dist/conference/generated.d.ts +30 -30
- package/dist/conference/generated.d.ts.map +1 -1
- package/dist/config/generated.d.ts +25 -25
- package/dist/config/generated.d.ts.map +1 -1
- package/dist/content/generated.d.ts +658 -658
- package/dist/content/generated.d.ts.map +1 -1
- package/dist/cookies/generated.d.ts +46 -46
- package/dist/cookies/generated.d.ts.map +1 -1
- package/dist/courses/generated.d.ts +250 -250
- 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 +202 -202
- package/dist/dashboard/generated.d.ts.map +1 -1
- package/dist/elasticsearch/generated.d.ts +25 -25
- package/dist/elasticsearch/generated.d.ts.map +1 -1
- package/dist/enrollments/generated.d.ts +9 -9
- package/dist/enrollments/generated.d.ts.map +1 -1
- package/dist/errors/generated.d.ts +30 -30
- package/dist/errors/generated.d.ts.map +1 -1
- package/dist/eventconfig/generated.d.ts +103 -103
- package/dist/eventconfig/generated.d.ts.map +1 -1
- package/dist/funnels/generated.d.ts +94 -95
- package/dist/funnels/generated.d.ts.map +1 -1
- package/dist/gamification/generated.d.ts +103 -103
- package/dist/gamification/generated.d.ts.map +1 -1
- package/dist/impersonation/generated.d.ts +77 -77
- package/dist/impersonation/generated.d.ts.map +1 -1
- package/dist/inbox/generated.d.ts +99 -99
- package/dist/inbox/generated.d.ts.map +1 -1
- package/dist/internal/generated.d.ts +9 -9
- package/dist/internal/generated.d.ts.map +1 -1
- package/dist/internationalization/generated.d.ts +11 -11
- package/dist/internationalization/generated.d.ts.map +1 -1
- package/dist/invitations/generated.d.ts +131 -131
- package/dist/invitations/generated.d.ts.map +1 -1
- package/dist/meetings/generated.d.ts +251 -251
- package/dist/meetings/generated.d.ts.map +1 -1
- package/dist/metas/generated.d.ts +183 -183
- package/dist/metas/generated.d.ts.map +1 -1
- package/dist/notification/generated.d.ts +379 -379
- package/dist/notification/generated.d.ts.map +1 -1
- package/dist/notifications/generated.d.ts +9 -9
- package/dist/notifications/generated.d.ts.map +1 -1
- package/dist/onboarding/generated.d.ts +124 -124
- 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 +555 -558
- package/dist/payments/generated.d.ts.map +1 -1
- package/dist/payouts/generated.d.ts +9 -9
- package/dist/payouts/generated.d.ts.map +1 -1
- package/dist/plans/generated.d.ts +227 -227
- package/dist/plans/generated.d.ts.map +1 -1
- package/dist/pricing/generated.d.ts +34 -34
- package/dist/pricing/generated.d.ts.map +1 -1
- package/dist/products/generated.d.ts +610 -610
- package/dist/products/generated.d.ts.map +1 -1
- package/dist/profile/generated.d.ts +286 -286
- package/dist/profile/generated.d.ts.map +1 -1
- package/dist/reasons/generated.d.ts +32 -32
- package/dist/reasons/generated.d.ts.map +1 -1
- package/dist/registration/generated.d.ts +164 -164
- package/dist/registration/generated.d.ts.map +1 -1
- package/dist/reviews/generated.d.ts +51 -51
- package/dist/reviews/generated.d.ts.map +1 -1
- package/dist/role/generated.d.ts +899 -401
- package/dist/role/generated.d.ts.map +1 -1
- package/dist/scheduling/generated.d.ts +156 -156
- package/dist/scheduling/generated.d.ts.map +1 -1
- package/dist/services/generated.d.ts +1028 -1028
- package/dist/services/generated.d.ts.map +1 -1
- package/dist/sessions/generated.d.ts +247 -247
- package/dist/sessions/generated.d.ts.map +1 -1
- package/dist/spaces/generated.d.ts +419 -419
- package/dist/spaces/generated.d.ts.map +1 -1
- package/dist/storefront/generated.d.ts +9 -9
- package/dist/storefront/generated.d.ts.map +1 -1
- package/dist/support/generated.d.ts +1510 -1510
- package/dist/support/generated.d.ts.map +1 -1
- package/dist/sync/generated.d.ts +179 -179
- package/dist/sync/generated.d.ts.map +1 -1
- package/dist/tenant/generated.d.ts +537 -537
- package/dist/tenant/generated.d.ts.map +1 -1
- package/dist/testimonials/generated.d.ts +79 -79
- package/dist/testimonials/generated.d.ts.map +1 -1
- package/dist/tests/generated.d.ts +343 -343
- package/dist/tests/generated.d.ts.map +1 -1
- package/dist/tokens/generated.d.ts +37 -37
- package/dist/tokens/generated.d.ts.map +1 -1
- package/dist/uploads/generated.d.ts +33 -33
- package/dist/uploads/generated.d.ts.map +1 -1
- package/dist/upsell/generated.d.ts +82 -82
- package/dist/upsell/generated.d.ts.map +1 -1
- package/dist/user/generated.d.ts +280 -541
- package/dist/user/generated.d.ts.map +1 -1
- package/dist/webinars/generated.d.ts +183 -183
- package/dist/webinars/generated.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -634,54 +634,6 @@ export interface paths {
|
|
|
634
634
|
patch?: never;
|
|
635
635
|
trace?: never;
|
|
636
636
|
};
|
|
637
|
-
"/v1/orders/{order_id}": {
|
|
638
|
-
parameters: {
|
|
639
|
-
query?: never;
|
|
640
|
-
header?: never;
|
|
641
|
-
path?: never;
|
|
642
|
-
cookie?: never;
|
|
643
|
-
};
|
|
644
|
-
/**
|
|
645
|
-
* Get Order
|
|
646
|
-
* @description Get full details of a specific order.
|
|
647
|
-
*
|
|
648
|
-
* **For**: Users viewing their order details
|
|
649
|
-
* **Purpose**: Retrieve complete order information including items, pricing, status, and payment details
|
|
650
|
-
*
|
|
651
|
-
* **Flow**:
|
|
652
|
-
* 1. Validates order exists and belongs to authenticated user
|
|
653
|
-
* 2. Fetches order details (status, amounts, dates)
|
|
654
|
-
* 3. Fetches all order items with product details
|
|
655
|
-
* 4. Includes payment information if available
|
|
656
|
-
* 5. Includes coupon details if applied
|
|
657
|
-
* 6. Returns complete order object
|
|
658
|
-
*
|
|
659
|
-
* **Path Parameters**: order_id (order identifier)
|
|
660
|
-
* **Authentication**: User authentication required (no guest access for this endpoint)
|
|
661
|
-
* **Headers**:
|
|
662
|
-
* - Authorization: Bearer <token>
|
|
663
|
-
*
|
|
664
|
-
* **Response**: Complete order object with:
|
|
665
|
-
* - Order details (id, status, amounts, dates)
|
|
666
|
-
* - Order items (products, quantities, prices)
|
|
667
|
-
* - Payment information
|
|
668
|
-
* - Coupon details (if applied)
|
|
669
|
-
* - Shipping/billing information
|
|
670
|
-
*
|
|
671
|
-
* **Validation**:
|
|
672
|
-
* - Order must exist
|
|
673
|
-
* - Order must belong to authenticated user
|
|
674
|
-
* - Guest access not allowed (user_id required)
|
|
675
|
-
*/
|
|
676
|
-
get: operations["getOrder"];
|
|
677
|
-
put?: never;
|
|
678
|
-
post?: never;
|
|
679
|
-
delete?: never;
|
|
680
|
-
options?: never;
|
|
681
|
-
head?: never;
|
|
682
|
-
patch?: never;
|
|
683
|
-
trace?: never;
|
|
684
|
-
};
|
|
685
637
|
"/v1/orders/admin": {
|
|
686
638
|
parameters: {
|
|
687
639
|
query?: never;
|
|
@@ -714,7 +666,6 @@ export interface paths {
|
|
|
714
666
|
* **Authentication**: Admin only (api_access permission)
|
|
715
667
|
* **Headers**:
|
|
716
668
|
* - Authorization: Bearer <admin_token>
|
|
717
|
-
* - X-Api-Key: <api_key>
|
|
718
669
|
*
|
|
719
670
|
* **Response**: Paginated list of all orders with:
|
|
720
671
|
* - orders: Array of order summaries with user info
|
|
@@ -764,7 +715,6 @@ export interface paths {
|
|
|
764
715
|
* **Authentication**: Admin only (api_access permission)
|
|
765
716
|
* **Headers**:
|
|
766
717
|
* - Authorization: Bearer <admin_token>
|
|
767
|
-
* - X-Api-Key: <api_key>
|
|
768
718
|
*
|
|
769
719
|
* **Response**: Complete order object with:
|
|
770
720
|
* - Order details (id, status, amounts, dates)
|
|
@@ -788,6 +738,54 @@ export interface paths {
|
|
|
788
738
|
patch?: never;
|
|
789
739
|
trace?: never;
|
|
790
740
|
};
|
|
741
|
+
"/v1/orders/{order_id}": {
|
|
742
|
+
parameters: {
|
|
743
|
+
query?: never;
|
|
744
|
+
header?: never;
|
|
745
|
+
path?: never;
|
|
746
|
+
cookie?: never;
|
|
747
|
+
};
|
|
748
|
+
/**
|
|
749
|
+
* Get Order
|
|
750
|
+
* @description Get full details of a specific order.
|
|
751
|
+
*
|
|
752
|
+
* **For**: Users viewing their order details
|
|
753
|
+
* **Purpose**: Retrieve complete order information including items, pricing, status, and payment details
|
|
754
|
+
*
|
|
755
|
+
* **Flow**:
|
|
756
|
+
* 1. Validates order exists and belongs to authenticated user
|
|
757
|
+
* 2. Fetches order details (status, amounts, dates)
|
|
758
|
+
* 3. Fetches all order items with product details
|
|
759
|
+
* 4. Includes payment information if available
|
|
760
|
+
* 5. Includes coupon details if applied
|
|
761
|
+
* 6. Returns complete order object
|
|
762
|
+
*
|
|
763
|
+
* **Path Parameters**: order_id (order identifier)
|
|
764
|
+
* **Authentication**: User authentication required (no guest access for this endpoint)
|
|
765
|
+
* **Headers**:
|
|
766
|
+
* - Authorization: Bearer <token>
|
|
767
|
+
*
|
|
768
|
+
* **Response**: Complete order object with:
|
|
769
|
+
* - Order details (id, status, amounts, dates)
|
|
770
|
+
* - Order items (products, quantities, prices)
|
|
771
|
+
* - Payment information
|
|
772
|
+
* - Coupon details (if applied)
|
|
773
|
+
* - Shipping/billing information
|
|
774
|
+
*
|
|
775
|
+
* **Validation**:
|
|
776
|
+
* - Order must exist
|
|
777
|
+
* - Order must belong to authenticated user
|
|
778
|
+
* - Guest access not allowed (user_id required)
|
|
779
|
+
*/
|
|
780
|
+
get: operations["getOrder"];
|
|
781
|
+
put?: never;
|
|
782
|
+
post?: never;
|
|
783
|
+
delete?: never;
|
|
784
|
+
options?: never;
|
|
785
|
+
head?: never;
|
|
786
|
+
patch?: never;
|
|
787
|
+
trace?: never;
|
|
788
|
+
};
|
|
791
789
|
"/v1/orders/admin/{order_id}/status": {
|
|
792
790
|
parameters: {
|
|
793
791
|
query?: never;
|
|
@@ -838,7 +836,6 @@ export interface paths {
|
|
|
838
836
|
* **Authentication**: Admin only (api_access permission)
|
|
839
837
|
* **Headers**:
|
|
840
838
|
* - Authorization: Bearer <admin_token>
|
|
841
|
-
* - X-Api-Key: <api_key>
|
|
842
839
|
*
|
|
843
840
|
* **Response**: Order ID and updated status
|
|
844
841
|
* **Validation**:
|
|
@@ -1012,7 +1009,7 @@ export interface paths {
|
|
|
1012
1009
|
patch?: never;
|
|
1013
1010
|
trace?: never;
|
|
1014
1011
|
};
|
|
1015
|
-
"/v1/payments/transactions/
|
|
1012
|
+
"/v1/payments/transactions/export": {
|
|
1016
1013
|
parameters: {
|
|
1017
1014
|
query?: never;
|
|
1018
1015
|
header?: never;
|
|
@@ -1020,16 +1017,17 @@ export interface paths {
|
|
|
1020
1017
|
cookie?: never;
|
|
1021
1018
|
};
|
|
1022
1019
|
/**
|
|
1023
|
-
*
|
|
1024
|
-
* @description
|
|
1020
|
+
* Export Transactions
|
|
1021
|
+
* @description Export transactions to CSV.
|
|
1025
1022
|
*
|
|
1026
|
-
* **For**: Users
|
|
1027
|
-
* **Purpose**:
|
|
1023
|
+
* **For**: Users exporting their payment history
|
|
1024
|
+
* **Purpose**: Generates CSV export of transactions
|
|
1028
1025
|
*
|
|
1029
1026
|
* **Authentication**: Required (JWT token)
|
|
1030
1027
|
* **Headers**: Authorization: Bearer <token>
|
|
1028
|
+
* **Query Params**: ?start_date=2025-01-01&end_date=2025-12-31&format=csv
|
|
1031
1029
|
*/
|
|
1032
|
-
get: operations["
|
|
1030
|
+
get: operations["listTransactionExports"];
|
|
1033
1031
|
put?: never;
|
|
1034
1032
|
post?: never;
|
|
1035
1033
|
delete?: never;
|
|
@@ -1038,7 +1036,7 @@ export interface paths {
|
|
|
1038
1036
|
patch?: never;
|
|
1039
1037
|
trace?: never;
|
|
1040
1038
|
};
|
|
1041
|
-
"/v1/payments/transactions/
|
|
1039
|
+
"/v1/payments/transactions/{payment_id}": {
|
|
1042
1040
|
parameters: {
|
|
1043
1041
|
query?: never;
|
|
1044
1042
|
header?: never;
|
|
@@ -1046,17 +1044,16 @@ export interface paths {
|
|
|
1046
1044
|
cookie?: never;
|
|
1047
1045
|
};
|
|
1048
1046
|
/**
|
|
1049
|
-
*
|
|
1050
|
-
* @description
|
|
1047
|
+
* Get Transaction
|
|
1048
|
+
* @description Get single transaction details.
|
|
1051
1049
|
*
|
|
1052
|
-
* **For**: Users
|
|
1053
|
-
* **Purpose**:
|
|
1050
|
+
* **For**: Users viewing specific payment details
|
|
1051
|
+
* **Purpose**: Returns detailed information about a payment
|
|
1054
1052
|
*
|
|
1055
1053
|
* **Authentication**: Required (JWT token)
|
|
1056
1054
|
* **Headers**: Authorization: Bearer <token>
|
|
1057
|
-
* **Query Params**: ?start_date=2025-01-01&end_date=2025-12-31&format=csv
|
|
1058
1055
|
*/
|
|
1059
|
-
get: operations["
|
|
1056
|
+
get: operations["getTransaction"];
|
|
1060
1057
|
put?: never;
|
|
1061
1058
|
post?: never;
|
|
1062
1059
|
delete?: never;
|
|
@@ -1528,7 +1525,7 @@ export interface paths {
|
|
|
1528
1525
|
*
|
|
1529
1526
|
* **Required Fields**: payment_id, company_id
|
|
1530
1527
|
* **Authentication**: Required (JWT token with admin permissions)
|
|
1531
|
-
* **Headers**: Authorization: Bearer
|
|
1528
|
+
* **Headers**: Authorization: Bearer {token}
|
|
1532
1529
|
* **Note**: Leave refund_amount as null for full refund
|
|
1533
1530
|
*/
|
|
1534
1531
|
post: operations["createRefund"];
|
|
@@ -3244,213 +3241,93 @@ export interface paths {
|
|
|
3244
3241
|
export type webhooks = Record<string, never>;
|
|
3245
3242
|
export interface components {
|
|
3246
3243
|
schemas: {
|
|
3247
|
-
/**
|
|
3248
|
-
|
|
3249
|
-
/**
|
|
3250
|
-
* User Id
|
|
3251
|
-
* @description User ID to credit/debit
|
|
3252
|
-
*/
|
|
3253
|
-
user_id: number;
|
|
3254
|
-
/**
|
|
3255
|
-
* Amount
|
|
3256
|
-
* @description Amount to credit/debit
|
|
3257
|
-
*/
|
|
3258
|
-
amount: number;
|
|
3244
|
+
/** CancelSubscriptionRequest */
|
|
3245
|
+
CancelSubscriptionRequest: {
|
|
3259
3246
|
/**
|
|
3260
|
-
*
|
|
3261
|
-
* @description
|
|
3247
|
+
* Cancel At Period End
|
|
3248
|
+
* @description Cancel at end of billing period
|
|
3249
|
+
* @default true
|
|
3262
3250
|
*/
|
|
3263
|
-
|
|
3251
|
+
cancel_at_period_end: boolean;
|
|
3264
3252
|
/**
|
|
3265
3253
|
* Reason
|
|
3266
|
-
* @description
|
|
3254
|
+
* @description Cancellation reason
|
|
3267
3255
|
*/
|
|
3268
|
-
reason
|
|
3269
|
-
};
|
|
3270
|
-
StandardResponse_MergeCartResponseData_: {
|
|
3271
|
-
[key: string]: unknown;
|
|
3256
|
+
reason?: string | null;
|
|
3272
3257
|
};
|
|
3273
3258
|
/**
|
|
3274
|
-
*
|
|
3259
|
+
* Interval
|
|
3275
3260
|
* @enum {string}
|
|
3276
3261
|
*/
|
|
3277
|
-
|
|
3278
|
-
/**
|
|
3279
|
-
|
|
3262
|
+
Interval: "day" | "week" | "month" | "year";
|
|
3263
|
+
/** InitPaymentRequest */
|
|
3264
|
+
InitPaymentRequest: {
|
|
3280
3265
|
/**
|
|
3281
|
-
*
|
|
3282
|
-
* @description
|
|
3266
|
+
* Order Id
|
|
3267
|
+
* @description Order ID (external order_id like ord_xxx)
|
|
3283
3268
|
*/
|
|
3284
|
-
|
|
3269
|
+
order_id: string;
|
|
3285
3270
|
/**
|
|
3286
3271
|
* Company Id
|
|
3287
3272
|
* @description Company ID
|
|
3288
3273
|
*/
|
|
3289
3274
|
company_id: number;
|
|
3290
3275
|
/**
|
|
3291
|
-
*
|
|
3292
|
-
* @description
|
|
3293
|
-
*/
|
|
3294
|
-
refund_amount?: number | null;
|
|
3295
|
-
/**
|
|
3296
|
-
* Reason
|
|
3297
|
-
* @description Refund reason
|
|
3276
|
+
* Gateway
|
|
3277
|
+
* @description Payment gateway (stripe, razorpay, paypal, etc)
|
|
3298
3278
|
*/
|
|
3299
|
-
|
|
3300
|
-
};
|
|
3301
|
-
ErrorResponse: {
|
|
3302
|
-
/** @example about:blank */
|
|
3303
|
-
type?: string;
|
|
3304
|
-
/** @example GENERIC_ERROR */
|
|
3305
|
-
code?: string;
|
|
3306
|
-
/** @example Client Error */
|
|
3307
|
-
title?: string;
|
|
3308
|
-
/** @example 400 */
|
|
3309
|
-
status?: number;
|
|
3310
|
-
/** @example An error occurred */
|
|
3311
|
-
detail?: string;
|
|
3312
|
-
/** @example /v1/cart/items */
|
|
3313
|
-
instance?: string;
|
|
3314
|
-
extensions?: components["schemas"]["Extensions"];
|
|
3315
|
-
};
|
|
3316
|
-
StandardResponse_DeleteCartItemResponseData_: {
|
|
3317
|
-
[key: string]: unknown;
|
|
3318
|
-
};
|
|
3319
|
-
/** VerifyPaymentRequest */
|
|
3320
|
-
VerifyPaymentRequest: {
|
|
3279
|
+
gateway: string;
|
|
3321
3280
|
/**
|
|
3322
|
-
* Payment Id
|
|
3323
|
-
* @description
|
|
3281
|
+
* Payment Method Id
|
|
3282
|
+
* @description Saved payment method ID (optional)
|
|
3324
3283
|
*/
|
|
3325
|
-
|
|
3284
|
+
payment_method_id?: string | null;
|
|
3326
3285
|
/**
|
|
3327
|
-
*
|
|
3328
|
-
* @description
|
|
3286
|
+
* Save Payment Method
|
|
3287
|
+
* @description Save this payment method for future use
|
|
3288
|
+
* @default false
|
|
3329
3289
|
*/
|
|
3330
|
-
|
|
3331
|
-
};
|
|
3332
|
-
/** AddPaymentMethodRequest */
|
|
3333
|
-
AddPaymentMethodRequest: {
|
|
3290
|
+
save_payment_method: boolean;
|
|
3334
3291
|
/**
|
|
3335
|
-
*
|
|
3336
|
-
* @description
|
|
3292
|
+
* Coupon Code
|
|
3293
|
+
* @description Coupon code to apply (optional)
|
|
3337
3294
|
*/
|
|
3338
|
-
|
|
3295
|
+
coupon_code?: string | null;
|
|
3339
3296
|
/**
|
|
3340
|
-
*
|
|
3341
|
-
* @description
|
|
3297
|
+
* Return Url
|
|
3298
|
+
* @description URL to redirect after payment
|
|
3342
3299
|
*/
|
|
3343
|
-
|
|
3300
|
+
return_url?: string | null;
|
|
3301
|
+
};
|
|
3302
|
+
/** ApplyCouponRequest */
|
|
3303
|
+
ApplyCouponRequest: {
|
|
3304
|
+
/** Coupon Code */
|
|
3305
|
+
coupon_code: string;
|
|
3306
|
+
};
|
|
3307
|
+
StandardResponse_CartResponseData_: {
|
|
3308
|
+
[key: string]: unknown;
|
|
3344
3309
|
};
|
|
3345
3310
|
/**
|
|
3346
|
-
*
|
|
3347
|
-
* @description
|
|
3311
|
+
* CouponBulkCreateRequest
|
|
3312
|
+
* @description Bulk coupon creation request - coupon_code is NOT required (auto-generated).
|
|
3313
|
+
* Used for creating multiple coupons with a shared prefix and rules.
|
|
3348
3314
|
*/
|
|
3349
|
-
|
|
3315
|
+
CouponBulkCreateRequest: {
|
|
3316
|
+
/** Coupon Name */
|
|
3317
|
+
coupon_name: string;
|
|
3318
|
+
/** Duration */
|
|
3319
|
+
duration?: string | null;
|
|
3350
3320
|
/**
|
|
3351
|
-
*
|
|
3352
|
-
* @
|
|
3321
|
+
* Duration In Months
|
|
3322
|
+
* @default 0
|
|
3353
3323
|
*/
|
|
3354
|
-
|
|
3355
|
-
/**
|
|
3356
|
-
|
|
3357
|
-
|
|
3358
|
-
|
|
3359
|
-
|
|
3360
|
-
|
|
3361
|
-
* Mobile No
|
|
3362
|
-
* @description Mobile number
|
|
3363
|
-
*/
|
|
3364
|
-
mobile_no: string;
|
|
3365
|
-
/**
|
|
3366
|
-
* First Name
|
|
3367
|
-
* @description Guest first name
|
|
3368
|
-
*/
|
|
3369
|
-
first_name: string;
|
|
3370
|
-
/**
|
|
3371
|
-
* Last Name
|
|
3372
|
-
* @description Guest last name
|
|
3373
|
-
*/
|
|
3374
|
-
last_name: string;
|
|
3375
|
-
/**
|
|
3376
|
-
* Address Line1
|
|
3377
|
-
* @description Street address, PO box, company name
|
|
3378
|
-
*/
|
|
3379
|
-
address_line1?: string | null;
|
|
3380
|
-
/**
|
|
3381
|
-
* Address Line2
|
|
3382
|
-
* @description Apartment, suite, unit, building, floor, etc.
|
|
3383
|
-
*/
|
|
3384
|
-
address_line2?: string | null;
|
|
3385
|
-
/**
|
|
3386
|
-
* City
|
|
3387
|
-
* @description City, district, suburb, town, or village
|
|
3388
|
-
*/
|
|
3389
|
-
city?: string | null;
|
|
3390
|
-
/**
|
|
3391
|
-
* State
|
|
3392
|
-
* @description State, province, prefecture, or region
|
|
3393
|
-
*/
|
|
3394
|
-
state?: string | null;
|
|
3395
|
-
/**
|
|
3396
|
-
* Postal Code
|
|
3397
|
-
* @description ZIP or postal code
|
|
3398
|
-
*/
|
|
3399
|
-
postal_code?: string | null;
|
|
3400
|
-
/**
|
|
3401
|
-
* Country
|
|
3402
|
-
* @description Two-letter country code (ISO 3166-1 alpha-2, e.g., IN, US, GB)
|
|
3403
|
-
*/
|
|
3404
|
-
country?: string | null;
|
|
3405
|
-
};
|
|
3406
|
-
/**
|
|
3407
|
-
* InitiateTopupRequest
|
|
3408
|
-
* @description Request model for initiating wallet top-up
|
|
3409
|
-
*
|
|
3410
|
-
* Example:
|
|
3411
|
-
* {
|
|
3412
|
-
* "amount": 1000.00,
|
|
3413
|
-
* "company_id": 5
|
|
3414
|
-
* }
|
|
3415
|
-
*/
|
|
3416
|
-
InitiateTopupRequest: {
|
|
3417
|
-
/**
|
|
3418
|
-
* Amount
|
|
3419
|
-
* @description Top-up amount (must be positive)
|
|
3420
|
-
*/
|
|
3421
|
-
amount: number;
|
|
3422
|
-
/**
|
|
3423
|
-
* Company Id
|
|
3424
|
-
* @description Company ID
|
|
3425
|
-
*/
|
|
3426
|
-
company_id: number;
|
|
3427
|
-
};
|
|
3428
|
-
StandardResponse_ClearCartResponseData_: {
|
|
3429
|
-
[key: string]: unknown;
|
|
3430
|
-
};
|
|
3431
|
-
/**
|
|
3432
|
-
* CouponAdminCreateRequest
|
|
3433
|
-
* @description Admin-specific coupon creation request with optional owner parameter.
|
|
3434
|
-
* Allows admins to create coupons on behalf of other users.
|
|
3435
|
-
*/
|
|
3436
|
-
CouponAdminCreateRequest: {
|
|
3437
|
-
/** Coupon Name */
|
|
3438
|
-
coupon_name: string;
|
|
3439
|
-
/** Coupon Code */
|
|
3440
|
-
coupon_code: string;
|
|
3441
|
-
/** Duration */
|
|
3442
|
-
duration?: string | null;
|
|
3443
|
-
/**
|
|
3444
|
-
* Duration In Months
|
|
3445
|
-
* @default 0
|
|
3446
|
-
*/
|
|
3447
|
-
duration_in_months: number;
|
|
3448
|
-
/** Amount Off */
|
|
3449
|
-
amount_off?: number | null;
|
|
3450
|
-
/** Currency */
|
|
3451
|
-
currency?: string | null;
|
|
3452
|
-
/** Percent Off */
|
|
3453
|
-
percent_off?: number | null;
|
|
3324
|
+
duration_in_months: number;
|
|
3325
|
+
/** Amount Off */
|
|
3326
|
+
amount_off?: number | null;
|
|
3327
|
+
/** Currency */
|
|
3328
|
+
currency?: string | null;
|
|
3329
|
+
/** Percent Off */
|
|
3330
|
+
percent_off?: number | null;
|
|
3454
3331
|
/**
|
|
3455
3332
|
* Redeem From
|
|
3456
3333
|
* @description Coupon valid from datetime (YYYY-MM-DD HH:MM:SS)
|
|
@@ -3491,70 +3368,6 @@ export interface components {
|
|
|
3491
3368
|
*/
|
|
3492
3369
|
owner?: number | null;
|
|
3493
3370
|
};
|
|
3494
|
-
/** CartItem */
|
|
3495
|
-
CartItem: {
|
|
3496
|
-
/** Product Id */
|
|
3497
|
-
product_id: number;
|
|
3498
|
-
/** Product Pricing Id */
|
|
3499
|
-
product_pricing_id?: number | null;
|
|
3500
|
-
/**
|
|
3501
|
-
* Sub Product Id
|
|
3502
|
-
* @default 0
|
|
3503
|
-
*/
|
|
3504
|
-
sub_product_id: number | null;
|
|
3505
|
-
/**
|
|
3506
|
-
* Quantity
|
|
3507
|
-
* @default 1
|
|
3508
|
-
*/
|
|
3509
|
-
quantity: number | null;
|
|
3510
|
-
};
|
|
3511
|
-
/** GuestCheckRequest */
|
|
3512
|
-
GuestCheckRequest: {
|
|
3513
|
-
/** Email */
|
|
3514
|
-
email: string;
|
|
3515
|
-
/** Mobile Isd Code */
|
|
3516
|
-
mobile_isd_code: string;
|
|
3517
|
-
/** Mobile No */
|
|
3518
|
-
mobile_no: string;
|
|
3519
|
-
};
|
|
3520
|
-
Extensions: {
|
|
3521
|
-
/** @example GENERIC_ERROR */
|
|
3522
|
-
message_code?: string;
|
|
3523
|
-
/** @example [] */
|
|
3524
|
-
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
3525
|
-
extra_data?: Record<string, never> | null;
|
|
3526
|
-
/** @example Detailed debug information */
|
|
3527
|
-
debug?: string | null;
|
|
3528
|
-
};
|
|
3529
|
-
/** PriceUpdateRequest */
|
|
3530
|
-
PriceUpdateRequest: {
|
|
3531
|
-
/** Amount */
|
|
3532
|
-
amount?: number | null;
|
|
3533
|
-
currency?: components["schemas"]["Currency"] | null;
|
|
3534
|
-
interval?: components["schemas"]["Interval"] | null;
|
|
3535
|
-
/** Interval Count */
|
|
3536
|
-
interval_count?: number | null;
|
|
3537
|
-
/** Trial Period Days */
|
|
3538
|
-
trial_period_days?: number | null;
|
|
3539
|
-
/** Initial Amount */
|
|
3540
|
-
initial_amount?: number | null;
|
|
3541
|
-
/** Compare Price */
|
|
3542
|
-
compare_price?: number | null;
|
|
3543
|
-
};
|
|
3544
|
-
InvalidParam: {
|
|
3545
|
-
/** @example items[0].quantity */
|
|
3546
|
-
field?: string;
|
|
3547
|
-
/** @example Input should be greater than or equal to 1 */
|
|
3548
|
-
error?: string;
|
|
3549
|
-
};
|
|
3550
|
-
StandardResponse_CartItemResponseData_: {
|
|
3551
|
-
[key: string]: unknown;
|
|
3552
|
-
};
|
|
3553
|
-
/** CartUpdateRequest */
|
|
3554
|
-
CartUpdateRequest: {
|
|
3555
|
-
/** Quantity */
|
|
3556
|
-
quantity: number;
|
|
3557
|
-
};
|
|
3558
3371
|
/** PriceRequest */
|
|
3559
3372
|
PriceRequest: {
|
|
3560
3373
|
/**
|
|
@@ -3629,6 +3442,167 @@ export interface components {
|
|
|
3629
3442
|
*/
|
|
3630
3443
|
requires_payment_method_upfront: boolean;
|
|
3631
3444
|
};
|
|
3445
|
+
/** OrderCreateRequest */
|
|
3446
|
+
OrderCreateRequest: {
|
|
3447
|
+
/** Company Id */
|
|
3448
|
+
company_id: number;
|
|
3449
|
+
/**
|
|
3450
|
+
* Recovery Token
|
|
3451
|
+
* @description Cart recovery token from abandoned cart email link (enables recovery attribution)
|
|
3452
|
+
*/
|
|
3453
|
+
recovery_token?: string | null;
|
|
3454
|
+
};
|
|
3455
|
+
StandardResponse_MergeCartResponseData_: {
|
|
3456
|
+
[key: string]: unknown;
|
|
3457
|
+
};
|
|
3458
|
+
/** GenerateInvoiceRequest */
|
|
3459
|
+
GenerateInvoiceRequest: {
|
|
3460
|
+
/**
|
|
3461
|
+
* Order Id
|
|
3462
|
+
* @description Order ID
|
|
3463
|
+
*/
|
|
3464
|
+
order_id: number;
|
|
3465
|
+
/**
|
|
3466
|
+
* Company Id
|
|
3467
|
+
* @description Company ID
|
|
3468
|
+
*/
|
|
3469
|
+
company_id: number;
|
|
3470
|
+
};
|
|
3471
|
+
/** CouponValidateRequest */
|
|
3472
|
+
CouponValidateRequest: {
|
|
3473
|
+
/** Coupon Code */
|
|
3474
|
+
coupon_code: string;
|
|
3475
|
+
/** Company Id */
|
|
3476
|
+
company_id: number;
|
|
3477
|
+
/** Gateway */
|
|
3478
|
+
gateway?: string | null;
|
|
3479
|
+
/** Order Amount */
|
|
3480
|
+
order_amount?: number | null;
|
|
3481
|
+
/** Product Ids */
|
|
3482
|
+
product_ids?: number[] | null;
|
|
3483
|
+
/** Category Ids */
|
|
3484
|
+
category_ids?: number[] | null;
|
|
3485
|
+
/**
|
|
3486
|
+
* Test Mode
|
|
3487
|
+
* @default false
|
|
3488
|
+
*/
|
|
3489
|
+
test_mode: boolean;
|
|
3490
|
+
};
|
|
3491
|
+
/** UpdateOrderStatusRequest */
|
|
3492
|
+
UpdateOrderStatusRequest: {
|
|
3493
|
+
/** Status */
|
|
3494
|
+
status: string;
|
|
3495
|
+
};
|
|
3496
|
+
/** GuestCheckRequest */
|
|
3497
|
+
GuestCheckRequest: {
|
|
3498
|
+
/** Email */
|
|
3499
|
+
email: string;
|
|
3500
|
+
/** Mobile Isd Code */
|
|
3501
|
+
mobile_isd_code: string;
|
|
3502
|
+
/** Mobile No */
|
|
3503
|
+
mobile_no: string;
|
|
3504
|
+
};
|
|
3505
|
+
/** AdminStatusVerifyRequest */
|
|
3506
|
+
AdminStatusVerifyRequest: {
|
|
3507
|
+
/**
|
|
3508
|
+
* Status
|
|
3509
|
+
* @description Status: completed or failed
|
|
3510
|
+
*/
|
|
3511
|
+
status: string;
|
|
3512
|
+
/**
|
|
3513
|
+
* Admin Remark
|
|
3514
|
+
* @description Admin remark
|
|
3515
|
+
*/
|
|
3516
|
+
admin_remark?: string | null;
|
|
3517
|
+
};
|
|
3518
|
+
/** BuyNowRequest */
|
|
3519
|
+
BuyNowRequest: {
|
|
3520
|
+
/** Company Id */
|
|
3521
|
+
company_id: number;
|
|
3522
|
+
/** Product Id */
|
|
3523
|
+
product_id: number;
|
|
3524
|
+
/** Product Pricing Id */
|
|
3525
|
+
product_pricing_id: number;
|
|
3526
|
+
/** Quantity */
|
|
3527
|
+
quantity: number;
|
|
3528
|
+
};
|
|
3529
|
+
Extensions: {
|
|
3530
|
+
/** @example GENERIC_ERROR */
|
|
3531
|
+
message_code?: string;
|
|
3532
|
+
/** @example [] */
|
|
3533
|
+
invalid_params?: components["schemas"]["InvalidParam"][];
|
|
3534
|
+
extra_data?: Record<string, never> | null;
|
|
3535
|
+
/** @example Detailed debug information */
|
|
3536
|
+
debug?: string | null;
|
|
3537
|
+
};
|
|
3538
|
+
StandardResponse_ClearCartResponseData_: {
|
|
3539
|
+
[key: string]: unknown;
|
|
3540
|
+
};
|
|
3541
|
+
ErrorResponse: {
|
|
3542
|
+
/** @example about:blank */
|
|
3543
|
+
type?: string;
|
|
3544
|
+
/** @example GENERIC_ERROR */
|
|
3545
|
+
code?: string;
|
|
3546
|
+
/** @example Client Error */
|
|
3547
|
+
title?: string;
|
|
3548
|
+
/** @example 400 */
|
|
3549
|
+
status?: number;
|
|
3550
|
+
/** @example An error occurred */
|
|
3551
|
+
detail?: string;
|
|
3552
|
+
/** @example /v1/cart/items */
|
|
3553
|
+
instance?: string;
|
|
3554
|
+
extensions?: components["schemas"]["Extensions"];
|
|
3555
|
+
};
|
|
3556
|
+
/** SendInvoiceRequest */
|
|
3557
|
+
SendInvoiceRequest: {
|
|
3558
|
+
/**
|
|
3559
|
+
* Recipient Email
|
|
3560
|
+
* @description Email address to send invoice
|
|
3561
|
+
*/
|
|
3562
|
+
recipient_email: string;
|
|
3563
|
+
};
|
|
3564
|
+
/** PriceUpdateRequest */
|
|
3565
|
+
PriceUpdateRequest: {
|
|
3566
|
+
/** Amount */
|
|
3567
|
+
amount?: number | null;
|
|
3568
|
+
currency?: components["schemas"]["Currency"] | null;
|
|
3569
|
+
interval?: components["schemas"]["Interval"] | null;
|
|
3570
|
+
/** Interval Count */
|
|
3571
|
+
interval_count?: number | null;
|
|
3572
|
+
/** Trial Period Days */
|
|
3573
|
+
trial_period_days?: number | null;
|
|
3574
|
+
/** Initial Amount */
|
|
3575
|
+
initial_amount?: number | null;
|
|
3576
|
+
/** Compare Price */
|
|
3577
|
+
compare_price?: number | null;
|
|
3578
|
+
};
|
|
3579
|
+
/**
|
|
3580
|
+
* SyncCustomerRequest
|
|
3581
|
+
* @description Request to sync customer to payment gateway
|
|
3582
|
+
*/
|
|
3583
|
+
SyncCustomerRequest: {
|
|
3584
|
+
/**
|
|
3585
|
+
* Gateway
|
|
3586
|
+
* @description Gateway (stripe, razorpay, paypal, athmovil)
|
|
3587
|
+
*/
|
|
3588
|
+
gateway: string;
|
|
3589
|
+
/**
|
|
3590
|
+
* Company Id
|
|
3591
|
+
* @description Company ID (required for gateway config lookup)
|
|
3592
|
+
*/
|
|
3593
|
+
company_id: number;
|
|
3594
|
+
/**
|
|
3595
|
+
* Email
|
|
3596
|
+
* @description Email to sync (defaults to current user)
|
|
3597
|
+
*/
|
|
3598
|
+
email?: string | null;
|
|
3599
|
+
/**
|
|
3600
|
+
* Force Create
|
|
3601
|
+
* @description Force create new customer even if exists
|
|
3602
|
+
* @default false
|
|
3603
|
+
*/
|
|
3604
|
+
force_create: boolean;
|
|
3605
|
+
};
|
|
3632
3606
|
/** CouponUpdateRequest */
|
|
3633
3607
|
CouponUpdateRequest: {
|
|
3634
3608
|
/** Coupon Name */
|
|
@@ -3670,45 +3644,31 @@ export interface components {
|
|
|
3670
3644
|
/** Min Order Amount */
|
|
3671
3645
|
min_order_amount?: number | null;
|
|
3672
3646
|
};
|
|
3673
|
-
/**
|
|
3674
|
-
|
|
3675
|
-
|
|
3676
|
-
|
|
3677
|
-
|
|
3647
|
+
/**
|
|
3648
|
+
* PriceType
|
|
3649
|
+
* @enum {string}
|
|
3650
|
+
*/
|
|
3651
|
+
PriceType: "free" | "subscription" | "onetime" | "emi";
|
|
3678
3652
|
/** AttachGuestDetailsRequest */
|
|
3679
|
-
AttachGuestDetailsRequest: {
|
|
3680
|
-
guest_details: components["schemas"]["GuestDetails"];
|
|
3681
|
-
};
|
|
3682
|
-
/**
|
|
3683
|
-
|
|
3684
|
-
/** Company Id */
|
|
3685
|
-
company_id: number;
|
|
3653
|
+
AttachGuestDetailsRequest: {
|
|
3654
|
+
guest_details: components["schemas"]["GuestDetails"];
|
|
3655
|
+
};
|
|
3656
|
+
/** CartItem */
|
|
3657
|
+
CartItem: {
|
|
3686
3658
|
/** Product Id */
|
|
3687
3659
|
product_id: number;
|
|
3688
3660
|
/** Product Pricing Id */
|
|
3689
|
-
product_pricing_id
|
|
3690
|
-
/** Quantity */
|
|
3691
|
-
quantity: number;
|
|
3692
|
-
};
|
|
3693
|
-
/** CouponValidateRequest */
|
|
3694
|
-
CouponValidateRequest: {
|
|
3695
|
-
/** Coupon Code */
|
|
3696
|
-
coupon_code: string;
|
|
3697
|
-
/** Company Id */
|
|
3698
|
-
company_id: number;
|
|
3699
|
-
/** Gateway */
|
|
3700
|
-
gateway?: string | null;
|
|
3701
|
-
/** Order Amount */
|
|
3702
|
-
order_amount?: number | null;
|
|
3703
|
-
/** Product Ids */
|
|
3704
|
-
product_ids?: number[] | null;
|
|
3705
|
-
/** Category Ids */
|
|
3706
|
-
category_ids?: number[] | null;
|
|
3661
|
+
product_pricing_id?: number | null;
|
|
3707
3662
|
/**
|
|
3708
|
-
*
|
|
3709
|
-
* @default
|
|
3663
|
+
* Sub Product Id
|
|
3664
|
+
* @default 0
|
|
3710
3665
|
*/
|
|
3711
|
-
|
|
3666
|
+
sub_product_id: number | null;
|
|
3667
|
+
/**
|
|
3668
|
+
* Quantity
|
|
3669
|
+
* @default 1
|
|
3670
|
+
*/
|
|
3671
|
+
quantity: number | null;
|
|
3712
3672
|
};
|
|
3713
3673
|
/** SavePaymentMethodRequest */
|
|
3714
3674
|
SavePaymentMethodRequest: {
|
|
@@ -3760,13 +3720,60 @@ export interface components {
|
|
|
3760
3720
|
is_default: boolean;
|
|
3761
3721
|
};
|
|
3762
3722
|
/**
|
|
3763
|
-
*
|
|
3764
|
-
* @description
|
|
3765
|
-
*
|
|
3723
|
+
* InitiateTopupRequest
|
|
3724
|
+
* @description Request model for initiating wallet top-up
|
|
3725
|
+
*
|
|
3726
|
+
* Example:
|
|
3727
|
+
* {
|
|
3728
|
+
* "amount": 1000.00,
|
|
3729
|
+
* "company_id": 5
|
|
3730
|
+
* }
|
|
3766
3731
|
*/
|
|
3767
|
-
|
|
3732
|
+
InitiateTopupRequest: {
|
|
3733
|
+
/**
|
|
3734
|
+
* Amount
|
|
3735
|
+
* @description Top-up amount (must be positive)
|
|
3736
|
+
*/
|
|
3737
|
+
amount: number;
|
|
3738
|
+
/**
|
|
3739
|
+
* Company Id
|
|
3740
|
+
* @description Company ID
|
|
3741
|
+
*/
|
|
3742
|
+
company_id: number;
|
|
3743
|
+
};
|
|
3744
|
+
/** CartUpdateRequest */
|
|
3745
|
+
CartUpdateRequest: {
|
|
3746
|
+
/** Quantity */
|
|
3747
|
+
quantity: number;
|
|
3748
|
+
};
|
|
3749
|
+
/** WalletPaymentRequest */
|
|
3750
|
+
WalletPaymentRequest: {
|
|
3751
|
+
/**
|
|
3752
|
+
* Amount
|
|
3753
|
+
* @description Payment amount
|
|
3754
|
+
*/
|
|
3755
|
+
amount: number;
|
|
3756
|
+
/**
|
|
3757
|
+
* Currency
|
|
3758
|
+
* @description Currency code (e.g., USD)
|
|
3759
|
+
*/
|
|
3760
|
+
currency: string;
|
|
3761
|
+
/**
|
|
3762
|
+
* Order Id
|
|
3763
|
+
* @description Order ID from order_tbl
|
|
3764
|
+
*/
|
|
3765
|
+
order_id: string;
|
|
3766
|
+
};
|
|
3767
|
+
/**
|
|
3768
|
+
* CouponAdminCreateRequest
|
|
3769
|
+
* @description Admin-specific coupon creation request with optional owner parameter.
|
|
3770
|
+
* Allows admins to create coupons on behalf of other users.
|
|
3771
|
+
*/
|
|
3772
|
+
CouponAdminCreateRequest: {
|
|
3768
3773
|
/** Coupon Name */
|
|
3769
3774
|
coupon_name: string;
|
|
3775
|
+
/** Coupon Code */
|
|
3776
|
+
coupon_code: string;
|
|
3770
3777
|
/** Duration */
|
|
3771
3778
|
duration?: string | null;
|
|
3772
3779
|
/**
|
|
@@ -3820,19 +3827,77 @@ export interface components {
|
|
|
3820
3827
|
*/
|
|
3821
3828
|
owner?: number | null;
|
|
3822
3829
|
};
|
|
3823
|
-
|
|
3824
|
-
|
|
3830
|
+
StandardResponse_DeleteCartItemResponseData_: {
|
|
3831
|
+
[key: string]: unknown;
|
|
3832
|
+
};
|
|
3833
|
+
/** CancelOfflineOrderRequest */
|
|
3834
|
+
CancelOfflineOrderRequest: {
|
|
3825
3835
|
/**
|
|
3826
|
-
*
|
|
3827
|
-
* @description
|
|
3836
|
+
* User Remark
|
|
3837
|
+
* @description User remark for cancellation
|
|
3828
3838
|
*/
|
|
3829
|
-
|
|
3839
|
+
user_remark?: string | null;
|
|
3840
|
+
/**
|
|
3841
|
+
* Admin Remark
|
|
3842
|
+
* @description Admin remark for cancellation
|
|
3843
|
+
*/
|
|
3844
|
+
admin_remark?: string | null;
|
|
3830
3845
|
};
|
|
3831
|
-
/**
|
|
3832
|
-
|
|
3846
|
+
/**
|
|
3847
|
+
* @example {
|
|
3848
|
+
* "status": "success",
|
|
3849
|
+
* "message": "Operation successful",
|
|
3850
|
+
* "message_code": "api_suc_20001",
|
|
3851
|
+
* "data": {},
|
|
3852
|
+
* "metadata": {
|
|
3853
|
+
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
3854
|
+
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
3855
|
+
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
3856
|
+
* "version": "v1",
|
|
3857
|
+
* "executionTime": 42,
|
|
3858
|
+
* "language": "en-US"
|
|
3859
|
+
* }
|
|
3860
|
+
* }
|
|
3861
|
+
*/
|
|
3862
|
+
StandardResponse: {
|
|
3863
|
+
/** @example success */
|
|
3864
|
+
status?: string;
|
|
3865
|
+
data?: Record<string, never> | null;
|
|
3866
|
+
/** @example Operation successful */
|
|
3867
|
+
message?: string | null;
|
|
3868
|
+
/** @example api_suc_20001 */
|
|
3869
|
+
message_code?: string | null;
|
|
3870
|
+
metadata?: Record<string, never> | null;
|
|
3871
|
+
error?: components["schemas"]["ErrorResponse"];
|
|
3872
|
+
};
|
|
3873
|
+
/**
|
|
3874
|
+
* Currency
|
|
3875
|
+
* @enum {string}
|
|
3876
|
+
*/
|
|
3877
|
+
Currency: "USD" | "INR" | "EUR" | "GBP";
|
|
3878
|
+
/** VerifyPaymentRequest */
|
|
3879
|
+
VerifyPaymentRequest: {
|
|
3880
|
+
/**
|
|
3881
|
+
* Payment Id
|
|
3882
|
+
* @description Blezgo payment ID
|
|
3883
|
+
*/
|
|
3884
|
+
payment_id: string;
|
|
3885
|
+
/**
|
|
3886
|
+
* Gateway Payment Id
|
|
3887
|
+
* @description Gateway payment/transaction ID
|
|
3888
|
+
*/
|
|
3889
|
+
gateway_payment_id?: string | null;
|
|
3890
|
+
};
|
|
3891
|
+
/** WalletCreditDebitRequest */
|
|
3892
|
+
WalletCreditDebitRequest: {
|
|
3893
|
+
/**
|
|
3894
|
+
* User Id
|
|
3895
|
+
* @description User ID to credit/debit
|
|
3896
|
+
*/
|
|
3897
|
+
user_id: number;
|
|
3833
3898
|
/**
|
|
3834
3899
|
* Amount
|
|
3835
|
-
* @description
|
|
3900
|
+
* @description Amount to credit/debit
|
|
3836
3901
|
*/
|
|
3837
3902
|
amount: number;
|
|
3838
3903
|
/**
|
|
@@ -3841,15 +3906,32 @@ export interface components {
|
|
|
3841
3906
|
*/
|
|
3842
3907
|
currency: string;
|
|
3843
3908
|
/**
|
|
3844
|
-
*
|
|
3845
|
-
* @description
|
|
3909
|
+
* Reason
|
|
3910
|
+
* @description Reason for credit/debit
|
|
3846
3911
|
*/
|
|
3847
|
-
|
|
3912
|
+
reason: string;
|
|
3913
|
+
};
|
|
3914
|
+
/** AddPaymentMethodRequest */
|
|
3915
|
+
AddPaymentMethodRequest: {
|
|
3848
3916
|
/**
|
|
3849
|
-
*
|
|
3850
|
-
* @description
|
|
3917
|
+
* Payment Method Token
|
|
3918
|
+
* @description Payment method token from gateway
|
|
3851
3919
|
*/
|
|
3852
|
-
|
|
3920
|
+
payment_method_token: string;
|
|
3921
|
+
/**
|
|
3922
|
+
* Gateway
|
|
3923
|
+
* @description Payment gateway (stripe, razorpay, etc)
|
|
3924
|
+
*/
|
|
3925
|
+
gateway: string;
|
|
3926
|
+
};
|
|
3927
|
+
InvalidParam: {
|
|
3928
|
+
/** @example items[0].quantity */
|
|
3929
|
+
field?: string;
|
|
3930
|
+
/** @example Input should be greater than or equal to 1 */
|
|
3931
|
+
error?: string;
|
|
3932
|
+
};
|
|
3933
|
+
StandardResponse_CartItemDetail_: {
|
|
3934
|
+
[key: string]: unknown;
|
|
3853
3935
|
};
|
|
3854
3936
|
/** CouponCreateRequest */
|
|
3855
3937
|
CouponCreateRequest: {
|
|
@@ -3905,89 +3987,37 @@ export interface components {
|
|
|
3905
3987
|
/** Min Order Amount */
|
|
3906
3988
|
min_order_amount?: number | null;
|
|
3907
3989
|
};
|
|
3908
|
-
|
|
3990
|
+
StandardResponse_CartItemResponseData_: {
|
|
3909
3991
|
[key: string]: unknown;
|
|
3910
3992
|
};
|
|
3911
|
-
/**
|
|
3912
|
-
|
|
3913
|
-
/**
|
|
3914
|
-
* Status
|
|
3915
|
-
* @description Status: proof_uploaded or cancelled for users
|
|
3916
|
-
*/
|
|
3917
|
-
status: string;
|
|
3918
|
-
/**
|
|
3919
|
-
* Proof Of Payment
|
|
3920
|
-
* @description Proof of payment (required for proof_uploaded)
|
|
3921
|
-
*/
|
|
3922
|
-
proof_of_payment?: string | null;
|
|
3923
|
-
/**
|
|
3924
|
-
* User Remark
|
|
3925
|
-
* @description User remark
|
|
3926
|
-
*/
|
|
3927
|
-
user_remark?: string | null;
|
|
3928
|
-
};
|
|
3929
|
-
/**
|
|
3930
|
-
* Interval
|
|
3931
|
-
* @enum {string}
|
|
3932
|
-
*/
|
|
3933
|
-
Interval: "day" | "week" | "month" | "year";
|
|
3934
|
-
/** GenerateInvoiceRequest */
|
|
3935
|
-
GenerateInvoiceRequest: {
|
|
3936
|
-
/**
|
|
3937
|
-
* Order Id
|
|
3938
|
-
* @description Order ID
|
|
3939
|
-
*/
|
|
3940
|
-
order_id: number;
|
|
3941
|
-
/**
|
|
3942
|
-
* Company Id
|
|
3943
|
-
* @description Company ID
|
|
3944
|
-
*/
|
|
3945
|
-
company_id: number;
|
|
3946
|
-
};
|
|
3947
|
-
/** CreateSubscriptionRequest */
|
|
3948
|
-
CreateSubscriptionRequest: {
|
|
3949
|
-
/**
|
|
3950
|
-
* Order Id
|
|
3951
|
-
* @description Order ID (external ord_xxx format)
|
|
3952
|
-
*/
|
|
3953
|
-
order_id: string;
|
|
3954
|
-
/**
|
|
3955
|
-
* Company Id
|
|
3956
|
-
* @description Company ID
|
|
3957
|
-
*/
|
|
3958
|
-
company_id: number;
|
|
3959
|
-
/**
|
|
3960
|
-
* Gateway
|
|
3961
|
-
* @description Payment gateway (stripe, razorpay, etc)
|
|
3962
|
-
*/
|
|
3963
|
-
gateway: string;
|
|
3993
|
+
/** OfflinePaymentRequest */
|
|
3994
|
+
OfflinePaymentRequest: {
|
|
3964
3995
|
/**
|
|
3965
|
-
*
|
|
3966
|
-
* @description
|
|
3996
|
+
* Amount
|
|
3997
|
+
* @description Payment amount
|
|
3967
3998
|
*/
|
|
3968
|
-
|
|
3999
|
+
amount: number;
|
|
3969
4000
|
/**
|
|
3970
|
-
*
|
|
3971
|
-
* @description
|
|
3972
|
-
* @default false
|
|
4001
|
+
* Currency
|
|
4002
|
+
* @description Currency code (e.g., USD)
|
|
3973
4003
|
*/
|
|
3974
|
-
|
|
4004
|
+
currency: string;
|
|
3975
4005
|
/**
|
|
3976
|
-
*
|
|
3977
|
-
* @description
|
|
4006
|
+
* Company Id
|
|
4007
|
+
* @description Company ID
|
|
3978
4008
|
*/
|
|
3979
|
-
|
|
4009
|
+
company_id: number;
|
|
3980
4010
|
/**
|
|
3981
|
-
*
|
|
3982
|
-
* @description
|
|
4011
|
+
* Order Id
|
|
4012
|
+
* @description Order ID
|
|
3983
4013
|
*/
|
|
3984
|
-
|
|
4014
|
+
order_id: string;
|
|
3985
4015
|
};
|
|
3986
|
-
/**
|
|
3987
|
-
|
|
4016
|
+
/** CreateSubscriptionRequest */
|
|
4017
|
+
CreateSubscriptionRequest: {
|
|
3988
4018
|
/**
|
|
3989
4019
|
* Order Id
|
|
3990
|
-
* @description Order ID (external
|
|
4020
|
+
* @description Order ID (external ord_xxx format)
|
|
3991
4021
|
*/
|
|
3992
4022
|
order_id: string;
|
|
3993
4023
|
/**
|
|
@@ -3997,7 +4027,7 @@ export interface components {
|
|
|
3997
4027
|
company_id: number;
|
|
3998
4028
|
/**
|
|
3999
4029
|
* Gateway
|
|
4000
|
-
* @description Payment gateway (stripe, razorpay,
|
|
4030
|
+
* @description Payment gateway (stripe, razorpay, etc)
|
|
4001
4031
|
*/
|
|
4002
4032
|
gateway: string;
|
|
4003
4033
|
/**
|
|
@@ -4022,145 +4052,112 @@ export interface components {
|
|
|
4022
4052
|
*/
|
|
4023
4053
|
return_url?: string | null;
|
|
4024
4054
|
};
|
|
4025
|
-
/**
|
|
4026
|
-
|
|
4055
|
+
/** OfflineStatusUpdateRequest */
|
|
4056
|
+
OfflineStatusUpdateRequest: {
|
|
4027
4057
|
/**
|
|
4028
|
-
*
|
|
4029
|
-
* @description
|
|
4058
|
+
* Status
|
|
4059
|
+
* @description Status: proof_uploaded or cancelled for users
|
|
4030
4060
|
*/
|
|
4031
|
-
|
|
4061
|
+
status: string;
|
|
4032
4062
|
/**
|
|
4033
|
-
*
|
|
4034
|
-
* @description
|
|
4063
|
+
* Proof Of Payment
|
|
4064
|
+
* @description Proof of payment (required for proof_uploaded)
|
|
4035
4065
|
*/
|
|
4036
|
-
|
|
4037
|
-
};
|
|
4038
|
-
/** UpdateOrderStatusRequest */
|
|
4039
|
-
UpdateOrderStatusRequest: {
|
|
4040
|
-
/** Status */
|
|
4041
|
-
status: string;
|
|
4042
|
-
};
|
|
4043
|
-
/** WalletPaymentRequest */
|
|
4044
|
-
WalletPaymentRequest: {
|
|
4066
|
+
proof_of_payment?: string | null;
|
|
4045
4067
|
/**
|
|
4046
|
-
*
|
|
4047
|
-
* @description
|
|
4068
|
+
* User Remark
|
|
4069
|
+
* @description User remark
|
|
4048
4070
|
*/
|
|
4049
|
-
|
|
4071
|
+
user_remark?: string | null;
|
|
4072
|
+
};
|
|
4073
|
+
/** ProcessRefundRequest */
|
|
4074
|
+
ProcessRefundRequest: {
|
|
4050
4075
|
/**
|
|
4051
|
-
*
|
|
4052
|
-
* @description
|
|
4076
|
+
* Payment Id
|
|
4077
|
+
* @description Payment ID to refund
|
|
4053
4078
|
*/
|
|
4054
|
-
|
|
4079
|
+
payment_id: string;
|
|
4055
4080
|
/**
|
|
4056
|
-
*
|
|
4057
|
-
* @description
|
|
4081
|
+
* Company Id
|
|
4082
|
+
* @description Company ID
|
|
4058
4083
|
*/
|
|
4059
|
-
order_id: string;
|
|
4060
|
-
};
|
|
4061
|
-
/** OrderCreateRequest */
|
|
4062
|
-
OrderCreateRequest: {
|
|
4063
|
-
/** Company Id */
|
|
4064
4084
|
company_id: number;
|
|
4065
4085
|
/**
|
|
4066
|
-
*
|
|
4067
|
-
* @description
|
|
4086
|
+
* Refund Amount
|
|
4087
|
+
* @description Refund amount (None for full refund)
|
|
4068
4088
|
*/
|
|
4069
|
-
|
|
4089
|
+
refund_amount?: number | null;
|
|
4090
|
+
/**
|
|
4091
|
+
* Reason
|
|
4092
|
+
* @description Refund reason
|
|
4093
|
+
*/
|
|
4094
|
+
reason?: string | null;
|
|
4070
4095
|
};
|
|
4071
4096
|
/**
|
|
4072
|
-
*
|
|
4073
|
-
* @
|
|
4074
|
-
*/
|
|
4075
|
-
Currency: "USD" | "INR" | "EUR" | "GBP";
|
|
4076
|
-
/**
|
|
4077
|
-
* SyncCustomerRequest
|
|
4078
|
-
* @description Request to sync customer to payment gateway
|
|
4097
|
+
* GuestDetails
|
|
4098
|
+
* @description Guest customer details for checkout
|
|
4079
4099
|
*/
|
|
4080
|
-
|
|
4100
|
+
GuestDetails: {
|
|
4081
4101
|
/**
|
|
4082
|
-
*
|
|
4083
|
-
* @description
|
|
4102
|
+
* Email
|
|
4103
|
+
* @description Guest email address
|
|
4084
4104
|
*/
|
|
4085
|
-
|
|
4105
|
+
email: string;
|
|
4086
4106
|
/**
|
|
4087
|
-
*
|
|
4088
|
-
* @description
|
|
4107
|
+
* Mobile Isd Code
|
|
4108
|
+
* @description Mobile country code (e.g., +91, +1)
|
|
4089
4109
|
*/
|
|
4090
|
-
|
|
4110
|
+
mobile_isd_code: string;
|
|
4091
4111
|
/**
|
|
4092
|
-
*
|
|
4093
|
-
* @description
|
|
4112
|
+
* Mobile No
|
|
4113
|
+
* @description Mobile number
|
|
4094
4114
|
*/
|
|
4095
|
-
|
|
4115
|
+
mobile_no: string;
|
|
4096
4116
|
/**
|
|
4097
|
-
*
|
|
4098
|
-
* @description
|
|
4099
|
-
* @default false
|
|
4117
|
+
* First Name
|
|
4118
|
+
* @description Guest first name
|
|
4100
4119
|
*/
|
|
4101
|
-
|
|
4102
|
-
};
|
|
4103
|
-
/**
|
|
4104
|
-
* @example {
|
|
4105
|
-
* "status": "success",
|
|
4106
|
-
* "message": "Operation successful",
|
|
4107
|
-
* "message_code": "api_suc_20001",
|
|
4108
|
-
* "data": {},
|
|
4109
|
-
* "metadata": {
|
|
4110
|
-
* "timestamp": "2026-03-26T10:00:00.000Z",
|
|
4111
|
-
* "requestId": "07e22004-cb60-4dfc-bc9c-b6f99664dca1",
|
|
4112
|
-
* "traceId": "a9f1204c-bb82-41de-b234-7c3a9e120000",
|
|
4113
|
-
* "version": "v1",
|
|
4114
|
-
* "executionTime": 42,
|
|
4115
|
-
* "language": "en-US"
|
|
4116
|
-
* }
|
|
4117
|
-
* }
|
|
4118
|
-
*/
|
|
4119
|
-
StandardResponse: {
|
|
4120
|
-
/** @example success */
|
|
4121
|
-
status?: string;
|
|
4122
|
-
data?: Record<string, never> | null;
|
|
4123
|
-
/** @example Operation successful */
|
|
4124
|
-
message?: string | null;
|
|
4125
|
-
/** @example api_suc_20001 */
|
|
4126
|
-
message_code?: string | null;
|
|
4127
|
-
metadata?: Record<string, never> | null;
|
|
4128
|
-
error?: components["schemas"]["ErrorResponse"];
|
|
4129
|
-
};
|
|
4130
|
-
/** CancelSubscriptionRequest */
|
|
4131
|
-
CancelSubscriptionRequest: {
|
|
4120
|
+
first_name: string;
|
|
4132
4121
|
/**
|
|
4133
|
-
*
|
|
4134
|
-
* @description
|
|
4135
|
-
* @default true
|
|
4122
|
+
* Last Name
|
|
4123
|
+
* @description Guest last name
|
|
4136
4124
|
*/
|
|
4137
|
-
|
|
4125
|
+
last_name: string;
|
|
4138
4126
|
/**
|
|
4139
|
-
*
|
|
4140
|
-
* @description
|
|
4127
|
+
* Address Line1
|
|
4128
|
+
* @description Street address, PO box, company name
|
|
4141
4129
|
*/
|
|
4142
|
-
|
|
4143
|
-
};
|
|
4144
|
-
StandardResponse_CartItemDetail_: {
|
|
4145
|
-
[key: string]: unknown;
|
|
4146
|
-
};
|
|
4147
|
-
/** AdminStatusVerifyRequest */
|
|
4148
|
-
AdminStatusVerifyRequest: {
|
|
4130
|
+
address_line1?: string | null;
|
|
4149
4131
|
/**
|
|
4150
|
-
*
|
|
4151
|
-
* @description
|
|
4132
|
+
* Address Line2
|
|
4133
|
+
* @description Apartment, suite, unit, building, floor, etc.
|
|
4152
4134
|
*/
|
|
4153
|
-
|
|
4135
|
+
address_line2?: string | null;
|
|
4154
4136
|
/**
|
|
4155
|
-
*
|
|
4156
|
-
* @description
|
|
4137
|
+
* City
|
|
4138
|
+
* @description City, district, suburb, town, or village
|
|
4157
4139
|
*/
|
|
4158
|
-
|
|
4140
|
+
city?: string | null;
|
|
4141
|
+
/**
|
|
4142
|
+
* State
|
|
4143
|
+
* @description State, province, prefecture, or region
|
|
4144
|
+
*/
|
|
4145
|
+
state?: string | null;
|
|
4146
|
+
/**
|
|
4147
|
+
* Postal Code
|
|
4148
|
+
* @description ZIP or postal code
|
|
4149
|
+
*/
|
|
4150
|
+
postal_code?: string | null;
|
|
4151
|
+
/**
|
|
4152
|
+
* Country
|
|
4153
|
+
* @description Two-letter country code (ISO 3166-1 alpha-2, e.g., IN, US, GB)
|
|
4154
|
+
*/
|
|
4155
|
+
country?: string | null;
|
|
4159
4156
|
};
|
|
4160
|
-
/**
|
|
4161
|
-
|
|
4162
|
-
/**
|
|
4163
|
-
|
|
4157
|
+
/** CartItemRequest */
|
|
4158
|
+
CartItemRequest: {
|
|
4159
|
+
/** Items */
|
|
4160
|
+
items: components["schemas"]["CartItem"][];
|
|
4164
4161
|
};
|
|
4165
4162
|
};
|
|
4166
4163
|
responses: never;
|
|
@@ -7618,16 +7615,16 @@ export interface operations {
|
|
|
7618
7615
|
};
|
|
7619
7616
|
};
|
|
7620
7617
|
};
|
|
7621
|
-
|
|
7618
|
+
adminListOrders: {
|
|
7622
7619
|
parameters: {
|
|
7623
|
-
query?:
|
|
7620
|
+
query?: {
|
|
7621
|
+
page?: number;
|
|
7622
|
+
limit?: number;
|
|
7623
|
+
};
|
|
7624
7624
|
header?: {
|
|
7625
7625
|
authorization?: string | null;
|
|
7626
|
-
"X-Guest-Session-ID"?: string | null;
|
|
7627
|
-
};
|
|
7628
|
-
path: {
|
|
7629
|
-
order_id: string;
|
|
7630
7626
|
};
|
|
7627
|
+
path?: never;
|
|
7631
7628
|
cookie?: never;
|
|
7632
7629
|
};
|
|
7633
7630
|
requestBody?: never;
|
|
@@ -7820,16 +7817,15 @@ export interface operations {
|
|
|
7820
7817
|
};
|
|
7821
7818
|
};
|
|
7822
7819
|
};
|
|
7823
|
-
|
|
7820
|
+
adminGetOrder: {
|
|
7824
7821
|
parameters: {
|
|
7825
|
-
query?:
|
|
7826
|
-
page?: number;
|
|
7827
|
-
limit?: number;
|
|
7828
|
-
};
|
|
7822
|
+
query?: never;
|
|
7829
7823
|
header?: {
|
|
7830
7824
|
authorization?: string | null;
|
|
7831
7825
|
};
|
|
7832
|
-
path
|
|
7826
|
+
path: {
|
|
7827
|
+
order_id: string;
|
|
7828
|
+
};
|
|
7833
7829
|
cookie?: never;
|
|
7834
7830
|
};
|
|
7835
7831
|
requestBody?: never;
|
|
@@ -8022,11 +8018,12 @@ export interface operations {
|
|
|
8022
8018
|
};
|
|
8023
8019
|
};
|
|
8024
8020
|
};
|
|
8025
|
-
|
|
8021
|
+
getOrder: {
|
|
8026
8022
|
parameters: {
|
|
8027
8023
|
query?: never;
|
|
8028
8024
|
header?: {
|
|
8029
8025
|
authorization?: string | null;
|
|
8026
|
+
"X-Guest-Session-ID"?: string | null;
|
|
8030
8027
|
};
|
|
8031
8028
|
path: {
|
|
8032
8029
|
order_id: string;
|
|
@@ -9439,15 +9436,17 @@ export interface operations {
|
|
|
9439
9436
|
};
|
|
9440
9437
|
};
|
|
9441
9438
|
};
|
|
9442
|
-
|
|
9439
|
+
listTransactionExports: {
|
|
9443
9440
|
parameters: {
|
|
9444
|
-
query?:
|
|
9441
|
+
query?: {
|
|
9442
|
+
start_date?: string | null;
|
|
9443
|
+
end_date?: string | null;
|
|
9444
|
+
format?: string;
|
|
9445
|
+
};
|
|
9445
9446
|
header?: {
|
|
9446
9447
|
authorization?: string | null;
|
|
9447
9448
|
};
|
|
9448
|
-
path
|
|
9449
|
-
payment_id: string;
|
|
9450
|
-
};
|
|
9449
|
+
path?: never;
|
|
9451
9450
|
cookie?: never;
|
|
9452
9451
|
};
|
|
9453
9452
|
requestBody?: never;
|
|
@@ -9640,17 +9639,15 @@ export interface operations {
|
|
|
9640
9639
|
};
|
|
9641
9640
|
};
|
|
9642
9641
|
};
|
|
9643
|
-
|
|
9642
|
+
getTransaction: {
|
|
9644
9643
|
parameters: {
|
|
9645
|
-
query?:
|
|
9646
|
-
start_date?: string | null;
|
|
9647
|
-
end_date?: string | null;
|
|
9648
|
-
format?: string;
|
|
9649
|
-
};
|
|
9644
|
+
query?: never;
|
|
9650
9645
|
header?: {
|
|
9651
9646
|
authorization?: string | null;
|
|
9652
9647
|
};
|
|
9653
|
-
path
|
|
9648
|
+
path: {
|
|
9649
|
+
payment_id: string;
|
|
9650
|
+
};
|
|
9654
9651
|
cookie?: never;
|
|
9655
9652
|
};
|
|
9656
9653
|
requestBody?: never;
|