@aimee.shop/sdk 0.20.0-dev.155 → 0.20.0-dev.157
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.
|
@@ -1459,7 +1459,7 @@ export interface paths {
|
|
|
1459
1459
|
head?: never;
|
|
1460
1460
|
/**
|
|
1461
1461
|
* Update a tenant
|
|
1462
|
-
* @description Update an existing tenant with new data. Tenant owners can update their own tenant settings.
|
|
1462
|
+
* @description Update an existing tenant with new data. Tenant owners can update their own tenant settings. billingType, isSandbox, sandboxTenantId and productionTenantId are staff-only and rejected here.
|
|
1463
1463
|
*/
|
|
1464
1464
|
patch: operations['TenantsController_update'];
|
|
1465
1465
|
trace?: never;
|
|
@@ -1495,7 +1495,7 @@ export interface paths {
|
|
|
1495
1495
|
put?: never;
|
|
1496
1496
|
/**
|
|
1497
1497
|
* Suspend a tenant
|
|
1498
|
-
* @description Suspend a tenant by setting its status to suspended. This prevents access to the tenant while preserving data. Platform admin only; audited.
|
|
1498
|
+
* @description Suspend a tenant by setting its status to suspended. This prevents access to the tenant while preserving data. The cause (default manual), reason, time and actor are kept on the tenant until it is activated. Platform admin only; audited.
|
|
1499
1499
|
*/
|
|
1500
1500
|
post: operations['TenantsController_suspend'];
|
|
1501
1501
|
delete?: never;
|
|
@@ -1504,6 +1504,46 @@ export interface paths {
|
|
|
1504
1504
|
patch?: never;
|
|
1505
1505
|
trace?: never;
|
|
1506
1506
|
};
|
|
1507
|
+
'/v1/tenants/{id}/billing-type': {
|
|
1508
|
+
parameters: {
|
|
1509
|
+
query?: never;
|
|
1510
|
+
header?: never;
|
|
1511
|
+
path?: never;
|
|
1512
|
+
cookie?: never;
|
|
1513
|
+
};
|
|
1514
|
+
get?: never;
|
|
1515
|
+
put?: never;
|
|
1516
|
+
/**
|
|
1517
|
+
* Set a tenant billing type
|
|
1518
|
+
* @description Change how Aimee collects the platform fee from this tenant. Platform admin only; audited.
|
|
1519
|
+
*/
|
|
1520
|
+
post: operations['TenantsController_setBillingType'];
|
|
1521
|
+
delete?: never;
|
|
1522
|
+
options?: never;
|
|
1523
|
+
head?: never;
|
|
1524
|
+
patch?: never;
|
|
1525
|
+
trace?: never;
|
|
1526
|
+
};
|
|
1527
|
+
'/v1/tenants/{id}/sandbox': {
|
|
1528
|
+
parameters: {
|
|
1529
|
+
query?: never;
|
|
1530
|
+
header?: never;
|
|
1531
|
+
path?: never;
|
|
1532
|
+
cookie?: never;
|
|
1533
|
+
};
|
|
1534
|
+
get?: never;
|
|
1535
|
+
put?: never;
|
|
1536
|
+
/**
|
|
1537
|
+
* Set whether a tenant is a sandbox
|
|
1538
|
+
* @description Sandbox tenants skip billing usage and cannot use live payment credentials. Platform admin only; audited.
|
|
1539
|
+
*/
|
|
1540
|
+
post: operations['TenantsController_setSandbox'];
|
|
1541
|
+
delete?: never;
|
|
1542
|
+
options?: never;
|
|
1543
|
+
head?: never;
|
|
1544
|
+
patch?: never;
|
|
1545
|
+
trace?: never;
|
|
1546
|
+
};
|
|
1507
1547
|
'/v1/tenants/{id}/activate': {
|
|
1508
1548
|
parameters: {
|
|
1509
1549
|
query?: never;
|
|
@@ -16213,6 +16253,15 @@ export interface components {
|
|
|
16213
16253
|
* @enum {string|null}
|
|
16214
16254
|
*/
|
|
16215
16255
|
suspensionCause?: 'manual' | 'non_payment' | null;
|
|
16256
|
+
/** @description Reason given for the current suspension; null unless status is suspended. */
|
|
16257
|
+
suspensionReason?: string | null;
|
|
16258
|
+
/**
|
|
16259
|
+
* Format: date-time
|
|
16260
|
+
* @description When the current suspension started; null unless status is suspended.
|
|
16261
|
+
*/
|
|
16262
|
+
suspendedAt?: string | null;
|
|
16263
|
+
/** @description Staff user who suspended the tenant; null for a system (non_payment) suspension or when not suspended. */
|
|
16264
|
+
suspendedBy?: string | null;
|
|
16216
16265
|
/**
|
|
16217
16266
|
* @description Platform fee collection path. SELF_SERVICE_CARD for public signup; ENTERPRISE_INVOICE for hand-onboarded orgs. Null when not set.
|
|
16218
16267
|
* @example SELF_SERVICE_CARD
|
|
@@ -16421,28 +16470,6 @@ export interface components {
|
|
|
16421
16470
|
* @example ACME
|
|
16422
16471
|
*/
|
|
16423
16472
|
orderNumberPrefix?: string;
|
|
16424
|
-
/**
|
|
16425
|
-
* @description Whether this tenant is a sandbox environment
|
|
16426
|
-
* @default false
|
|
16427
|
-
* @example false
|
|
16428
|
-
*/
|
|
16429
|
-
isSandbox?: boolean;
|
|
16430
|
-
/**
|
|
16431
|
-
* @description Platform fee collection path. SELF_SERVICE_CARD for public signup; ENTERPRISE_INVOICE for hand-onboarded orgs.
|
|
16432
|
-
* @example SELF_SERVICE_CARD
|
|
16433
|
-
* @enum {string}
|
|
16434
|
-
*/
|
|
16435
|
-
billingType?: 'SELF_SERVICE_CARD' | 'ENTERPRISE_INVOICE';
|
|
16436
|
-
/**
|
|
16437
|
-
* @description UUID of the sandbox tenant (for production tenants)
|
|
16438
|
-
* @example 550e8400-e29b-41d4-a716-446655440000
|
|
16439
|
-
*/
|
|
16440
|
-
sandboxTenantId?: string;
|
|
16441
|
-
/**
|
|
16442
|
-
* @description UUID of the production tenant (for sandbox tenants)
|
|
16443
|
-
* @example 550e8400-e29b-41d4-a716-446655440000
|
|
16444
|
-
*/
|
|
16445
|
-
productionTenantId?: string;
|
|
16446
16473
|
/**
|
|
16447
16474
|
* @description CMS type (strapi, contentful, sanity, etc.)
|
|
16448
16475
|
* @example strapi
|
|
@@ -16546,6 +16573,27 @@ export interface components {
|
|
|
16546
16573
|
* @example Suspended after repeated charge failures
|
|
16547
16574
|
*/
|
|
16548
16575
|
notes?: string;
|
|
16576
|
+
/**
|
|
16577
|
+
* @description Why the tenant is suspended. non_payment is lifted automatically when the unpaid platform invoice is paid.
|
|
16578
|
+
* @default manual
|
|
16579
|
+
* @enum {string}
|
|
16580
|
+
*/
|
|
16581
|
+
cause?: 'manual' | 'non_payment';
|
|
16582
|
+
};
|
|
16583
|
+
SetTenantBillingTypeDto: {
|
|
16584
|
+
/**
|
|
16585
|
+
* @description Platform fee collection path. SELF_SERVICE_CARD charges the vaulted card; ENTERPRISE_INVOICE is invoiced manually.
|
|
16586
|
+
* @example ENTERPRISE_INVOICE
|
|
16587
|
+
* @enum {string}
|
|
16588
|
+
*/
|
|
16589
|
+
billingType: 'SELF_SERVICE_CARD' | 'ENTERPRISE_INVOICE';
|
|
16590
|
+
};
|
|
16591
|
+
SetTenantSandboxDto: {
|
|
16592
|
+
/**
|
|
16593
|
+
* @description Whether the tenant is a sandbox. Sandbox tenants skip billing usage and cannot use live payment credentials.
|
|
16594
|
+
* @example false
|
|
16595
|
+
*/
|
|
16596
|
+
isSandbox: boolean;
|
|
16549
16597
|
};
|
|
16550
16598
|
ActivateTenantDto: {
|
|
16551
16599
|
/**
|
|
@@ -16595,6 +16643,12 @@ export interface components {
|
|
|
16595
16643
|
* @example en-US
|
|
16596
16644
|
*/
|
|
16597
16645
|
defaultLocale?: string;
|
|
16646
|
+
/**
|
|
16647
|
+
* @description Platform fee collection path. Defaults to ENTERPRISE_INVOICE when omitted.
|
|
16648
|
+
* @example ENTERPRISE_INVOICE
|
|
16649
|
+
* @enum {string}
|
|
16650
|
+
*/
|
|
16651
|
+
billingType?: 'SELF_SERVICE_CARD' | 'ENTERPRISE_INVOICE';
|
|
16598
16652
|
/**
|
|
16599
16653
|
* @description Store name
|
|
16600
16654
|
* @example Acme Store
|
|
@@ -40669,6 +40723,88 @@ export interface operations {
|
|
|
40669
40723
|
};
|
|
40670
40724
|
};
|
|
40671
40725
|
};
|
|
40726
|
+
TenantsController_setBillingType: {
|
|
40727
|
+
parameters: {
|
|
40728
|
+
query?: never;
|
|
40729
|
+
header?: never;
|
|
40730
|
+
path: {
|
|
40731
|
+
/** @description Tenant ID (UUID) */
|
|
40732
|
+
id: string;
|
|
40733
|
+
};
|
|
40734
|
+
cookie?: never;
|
|
40735
|
+
};
|
|
40736
|
+
requestBody: {
|
|
40737
|
+
content: {
|
|
40738
|
+
'application/json': components['schemas']['SetTenantBillingTypeDto'];
|
|
40739
|
+
};
|
|
40740
|
+
};
|
|
40741
|
+
responses: {
|
|
40742
|
+
/** @description Billing type set */
|
|
40743
|
+
200: {
|
|
40744
|
+
headers: {
|
|
40745
|
+
[name: string]: unknown;
|
|
40746
|
+
};
|
|
40747
|
+
content: {
|
|
40748
|
+
'application/json': components['schemas']['TenantDto'];
|
|
40749
|
+
};
|
|
40750
|
+
};
|
|
40751
|
+
/** @description Unauthorized */
|
|
40752
|
+
401: {
|
|
40753
|
+
headers: {
|
|
40754
|
+
[name: string]: unknown;
|
|
40755
|
+
};
|
|
40756
|
+
content?: never;
|
|
40757
|
+
};
|
|
40758
|
+
/** @description Tenant not found */
|
|
40759
|
+
404: {
|
|
40760
|
+
headers: {
|
|
40761
|
+
[name: string]: unknown;
|
|
40762
|
+
};
|
|
40763
|
+
content?: never;
|
|
40764
|
+
};
|
|
40765
|
+
};
|
|
40766
|
+
};
|
|
40767
|
+
TenantsController_setSandbox: {
|
|
40768
|
+
parameters: {
|
|
40769
|
+
query?: never;
|
|
40770
|
+
header?: never;
|
|
40771
|
+
path: {
|
|
40772
|
+
/** @description Tenant ID (UUID) */
|
|
40773
|
+
id: string;
|
|
40774
|
+
};
|
|
40775
|
+
cookie?: never;
|
|
40776
|
+
};
|
|
40777
|
+
requestBody: {
|
|
40778
|
+
content: {
|
|
40779
|
+
'application/json': components['schemas']['SetTenantSandboxDto'];
|
|
40780
|
+
};
|
|
40781
|
+
};
|
|
40782
|
+
responses: {
|
|
40783
|
+
/** @description Sandbox flag set */
|
|
40784
|
+
200: {
|
|
40785
|
+
headers: {
|
|
40786
|
+
[name: string]: unknown;
|
|
40787
|
+
};
|
|
40788
|
+
content: {
|
|
40789
|
+
'application/json': components['schemas']['TenantDto'];
|
|
40790
|
+
};
|
|
40791
|
+
};
|
|
40792
|
+
/** @description Unauthorized */
|
|
40793
|
+
401: {
|
|
40794
|
+
headers: {
|
|
40795
|
+
[name: string]: unknown;
|
|
40796
|
+
};
|
|
40797
|
+
content?: never;
|
|
40798
|
+
};
|
|
40799
|
+
/** @description Tenant not found */
|
|
40800
|
+
404: {
|
|
40801
|
+
headers: {
|
|
40802
|
+
[name: string]: unknown;
|
|
40803
|
+
};
|
|
40804
|
+
content?: never;
|
|
40805
|
+
};
|
|
40806
|
+
};
|
|
40807
|
+
};
|
|
40672
40808
|
TenantsController_activate: {
|
|
40673
40809
|
parameters: {
|
|
40674
40810
|
query?: never;
|