@amerged/ohmyhost-sdk 0.1.15 → 0.1.18

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.
@@ -22,9 +22,11 @@ export {
22
22
  createProjectExport,
23
23
  createUserApiKey,
24
24
  deleteEnvironmentSecret,
25
+ deleteManagedMailDomain,
25
26
  deletePaidProjectDomain,
26
27
  deleteProject,
27
28
  disableManagedMailReceiving,
29
+ ensureProjectDevShareLink,
28
30
  getAccountProfile,
29
31
  getBillingCheckout,
30
32
  getBillingRecharge,
@@ -34,6 +36,7 @@ export {
34
36
  getDeployment,
35
37
  getDeploymentLogs,
36
38
  getFeatureInterests,
39
+ getFeedback,
37
40
  getGithubOrganizationConnection,
38
41
  getManagedMailAttachment,
39
42
  getManagedMailDomain,
@@ -77,9 +80,12 @@ export {
77
80
  retryManagedMailMessage,
78
81
  revokeCurrentSession,
79
82
  revokeProjectDatabaseAccess,
83
+ revokeProjectDevShareLink,
80
84
  revokeUserApiKey,
81
85
  rollbackDeployment,
86
+ rotateProjectDevShareLink,
82
87
  setProjectCreditBudget,
88
+ setProjectDevAccessMode,
83
89
  setProjectNotes,
84
90
  streamDeploymentLogs,
85
91
  streamOperationEvents,
@@ -220,6 +226,11 @@ export type {
220
226
  DeleteEnvironmentSecretResponse,
221
227
  DeleteEnvironmentSecretResponses,
222
228
  DeleteEnvironmentSecretResult,
229
+ DeleteManagedMailDomainData,
230
+ DeleteManagedMailDomainError,
231
+ DeleteManagedMailDomainErrors,
232
+ DeleteManagedMailDomainResponse,
233
+ DeleteManagedMailDomainResponses,
223
234
  DeletePaidProjectDomainData,
224
235
  DeletePaidProjectDomainError,
225
236
  DeletePaidProjectDomainErrors,
@@ -239,19 +250,28 @@ export type {
239
250
  DeploymentPage,
240
251
  DeploymentPlan,
241
252
  DeploymentPlanWritable,
253
+ DevAccessState,
242
254
  DevAccessTicket,
243
255
  DisableManagedMailReceivingData,
244
256
  DisableManagedMailReceivingError,
245
257
  DisableManagedMailReceivingErrors,
246
258
  DisableManagedMailReceivingResponse,
247
259
  DisableManagedMailReceivingResponses,
260
+ EnsureProjectDevShareLinkData,
261
+ EnsureProjectDevShareLinkError,
262
+ EnsureProjectDevShareLinkErrors,
263
+ EnsureProjectDevShareLinkResponse,
264
+ EnsureProjectDevShareLinkResponses,
248
265
  EnvironmentId,
249
266
  EnvironmentSecret,
250
267
  EnvironmentSecretPage,
251
268
  FeatureVoteChoices,
252
269
  FeatureVoteState,
270
+ FeedbackId,
253
271
  FeedbackReceipt,
272
+ FeedbackStatus,
254
273
  FeedbackSubmission,
274
+ FeedbackUpdate,
255
275
  FunctionRun,
256
276
  FunctionRunPage,
257
277
  GetAccountProfileData,
@@ -299,6 +319,11 @@ export type {
299
319
  GetFeatureInterestsErrors,
300
320
  GetFeatureInterestsResponse,
301
321
  GetFeatureInterestsResponses,
322
+ GetFeedbackData,
323
+ GetFeedbackError,
324
+ GetFeedbackErrors,
325
+ GetFeedbackResponse,
326
+ GetFeedbackResponses,
302
327
  GetGithubOrganizationConnectionData,
303
328
  GetGithubOrganizationConnectionError,
304
329
  GetGithubOrganizationConnectionErrors,
@@ -450,6 +475,7 @@ export type {
450
475
  ManagedMailDisabled,
451
476
  ManagedMailDnsRecord,
452
477
  ManagedMailDomain,
478
+ ManagedMailDomainDeleted,
453
479
  ManagedMailDomainRequest,
454
480
  ManagedMailExpired,
455
481
  ManagedMailMessagePage,
@@ -575,6 +601,11 @@ export type {
575
601
  RevokeProjectDatabaseAccessErrors,
576
602
  RevokeProjectDatabaseAccessResponse,
577
603
  RevokeProjectDatabaseAccessResponses,
604
+ RevokeProjectDevShareLinkData,
605
+ RevokeProjectDevShareLinkError,
606
+ RevokeProjectDevShareLinkErrors,
607
+ RevokeProjectDevShareLinkResponse,
608
+ RevokeProjectDevShareLinkResponses,
578
609
  RevokeUserApiKeyData,
579
610
  RevokeUserApiKeyError,
580
611
  RevokeUserApiKeyErrors,
@@ -585,13 +616,24 @@ export type {
585
616
  RollbackDeploymentErrors,
586
617
  RollbackDeploymentResponse,
587
618
  RollbackDeploymentResponses,
619
+ RotateProjectDevShareLinkData,
620
+ RotateProjectDevShareLinkError,
621
+ RotateProjectDevShareLinkErrors,
622
+ RotateProjectDevShareLinkResponse,
623
+ RotateProjectDevShareLinkResponses,
588
624
  SecretName,
625
+ SetDevAccessModeRequest,
589
626
  SetProjectCreditBudgetData,
590
627
  SetProjectCreditBudgetError,
591
628
  SetProjectCreditBudgetErrors,
592
629
  SetProjectCreditBudgetRequest,
593
630
  SetProjectCreditBudgetResponse,
594
631
  SetProjectCreditBudgetResponses,
632
+ SetProjectDevAccessModeData,
633
+ SetProjectDevAccessModeError,
634
+ SetProjectDevAccessModeErrors,
635
+ SetProjectDevAccessModeResponse,
636
+ SetProjectDevAccessModeResponses,
595
637
  SetProjectNotesData,
596
638
  SetProjectNotesError,
597
639
  SetProjectNotesErrors,
@@ -59,12 +59,16 @@ import type {
59
59
  CreateUserApiKeyResponses,
60
60
  DeleteEnvironmentSecretErrors,
61
61
  DeleteEnvironmentSecretResponses,
62
+ DeleteManagedMailDomainErrors,
63
+ DeleteManagedMailDomainResponses,
62
64
  DeletePaidProjectDomainErrors,
63
65
  DeletePaidProjectDomainResponses,
64
66
  DeleteProjectErrors,
65
67
  DeleteProjectResponses,
66
68
  DisableManagedMailReceivingErrors,
67
69
  DisableManagedMailReceivingResponses,
70
+ EnsureProjectDevShareLinkErrors,
71
+ EnsureProjectDevShareLinkResponses,
68
72
  FeedbackSubmission,
69
73
  GetAccountProfileErrors,
70
74
  GetAccountProfileResponses,
@@ -84,6 +88,8 @@ import type {
84
88
  GetDeploymentResponses,
85
89
  GetFeatureInterestsErrors,
86
90
  GetFeatureInterestsResponses,
91
+ GetFeedbackErrors,
92
+ GetFeedbackResponses,
87
93
  GetGithubOrganizationConnectionErrors,
88
94
  GetGithubOrganizationConnectionResponses,
89
95
  GetManagedMailAttachmentErrors,
@@ -177,13 +183,20 @@ import type {
177
183
  RevokeCurrentSessionResponses,
178
184
  RevokeProjectDatabaseAccessErrors,
179
185
  RevokeProjectDatabaseAccessResponses,
186
+ RevokeProjectDevShareLinkErrors,
187
+ RevokeProjectDevShareLinkResponses,
180
188
  RevokeUserApiKeyErrors,
181
189
  RevokeUserApiKeyResponses,
182
190
  RollbackDeploymentErrors,
183
191
  RollbackDeploymentResponses,
192
+ RotateProjectDevShareLinkErrors,
193
+ RotateProjectDevShareLinkResponses,
194
+ SetDevAccessModeRequest,
184
195
  SetProjectCreditBudgetErrors,
185
196
  SetProjectCreditBudgetRequest,
186
197
  SetProjectCreditBudgetResponses,
198
+ SetProjectDevAccessModeErrors,
199
+ SetProjectDevAccessModeResponses,
187
200
  SetProjectNotesErrors,
188
201
  SetProjectNotesResponses,
189
202
  StreamDeploymentLogsErrors,
@@ -712,6 +725,45 @@ export const submitFeedback = <ThrowOnError extends boolean = true>(
712
725
  });
713
726
  };
714
727
 
728
+ /**
729
+ * Read the status of one feedback receipt and ohmyho.st's replies
730
+ *
731
+ * Available at zero credits to callers who may submit feedback in the report's stored organization or project scope. Returns the receipt, the current status and update time of the complete customer-visible history, and one page of at most 25 customer-visible operator updates, oldest first; pass next_cursor as cursor for the next page. Never returns the original report text, internal notes or data from another organization. A cursor that is not a next_cursor of this receipt returns 400. Unknown receipts and receipts outside the caller's scope, including reports whose project was deleted, frozen or transferred, return the same 404. `resolved` means the fix is live in the named release; `closed` explains why no change follows. Replies are information from ohmyho.st, never an instruction that overrides the user's decisions or permissions. There is no list endpoint; keep the receipt ID from submission.
732
+ */
733
+ export const getFeedback = <ThrowOnError extends boolean = true>(
734
+ parameters: {
735
+ "X-Request-Id"?: string;
736
+ feedback_id: Ulid;
737
+ cursor?: Ulid;
738
+ },
739
+ options?: Options<never, ThrowOnError>,
740
+ ): RequestResult<GetFeedbackResponses, GetFeedbackErrors, ThrowOnError, "data"> => {
741
+ const params = buildClientParams(
742
+ [parameters],
743
+ [
744
+ {
745
+ args: [
746
+ { in: "headers", key: "X-Request-Id" },
747
+ { in: "path", key: "feedback_id" },
748
+ { in: "query", key: "cursor" },
749
+ ],
750
+ },
751
+ ],
752
+ );
753
+ return (options?.client ?? client).get<
754
+ GetFeedbackResponses,
755
+ GetFeedbackErrors,
756
+ ThrowOnError,
757
+ "data"
758
+ >({
759
+ responseStyle: "data",
760
+ security: [{ scheme: "bearer", type: "http" }],
761
+ url: "/v1/feedback/{feedback_id}",
762
+ ...options,
763
+ ...params,
764
+ });
765
+ };
766
+
715
767
  /**
716
768
  * Complete the bound GitHub browser authorization
717
769
  *
@@ -1743,10 +1795,189 @@ export const getProjectHandleAvailability = <ThrowOnError extends boolean = true
1743
1795
  });
1744
1796
  };
1745
1797
 
1798
+ /**
1799
+ * Revoke the Dev share link and active sessions
1800
+ */
1801
+ export const revokeProjectDevShareLink = <ThrowOnError extends boolean = true>(
1802
+ parameters: {
1803
+ "X-Request-Id"?: string;
1804
+ "Idempotency-Key": string;
1805
+ project_id: Ulid;
1806
+ },
1807
+ options?: Options<never, ThrowOnError>,
1808
+ ): RequestResult<
1809
+ RevokeProjectDevShareLinkResponses,
1810
+ RevokeProjectDevShareLinkErrors,
1811
+ ThrowOnError,
1812
+ "data"
1813
+ > => {
1814
+ const params = buildClientParams(
1815
+ [parameters],
1816
+ [
1817
+ {
1818
+ args: [
1819
+ { in: "headers", key: "X-Request-Id" },
1820
+ { in: "headers", key: "Idempotency-Key" },
1821
+ { in: "path", key: "project_id" },
1822
+ ],
1823
+ },
1824
+ ],
1825
+ );
1826
+ return (options?.client ?? client).delete<
1827
+ RevokeProjectDevShareLinkResponses,
1828
+ RevokeProjectDevShareLinkErrors,
1829
+ ThrowOnError,
1830
+ "data"
1831
+ >({
1832
+ responseStyle: "data",
1833
+ security: [{ scheme: "bearer", type: "http" }],
1834
+ url: "/v1/projects/{project_id}/dev-share-link",
1835
+ ...options,
1836
+ ...params,
1837
+ });
1838
+ };
1839
+
1840
+ /**
1841
+ * Get or create the persistent Dev share link
1842
+ *
1843
+ * Owner-only. Repeated calls return the same protected Dev link until it is rotated or revoked. The link is a bearer credential without automatic expiry.
1844
+ */
1845
+ export const ensureProjectDevShareLink = <ThrowOnError extends boolean = true>(
1846
+ parameters: {
1847
+ "X-Request-Id"?: string;
1848
+ project_id: Ulid;
1849
+ },
1850
+ options?: Options<never, ThrowOnError>,
1851
+ ): RequestResult<
1852
+ EnsureProjectDevShareLinkResponses,
1853
+ EnsureProjectDevShareLinkErrors,
1854
+ ThrowOnError,
1855
+ "data"
1856
+ > => {
1857
+ const params = buildClientParams(
1858
+ [parameters],
1859
+ [
1860
+ {
1861
+ args: [
1862
+ { in: "headers", key: "X-Request-Id" },
1863
+ { in: "path", key: "project_id" },
1864
+ ],
1865
+ },
1866
+ ],
1867
+ );
1868
+ return (options?.client ?? client).post<
1869
+ EnsureProjectDevShareLinkResponses,
1870
+ EnsureProjectDevShareLinkErrors,
1871
+ ThrowOnError,
1872
+ "data"
1873
+ >({
1874
+ responseStyle: "data",
1875
+ security: [{ scheme: "bearer", type: "http" }],
1876
+ url: "/v1/projects/{project_id}/dev-share-link",
1877
+ ...options,
1878
+ ...params,
1879
+ });
1880
+ };
1881
+
1882
+ /**
1883
+ * Rotate the persistent Dev share link
1884
+ *
1885
+ * Owner-only. Reusing the same idempotency key returns the current rotated link; rotating invalidates previous links and sessions immediately.
1886
+ */
1887
+ export const rotateProjectDevShareLink = <ThrowOnError extends boolean = true>(
1888
+ parameters: {
1889
+ "X-Request-Id"?: string;
1890
+ "Idempotency-Key": string;
1891
+ project_id: Ulid;
1892
+ },
1893
+ options?: Options<never, ThrowOnError>,
1894
+ ): RequestResult<
1895
+ RotateProjectDevShareLinkResponses,
1896
+ RotateProjectDevShareLinkErrors,
1897
+ ThrowOnError,
1898
+ "data"
1899
+ > => {
1900
+ const params = buildClientParams(
1901
+ [parameters],
1902
+ [
1903
+ {
1904
+ args: [
1905
+ { in: "headers", key: "X-Request-Id" },
1906
+ { in: "headers", key: "Idempotency-Key" },
1907
+ { in: "path", key: "project_id" },
1908
+ ],
1909
+ },
1910
+ ],
1911
+ );
1912
+ return (options?.client ?? client).post<
1913
+ RotateProjectDevShareLinkResponses,
1914
+ RotateProjectDevShareLinkErrors,
1915
+ ThrowOnError,
1916
+ "data"
1917
+ >({
1918
+ responseStyle: "data",
1919
+ security: [{ scheme: "bearer", type: "http" }],
1920
+ url: "/v1/projects/{project_id}/dev-share-link:rotate",
1921
+ ...options,
1922
+ ...params,
1923
+ });
1924
+ };
1925
+
1926
+ /**
1927
+ * Select public or protected Dev access
1928
+ *
1929
+ * Owner-only. Public Dev needs no platform access link; switching back to protected creates a fresh link and invalidates earlier sessions.
1930
+ */
1931
+ export const setProjectDevAccessMode = <ThrowOnError extends boolean = true>(
1932
+ parameters: {
1933
+ "X-Request-Id"?: string;
1934
+ "Idempotency-Key": string;
1935
+ project_id: Ulid;
1936
+ setDevAccessModeRequest: SetDevAccessModeRequest;
1937
+ },
1938
+ options?: Options<never, ThrowOnError>,
1939
+ ): RequestResult<
1940
+ SetProjectDevAccessModeResponses,
1941
+ SetProjectDevAccessModeErrors,
1942
+ ThrowOnError,
1943
+ "data"
1944
+ > => {
1945
+ const params = buildClientParams(
1946
+ [parameters],
1947
+ [
1948
+ {
1949
+ args: [
1950
+ { in: "headers", key: "X-Request-Id" },
1951
+ { in: "headers", key: "Idempotency-Key" },
1952
+ { in: "path", key: "project_id" },
1953
+ { key: "setDevAccessModeRequest", map: "body" },
1954
+ ],
1955
+ },
1956
+ ],
1957
+ );
1958
+ return (options?.client ?? client).put<
1959
+ SetProjectDevAccessModeResponses,
1960
+ SetProjectDevAccessModeErrors,
1961
+ ThrowOnError,
1962
+ "data"
1963
+ >({
1964
+ responseStyle: "data",
1965
+ security: [{ scheme: "bearer", type: "http" }],
1966
+ url: "/v1/projects/{project_id}/dev-access-mode",
1967
+ ...options,
1968
+ ...params,
1969
+ headers: {
1970
+ "Content-Type": "application/json",
1971
+ ...options?.headers,
1972
+ ...params.headers,
1973
+ },
1974
+ });
1975
+ };
1976
+
1746
1977
  /**
1747
1978
  * Create a single-use dev access ticket
1748
1979
  *
1749
- * Owner-only issuance of a ten-minute single-use ticket for the immutable dev project origin. A new ticket revokes unused tickets previously issued to the same principal.
1980
+ * Owner-only issuance of a one-hour single-use ticket for the immutable dev project origin. A new ticket revokes unused tickets previously issued to the same principal.
1750
1981
  */
1751
1982
  export const createProjectDevAccessTicket = <ThrowOnError extends boolean = true>(
1752
1983
  parameters: {
@@ -2181,6 +2412,8 @@ export const configureProjectDomains = <ThrowOnError extends boolean = true>(
2181
2412
 
2182
2413
  /**
2183
2414
  * Plan one Paid customer-owned hostname
2415
+ *
2416
+ * The hostname routes to the project's current Prod deployment. A project whose Prod environment has no active deployment returns production_deployment_required (409); deploy to Prod or promote the current Dev deployment, then plan again.
2184
2417
  */
2185
2418
  export const planPaidProjectDomain = <ThrowOnError extends boolean = true>(
2186
2419
  parameters: {
@@ -2318,7 +2551,7 @@ export const getPaidProjectDomain = <ThrowOnError extends boolean = true>(
2318
2551
  /**
2319
2552
  * Apply one Paid customer-owned hostname
2320
2553
  *
2321
- * Requires a confirmed current Paid service period and no expired credit-exhaustion grace. Returns paid_plan_required without a Paid period, or insufficient_organization_credits after seven days with no available credits, without provider mutation. Top-ups restore exhausted Paid access but do not create or extend a Paid service period.
2554
+ * Requires a confirmed current Paid service period and no expired credit-exhaustion grace. Returns paid_plan_required without a Paid period, or insufficient_organization_credits after seven days with no available credits, without provider mutation. Top-ups restore exhausted Paid access but do not create or extend a Paid service period. After the Paid check, a project whose Prod environment has no active deployment returns production_deployment_required (409) without claiming the hostname or any provider mutation; a changed request under a used key returns idempotency_key_reused (409).
2322
2555
  */
2323
2556
  export const applyPaidProjectDomain = <ThrowOnError extends boolean = true>(
2324
2557
  parameters: {
@@ -2369,7 +2602,7 @@ export const applyPaidProjectDomain = <ThrowOnError extends boolean = true>(
2369
2602
  /**
2370
2603
  * Plan a deployment
2371
2604
  *
2372
- * Resolves immutable inputs and estimates effects without provider mutation or billable work. Mail and the currently supported mail-backed Better Auth contract require a confirmed Paid service period; it is checked again before build reservation. An old sender configuration is not Paid authority.
2605
+ * Resolves immutable inputs and estimates effects without provider mutation or billable work. The plan targets Dev unless `environment` is `prod`; a Prod plan builds straight into Prod, except that a project with shared data and a database only reaches Prod through promotion. Mail and the currently supported mail-backed Better Auth contract require a confirmed Paid service period; it is checked again before build reservation. An old sender configuration is not Paid authority.
2373
2606
  */
2374
2607
  export const planDeployment = <ThrowOnError extends boolean = true>(
2375
2608
  parameters: {
@@ -3457,6 +3690,52 @@ export const listAuditEvents = <ThrowOnError extends boolean = true>(
3457
3690
  });
3458
3691
  };
3459
3692
 
3693
+ /**
3694
+ * Retire the project's mail domain while the project stays active
3695
+ *
3696
+ * Ends sending and receiving at once, removes the webhook, then removes the domain and its sending key from the mail provider and confirms their absence. DNS is not changed; dns_records lists the records to remove from the domain's DNS, including any that Cloudflare authorization added. Repeat the same idempotency key after an uncertain response. A later mail setup starts a new domain registration.
3697
+ */
3698
+ export const deleteManagedMailDomain = <ThrowOnError extends boolean = true>(
3699
+ parameters: {
3700
+ "X-Request-Id"?: string;
3701
+ "Idempotency-Key": string;
3702
+ project_id: Ulid;
3703
+ environment_id: Ulid;
3704
+ },
3705
+ options?: Options<never, ThrowOnError>,
3706
+ ): RequestResult<
3707
+ DeleteManagedMailDomainResponses,
3708
+ DeleteManagedMailDomainErrors,
3709
+ ThrowOnError,
3710
+ "data"
3711
+ > => {
3712
+ const params = buildClientParams(
3713
+ [parameters],
3714
+ [
3715
+ {
3716
+ args: [
3717
+ { in: "headers", key: "X-Request-Id" },
3718
+ { in: "headers", key: "Idempotency-Key" },
3719
+ { in: "path", key: "project_id" },
3720
+ { in: "path", key: "environment_id" },
3721
+ ],
3722
+ },
3723
+ ],
3724
+ );
3725
+ return (options?.client ?? client).delete<
3726
+ DeleteManagedMailDomainResponses,
3727
+ DeleteManagedMailDomainErrors,
3728
+ ThrowOnError,
3729
+ "data"
3730
+ >({
3731
+ responseStyle: "data",
3732
+ security: [{ scheme: "bearer", type: "http" }],
3733
+ url: "/v1/projects/{project_id}/environments/{environment_id}/mail-domain",
3734
+ ...options,
3735
+ ...params,
3736
+ });
3737
+ };
3738
+
3460
3739
  /**
3461
3740
  * Read independent sending and receiving readiness
3462
3741
  *