@shipstatic/types 2.17.0-beta.2 → 2.17.0-beta.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.ts +15 -4
- package/dist/index.js +4 -3
- package/package.json +1 -1
- package/src/index.ts +14 -4
package/dist/index.d.ts
CHANGED
|
@@ -669,6 +669,16 @@ export interface Account {
|
|
|
669
669
|
* `DELETE /billing/change` releases it.
|
|
670
670
|
*/
|
|
671
671
|
readonly scheduled: ScheduledChange | null;
|
|
672
|
+
/**
|
|
673
|
+
* When the Subscription is set to END — Stripe's `cancel_at`, mirrored
|
|
674
|
+
* (Unix seconds) — or `null` while it renews. Set by a cancellation in the
|
|
675
|
+
* Customer Portal; the Portal is also where it is resumed. The console
|
|
676
|
+
* needs it to ACT: no "cancel" offered to an account already cancelling,
|
|
677
|
+
* and no plan change offered until it is resumed (the API refuses one).
|
|
678
|
+
* Mirrored on the rule that survives: what the console must act on is
|
|
679
|
+
* mirrored, what it would merely display is not.
|
|
680
|
+
*/
|
|
681
|
+
readonly cancelAt: number | null;
|
|
672
682
|
}
|
|
673
683
|
/**
|
|
674
684
|
* Account as returned by `GET /account` — the entity plus how the request
|
|
@@ -1213,8 +1223,10 @@ export declare const SIGN_IN_RETURN_PARAM = "signing-in";
|
|
|
1213
1223
|
* Client populations: `SESSION` (first-party cookie), `API_KEY` (`ship-`
|
|
1214
1224
|
* key), `TOKEN` (`deploy-` deploy token), `AGENT` (anonymous public deploy —
|
|
1215
1225
|
* no credential; the platform grants the public-account identity per
|
|
1216
|
-
* request), `OAUTH` (delegated access token).
|
|
1217
|
-
*
|
|
1226
|
+
* request), `OAUTH` (delegated access token). The one server population:
|
|
1227
|
+
* `SYSTEM` (scheduled/background jobs). Webhook receipt is deliberately not
|
|
1228
|
+
* a population: a signed delivery is verified, never authorized — it acts
|
|
1229
|
+
* as no one and audits as no one.
|
|
1218
1230
|
*/
|
|
1219
1231
|
export declare const AuthMethod: {
|
|
1220
1232
|
readonly SESSION: "session";
|
|
@@ -1222,7 +1234,6 @@ export declare const AuthMethod: {
|
|
|
1222
1234
|
readonly TOKEN: "token";
|
|
1223
1235
|
readonly AGENT: "agent";
|
|
1224
1236
|
readonly OAUTH: "oauth";
|
|
1225
|
-
readonly WEBHOOK: "webhook";
|
|
1226
1237
|
readonly SYSTEM: "system";
|
|
1227
1238
|
};
|
|
1228
1239
|
export type AuthMethodType = (typeof AuthMethod)[keyof typeof AuthMethod];
|
|
@@ -1929,7 +1940,7 @@ export interface BillingSyncResponse {
|
|
|
1929
1940
|
* All activity event types logged in the system.
|
|
1930
1941
|
* Uses dot notation consistently: {resource}.{action}
|
|
1931
1942
|
*/
|
|
1932
|
-
export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.
|
|
1943
|
+
export type ActivityEvent = 'account.create' | 'account.update' | 'account.delete' | 'account.key.generate' | 'account.plan.transition' | 'deployment.create' | 'deployment.update' | 'deployment.delete' | 'deployment.claim' | 'deployment.flagged' | 'deployment.open' | 'domain.create' | 'domain.update' | 'domain.delete' | 'domain.verify' | 'token.create' | 'token.consume' | 'token.delete' | 'admin.account.plan.update' | 'admin.account.suspended.update' | 'admin.account.ref.update' | 'admin.account.labels.update' | 'admin.deployment.delete' | 'admin.domain.delete' | 'admin.impersonate';
|
|
1933
1944
|
/**
|
|
1934
1945
|
* Activity events visible to users in the dashboard
|
|
1935
1946
|
*/
|
package/dist/index.js
CHANGED
|
@@ -1150,8 +1150,10 @@ export const SIGN_IN_RETURN_PARAM = 'signing-in';
|
|
|
1150
1150
|
* Client populations: `SESSION` (first-party cookie), `API_KEY` (`ship-`
|
|
1151
1151
|
* key), `TOKEN` (`deploy-` deploy token), `AGENT` (anonymous public deploy —
|
|
1152
1152
|
* no credential; the platform grants the public-account identity per
|
|
1153
|
-
* request), `OAUTH` (delegated access token).
|
|
1154
|
-
*
|
|
1153
|
+
* request), `OAUTH` (delegated access token). The one server population:
|
|
1154
|
+
* `SYSTEM` (scheduled/background jobs). Webhook receipt is deliberately not
|
|
1155
|
+
* a population: a signed delivery is verified, never authorized — it acts
|
|
1156
|
+
* as no one and audits as no one.
|
|
1155
1157
|
*/
|
|
1156
1158
|
export const AuthMethod = {
|
|
1157
1159
|
SESSION: 'session',
|
|
@@ -1159,7 +1161,6 @@ export const AuthMethod = {
|
|
|
1159
1161
|
TOKEN: 'token',
|
|
1160
1162
|
AGENT: 'agent',
|
|
1161
1163
|
OAUTH: 'oauth',
|
|
1162
|
-
WEBHOOK: 'webhook',
|
|
1163
1164
|
SYSTEM: 'system',
|
|
1164
1165
|
};
|
|
1165
1166
|
/**
|
package/package.json
CHANGED
package/src/index.ts
CHANGED
|
@@ -744,6 +744,16 @@ export interface Account {
|
|
|
744
744
|
* `DELETE /billing/change` releases it.
|
|
745
745
|
*/
|
|
746
746
|
readonly scheduled: ScheduledChange | null;
|
|
747
|
+
/**
|
|
748
|
+
* When the Subscription is set to END — Stripe's `cancel_at`, mirrored
|
|
749
|
+
* (Unix seconds) — or `null` while it renews. Set by a cancellation in the
|
|
750
|
+
* Customer Portal; the Portal is also where it is resumed. The console
|
|
751
|
+
* needs it to ACT: no "cancel" offered to an account already cancelling,
|
|
752
|
+
* and no plan change offered until it is resumed (the API refuses one).
|
|
753
|
+
* Mirrored on the rule that survives: what the console must act on is
|
|
754
|
+
* mirrored, what it would merely display is not.
|
|
755
|
+
*/
|
|
756
|
+
readonly cancelAt: number | null;
|
|
747
757
|
}
|
|
748
758
|
|
|
749
759
|
/**
|
|
@@ -1888,8 +1898,10 @@ export const SIGN_IN_RETURN_PARAM = 'signing-in';
|
|
|
1888
1898
|
* Client populations: `SESSION` (first-party cookie), `API_KEY` (`ship-`
|
|
1889
1899
|
* key), `TOKEN` (`deploy-` deploy token), `AGENT` (anonymous public deploy —
|
|
1890
1900
|
* no credential; the platform grants the public-account identity per
|
|
1891
|
-
* request), `OAUTH` (delegated access token).
|
|
1892
|
-
*
|
|
1901
|
+
* request), `OAUTH` (delegated access token). The one server population:
|
|
1902
|
+
* `SYSTEM` (scheduled/background jobs). Webhook receipt is deliberately not
|
|
1903
|
+
* a population: a signed delivery is verified, never authorized — it acts
|
|
1904
|
+
* as no one and audits as no one.
|
|
1893
1905
|
*/
|
|
1894
1906
|
export const AuthMethod = {
|
|
1895
1907
|
SESSION: 'session',
|
|
@@ -1897,7 +1909,6 @@ export const AuthMethod = {
|
|
|
1897
1909
|
TOKEN: 'token',
|
|
1898
1910
|
AGENT: 'agent',
|
|
1899
1911
|
OAUTH: 'oauth',
|
|
1900
|
-
WEBHOOK: 'webhook',
|
|
1901
1912
|
SYSTEM: 'system',
|
|
1902
1913
|
} as const;
|
|
1903
1914
|
|
|
@@ -2801,7 +2812,6 @@ export type ActivityEvent =
|
|
|
2801
2812
|
| 'account.update'
|
|
2802
2813
|
| 'account.delete'
|
|
2803
2814
|
| 'account.key.generate'
|
|
2804
|
-
| 'account.plan.paid'
|
|
2805
2815
|
| 'account.plan.transition'
|
|
2806
2816
|
// Deployment events
|
|
2807
2817
|
| 'deployment.create'
|