@ophelio/sdk 0.2.1 → 0.3.0
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/README.md +17 -17
- package/dist/index.cjs +66 -2
- package/dist/index.d.cts +353 -143
- package/dist/index.d.mts +353 -143
- package/dist/index.mjs +66 -2
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -552,10 +552,10 @@ interface paths {
|
|
|
552
552
|
get: operations["MembersController_get"];
|
|
553
553
|
put?: never;
|
|
554
554
|
post?: never;
|
|
555
|
-
delete
|
|
555
|
+
delete: operations["MembersController_remove"];
|
|
556
556
|
options?: never;
|
|
557
557
|
head?: never;
|
|
558
|
-
patch
|
|
558
|
+
patch: operations["MembersController_update"];
|
|
559
559
|
trace?: never;
|
|
560
560
|
};
|
|
561
561
|
"/api/v1/members/{id}/entitlements": {
|
|
@@ -574,6 +574,22 @@ interface paths {
|
|
|
574
574
|
patch?: never;
|
|
575
575
|
trace?: never;
|
|
576
576
|
};
|
|
577
|
+
"/api/v1/members/{id}/set-primary": {
|
|
578
|
+
parameters: {
|
|
579
|
+
query?: never;
|
|
580
|
+
header?: never;
|
|
581
|
+
path?: never;
|
|
582
|
+
cookie?: never;
|
|
583
|
+
};
|
|
584
|
+
get?: never;
|
|
585
|
+
put?: never;
|
|
586
|
+
post: operations["MembersController_setPrimary"];
|
|
587
|
+
delete?: never;
|
|
588
|
+
options?: never;
|
|
589
|
+
head?: never;
|
|
590
|
+
patch?: never;
|
|
591
|
+
trace?: never;
|
|
592
|
+
};
|
|
577
593
|
"/api/v1/members/{id}/reissue-card": {
|
|
578
594
|
parameters: {
|
|
579
595
|
query?: never;
|
|
@@ -606,84 +622,84 @@ interface paths {
|
|
|
606
622
|
patch?: never;
|
|
607
623
|
trace?: never;
|
|
608
624
|
};
|
|
609
|
-
"/api/v1/
|
|
625
|
+
"/api/v1/member-roles": {
|
|
610
626
|
parameters: {
|
|
611
627
|
query?: never;
|
|
612
628
|
header?: never;
|
|
613
629
|
path?: never;
|
|
614
630
|
cookie?: never;
|
|
615
631
|
};
|
|
616
|
-
get: operations["
|
|
632
|
+
get: operations["MemberRolesController_list"];
|
|
617
633
|
put?: never;
|
|
618
|
-
post: operations["
|
|
634
|
+
post: operations["MemberRolesController_create"];
|
|
619
635
|
delete?: never;
|
|
620
636
|
options?: never;
|
|
621
637
|
head?: never;
|
|
622
638
|
patch?: never;
|
|
623
639
|
trace?: never;
|
|
624
640
|
};
|
|
625
|
-
"/api/v1/
|
|
641
|
+
"/api/v1/member-roles/{id}": {
|
|
626
642
|
parameters: {
|
|
627
643
|
query?: never;
|
|
628
644
|
header?: never;
|
|
629
645
|
path?: never;
|
|
630
646
|
cookie?: never;
|
|
631
647
|
};
|
|
632
|
-
get: operations["
|
|
648
|
+
get: operations["MemberRolesController_get"];
|
|
633
649
|
put?: never;
|
|
634
650
|
post?: never;
|
|
635
|
-
delete: operations["
|
|
651
|
+
delete: operations["MemberRolesController_delete"];
|
|
636
652
|
options?: never;
|
|
637
653
|
head?: never;
|
|
638
|
-
patch: operations["
|
|
654
|
+
patch: operations["MemberRolesController_update"];
|
|
639
655
|
trace?: never;
|
|
640
656
|
};
|
|
641
|
-
"/api/v1/webhook-subscriptions
|
|
657
|
+
"/api/v1/webhook-subscriptions": {
|
|
642
658
|
parameters: {
|
|
643
659
|
query?: never;
|
|
644
660
|
header?: never;
|
|
645
661
|
path?: never;
|
|
646
662
|
cookie?: never;
|
|
647
663
|
};
|
|
648
|
-
get: operations["
|
|
664
|
+
get: operations["WebhookSubscriptionsController_list"];
|
|
649
665
|
put?: never;
|
|
650
|
-
post
|
|
666
|
+
post: operations["WebhookSubscriptionsController_create"];
|
|
651
667
|
delete?: never;
|
|
652
668
|
options?: never;
|
|
653
669
|
head?: never;
|
|
654
670
|
patch?: never;
|
|
655
671
|
trace?: never;
|
|
656
672
|
};
|
|
657
|
-
"/api/v1/
|
|
673
|
+
"/api/v1/webhook-subscriptions/{id}": {
|
|
658
674
|
parameters: {
|
|
659
675
|
query?: never;
|
|
660
676
|
header?: never;
|
|
661
677
|
path?: never;
|
|
662
678
|
cookie?: never;
|
|
663
679
|
};
|
|
664
|
-
get: operations["
|
|
680
|
+
get: operations["WebhookSubscriptionsController_get"];
|
|
665
681
|
put?: never;
|
|
666
|
-
post
|
|
667
|
-
delete
|
|
682
|
+
post?: never;
|
|
683
|
+
delete: operations["WebhookSubscriptionsController_delete"];
|
|
668
684
|
options?: never;
|
|
669
685
|
head?: never;
|
|
670
|
-
patch
|
|
686
|
+
patch: operations["WebhookSubscriptionsController_update"];
|
|
671
687
|
trace?: never;
|
|
672
688
|
};
|
|
673
|
-
"/api/v1/
|
|
689
|
+
"/api/v1/webhook-subscriptions/{id}/deliveries": {
|
|
674
690
|
parameters: {
|
|
675
691
|
query?: never;
|
|
676
692
|
header?: never;
|
|
677
693
|
path?: never;
|
|
678
694
|
cookie?: never;
|
|
679
695
|
};
|
|
680
|
-
get: operations["
|
|
696
|
+
get: operations["WebhookSubscriptionsController_listDeliveries"];
|
|
681
697
|
put?: never;
|
|
682
698
|
post?: never;
|
|
683
|
-
delete
|
|
699
|
+
delete?: never;
|
|
684
700
|
options?: never;
|
|
685
701
|
head?: never;
|
|
686
|
-
patch
|
|
702
|
+
patch?: never;
|
|
687
703
|
trace?: never;
|
|
688
704
|
};
|
|
689
705
|
"/api/v1/pricing-groups": {
|
|
@@ -759,7 +775,7 @@ interface paths {
|
|
|
759
775
|
};
|
|
760
776
|
get: operations["MembershipsController_listMembers"];
|
|
761
777
|
put?: never;
|
|
762
|
-
post
|
|
778
|
+
post: operations["MembershipsController_addMember"];
|
|
763
779
|
delete?: never;
|
|
764
780
|
options?: never;
|
|
765
781
|
head?: never;
|
|
@@ -981,8 +997,10 @@ interface components {
|
|
|
981
997
|
id: string;
|
|
982
998
|
entity_type: string;
|
|
983
999
|
entity_id: string; /** @enum {string} */
|
|
984
|
-
action: "create" | "
|
|
985
|
-
changes:
|
|
1000
|
+
action: "create" | "delete" | "update";
|
|
1001
|
+
changes: {
|
|
1002
|
+
[key: string]: unknown;
|
|
1003
|
+
};
|
|
986
1004
|
actor_id: string | null; /** Format: date-time */
|
|
987
1005
|
create_time: string;
|
|
988
1006
|
};
|
|
@@ -1016,12 +1034,12 @@ interface components {
|
|
|
1016
1034
|
};
|
|
1017
1035
|
UpdateProjectSettingsDto: {
|
|
1018
1036
|
card_id_prefix?: string | null; /** @enum {string|null} */
|
|
1019
|
-
card_id_character_set?: "
|
|
1037
|
+
card_id_character_set?: "alphanumeric_safe" | "digits" | "letters" | null;
|
|
1020
1038
|
card_id_length?: number | null;
|
|
1021
1039
|
regenerate_card_id_on_term_open?: boolean | null;
|
|
1022
1040
|
timezone?: string | null;
|
|
1023
1041
|
default_currency?: string | null; /** @enum {string|null} */
|
|
1024
|
-
display_locale?: "
|
|
1042
|
+
display_locale?: "de-DE" | "en-GB" | "en-US" | "es-ES" | "fr-FR" | "it-IT" | "nl-NL" | null;
|
|
1025
1043
|
};
|
|
1026
1044
|
CreateOrganizationDto: {
|
|
1027
1045
|
slug: string;
|
|
@@ -1061,7 +1079,7 @@ interface components {
|
|
|
1061
1079
|
description: string;
|
|
1062
1080
|
max_party_size: number;
|
|
1063
1081
|
grace_period_duration: number; /** @enum {string} */
|
|
1064
|
-
grace_period_unit: "day" | "
|
|
1082
|
+
grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
|
|
1065
1083
|
status: "active" | "archived"; /** Format: date-time */
|
|
1066
1084
|
create_time: string; /** Format: date-time */
|
|
1067
1085
|
update_time: string;
|
|
@@ -1086,7 +1104,7 @@ interface components {
|
|
|
1086
1104
|
display_name: string;
|
|
1087
1105
|
max_party_size: number;
|
|
1088
1106
|
grace_period_duration: number; /** @enum {string} */
|
|
1089
|
-
grace_period_unit: "day" | "
|
|
1107
|
+
grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
|
|
1090
1108
|
status: "active" | "archived";
|
|
1091
1109
|
};
|
|
1092
1110
|
UpdatePlanDto: {
|
|
@@ -1095,14 +1113,14 @@ interface components {
|
|
|
1095
1113
|
description: string;
|
|
1096
1114
|
max_party_size: number;
|
|
1097
1115
|
grace_period_duration: number; /** @enum {string} */
|
|
1098
|
-
grace_period_unit: "day" | "
|
|
1116
|
+
grace_period_unit: "day" | "month" | "week" | "year"; /** @enum {string} */
|
|
1099
1117
|
status: "active" | "archived";
|
|
1100
1118
|
};
|
|
1101
1119
|
BillingOption: {
|
|
1102
1120
|
id: string;
|
|
1103
1121
|
plan_id: string;
|
|
1104
1122
|
unit_amount: number; /** @enum {string} */
|
|
1105
|
-
frequency_unit: "day" | "
|
|
1123
|
+
frequency_unit: "day" | "month" | "week" | "year";
|
|
1106
1124
|
frequency_interval: number;
|
|
1107
1125
|
is_recurring: boolean;
|
|
1108
1126
|
display_name: string;
|
|
@@ -1120,7 +1138,7 @@ interface components {
|
|
|
1120
1138
|
};
|
|
1121
1139
|
CreateBillingOptionForPlanDto: {
|
|
1122
1140
|
unit_amount: number; /** @enum {string} */
|
|
1123
|
-
frequency_unit: "day" | "
|
|
1141
|
+
frequency_unit: "day" | "month" | "week" | "year";
|
|
1124
1142
|
frequency_interval: number;
|
|
1125
1143
|
is_recurring: boolean;
|
|
1126
1144
|
display_name: string;
|
|
@@ -1138,7 +1156,7 @@ interface components {
|
|
|
1138
1156
|
};
|
|
1139
1157
|
PlanLinkView: {
|
|
1140
1158
|
id: string; /** @enum {string} */
|
|
1141
|
-
type: "
|
|
1159
|
+
type: "downgrade" | "upgrade";
|
|
1142
1160
|
plan: components["schemas"]["PlanLinkTargetPlan"];
|
|
1143
1161
|
require_interval_match: boolean; /** Format: date-time */
|
|
1144
1162
|
create_time: string; /** Format: date-time */
|
|
@@ -1149,7 +1167,7 @@ interface components {
|
|
|
1149
1167
|
};
|
|
1150
1168
|
CreatePlanLinkDto: {
|
|
1151
1169
|
/** Format: uuid */target_plan_id: string; /** @enum {string} */
|
|
1152
|
-
type: "
|
|
1170
|
+
type: "downgrade" | "upgrade";
|
|
1153
1171
|
require_interval_match: boolean;
|
|
1154
1172
|
};
|
|
1155
1173
|
PlanLink: {
|
|
@@ -1162,7 +1180,7 @@ interface components {
|
|
|
1162
1180
|
};
|
|
1163
1181
|
PlanEntitlementDefinition: {
|
|
1164
1182
|
code: string; /** @enum {string} */
|
|
1165
|
-
type: "
|
|
1183
|
+
type: "discount" | "early_access" | "free_entry" | "guest_pass";
|
|
1166
1184
|
display_name: string;
|
|
1167
1185
|
};
|
|
1168
1186
|
PlanEntitlement: {
|
|
@@ -1171,7 +1189,7 @@ interface components {
|
|
|
1171
1189
|
entitlement_id: string;
|
|
1172
1190
|
discount_percentage: number | null;
|
|
1173
1191
|
quota_limit: number | null; /** @enum {string} */
|
|
1174
|
-
quota_period: "day" | "
|
|
1192
|
+
quota_period: "day" | "month" | "week" | "year";
|
|
1175
1193
|
requires_member_present: boolean;
|
|
1176
1194
|
early_access_days: number | null;
|
|
1177
1195
|
active_during_grace: boolean; /** Format: date-time */
|
|
@@ -1186,7 +1204,7 @@ interface components {
|
|
|
1186
1204
|
/** Format: uuid */entitlement_id: string;
|
|
1187
1205
|
discount_percentage: number;
|
|
1188
1206
|
quota_limit: number; /** @enum {string} */
|
|
1189
|
-
quota_period: "day" | "
|
|
1207
|
+
quota_period: "day" | "month" | "week" | "year";
|
|
1190
1208
|
requires_member_present: boolean;
|
|
1191
1209
|
early_access_days: number;
|
|
1192
1210
|
active_during_grace: boolean;
|
|
@@ -1264,7 +1282,7 @@ interface components {
|
|
|
1264
1282
|
UpdatePlanEntitlementDto: {
|
|
1265
1283
|
discount_percentage: number;
|
|
1266
1284
|
quota_limit: number; /** @enum {string} */
|
|
1267
|
-
quota_period: "day" | "
|
|
1285
|
+
quota_period: "day" | "month" | "week" | "year";
|
|
1268
1286
|
requires_member_present: boolean;
|
|
1269
1287
|
early_access_days: number;
|
|
1270
1288
|
active_during_grace: boolean;
|
|
@@ -1273,7 +1291,7 @@ interface components {
|
|
|
1273
1291
|
id: string;
|
|
1274
1292
|
code: string;
|
|
1275
1293
|
display_name: string; /** @enum {string} */
|
|
1276
|
-
type: "
|
|
1294
|
+
type: "discount" | "early_access" | "free_entry" | "guest_pass";
|
|
1277
1295
|
target: string | null;
|
|
1278
1296
|
description: string | null; /** Format: date-time */
|
|
1279
1297
|
create_time: string; /** Format: date-time */
|
|
@@ -1297,7 +1315,9 @@ interface components {
|
|
|
1297
1315
|
entitlement_code: string;
|
|
1298
1316
|
members: string[];
|
|
1299
1317
|
used_time?: string;
|
|
1300
|
-
context:
|
|
1318
|
+
context: {
|
|
1319
|
+
[key: string]: unknown;
|
|
1320
|
+
};
|
|
1301
1321
|
};
|
|
1302
1322
|
EntitlementUsage: {
|
|
1303
1323
|
id: string;
|
|
@@ -1305,7 +1325,9 @@ interface components {
|
|
|
1305
1325
|
member_id: string;
|
|
1306
1326
|
plan_entitlement_id: string; /** Format: date-time */
|
|
1307
1327
|
used_time: string;
|
|
1308
|
-
context:
|
|
1328
|
+
context: {
|
|
1329
|
+
[key: string]: unknown;
|
|
1330
|
+
} | null;
|
|
1309
1331
|
idempotency_key: string; /** Format: date-time */
|
|
1310
1332
|
create_time: string;
|
|
1311
1333
|
};
|
|
@@ -1315,7 +1337,7 @@ interface components {
|
|
|
1315
1337
|
CreateEntitlementDto: {
|
|
1316
1338
|
code: string;
|
|
1317
1339
|
display_name: string; /** @enum {string} */
|
|
1318
|
-
type: "
|
|
1340
|
+
type: "discount" | "early_access" | "free_entry" | "guest_pass";
|
|
1319
1341
|
target: string;
|
|
1320
1342
|
description: string;
|
|
1321
1343
|
};
|
|
@@ -1365,13 +1387,13 @@ interface components {
|
|
|
1365
1387
|
};
|
|
1366
1388
|
MemberEntitlement: {
|
|
1367
1389
|
code: string; /** @enum {string} */
|
|
1368
|
-
type: "
|
|
1390
|
+
type: "discount" | "early_access" | "free_entry" | "guest_pass";
|
|
1369
1391
|
target: string | null;
|
|
1370
1392
|
display_name: string;
|
|
1371
1393
|
plan_entitlement_id: string;
|
|
1372
1394
|
discount_percentage: number | null;
|
|
1373
1395
|
quota_limit: number | null; /** @enum {string} */
|
|
1374
|
-
quota_period: "day" | "
|
|
1396
|
+
quota_period: "day" | "month" | "week" | "year";
|
|
1375
1397
|
requires_member_present: boolean;
|
|
1376
1398
|
early_access_days: number | null;
|
|
1377
1399
|
active_during_grace: boolean;
|
|
@@ -1379,6 +1401,11 @@ interface components {
|
|
|
1379
1401
|
ListMemberEntitlementsResponse: {
|
|
1380
1402
|
entitlements: components["schemas"]["MemberEntitlement"][];
|
|
1381
1403
|
};
|
|
1404
|
+
UpdateMemberDto: {
|
|
1405
|
+
name?: string;
|
|
1406
|
+
role?: string;
|
|
1407
|
+
date_of_birth?: string | null;
|
|
1408
|
+
};
|
|
1382
1409
|
ReissueCardDto: {
|
|
1383
1410
|
note?: string;
|
|
1384
1411
|
};
|
|
@@ -1398,14 +1425,41 @@ interface components {
|
|
|
1398
1425
|
reason: string;
|
|
1399
1426
|
})[];
|
|
1400
1427
|
admitted: boolean; /** @enum {string|null} */
|
|
1401
|
-
deny_reason: "
|
|
1428
|
+
deny_reason: "card_not_found" | "member_removed" | "membership_cancelled" | "membership_expired" | "membership_incomplete" | "payment_overdue" | null;
|
|
1402
1429
|
member: components["schemas"]["AdmitMember"] | null;
|
|
1403
1430
|
membership_id: string | null; /** @enum {string|null} */
|
|
1404
|
-
membership_status: "
|
|
1431
|
+
membership_status: "active" | "cancelled" | "expired" | "grace_period" | "incomplete" | "past_due" | null;
|
|
1405
1432
|
plan: string | null;
|
|
1406
1433
|
pricing_group: string | null;
|
|
1407
1434
|
entitlements: components["schemas"]["MemberEntitlement"][];
|
|
1408
1435
|
};
|
|
1436
|
+
MemberRole: {
|
|
1437
|
+
id: string;
|
|
1438
|
+
code: string;
|
|
1439
|
+
display_name: string;
|
|
1440
|
+
min_age: number | null;
|
|
1441
|
+
max_age: number | null;
|
|
1442
|
+
description: string | null; /** Format: date-time */
|
|
1443
|
+
create_time: string; /** Format: date-time */
|
|
1444
|
+
update_time: string;
|
|
1445
|
+
};
|
|
1446
|
+
ListMemberRolesResponse: {
|
|
1447
|
+
member_roles: components["schemas"]["MemberRole"][];
|
|
1448
|
+
};
|
|
1449
|
+
CreateMemberRoleDto: {
|
|
1450
|
+
code: string;
|
|
1451
|
+
display_name: string;
|
|
1452
|
+
min_age: number;
|
|
1453
|
+
max_age: number;
|
|
1454
|
+
description: string;
|
|
1455
|
+
};
|
|
1456
|
+
UpdateMemberRoleDto: {
|
|
1457
|
+
code: string;
|
|
1458
|
+
display_name: string;
|
|
1459
|
+
min_age: number;
|
|
1460
|
+
max_age: number;
|
|
1461
|
+
description: string;
|
|
1462
|
+
};
|
|
1409
1463
|
WebhookSubscription: {
|
|
1410
1464
|
id: string;
|
|
1411
1465
|
url: string;
|
|
@@ -1422,8 +1476,10 @@ interface components {
|
|
|
1422
1476
|
id: string;
|
|
1423
1477
|
subscription_id: string;
|
|
1424
1478
|
event_type: string;
|
|
1425
|
-
payload:
|
|
1426
|
-
|
|
1479
|
+
payload: {
|
|
1480
|
+
[key: string]: unknown;
|
|
1481
|
+
}; /** @enum {string} */
|
|
1482
|
+
status: "delivered" | "exhausted" | "failed" | "pending";
|
|
1427
1483
|
attempts: number; /** Format: date-time */
|
|
1428
1484
|
last_attempt_time: string | null; /** Format: date-time */
|
|
1429
1485
|
next_retry_time: string | null;
|
|
@@ -1453,33 +1509,6 @@ interface components {
|
|
|
1453
1509
|
events: string[]; /** @enum {string} */
|
|
1454
1510
|
status: "active" | "inactive";
|
|
1455
1511
|
};
|
|
1456
|
-
MemberRole: {
|
|
1457
|
-
id: string;
|
|
1458
|
-
code: string;
|
|
1459
|
-
display_name: string;
|
|
1460
|
-
min_age: number | null;
|
|
1461
|
-
max_age: number | null;
|
|
1462
|
-
description: string | null; /** Format: date-time */
|
|
1463
|
-
create_time: string; /** Format: date-time */
|
|
1464
|
-
update_time: string;
|
|
1465
|
-
};
|
|
1466
|
-
ListMemberRolesResponse: {
|
|
1467
|
-
member_roles: components["schemas"]["MemberRole"][];
|
|
1468
|
-
};
|
|
1469
|
-
CreateMemberRoleDto: {
|
|
1470
|
-
code: string;
|
|
1471
|
-
display_name: string;
|
|
1472
|
-
min_age: number;
|
|
1473
|
-
max_age: number;
|
|
1474
|
-
description: string;
|
|
1475
|
-
};
|
|
1476
|
-
UpdateMemberRoleDto: {
|
|
1477
|
-
code: string;
|
|
1478
|
-
display_name: string;
|
|
1479
|
-
min_age: number;
|
|
1480
|
-
max_age: number;
|
|
1481
|
-
description: string;
|
|
1482
|
-
};
|
|
1483
1512
|
PricingGroup: {
|
|
1484
1513
|
id: string;
|
|
1485
1514
|
code: string;
|
|
@@ -1517,7 +1546,7 @@ interface components {
|
|
|
1517
1546
|
display_name: string;
|
|
1518
1547
|
unit_amount: number;
|
|
1519
1548
|
currency: string; /** @enum {string} */
|
|
1520
|
-
frequency_unit: "day" | "
|
|
1549
|
+
frequency_unit: "day" | "month" | "week" | "year";
|
|
1521
1550
|
frequency_interval: number;
|
|
1522
1551
|
};
|
|
1523
1552
|
MembershipTerm: {
|
|
@@ -1540,7 +1569,7 @@ interface components {
|
|
|
1540
1569
|
customer_id: string | null; /** Format: date-time */
|
|
1541
1570
|
start_time: string; /** Format: date-time */
|
|
1542
1571
|
end_time: string | null; /** @enum {string} */
|
|
1543
|
-
status: "
|
|
1572
|
+
status: "active" | "cancelled" | "expired" | "grace_period" | "incomplete" | "past_due"; /** Format: date-time */
|
|
1544
1573
|
grace_until: string | null;
|
|
1545
1574
|
auto_renew: boolean;
|
|
1546
1575
|
current_term_id: string | null; /** Format: date-time */
|
|
@@ -1569,6 +1598,13 @@ interface components {
|
|
|
1569
1598
|
ListMembershipMembersResponse: {
|
|
1570
1599
|
members: components["schemas"]["Member"][];
|
|
1571
1600
|
};
|
|
1601
|
+
AddMemberDto: {
|
|
1602
|
+
name: string;
|
|
1603
|
+
role: string;
|
|
1604
|
+
is_primary?: boolean;
|
|
1605
|
+
date_of_birth?: string; /** Format: email */
|
|
1606
|
+
email?: string;
|
|
1607
|
+
};
|
|
1572
1608
|
CreateMembershipMemberDto: {
|
|
1573
1609
|
name: string;
|
|
1574
1610
|
role: string;
|
|
@@ -1597,7 +1633,7 @@ interface components {
|
|
|
1597
1633
|
CancelMembershipDto: {
|
|
1598
1634
|
cancellation_reason?: string;
|
|
1599
1635
|
effective_time?: string; /** @enum {string} */
|
|
1600
|
-
effective_type?: "
|
|
1636
|
+
effective_type?: "at" | "end_of_term" | "immediate";
|
|
1601
1637
|
};
|
|
1602
1638
|
RenewMembershipDto: {
|
|
1603
1639
|
transaction?: components["schemas"]["CreateMembershipTransactionDto"];
|
|
@@ -1612,13 +1648,13 @@ interface components {
|
|
|
1612
1648
|
};
|
|
1613
1649
|
PlanChangeDto: {
|
|
1614
1650
|
/** Format: uuid */new_billing_option_id: string; /** @enum {string} */
|
|
1615
|
-
effective_type?: "
|
|
1651
|
+
effective_type?: "end_of_term" | "immediate";
|
|
1616
1652
|
members?: components["schemas"]["PlanChangeMemberDto"][];
|
|
1617
1653
|
note?: string;
|
|
1618
1654
|
};
|
|
1619
1655
|
MembershipScheduledChangeMemberResponseDto: {
|
|
1620
1656
|
id: string; /** @enum {string} */
|
|
1621
|
-
operation: "
|
|
1657
|
+
operation: "add" | "remove" | "update";
|
|
1622
1658
|
member_id: string | null;
|
|
1623
1659
|
name: string | null;
|
|
1624
1660
|
role_id: string | null;
|
|
@@ -1627,16 +1663,16 @@ interface components {
|
|
|
1627
1663
|
};
|
|
1628
1664
|
MembershipScheduledChangeResponseDto: {
|
|
1629
1665
|
id: string; /** @enum {string} */
|
|
1630
|
-
type: "
|
|
1666
|
+
type: "downgrade" | "upgrade"; /** Format: date-time */
|
|
1631
1667
|
effective_time: string; /** @enum {string} */
|
|
1632
|
-
status: "
|
|
1668
|
+
status: "applied" | "cancelled" | "failed" | "pending" | "superseded";
|
|
1633
1669
|
new_billing_option_id: string;
|
|
1634
1670
|
applied_term_id: string | null;
|
|
1635
1671
|
failure_reason: string | null;
|
|
1636
1672
|
superseded_by_id: string | null;
|
|
1637
1673
|
note: string | null;
|
|
1638
1674
|
created_by: string | null; /** @enum {string} */
|
|
1639
|
-
source: "
|
|
1675
|
+
source: "admin_ui" | "api" | "customer_self_service" | "system";
|
|
1640
1676
|
members: components["schemas"]["MembershipScheduledChangeMemberResponseDto"][]; /** Format: date-time */
|
|
1641
1677
|
create_time: string; /** Format: date-time */
|
|
1642
1678
|
apply_time: string | null;
|
|
@@ -1663,8 +1699,8 @@ interface components {
|
|
|
1663
1699
|
id: string;
|
|
1664
1700
|
membership_id: string;
|
|
1665
1701
|
membership_term_id: string; /** @enum {string} */
|
|
1666
|
-
type: "
|
|
1667
|
-
status: "failed" | "
|
|
1702
|
+
type: "adjustment" | "chargeback" | "credit" | "payment" | "refund"; /** @enum {string} */
|
|
1703
|
+
status: "failed" | "refunded" | "succeeded";
|
|
1668
1704
|
amount_cents: number;
|
|
1669
1705
|
currency: string;
|
|
1670
1706
|
payment_method_ref: string | null;
|
|
@@ -1690,8 +1726,8 @@ interface components {
|
|
|
1690
1726
|
transactions: components["schemas"]["Transaction"][];
|
|
1691
1727
|
};
|
|
1692
1728
|
CreateTransactionDto: {
|
|
1693
|
-
/** @enum {string} */type: "
|
|
1694
|
-
status: "
|
|
1729
|
+
/** @enum {string} */type: "adjustment" | "chargeback" | "credit" | "payment" | "refund"; /** @enum {string} */
|
|
1730
|
+
status: "failed" | "refunded" | "succeeded";
|
|
1695
1731
|
amount_cents: number;
|
|
1696
1732
|
currency?: string; /** Format: uuid */
|
|
1697
1733
|
membership_term_id?: string;
|
|
@@ -1702,12 +1738,17 @@ interface components {
|
|
|
1702
1738
|
failure_reason?: string;
|
|
1703
1739
|
processed_time?: string;
|
|
1704
1740
|
};
|
|
1741
|
+
CustomerMembershipSummary: {
|
|
1742
|
+
/** @description Memberships linked to the customer, as buyer or through a member row. */total_count: number; /** @description Linked memberships whose status is active or grace_period. */
|
|
1743
|
+
active_count: number;
|
|
1744
|
+
};
|
|
1705
1745
|
Customer: {
|
|
1706
1746
|
id: string;
|
|
1707
1747
|
name: string;
|
|
1708
1748
|
email: string; /** Format: date-time */
|
|
1709
1749
|
create_time: string; /** Format: date-time */
|
|
1710
1750
|
update_time: string;
|
|
1751
|
+
membership_summary?: components["schemas"]["CustomerMembershipSummary"];
|
|
1711
1752
|
};
|
|
1712
1753
|
ListCustomersResponse: {
|
|
1713
1754
|
/**
|
|
@@ -3135,24 +3176,20 @@ interface operations {
|
|
|
3135
3176
|
};
|
|
3136
3177
|
};
|
|
3137
3178
|
};
|
|
3138
|
-
|
|
3179
|
+
MembersController_remove: {
|
|
3139
3180
|
parameters: {
|
|
3140
|
-
query?:
|
|
3141
|
-
type?: "free_entry" | "guest_pass" | "discount" | "early_access";
|
|
3142
|
-
};
|
|
3181
|
+
query?: never;
|
|
3143
3182
|
header?: never;
|
|
3144
3183
|
path?: never;
|
|
3145
3184
|
cookie?: never;
|
|
3146
3185
|
};
|
|
3147
3186
|
requestBody?: never;
|
|
3148
3187
|
responses: {
|
|
3149
|
-
|
|
3188
|
+
204: {
|
|
3150
3189
|
headers: {
|
|
3151
3190
|
[name: string]: unknown;
|
|
3152
3191
|
};
|
|
3153
|
-
content
|
|
3154
|
-
"application/json": components["schemas"]["ListMemberEntitlementsResponse"];
|
|
3155
|
-
};
|
|
3192
|
+
content?: never;
|
|
3156
3193
|
};
|
|
3157
3194
|
404: {
|
|
3158
3195
|
headers: {
|
|
@@ -3164,7 +3201,7 @@ interface operations {
|
|
|
3164
3201
|
};
|
|
3165
3202
|
};
|
|
3166
3203
|
};
|
|
3167
|
-
|
|
3204
|
+
MembersController_update: {
|
|
3168
3205
|
parameters: {
|
|
3169
3206
|
query?: never;
|
|
3170
3207
|
header?: never;
|
|
@@ -3173,7 +3210,7 @@ interface operations {
|
|
|
3173
3210
|
};
|
|
3174
3211
|
requestBody: {
|
|
3175
3212
|
content: {
|
|
3176
|
-
"application/json": components["schemas"]["
|
|
3213
|
+
"application/json": components["schemas"]["UpdateMemberDto"];
|
|
3177
3214
|
};
|
|
3178
3215
|
};
|
|
3179
3216
|
responses: {
|
|
@@ -3195,10 +3232,10 @@ interface operations {
|
|
|
3195
3232
|
};
|
|
3196
3233
|
};
|
|
3197
3234
|
};
|
|
3198
|
-
|
|
3235
|
+
MembersController_listEntitlements: {
|
|
3199
3236
|
parameters: {
|
|
3200
|
-
query
|
|
3201
|
-
|
|
3237
|
+
query?: {
|
|
3238
|
+
type?: "discount" | "early_access" | "free_entry" | "guest_pass";
|
|
3202
3239
|
};
|
|
3203
3240
|
header?: never;
|
|
3204
3241
|
path?: never;
|
|
@@ -3211,7 +3248,7 @@ interface operations {
|
|
|
3211
3248
|
[name: string]: unknown;
|
|
3212
3249
|
};
|
|
3213
3250
|
content: {
|
|
3214
|
-
"application/json": components["schemas"]["
|
|
3251
|
+
"application/json": components["schemas"]["ListMemberEntitlementsResponse"];
|
|
3215
3252
|
};
|
|
3216
3253
|
};
|
|
3217
3254
|
404: {
|
|
@@ -3224,7 +3261,7 @@ interface operations {
|
|
|
3224
3261
|
};
|
|
3225
3262
|
};
|
|
3226
3263
|
};
|
|
3227
|
-
|
|
3264
|
+
MembersController_setPrimary: {
|
|
3228
3265
|
parameters: {
|
|
3229
3266
|
query?: never;
|
|
3230
3267
|
header?: never;
|
|
@@ -3238,12 +3275,28 @@ interface operations {
|
|
|
3238
3275
|
[name: string]: unknown;
|
|
3239
3276
|
};
|
|
3240
3277
|
content: {
|
|
3241
|
-
"application/json": components["schemas"]["
|
|
3278
|
+
"application/json": components["schemas"]["Member"];
|
|
3279
|
+
};
|
|
3280
|
+
};
|
|
3281
|
+
404: {
|
|
3282
|
+
headers: {
|
|
3283
|
+
[name: string]: unknown;
|
|
3284
|
+
};
|
|
3285
|
+
content: {
|
|
3286
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3287
|
+
};
|
|
3288
|
+
};
|
|
3289
|
+
409: {
|
|
3290
|
+
headers: {
|
|
3291
|
+
[name: string]: unknown;
|
|
3292
|
+
};
|
|
3293
|
+
content: {
|
|
3294
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3242
3295
|
};
|
|
3243
3296
|
};
|
|
3244
3297
|
};
|
|
3245
3298
|
};
|
|
3246
|
-
|
|
3299
|
+
MembersController_reissueCard: {
|
|
3247
3300
|
parameters: {
|
|
3248
3301
|
query?: never;
|
|
3249
3302
|
header?: never;
|
|
@@ -3252,23 +3305,33 @@ interface operations {
|
|
|
3252
3305
|
};
|
|
3253
3306
|
requestBody: {
|
|
3254
3307
|
content: {
|
|
3255
|
-
"application/json": components["schemas"]["
|
|
3308
|
+
"application/json": components["schemas"]["ReissueCardDto"];
|
|
3256
3309
|
};
|
|
3257
3310
|
};
|
|
3258
3311
|
responses: {
|
|
3259
|
-
|
|
3312
|
+
200: {
|
|
3260
3313
|
headers: {
|
|
3261
3314
|
[name: string]: unknown;
|
|
3262
3315
|
};
|
|
3263
3316
|
content: {
|
|
3264
|
-
"application/json": components["schemas"]["
|
|
3317
|
+
"application/json": components["schemas"]["Member"];
|
|
3318
|
+
};
|
|
3319
|
+
};
|
|
3320
|
+
404: {
|
|
3321
|
+
headers: {
|
|
3322
|
+
[name: string]: unknown;
|
|
3323
|
+
};
|
|
3324
|
+
content: {
|
|
3325
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3265
3326
|
};
|
|
3266
3327
|
};
|
|
3267
3328
|
};
|
|
3268
3329
|
};
|
|
3269
|
-
|
|
3330
|
+
AdmitController_check: {
|
|
3270
3331
|
parameters: {
|
|
3271
|
-
query
|
|
3332
|
+
query: {
|
|
3333
|
+
card: string;
|
|
3334
|
+
};
|
|
3272
3335
|
header?: never;
|
|
3273
3336
|
path?: never;
|
|
3274
3337
|
cookie?: never;
|
|
@@ -3280,7 +3343,7 @@ interface operations {
|
|
|
3280
3343
|
[name: string]: unknown;
|
|
3281
3344
|
};
|
|
3282
3345
|
content: {
|
|
3283
|
-
"application/json": components["schemas"]["
|
|
3346
|
+
"application/json": components["schemas"]["AdmitResult"];
|
|
3284
3347
|
};
|
|
3285
3348
|
};
|
|
3286
3349
|
404: {
|
|
@@ -3293,7 +3356,7 @@ interface operations {
|
|
|
3293
3356
|
};
|
|
3294
3357
|
};
|
|
3295
3358
|
};
|
|
3296
|
-
|
|
3359
|
+
MemberRolesController_list: {
|
|
3297
3360
|
parameters: {
|
|
3298
3361
|
query?: never;
|
|
3299
3362
|
header?: never;
|
|
@@ -3307,38 +3370,76 @@ interface operations {
|
|
|
3307
3370
|
[name: string]: unknown;
|
|
3308
3371
|
};
|
|
3309
3372
|
content: {
|
|
3310
|
-
"application/json":
|
|
3373
|
+
"application/json": components["schemas"]["ListMemberRolesResponse"];
|
|
3311
3374
|
};
|
|
3312
3375
|
};
|
|
3313
|
-
|
|
3376
|
+
};
|
|
3377
|
+
};
|
|
3378
|
+
MemberRolesController_create: {
|
|
3379
|
+
parameters: {
|
|
3380
|
+
query?: never;
|
|
3381
|
+
header?: never;
|
|
3382
|
+
path?: never;
|
|
3383
|
+
cookie?: never;
|
|
3384
|
+
};
|
|
3385
|
+
requestBody: {
|
|
3386
|
+
content: {
|
|
3387
|
+
"application/json": components["schemas"]["CreateMemberRoleDto"];
|
|
3388
|
+
};
|
|
3389
|
+
};
|
|
3390
|
+
responses: {
|
|
3391
|
+
201: {
|
|
3314
3392
|
headers: {
|
|
3315
3393
|
[name: string]: unknown;
|
|
3316
3394
|
};
|
|
3317
3395
|
content: {
|
|
3318
|
-
"application/json": components["schemas"]["
|
|
3396
|
+
"application/json": components["schemas"]["MemberRole"];
|
|
3319
3397
|
};
|
|
3320
3398
|
};
|
|
3321
3399
|
};
|
|
3322
3400
|
};
|
|
3323
|
-
|
|
3401
|
+
MemberRolesController_get: {
|
|
3324
3402
|
parameters: {
|
|
3325
3403
|
query?: never;
|
|
3326
3404
|
header?: never;
|
|
3327
3405
|
path?: never;
|
|
3328
3406
|
cookie?: never;
|
|
3329
3407
|
};
|
|
3330
|
-
requestBody
|
|
3331
|
-
|
|
3332
|
-
|
|
3408
|
+
requestBody?: never;
|
|
3409
|
+
responses: {
|
|
3410
|
+
200: {
|
|
3411
|
+
headers: {
|
|
3412
|
+
[name: string]: unknown;
|
|
3413
|
+
};
|
|
3414
|
+
content: {
|
|
3415
|
+
"application/json": components["schemas"]["MemberRole"];
|
|
3416
|
+
};
|
|
3417
|
+
};
|
|
3418
|
+
404: {
|
|
3419
|
+
headers: {
|
|
3420
|
+
[name: string]: unknown;
|
|
3421
|
+
};
|
|
3422
|
+
content: {
|
|
3423
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3424
|
+
};
|
|
3333
3425
|
};
|
|
3334
3426
|
};
|
|
3427
|
+
};
|
|
3428
|
+
MemberRolesController_delete: {
|
|
3429
|
+
parameters: {
|
|
3430
|
+
query?: never;
|
|
3431
|
+
header?: never;
|
|
3432
|
+
path?: never;
|
|
3433
|
+
cookie?: never;
|
|
3434
|
+
};
|
|
3435
|
+
requestBody?: never;
|
|
3335
3436
|
responses: {
|
|
3336
3437
|
200: {
|
|
3337
3438
|
headers: {
|
|
3338
3439
|
[name: string]: unknown;
|
|
3339
3440
|
};
|
|
3340
3441
|
content: {
|
|
3341
|
-
"application/json":
|
|
3442
|
+
"application/json": Record<string, never>;
|
|
3342
3443
|
};
|
|
3343
3444
|
};
|
|
3344
3445
|
404: {
|
|
@@ -3351,24 +3452,25 @@ interface operations {
|
|
|
3351
3452
|
};
|
|
3352
3453
|
};
|
|
3353
3454
|
};
|
|
3354
|
-
|
|
3455
|
+
MemberRolesController_update: {
|
|
3355
3456
|
parameters: {
|
|
3356
|
-
query?:
|
|
3357
|
-
page_size?: number;
|
|
3358
|
-
page_token?: string;
|
|
3359
|
-
};
|
|
3457
|
+
query?: never;
|
|
3360
3458
|
header?: never;
|
|
3361
3459
|
path?: never;
|
|
3362
3460
|
cookie?: never;
|
|
3363
3461
|
};
|
|
3364
|
-
requestBody
|
|
3462
|
+
requestBody: {
|
|
3463
|
+
content: {
|
|
3464
|
+
"application/json": components["schemas"]["UpdateMemberRoleDto"];
|
|
3465
|
+
};
|
|
3466
|
+
};
|
|
3365
3467
|
responses: {
|
|
3366
3468
|
200: {
|
|
3367
3469
|
headers: {
|
|
3368
3470
|
[name: string]: unknown;
|
|
3369
3471
|
};
|
|
3370
3472
|
content: {
|
|
3371
|
-
"application/json": components["schemas"]["
|
|
3473
|
+
"application/json": components["schemas"]["MemberRole"];
|
|
3372
3474
|
};
|
|
3373
3475
|
};
|
|
3374
3476
|
404: {
|
|
@@ -3381,7 +3483,7 @@ interface operations {
|
|
|
3381
3483
|
};
|
|
3382
3484
|
};
|
|
3383
3485
|
};
|
|
3384
|
-
|
|
3486
|
+
WebhookSubscriptionsController_list: {
|
|
3385
3487
|
parameters: {
|
|
3386
3488
|
query?: never;
|
|
3387
3489
|
header?: never;
|
|
@@ -3395,12 +3497,12 @@ interface operations {
|
|
|
3395
3497
|
[name: string]: unknown;
|
|
3396
3498
|
};
|
|
3397
3499
|
content: {
|
|
3398
|
-
"application/json": components["schemas"]["
|
|
3500
|
+
"application/json": components["schemas"]["ListWebhookSubscriptionsResponse"];
|
|
3399
3501
|
};
|
|
3400
3502
|
};
|
|
3401
3503
|
};
|
|
3402
3504
|
};
|
|
3403
|
-
|
|
3505
|
+
WebhookSubscriptionsController_create: {
|
|
3404
3506
|
parameters: {
|
|
3405
3507
|
query?: never;
|
|
3406
3508
|
header?: never;
|
|
@@ -3409,7 +3511,7 @@ interface operations {
|
|
|
3409
3511
|
};
|
|
3410
3512
|
requestBody: {
|
|
3411
3513
|
content: {
|
|
3412
|
-
"application/json": components["schemas"]["
|
|
3514
|
+
"application/json": components["schemas"]["CreateWebhookSubscriptionDto"];
|
|
3413
3515
|
};
|
|
3414
3516
|
};
|
|
3415
3517
|
responses: {
|
|
@@ -3418,12 +3520,12 @@ interface operations {
|
|
|
3418
3520
|
[name: string]: unknown;
|
|
3419
3521
|
};
|
|
3420
3522
|
content: {
|
|
3421
|
-
"application/json": components["schemas"]["
|
|
3523
|
+
"application/json": components["schemas"]["WebhookSubscription"];
|
|
3422
3524
|
};
|
|
3423
3525
|
};
|
|
3424
3526
|
};
|
|
3425
3527
|
};
|
|
3426
|
-
|
|
3528
|
+
WebhookSubscriptionsController_get: {
|
|
3427
3529
|
parameters: {
|
|
3428
3530
|
query?: never;
|
|
3429
3531
|
header?: never;
|
|
@@ -3437,7 +3539,7 @@ interface operations {
|
|
|
3437
3539
|
[name: string]: unknown;
|
|
3438
3540
|
};
|
|
3439
3541
|
content: {
|
|
3440
|
-
"application/json": components["schemas"]["
|
|
3542
|
+
"application/json": components["schemas"]["WebhookSubscription"];
|
|
3441
3543
|
};
|
|
3442
3544
|
};
|
|
3443
3545
|
404: {
|
|
@@ -3450,7 +3552,7 @@ interface operations {
|
|
|
3450
3552
|
};
|
|
3451
3553
|
};
|
|
3452
3554
|
};
|
|
3453
|
-
|
|
3555
|
+
WebhookSubscriptionsController_delete: {
|
|
3454
3556
|
parameters: {
|
|
3455
3557
|
query?: never;
|
|
3456
3558
|
header?: never;
|
|
@@ -3477,7 +3579,7 @@ interface operations {
|
|
|
3477
3579
|
};
|
|
3478
3580
|
};
|
|
3479
3581
|
};
|
|
3480
|
-
|
|
3582
|
+
WebhookSubscriptionsController_update: {
|
|
3481
3583
|
parameters: {
|
|
3482
3584
|
query?: never;
|
|
3483
3585
|
header?: never;
|
|
@@ -3486,7 +3588,7 @@ interface operations {
|
|
|
3486
3588
|
};
|
|
3487
3589
|
requestBody: {
|
|
3488
3590
|
content: {
|
|
3489
|
-
"application/json": components["schemas"]["
|
|
3591
|
+
"application/json": components["schemas"]["UpdateWebhookSubscriptionDto"];
|
|
3490
3592
|
};
|
|
3491
3593
|
};
|
|
3492
3594
|
responses: {
|
|
@@ -3495,7 +3597,37 @@ interface operations {
|
|
|
3495
3597
|
[name: string]: unknown;
|
|
3496
3598
|
};
|
|
3497
3599
|
content: {
|
|
3498
|
-
"application/json": components["schemas"]["
|
|
3600
|
+
"application/json": components["schemas"]["WebhookSubscription"];
|
|
3601
|
+
};
|
|
3602
|
+
};
|
|
3603
|
+
404: {
|
|
3604
|
+
headers: {
|
|
3605
|
+
[name: string]: unknown;
|
|
3606
|
+
};
|
|
3607
|
+
content: {
|
|
3608
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3609
|
+
};
|
|
3610
|
+
};
|
|
3611
|
+
};
|
|
3612
|
+
};
|
|
3613
|
+
WebhookSubscriptionsController_listDeliveries: {
|
|
3614
|
+
parameters: {
|
|
3615
|
+
query?: {
|
|
3616
|
+
page_size?: number;
|
|
3617
|
+
page_token?: string;
|
|
3618
|
+
};
|
|
3619
|
+
header?: never;
|
|
3620
|
+
path?: never;
|
|
3621
|
+
cookie?: never;
|
|
3622
|
+
};
|
|
3623
|
+
requestBody?: never;
|
|
3624
|
+
responses: {
|
|
3625
|
+
200: {
|
|
3626
|
+
headers: {
|
|
3627
|
+
[name: string]: unknown;
|
|
3628
|
+
};
|
|
3629
|
+
content: {
|
|
3630
|
+
"application/json": components["schemas"]["ListWebhookDeliveriesResponse"];
|
|
3499
3631
|
};
|
|
3500
3632
|
};
|
|
3501
3633
|
404: {
|
|
@@ -3783,6 +3915,45 @@ interface operations {
|
|
|
3783
3915
|
};
|
|
3784
3916
|
};
|
|
3785
3917
|
};
|
|
3918
|
+
MembershipsController_addMember: {
|
|
3919
|
+
parameters: {
|
|
3920
|
+
query?: never;
|
|
3921
|
+
header?: never;
|
|
3922
|
+
path?: never;
|
|
3923
|
+
cookie?: never;
|
|
3924
|
+
};
|
|
3925
|
+
requestBody: {
|
|
3926
|
+
content: {
|
|
3927
|
+
"application/json": components["schemas"]["AddMemberDto"];
|
|
3928
|
+
};
|
|
3929
|
+
};
|
|
3930
|
+
responses: {
|
|
3931
|
+
201: {
|
|
3932
|
+
headers: {
|
|
3933
|
+
[name: string]: unknown;
|
|
3934
|
+
};
|
|
3935
|
+
content: {
|
|
3936
|
+
"application/json": components["schemas"]["Member"];
|
|
3937
|
+
};
|
|
3938
|
+
};
|
|
3939
|
+
404: {
|
|
3940
|
+
headers: {
|
|
3941
|
+
[name: string]: unknown;
|
|
3942
|
+
};
|
|
3943
|
+
content: {
|
|
3944
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3945
|
+
};
|
|
3946
|
+
};
|
|
3947
|
+
409: {
|
|
3948
|
+
headers: {
|
|
3949
|
+
[name: string]: unknown;
|
|
3950
|
+
};
|
|
3951
|
+
content: {
|
|
3952
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
3953
|
+
};
|
|
3954
|
+
};
|
|
3955
|
+
};
|
|
3956
|
+
};
|
|
3786
3957
|
MembershipsController_cancel: {
|
|
3787
3958
|
parameters: {
|
|
3788
3959
|
query?: never;
|
|
@@ -3949,7 +4120,7 @@ interface operations {
|
|
|
3949
4120
|
query?: {
|
|
3950
4121
|
page_size?: number;
|
|
3951
4122
|
page_token?: string;
|
|
3952
|
-
status?: ("
|
|
4123
|
+
status?: ("all" | "applied" | "cancelled" | "failed" | "pending" | "superseded")[];
|
|
3953
4124
|
};
|
|
3954
4125
|
header?: never;
|
|
3955
4126
|
path?: never;
|
|
@@ -4097,7 +4268,8 @@ interface operations {
|
|
|
4097
4268
|
parameters: {
|
|
4098
4269
|
query?: {
|
|
4099
4270
|
page_size?: number;
|
|
4100
|
-
page_token?: string;
|
|
4271
|
+
page_token?: string; /** @description Response detail level; `full` populates `membership_summary`. */
|
|
4272
|
+
view?: "basic" | "full";
|
|
4101
4273
|
};
|
|
4102
4274
|
header?: never;
|
|
4103
4275
|
path?: never;
|
|
@@ -4148,7 +4320,9 @@ interface operations {
|
|
|
4148
4320
|
};
|
|
4149
4321
|
CustomersController_get: {
|
|
4150
4322
|
parameters: {
|
|
4151
|
-
query?:
|
|
4323
|
+
query?: {
|
|
4324
|
+
/** @description Response detail level; `full` populates `membership_summary`. */view?: "basic" | "full";
|
|
4325
|
+
};
|
|
4152
4326
|
header?: never;
|
|
4153
4327
|
path?: never;
|
|
4154
4328
|
cookie?: never;
|
|
@@ -4403,6 +4577,7 @@ type BillingOption = Schemas['BillingOption'];
|
|
|
4403
4577
|
type Membership = Schemas['Membership'];
|
|
4404
4578
|
type MembershipTerm = Schemas['MembershipTerm'];
|
|
4405
4579
|
type Customer = Schemas['Customer'];
|
|
4580
|
+
type CustomerMembershipSummary = Schemas['CustomerMembershipSummary'];
|
|
4406
4581
|
type Member = Schemas['Member'];
|
|
4407
4582
|
type SyncMember = Schemas['SyncMember'];
|
|
4408
4583
|
type MemberEntitlement = Schemas['MemberEntitlement'];
|
|
@@ -4424,6 +4599,7 @@ type ScheduledChange = Schemas['MembershipScheduledChangeResponseDto'];
|
|
|
4424
4599
|
type PlanChangeResult = Schemas['PlanChangeResponseDto'];
|
|
4425
4600
|
type MemberSyncResponse = Schemas['MemberSyncResponse'];
|
|
4426
4601
|
type RedeemEntitlementResponse = Schemas['RedeemEntitlementResponseDto'];
|
|
4602
|
+
type CustomerView = 'basic' | 'full';
|
|
4427
4603
|
interface PageParams {
|
|
4428
4604
|
/** Rows per page. Server default 50; capped at 250. */
|
|
4429
4605
|
page_size?: number;
|
|
@@ -4446,6 +4622,8 @@ type UpdateCustomerParams = Schemas['UpdateCustomerDto'];
|
|
|
4446
4622
|
type RedeemEntitlementParams = Schemas['RedeemEntitlementDto'];
|
|
4447
4623
|
type RecordUsageParams = Schemas['CreateEntitlementUsageDto'];
|
|
4448
4624
|
type ReissueCardParams = Schemas['ReissueCardDto'];
|
|
4625
|
+
type AddMemberParams = Schemas['AddMemberDto'];
|
|
4626
|
+
type UpdateMemberParams = Schemas['UpdateMemberDto'];
|
|
4449
4627
|
type CreatePlanParams = Schemas['CreatePlanDto'];
|
|
4450
4628
|
type UpdatePlanParams = Schemas['UpdatePlanDto'];
|
|
4451
4629
|
type CreateBillingOptionParams = Schemas['CreateBillingOptionForPlanDto'];
|
|
@@ -4501,8 +4679,18 @@ declare class BillingOptionsResource extends APIResource {
|
|
|
4501
4679
|
//#endregion
|
|
4502
4680
|
//#region src/resources/customers.d.ts
|
|
4503
4681
|
declare class CustomersResource extends APIResource {
|
|
4504
|
-
|
|
4505
|
-
|
|
4682
|
+
/**
|
|
4683
|
+
* Pass `view: 'full'` to include `membership_summary` on every customer.
|
|
4684
|
+
*/
|
|
4685
|
+
list(params?: PageParams & {
|
|
4686
|
+
view?: CustomerView;
|
|
4687
|
+
}, options?: RequestOptions): Promise<Page<Customer>>;
|
|
4688
|
+
/**
|
|
4689
|
+
* Pass `view: 'full'` to include `membership_summary`.
|
|
4690
|
+
*/
|
|
4691
|
+
get(id: string, params?: {
|
|
4692
|
+
view?: CustomerView;
|
|
4693
|
+
}, options?: RequestOptions): Promise<Customer>;
|
|
4506
4694
|
create(params: CreateCustomerParams, options?: RequestOptions): Promise<Customer>;
|
|
4507
4695
|
update(id: string, params: UpdateCustomerParams, options?: RequestOptions): Promise<Customer>;
|
|
4508
4696
|
delete(id: string, options?: RequestOptions): Promise<void>;
|
|
@@ -4551,6 +4739,22 @@ declare class MembersResource extends APIResource {
|
|
|
4551
4739
|
listEntitlements(id: string, params?: {
|
|
4552
4740
|
type?: EntitlementType;
|
|
4553
4741
|
}, options?: RequestOptions): Promise<MemberEntitlement[]>;
|
|
4742
|
+
/**
|
|
4743
|
+
* Updates a member's details. Accepts `name`, `date_of_birth` and `role`
|
|
4744
|
+
* (a member-role code). To reassign the primary member use `setPrimary`;
|
|
4745
|
+
* to rotate a card use `reissueCard`.
|
|
4746
|
+
*/
|
|
4747
|
+
update(id: string, params: UpdateMemberParams, options?: RequestOptions): Promise<Member>;
|
|
4748
|
+
/**
|
|
4749
|
+
* Remove a member from its membership. Rejected if it is the last member
|
|
4750
|
+
* or the sole primary — reassign the primary first with `setPrimary`.
|
|
4751
|
+
*/
|
|
4752
|
+
remove(id: string, options?: RequestOptions): Promise<void>;
|
|
4753
|
+
/**
|
|
4754
|
+
* Make this member the primary of its membership, demoting the current
|
|
4755
|
+
* primary atomically. A no-op if it is already primary.
|
|
4756
|
+
*/
|
|
4757
|
+
setPrimary(id: string, options?: RequestOptions): Promise<Member>;
|
|
4554
4758
|
/** Issue a fresh card id, invalidating the old card at the gate. */
|
|
4555
4759
|
reissueCard(id: string, params?: ReissueCardParams, options?: RequestOptions): Promise<Member>;
|
|
4556
4760
|
}
|
|
@@ -4581,6 +4785,12 @@ declare class MembershipsResource extends APIResource {
|
|
|
4581
4785
|
*/
|
|
4582
4786
|
createTransaction(id: string, params: CreateTransactionParams, options?: IdempotentRequestOptions): Promise<Transaction>;
|
|
4583
4787
|
listMembers(id: string, options?: RequestOptions): Promise<Member[]>;
|
|
4788
|
+
/**
|
|
4789
|
+
* Add a member to an existing membership, up to the plan's max party size.
|
|
4790
|
+
* `role` is a member-role code; an optional `email` links the member to a
|
|
4791
|
+
* customer record. Rejected on cancelled or expired memberships.
|
|
4792
|
+
*/
|
|
4793
|
+
addMember(id: string, params: AddMemberParams, options?: RequestOptions): Promise<Member>;
|
|
4584
4794
|
/**
|
|
4585
4795
|
* Open the next term. Rejected (409) while cancelled or cancellation-pending.
|
|
4586
4796
|
* Idempotent: the Idempotency-Key is generated once per call (and reused
|
|
@@ -4678,7 +4888,7 @@ declare class WebhookSubscriptionsResource extends APIResource {
|
|
|
4678
4888
|
* emission), the web app (subscription UI), and the SDK (typed webhook
|
|
4679
4889
|
* events). UI copy (labels, descriptions, categories) lives in ophelio-web.
|
|
4680
4890
|
*/
|
|
4681
|
-
declare const WEBHOOK_EVENT_CODES: readonly ["membership.created", "membership.renewed", "membership.renewal_due", "membership.payment_failed", "membership.expired", "membership.grace_entered", "membership.cancelled", "membership.upgraded", "membership.downgraded", "scheduled_change.failed", "entitlement.used", "member.card_issued", "member.removed", "plan.updated"];
|
|
4891
|
+
declare const WEBHOOK_EVENT_CODES: readonly ["membership.created", "membership.renewed", "membership.renewal_due", "membership.payment_failed", "membership.expired", "membership.grace_entered", "membership.cancelled", "membership.upgraded", "membership.downgraded", "scheduled_change.failed", "entitlement.used", "member.added", "member.card_issued", "member.updated", "member.removed", "plan.updated"];
|
|
4682
4892
|
type WebhookEventCode = (typeof WEBHOOK_EVENT_CODES)[number]; //#endregion
|
|
4683
4893
|
//#endregion
|
|
4684
4894
|
//#region src/webhooks/events.d.ts
|
|
@@ -4815,4 +5025,4 @@ declare function paginate<T>(fetchPage: (params: PageParams) => Promise<Page<T>>
|
|
|
4815
5025
|
*/
|
|
4816
5026
|
declare function collect<T>(fetchPage: (params: PageParams) => Promise<Page<T>>, params?: PageParams): Promise<T[]>;
|
|
4817
5027
|
//#endregion
|
|
4818
|
-
export { AdmitResult, AlreadyExistsError, BillingOption, BillingOptionSalesChannel, CancelMembershipParams, CreateBillingOptionParams, CreateBillingOptionSalesChannelParams, CreateCustomerParams, CreateEntitlementParams, CreateMemberRoleParams, CreateMembershipParams, CreatePlanEntitlementParams, CreatePlanLinkParams, CreatePlanParams, CreatePlanPricingGroupMappingParams, CreatePricingGroupParams, CreateSalesChannelParams, CreateTransactionParams, CreateWebhookSubscriptionParams, Customer, DEFAULT_BASE_URL, Entitlement, EntitlementType, EntitlementUsage, type IdempotentRequestOptions, InternalError, InvalidArgumentError, Member, MemberEntitlement, MemberRole, MemberSyncResponse, Membership, MembershipTerm, NotFoundError, Ophelio, OphelioConnectionError, OphelioError, type OphelioOptions, OphelioTimeoutError, type OphelioWebhookEvent, Page, PageParams, PermissionDeniedError, Plan, PlanChangeParams, PlanChangeResult, PlanEntitlement, PlanLink, PlanLinkView, PlanPricingGroupMapping, PricingGroup, RecordUsageParams, RedeemEntitlementParams, RedeemEntitlementResponse, ReissueCardParams, RenewMembershipParams, type RequestOptions, ResourceExhaustedError, SalesChannel, ScheduledChange, SyncMember, Transaction, UnauthenticatedError, UnavailableError, UnimplementedError, UpdateBillingOptionParams, UpdateCustomerParams, UpdateEntitlementParams, UpdateMemberRoleParams, UpdateMembershipParams, UpdatePlanEntitlementParams, UpdatePlanParams, UpdatePricingGroupParams, UpdateSalesChannelParams, UpdateWebhookSubscriptionParams, WEBHOOK_EVENT_CODES, WebhookDelivery, type WebhookEventCode, WebhookSignatureVerificationError, WebhookSubscription, collect, type components, constructEvent, type operations, paginate, type paths, verifyWebhookSignature };
|
|
5028
|
+
export { AddMemberParams, AdmitResult, AlreadyExistsError, BillingOption, BillingOptionSalesChannel, CancelMembershipParams, CreateBillingOptionParams, CreateBillingOptionSalesChannelParams, CreateCustomerParams, CreateEntitlementParams, CreateMemberRoleParams, CreateMembershipParams, CreatePlanEntitlementParams, CreatePlanLinkParams, CreatePlanParams, CreatePlanPricingGroupMappingParams, CreatePricingGroupParams, CreateSalesChannelParams, CreateTransactionParams, CreateWebhookSubscriptionParams, Customer, CustomerMembershipSummary, CustomerView, DEFAULT_BASE_URL, Entitlement, EntitlementType, EntitlementUsage, type IdempotentRequestOptions, InternalError, InvalidArgumentError, Member, MemberEntitlement, MemberRole, MemberSyncResponse, Membership, MembershipTerm, NotFoundError, Ophelio, OphelioConnectionError, OphelioError, type OphelioOptions, OphelioTimeoutError, type OphelioWebhookEvent, Page, PageParams, PermissionDeniedError, Plan, PlanChangeParams, PlanChangeResult, PlanEntitlement, PlanLink, PlanLinkView, PlanPricingGroupMapping, PricingGroup, RecordUsageParams, RedeemEntitlementParams, RedeemEntitlementResponse, ReissueCardParams, RenewMembershipParams, type RequestOptions, ResourceExhaustedError, SalesChannel, ScheduledChange, SyncMember, Transaction, UnauthenticatedError, UnavailableError, UnimplementedError, UpdateBillingOptionParams, UpdateCustomerParams, UpdateEntitlementParams, UpdateMemberParams, UpdateMemberRoleParams, UpdateMembershipParams, UpdatePlanEntitlementParams, UpdatePlanParams, UpdatePricingGroupParams, UpdateSalesChannelParams, UpdateWebhookSubscriptionParams, WEBHOOK_EVENT_CODES, WebhookDelivery, type WebhookEventCode, WebhookSignatureVerificationError, WebhookSubscription, collect, type components, constructEvent, type operations, paginate, type paths, verifyWebhookSignature };
|