@apollo-deploy/typescript-sdk 1.0.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.
Files changed (134) hide show
  1. package/README.md +828 -0
  2. package/dist/index.d.ts +35 -0
  3. package/dist/index.d.ts.map +1 -0
  4. package/dist/index.js +12 -0
  5. package/dist/index.js.map +1 -0
  6. package/dist/src/client.d.ts +135 -0
  7. package/dist/src/client.d.ts.map +1 -0
  8. package/dist/src/client.js +88 -0
  9. package/dist/src/client.js.map +1 -0
  10. package/dist/src/domain/admin-users.d.ts +31 -0
  11. package/dist/src/domain/admin-users.d.ts.map +1 -0
  12. package/dist/src/domain/admin-users.js +104 -0
  13. package/dist/src/domain/admin-users.js.map +1 -0
  14. package/dist/src/domain/analytics.d.ts +19 -0
  15. package/dist/src/domain/analytics.d.ts.map +1 -0
  16. package/dist/src/domain/analytics.js +70 -0
  17. package/dist/src/domain/analytics.js.map +1 -0
  18. package/dist/src/domain/approvals.d.ts +49 -0
  19. package/dist/src/domain/approvals.d.ts.map +1 -0
  20. package/dist/src/domain/approvals.js +237 -0
  21. package/dist/src/domain/approvals.js.map +1 -0
  22. package/dist/src/domain/apps.d.ts +29 -0
  23. package/dist/src/domain/apps.d.ts.map +1 -0
  24. package/dist/src/domain/apps.js +104 -0
  25. package/dist/src/domain/apps.js.map +1 -0
  26. package/dist/src/domain/artifacts.d.ts +35 -0
  27. package/dist/src/domain/artifacts.d.ts.map +1 -0
  28. package/dist/src/domain/artifacts.js +163 -0
  29. package/dist/src/domain/artifacts.js.map +1 -0
  30. package/dist/src/domain/audit-logs.d.ts +25 -0
  31. package/dist/src/domain/audit-logs.d.ts.map +1 -0
  32. package/dist/src/domain/audit-logs.js +125 -0
  33. package/dist/src/domain/audit-logs.js.map +1 -0
  34. package/dist/src/domain/auth.d.ts +35 -0
  35. package/dist/src/domain/auth.d.ts.map +1 -0
  36. package/dist/src/domain/auth.js +114 -0
  37. package/dist/src/domain/auth.js.map +1 -0
  38. package/dist/src/domain/billing.d.ts +27 -0
  39. package/dist/src/domain/billing.d.ts.map +1 -0
  40. package/dist/src/domain/billing.js +91 -0
  41. package/dist/src/domain/billing.js.map +1 -0
  42. package/dist/src/domain/credentials.d.ts +25 -0
  43. package/dist/src/domain/credentials.d.ts.map +1 -0
  44. package/dist/src/domain/credentials.js +81 -0
  45. package/dist/src/domain/credentials.js.map +1 -0
  46. package/dist/src/domain/general.d.ts +11 -0
  47. package/dist/src/domain/general.d.ts.map +1 -0
  48. package/dist/src/domain/general.js +19 -0
  49. package/dist/src/domain/general.js.map +1 -0
  50. package/dist/src/domain/health.d.ts +23 -0
  51. package/dist/src/domain/health.d.ts.map +1 -0
  52. package/dist/src/domain/health.js +67 -0
  53. package/dist/src/domain/health.js.map +1 -0
  54. package/dist/src/domain/index.d.ts +54 -0
  55. package/dist/src/domain/index.d.ts.map +1 -0
  56. package/dist/src/domain/index.js +30 -0
  57. package/dist/src/domain/index.js.map +1 -0
  58. package/dist/src/domain/integrations.d.ts +49 -0
  59. package/dist/src/domain/integrations.d.ts.map +1 -0
  60. package/dist/src/domain/integrations.js +192 -0
  61. package/dist/src/domain/integrations.js.map +1 -0
  62. package/dist/src/domain/o-auth.d.ts +65 -0
  63. package/dist/src/domain/o-auth.d.ts.map +1 -0
  64. package/dist/src/domain/o-auth.js +292 -0
  65. package/dist/src/domain/o-auth.js.map +1 -0
  66. package/dist/src/domain/organizations.d.ts +45 -0
  67. package/dist/src/domain/organizations.d.ts.map +1 -0
  68. package/dist/src/domain/organizations.js +165 -0
  69. package/dist/src/domain/organizations.js.map +1 -0
  70. package/dist/src/domain/policies.d.ts +43 -0
  71. package/dist/src/domain/policies.d.ts.map +1 -0
  72. package/dist/src/domain/policies.js +172 -0
  73. package/dist/src/domain/policies.js.map +1 -0
  74. package/dist/src/domain/release-pipelines.d.ts +25 -0
  75. package/dist/src/domain/release-pipelines.d.ts.map +1 -0
  76. package/dist/src/domain/release-pipelines.js +70 -0
  77. package/dist/src/domain/release-pipelines.js.map +1 -0
  78. package/dist/src/domain/releases.d.ts +31 -0
  79. package/dist/src/domain/releases.d.ts.map +1 -0
  80. package/dist/src/domain/releases.js +106 -0
  81. package/dist/src/domain/releases.js.map +1 -0
  82. package/dist/src/domain/sessions.d.ts +21 -0
  83. package/dist/src/domain/sessions.d.ts.map +1 -0
  84. package/dist/src/domain/sessions.js +51 -0
  85. package/dist/src/domain/sessions.js.map +1 -0
  86. package/dist/src/domain/settings.d.ts +29 -0
  87. package/dist/src/domain/settings.d.ts.map +1 -0
  88. package/dist/src/domain/settings.js +97 -0
  89. package/dist/src/domain/settings.js.map +1 -0
  90. package/dist/src/domain/share-links.d.ts +51 -0
  91. package/dist/src/domain/share-links.d.ts.map +1 -0
  92. package/dist/src/domain/share-links.js +208 -0
  93. package/dist/src/domain/share-links.js.map +1 -0
  94. package/dist/src/domain/teams.d.ts +27 -0
  95. package/dist/src/domain/teams.d.ts.map +1 -0
  96. package/dist/src/domain/teams.js +79 -0
  97. package/dist/src/domain/teams.js.map +1 -0
  98. package/dist/src/domain/waitlist.d.ts +15 -0
  99. package/dist/src/domain/waitlist.d.ts.map +1 -0
  100. package/dist/src/domain/waitlist.js +28 -0
  101. package/dist/src/domain/waitlist.js.map +1 -0
  102. package/dist/src/domain/webhooks.d.ts +43 -0
  103. package/dist/src/domain/webhooks.d.ts.map +1 -0
  104. package/dist/src/domain/webhooks.js +177 -0
  105. package/dist/src/domain/webhooks.js.map +1 -0
  106. package/dist/src/domain/workflows.d.ts +39 -0
  107. package/dist/src/domain/workflows.d.ts.map +1 -0
  108. package/dist/src/domain/workflows.js +153 -0
  109. package/dist/src/domain/workflows.js.map +1 -0
  110. package/dist/src/transport/axios.d.ts +52 -0
  111. package/dist/src/transport/axios.d.ts.map +1 -0
  112. package/dist/src/transport/axios.js +201 -0
  113. package/dist/src/transport/axios.js.map +1 -0
  114. package/dist/src/types/common.d.ts +87 -0
  115. package/dist/src/types/common.d.ts.map +1 -0
  116. package/dist/src/types/common.js +7 -0
  117. package/dist/src/types/common.js.map +1 -0
  118. package/dist/src/types/errors.d.ts +105 -0
  119. package/dist/src/types/errors.d.ts.map +1 -0
  120. package/dist/src/types/errors.js +148 -0
  121. package/dist/src/types/errors.js.map +1 -0
  122. package/dist/src/types/index.d.ts +6144 -0
  123. package/dist/src/types/index.d.ts.map +1 -0
  124. package/dist/src/types/index.js +7 -0
  125. package/dist/src/types/index.js.map +1 -0
  126. package/dist/src/utils/index.d.ts +7 -0
  127. package/dist/src/utils/index.d.ts.map +1 -0
  128. package/dist/src/utils/index.js +7 -0
  129. package/dist/src/utils/index.js.map +1 -0
  130. package/dist/src/utils/query.d.ts +11 -0
  131. package/dist/src/utils/query.d.ts.map +1 -0
  132. package/dist/src/utils/query.js +26 -0
  133. package/dist/src/utils/query.js.map +1 -0
  134. package/package.json +31 -0
package/README.md ADDED
@@ -0,0 +1,828 @@
1
+ # Apollo Deploy API SDK
2
+
3
+ Apollo Deploy platform API specification
4
+
5
+ > This SDK was automatically generated by [sdk-forge](https://github.com/sdk-forge).
6
+
7
+ ## Installation
8
+
9
+ ```bash
10
+ npm install apollo-deploy-api-sdk
11
+ ```
12
+
13
+ ## Quick Start
14
+
15
+ ```typescript
16
+ import { createApolloDeployApiClient } from 'apollo-deploy-api-sdk';
17
+
18
+ const client = createApolloDeployApiClient({
19
+ baseUrl: 'http://localhost:3000',
20
+ cookieAuthValue: 'your-cookie-auth-credential',
21
+ bearerAuthToken: 'your-bearer-auth-credential',
22
+ oAuth2AccessToken: 'your-o-auth2-credential',
23
+ });
24
+ ```
25
+
26
+ ## API Reference
27
+
28
+ ### GeneralAPI
29
+
30
+ | Method | HTTP | Path | Description |
31
+ |--------|------|------|-------------|
32
+ | `listMetrics` | GET | `/metrics` | - |
33
+
34
+ ### AuthAPI
35
+
36
+ | Method | HTTP | Path | Description |
37
+ |--------|------|------|-------------|
38
+ | `oauthAuthorizationServerMetadata` | GET | `/.well-known/oauth-authorization-server` | OAuth Authorization Server Metadata |
39
+ | `openidConnectDiscoveryMetadata` | GET | `/.well-known/openid-configuration` | OpenID Connect Discovery Metadata |
40
+ | `registerUser` | POST | `/auth/register` | Register a new user |
41
+ | `authenticateUser` | POST | `/auth/login` | Authenticate a user |
42
+ | `logOutUser` | POST | `/auth/logout` | Log out the current user |
43
+ | `resendEmailVerification` | POST | `/auth/resend-verification` | Resend email verification |
44
+ | `verifyEmailAddress` | POST | `/auth/verify-email` | Verify email address |
45
+ | `requestPasswordReset` | POST | `/auth/password/reset/request` | Request a password reset |
46
+ | `confirmPasswordReset` | POST | `/auth/password/reset/confirm` | Confirm a password reset |
47
+ | `signSocialProvider` | POST | `/auth/social/login` | Sign in with a social provider |
48
+ | `getUser` | GET | `/auth/me` | Get the current user |
49
+ | `getOnboardingStatus` | GET | `/auth/onboarding/check` | Get onboarding status |
50
+
51
+ ### OAuthAPI
52
+
53
+ | Method | HTTP | Path | Description |
54
+ |--------|------|------|-------------|
55
+ | `requestDeviceAuthorizationCodes` | POST | `/auth/device/code` | Request device authorization codes |
56
+ | `pollDeviceAuthorizationToken` | POST | `/auth/device/token` | Poll device authorization token |
57
+ | `getDeviceAuthorizationStatus` | GET | `/auth/device` | Get device authorization status |
58
+ | `approveDeviceAuthorizationRequest` | POST | `/auth/device/approve` | Approve a device authorization request |
59
+ | `denyDeviceAuthorizationRequest` | POST | `/auth/device/deny` | Deny a device authorization request |
60
+ | `oauth2AuthorizeEndpoint` | GET | `/auth/oauth2/authorize` | OAuth2 authorize endpoint |
61
+ | `oauth2ConsentEndpoint` | POST | `/auth/oauth2/consent` | OAuth2 consent endpoint |
62
+ | `oauth2ContinueEndpoint` | POST | `/auth/oauth2/continue` | OAuth2 continue endpoint |
63
+ | `oauth2TokenEndpoint` | POST | `/auth/oauth2/token` | OAuth2 token endpoint |
64
+ | `oauth2TokenIntrospectionEndpoint` | POST | `/auth/oauth2/introspect` | OAuth2 token introspection endpoint |
65
+ | `oauth2TokenRevocationEndpoint` | POST | `/auth/oauth2/revoke` | OAuth2 token revocation endpoint |
66
+ | `openidConnectUserinfoEndpoint` | GET | `/auth/oauth2/userinfo` | OpenID Connect userinfo endpoint |
67
+ | `openidRpInitiatedLogoutEndpoint` | GET | `/auth/oauth2/end-session` | OpenID RP-initiated logout endpoint |
68
+ | `dynamicOauth2ClientRegistration` | POST | `/auth/oauth2/register` | Dynamic OAuth2 client registration |
69
+ | `createOauth2Client` | POST | `/auth/oauth2/create-client` | Create OAuth2 client |
70
+ | `getOauth2Client` | GET | `/auth/oauth2/get-client` | Get OAuth2 client |
71
+ | `getOauth2PublicClient` | GET | `/auth/oauth2/public-client` | Get OAuth2 public client details |
72
+ | `listOauth2Clients` | GET | `/auth/oauth2/get-clients` | List OAuth2 clients |
73
+ | `updateOauth2Client` | POST | `/auth/oauth2/update-client` | Update OAuth2 client |
74
+ | `rotateOauth2ClientSecret` | POST | `/auth/oauth2/client/rotate-secret` | Rotate OAuth2 client secret |
75
+ | `deleteOauth2Client` | POST | `/auth/oauth2/delete-client` | Delete OAuth2 client |
76
+ | `getOauth2Consent` | GET | `/auth/oauth2/get-consent` | Get OAuth2 consent |
77
+ | `listOauth2Consents` | GET | `/auth/oauth2/get-consents` | List OAuth2 consents |
78
+ | `updateOauth2Consent` | POST | `/auth/oauth2/update-consent` | Update OAuth2 consent |
79
+ | `deleteOauth2Consent` | POST | `/auth/oauth2/delete-consent` | Delete OAuth2 consent |
80
+ | `adminCreateOauth2Client` | POST | `/auth/admin/oauth2/create-client` | Admin create OAuth2 client |
81
+ | `adminUpdateOauth2Client` | PATCH | `/auth/admin/oauth2/update-client` | Admin update OAuth2 client |
82
+
83
+ ### SessionsAPI
84
+
85
+ | Method | HTTP | Path | Description |
86
+ |--------|------|------|-------------|
87
+ | `get` | GET | `/sessions/current` | Get current active session |
88
+ | `listUser` | GET | `/sessions/` | List all user sessions |
89
+ | `revoke` | DELETE | `/sessions/${sessionToken}` | Revoke a specific session |
90
+ | `revokeOther` | DELETE | `/sessions/others` | Revoke all other sessions |
91
+ | `activate` | POST | `/sessions/${sessionToken}/activate` | Activate a session |
92
+
93
+ ### AdminUsersAPI
94
+
95
+ | Method | HTTP | Path | Description |
96
+ |--------|------|------|-------------|
97
+ | `list` | GET | `/admin/admin/users` | List all users |
98
+ | `createAccount` | POST | `/admin/admin/users` | Create a new user account |
99
+ | `updateRole` | PATCH | `/admin/admin/users/${userId}/role` | Update user role |
100
+ | `banAccount` | POST | `/admin/admin/users/${userId}/ban` | Ban a user account |
101
+ | `removeBan` | DELETE | `/admin/admin/users/${userId}/ban` | Remove user ban |
102
+ | `listSessions` | GET | `/admin/admin/users/${userId}/sessions` | List user sessions |
103
+ | `revokeSessions` | DELETE | `/admin/admin/users/${userId}/sessions` | Revoke all user sessions |
104
+ | `impersonate` | POST | `/admin/admin/users/${userId}/impersonate` | Impersonate a user |
105
+ | `stopImpersonating` | POST | `/admin/admin/users/impersonate/stop` | Stop impersonating |
106
+ | `deleteAccount` | DELETE | `/admin/admin/users/${userId}` | Delete a user account |
107
+
108
+ ### TeamsAPI
109
+
110
+ | Method | HTTP | Path | Description |
111
+ |--------|------|------|-------------|
112
+ | `listOrganization` | GET | `/teams/` | List teams for the active organization |
113
+ | `createOrganization` | POST | `/teams/` | Create a new team within the active organization |
114
+ | `updateMetadata` | PATCH | `/teams/${teamId}` | Update a team's metadata |
115
+ | `deleteOrganization` | DELETE | `/teams/${teamId}` | Delete a team from the active organization |
116
+ | `setSession` | POST | `/teams/active` | Set the active team for the current session |
117
+ | `listMembers` | GET | `/teams/${teamId}/members` | List team members |
118
+ | `addMember` | POST | `/teams/${teamId}/members` | Add a member to a team |
119
+ | `removeMember` | DELETE | `/teams/${teamId}/members/${userId}` | Remove a member from a team |
120
+
121
+ ### OrganizationsAPI
122
+
123
+ | Method | HTTP | Path | Description |
124
+ |--------|------|------|-------------|
125
+ | `listAuthenticatedUser` | GET | `/orgs/` | List organizations for the authenticated user |
126
+ | `create` | POST | `/orgs/` | Create a new organization |
127
+ | `getActive` | GET | `/orgs/active` | Get the currently active organization |
128
+ | `setSession` | POST | `/orgs/active` | Set the active organization for the current session |
129
+ | `getOrgId` | GET | `/orgs/${orgId}` | Get organization by ID |
130
+ | `update` | PATCH | `/orgs/${orgId}` | Update organization |
131
+ | `delete` | DELETE | `/orgs/${orgId}` | Delete organization |
132
+ | `listInvitations` | GET | `/orgs/invitations` | List invitations for the active organization |
133
+ | `listPendingInvitationsUser` | GET | `/orgs/invitations/pending` | List pending invitations for a user |
134
+ | `cancelPendingInvitation` | DELETE | `/orgs/invitations/${invitationId}` | Cancel a pending invitation |
135
+ | `rejectInvitation` | POST | `/orgs/invitations/${invitationId}/reject` | Reject an invitation |
136
+ | `inviteMember` | POST | `/orgs/invite` | Invite a member |
137
+ | `listMembers` | GET | `/orgs/members` | List organization members |
138
+ | `removeMember` | DELETE | `/orgs/members/${memberId}` | Remove organization member |
139
+ | `leave` | POST | `/orgs/leave` | Leave organization |
140
+ | `getMemberRole` | GET | `/orgs/members/role` | Get active member role |
141
+ | `updateMemberRole` | POST | `/orgs/members/role` | Update member role |
142
+
143
+ ### SettingsAPI
144
+
145
+ | Method | HTTP | Path | Description |
146
+ |--------|------|------|-------------|
147
+ | `getCombinedOrgUser` | GET | `/orgs/${orgId}/settings/all` | Get combined org and user settings for the current user context |
148
+ | `listOrgMergedSystem` | GET | `/orgs/${orgId}/settings` | List org settings merged with system defaults |
149
+ | `partiallyUpdateOrgPartial` | PATCH | `/orgs/${orgId}/settings` | Partially update org settings with partial success |
150
+ | `getSingleOrg` | GET | `/orgs/${orgId}/settings/${key}` | Get a single org setting |
151
+ | `resetOrgSystemDefault` | DELETE | `/orgs/${orgId}/settings/${key}` | Reset an org setting to system default |
152
+ | `listUserMergedSystem` | GET | `/users/me/settings` | List user settings merged with system defaults |
153
+ | `partiallyUpdateUserPartial` | PATCH | `/users/me/settings` | Partially update user settings with partial success |
154
+ | `getSingleUser` | GET | `/users/me/settings/${key}` | Get a single user setting |
155
+ | `resetUserSystemDefault` | DELETE | `/users/me/settings/${key}` | Reset a user setting to system default |
156
+
157
+ ### AppsAPI
158
+
159
+ | Method | HTTP | Path | Description |
160
+ |--------|------|------|-------------|
161
+ | `list` | GET | `/apps/` | List all applications |
162
+ | `create` | POST | `/apps/` | Create a new application |
163
+ | `getDetails` | GET | `/apps/${appId}` | Get application details |
164
+ | `updateMetadata` | PATCH | `/apps/${appId}` | Update application metadata |
165
+ | `delete` | DELETE | `/apps/${appId}` | Delete an application |
166
+ | `generatePresignedUploadUrl` | POST | `/apps/${appId}/artifacts/presign` | Generate a presigned upload URL for an artifact |
167
+ | `markArtifactUploadComplete` | POST | `/apps/${appId}/artifacts/${artifactId}/complete` | Mark an artifact upload as complete |
168
+ | `getPricingInformation` | GET | `/apps/${appId}/pricing` | Retrieve pricing information for an application |
169
+ | `updatePricingConfiguration` | PATCH | `/apps/${appId}/pricing` | Update pricing configuration for an application |
170
+
171
+ ### ReleasesAPI
172
+
173
+ | Method | HTTP | Path | Description |
174
+ |--------|------|------|-------------|
175
+ | `listApplication` | GET | `/apps/${appId}/releases` | List releases for an application |
176
+ | `createApplication` | POST | `/apps/${appId}/releases` | Create a release for an application |
177
+ | `getDetails` | GET | `/apps/${appId}/releases/${releaseId}` | Retrieve release details |
178
+ | `updateMetadata` | PATCH | `/apps/${appId}/releases/${releaseId}` | Update release metadata |
179
+ | `submitReview` | POST | `/apps/${appId}/releases/${releaseId}/submit` | Submit a release for review |
180
+ | `schedulePublication` | POST | `/apps/${appId}/releases/${releaseId}/schedule` | Schedule a release for publication |
181
+ | `rollback` | POST | `/apps/${appId}/releases/${releaseId}/rollback` | Rollback a release |
182
+ | `assignPipeline` | POST | `/apps/${appId}/releases/${releaseId}/assign-pipeline` | Assign a release pipeline to a release |
183
+ | `getStageStateGate` | GET | `/apps/${appId}/releases/${releaseId}/stage` | Get release stage state and gate status |
184
+ | `transitionNextPipelineStage` | POST | `/apps/${appId}/releases/${releaseId}/stage/transition` | Transition release to the next pipeline stage |
185
+
186
+ ### ReleasePipelinesAPI
187
+
188
+ | Method | HTTP | Path | Description |
189
+ |--------|------|------|-------------|
190
+ | `list` | GET | `/apps/${appId}/release-pipelines` | List release pipelines |
191
+ | `create` | POST | `/apps/${appId}/release-pipelines` | Create release pipeline |
192
+ | `get` | GET | `/apps/${appId}/release-pipelines/${pipelineId}` | Get release pipeline |
193
+ | `update` | PATCH | `/apps/${appId}/release-pipelines/${pipelineId}` | Update release pipeline |
194
+ | `softDelete` | DELETE | `/apps/${appId}/release-pipelines/${pipelineId}` | Soft delete release pipeline |
195
+ | `setDefault` | POST | `/apps/${appId}/release-pipelines/${pipelineId}/set-default` | Set default release pipeline |
196
+ | `dryRunValidate` | POST | `/apps/${appId}/release-pipelines/${pipelineId}/validate` | Dry-run validate release pipeline |
197
+
198
+ ### ArtifactsAPI
199
+
200
+ | Method | HTTP | Path | Description |
201
+ |--------|------|------|-------------|
202
+ | `prepareUpload` | POST | `/apps/${appId}/artifacts/prepare` | Prepare artifact upload |
203
+ | `finalizeUpload` | POST | `/apps/${appId}/artifacts/finalize` | Finalize artifact upload |
204
+ | `verify` | POST | `/apps/${appId}/artifacts/${artifactId}/verify` | Verify artifact |
205
+ | `getBatchUploadStatus` | GET | `/artifacts/status` | Get batch upload status |
206
+ | `getUploadStatus` | GET | `/artifacts/${artifactId}/status` | Get upload status |
207
+ | `get` | GET | `/artifacts/${artifactId}` | Get artifact by ID |
208
+ | `download` | GET | `/artifacts/${artifactId}/download` | Download artifact |
209
+ | `cancelUpload` | POST | `/artifacts/${artifactId}/cancel` | Cancel artifact upload |
210
+ | `archive` | POST | `/artifacts/${artifactId}/archive` | Archive artifact |
211
+ | `compareTwoApk` | GET | `/artifacts/compare` | Compare two APK artifacts |
212
+ | `triggerSync` | POST | `/artifacts/sync` | Trigger artifact sync |
213
+ | `list` | GET | `/artifacts/` | List artifacts |
214
+
215
+ ### AnalyticsAPI
216
+
217
+ | Method | HTTP | Path | Description |
218
+ |--------|------|------|-------------|
219
+ | `getOverview` | GET | `/analytics/overview` | Get analytics overview |
220
+ | `getMetricDetail` | GET | `/analytics/metrics/${metricKey}` | Get metric detail |
221
+ | `getMetricRegistry` | GET | `/analytics/registry` | Get metric registry |
222
+ | `triggerJob` | POST | `/analytics/trigger` | Trigger analytics job |
223
+
224
+ ### CredentialsAPI
225
+
226
+ | Method | HTTP | Path | Description |
227
+ |--------|------|------|-------------|
228
+ | `listStoreOrganization` | GET | `/credentials/` | List store credentials for the active organization |
229
+ | `get` | GET | `/credentials/${credentialId}` | Retrieve an individual credential by ID |
230
+ | `updateMetadata` | PATCH | `/credentials/${credentialId}` | Update credential metadata |
231
+ | `revoke` | DELETE | `/credentials/${credentialId}` | Revoke (soft delete) a credential |
232
+ | `create` | POST | `/credentials/${provider}` | Create a new credential |
233
+ | `rotateSecrets` | POST | `/credentials/${credentialId}/rotate` | Rotate credential secrets |
234
+ | `mintFreshAccessToken` | POST | `/credentials/${credentialId}/refresh-token` | Mint a fresh access token for a credential |
235
+
236
+ ### BillingAPI
237
+
238
+ | Method | HTTP | Path | Description |
239
+ |--------|------|------|-------------|
240
+ | `getOverview` | GET | `/billing/overview` | Get billing overview |
241
+ | `getEntitlementsSummary` | GET | `/billing/entitlements` | Get entitlements summary |
242
+ | `cancelSubscription` | POST | `/billing/subscriptions/cancel` | Cancel subscription |
243
+ | `getPortalUrl` | GET | `/billing/portal` | Get billing portal URL |
244
+ | `updateEmail` | PATCH | `/billing/email` | Update billing email |
245
+ | `createCheckoutSession` | POST | `/billing/checkout` | Create checkout session |
246
+ | `listOrders` | GET | `/billing/orders` | List orders |
247
+ | `getOrderDetails` | GET | `/billing/orders/${orderId}` | Get order details |
248
+
249
+ ### IntegrationsAPI
250
+
251
+ | Method | HTTP | Path | Description |
252
+ |--------|------|------|-------------|
253
+ | `listOrganization` | GET | `/integrations/` | List integrations for organization |
254
+ | `getDetails` | GET | `/integrations/${integrationKey}` | Get integration details |
255
+ | `install` | POST | `/integrations/${integrationKey}/install` | Install integration |
256
+ | `uninstall` | POST | `/integrations/${integrationKey}/uninstall` | Uninstall integration |
257
+ | `enable` | POST | `/integrations/${integrationKey}/enable` | Enable integration |
258
+ | `disable` | POST | `/integrations/${integrationKey}/disable` | Disable integration |
259
+ | `listCatalogEntries` | GET | `/admin/integrations/` | List all catalog entries |
260
+ | `getCatalogEntry` | GET | `/admin/integrations/${integrationKey}` | Get catalog entry |
261
+ | `searchInstallations` | GET | `/admin/integrations/installations` | Search installations |
262
+ | `listOrgInstallations` | GET | `/admin/integrations/orgs/${orgId}` | List org installations |
263
+ | `getOrgEntitlements` | GET | `/admin/integrations/orgs/${orgId}/entitlements` | Get org entitlements |
264
+ | `forceInstall` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/install` | Force install integration |
265
+ | `forceUninstall` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/uninstall` | Force uninstall integration |
266
+ | `forceEnable` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/enable` | Force enable integration |
267
+ | `forceDisable` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/disable` | Force disable integration |
268
+ | `revalidate` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/revalidate` | Revalidate integration |
269
+ | `triggerSync` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/trigger-sync` | Trigger sync |
270
+ | `createAllowOverride` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/entitlements/allow` | Create ALLOW override |
271
+ | `createDenyOverride` | POST | `/admin/integrations/orgs/${orgId}/${integrationKey}/entitlements/deny` | Create DENY override |
272
+
273
+ ### ShareLinksAPI
274
+
275
+ | Method | HTTP | Path | Description |
276
+ |--------|------|------|-------------|
277
+ | `list` | GET | `/share-links/` | List share links |
278
+ | `create` | POST | `/share-links/` | Create share link |
279
+ | `get` | GET | `/share-links/${shareLinkId}` | Get share link |
280
+ | `update` | PATCH | `/share-links/${shareLinkId}` | Update share link |
281
+ | `delete` | DELETE | `/share-links/${shareLinkId}` | Delete share link |
282
+ | `revoke` | POST | `/share-links/${shareLinkId}/revoke` | Revoke share link |
283
+ | `restore` | POST | `/share-links/${shareLinkId}/restore` | Restore share link |
284
+ | `getAnalytics` | GET | `/share-links/${shareLinkId}/analytics` | Get share link analytics |
285
+ | `getDownloadHistory` | GET | `/share-links/${shareLinkId}/downloads` | Get download history |
286
+ | `bulkRevoke` | POST | `/share-links/bulk/revoke` | Bulk revoke share links |
287
+ | `bulkExtendExpiration` | POST | `/share-links/bulk/extend` | Bulk extend expiration |
288
+ | `exportDataEmail` | POST | `/share-links/gdpr/export` | Export data by email (GDPR) |
289
+ | `deleteDataEmail` | POST | `/share-links/gdpr/delete` | Delete data by email (GDPR) |
290
+ | `rectifyEmail` | PATCH | `/share-links/gdpr/rectify` | Rectify email (GDPR) |
291
+ | `getInfo` | GET | `/s/${shortCode}` | Get share link info |
292
+ | `getPublicMetadata` | GET | `/s/${shortCode}/metadata` | Get public metadata |
293
+ | `validateAccess` | POST | `/s/${shortCode}/validate` | Validate access |
294
+ | `requestOtp` | POST | `/s/${shortCode}/request-otp` | Request OTP |
295
+ | `verifyOtp` | POST | `/s/${shortCode}/verify-otp` | Verify OTP |
296
+ | `downloadArtifact` | POST | `/s/${shortCode}/download` | Download artifact |
297
+
298
+ ### PoliciesAPI
299
+
300
+ | Method | HTTP | Path | Description |
301
+ |--------|------|------|-------------|
302
+ | `evaluateArtifactAgainstRules` | POST | `/policies/evaluate` | Evaluate artifact against policy rules |
303
+ | `simulateEvaluation` | POST | `/policies/simulate` | Simulate policy evaluation |
304
+ | `listRules` | GET | `/policies/rules` | List policy rules |
305
+ | `createRule` | POST | `/policies/rules` | Create policy rule |
306
+ | `updateRule` | PATCH | `/policies/rules/${ruleId}` | Update policy rule |
307
+ | `activateRule` | POST | `/policies/rules/${ruleId}/activate` | Activate policy rule |
308
+ | `deactivateRule` | POST | `/policies/rules/${ruleId}/deactivate` | Deactivate policy rule |
309
+ | `getRuleHistory` | GET | `/policies/rules/${ruleId}/history` | Get policy rule history |
310
+ | `exportRules` | GET | `/policies/rules/export` | Export policy rules |
311
+ | `importRules` | POST | `/policies/rules/import` | Import policy rules |
312
+ | `listEvaluationAudits` | GET | `/policies/audits` | List policy evaluation audits |
313
+ | `getEvaluationAudit` | GET | `/policies/audits/${auditId}` | Get policy evaluation audit |
314
+ | `listStores` | GET | `/policies/stores` | List policy stores |
315
+ | `getStore` | GET | `/policies/stores/${code}` | Get policy store |
316
+ | `listPlatforms` | GET | `/policies/platforms` | List policy platforms |
317
+ | `getPlatform` | GET | `/policies/platforms/${code}` | Get policy platform |
318
+
319
+ ### ApprovalsAPI
320
+
321
+ | Method | HTTP | Path | Description |
322
+ |--------|------|------|-------------|
323
+ | `list` | GET | `/approvals/` | List approvals by resource |
324
+ | `createRequest` | POST | `/approvals/` | Create an approval request |
325
+ | `listRequestsAcrossOrganization` | GET | `/approvals/requests` | List approval requests across organization |
326
+ | `listApproversResource` | GET | `/approvals/approvers` | List approvers for a resource |
327
+ | `grantUserRightsResource` | POST | `/approvals/approvers` | Grant a user approval rights for a resource |
328
+ | `listGrants` | GET | `/approvals/grants` | List approval grants |
329
+ | `revokeGrant` | POST | `/approvals/grants/${id}/revoke` | Revoke an approval grant |
330
+ | `extendGrant` | POST | `/approvals/grants/${id}/extend` | Extend an approval grant |
331
+ | `listPolicyTemplates` | GET | `/approvals/templates` | List approval policy templates |
332
+ | `createPolicyTemplate` | POST | `/approvals/templates` | Create approval policy template |
333
+ | `updatePolicyTemplate` | PATCH | `/approvals/templates/${id}` | Update approval policy template |
334
+ | `archivePolicyTemplate` | POST | `/approvals/templates/${id}/archive` | Archive approval policy template |
335
+ | `listTemplateDefaults` | GET | `/approvals/template-defaults` | List approval template defaults |
336
+ | `upsertTemplateDefault` | PUT | `/approvals/template-defaults/${actionType}/${riskLevel}` | Upsert approval template default |
337
+ | `getRequest` | GET | `/approvals/${id}` | Get an approval request |
338
+ | `recordDecision` | POST | `/approvals/${id}/decisions` | Record an approval decision (approve or reject) |
339
+ | `cancelPendingRequest` | POST | `/approvals/${id}/cancel` | Cancel a pending approval request |
340
+ | `archiveRequest` | POST | `/approvals/${id}/archive` | Archive an approval request |
341
+ | `refreshExpiredDriftedRequest` | POST | `/approvals/${id}/refresh` | Refresh an expired or drifted approval request |
342
+
343
+ ### WaitlistAPI
344
+
345
+ | Method | HTTP | Path | Description |
346
+ |--------|------|------|-------------|
347
+ | `signUpProduct` | POST | `/waitlist/` | Sign up for a product waitlist |
348
+ | `getCountProduct` | GET | `/waitlist/${productId}/count` | Get waitlist count for a product |
349
+
350
+ ### AuditLogsAPI
351
+
352
+ | Method | HTTP | Path | Description |
353
+ |--------|------|------|-------------|
354
+ | `getActivitySummary` | GET | `/audit-logs/summary` | Get activity summary |
355
+ | `getSecurityInsights` | GET | `/audit-logs/security` | Get security insights |
356
+ | `getUserActivityTimeline` | GET | `/audit-logs/users/${userId}/timeline` | Get user activity timeline |
357
+ | `getResourceChangeHistory` | GET | `/audit-logs/resources/${resourceType}/${resourceId}/history` | Get resource change history |
358
+ | `list` | GET | `/audit-logs/` | List audit logs |
359
+ | `get` | GET | `/audit-logs/${id}` | Get audit log by ID |
360
+ | `export` | POST | `/audit-logs/export` | Export audit logs |
361
+
362
+ ### WebhooksAPI
363
+
364
+ | Method | HTTP | Path | Description |
365
+ |--------|------|------|-------------|
366
+ | `receiveExternalProvider` | POST | `/webhooks/inbound/${provider}/${endpointId}` | Receive webhook from external provider |
367
+ | `webhookHealthCheck` | GET | `/webhooks/inbound/health` | Webhook health check |
368
+ | `listEndpoints` | GET | `/webhooks/endpoints` | List webhook endpoints |
369
+ | `createEndpoint` | POST | `/webhooks/endpoints` | Create webhook endpoint |
370
+ | `getEndpoint` | GET | `/webhooks/endpoints/${id}` | Get webhook endpoint |
371
+ | `updateEndpointStatus` | PATCH | `/webhooks/endpoints/${id}` | Update webhook endpoint status |
372
+ | `deleteEndpoint` | DELETE | `/webhooks/endpoints/${id}` | Delete webhook endpoint |
373
+ | `getPayloadHistoryEndpoint` | GET | `/webhooks/endpoints/${id}/payloads` | Get payload history for endpoint |
374
+ | `listSubscriptions` | GET | `/webhooks/subscriptions` | List webhook subscriptions |
375
+ | `createSubscription` | POST | `/webhooks/subscriptions` | Create webhook subscription |
376
+ | `getSubscription` | GET | `/webhooks/subscriptions/${id}` | Get webhook subscription |
377
+ | `updateSubscription` | PATCH | `/webhooks/subscriptions/${id}` | Update webhook subscription |
378
+ | `deleteSubscription` | DELETE | `/webhooks/subscriptions/${id}` | Delete webhook subscription |
379
+ | `sendTest` | POST | `/webhooks/subscriptions/${id}/test` | Send test webhook |
380
+ | `getDeliveryHistorySubscription` | GET | `/webhooks/subscriptions/${id}/deliveries` | Get delivery history for subscription |
381
+ | `replayDelivery` | POST | `/webhooks/deliveries/${id}/replay` | Replay a webhook delivery |
382
+
383
+ ### WorkflowsAPI
384
+
385
+ | Method | HTTP | Path | Description |
386
+ |--------|------|------|-------------|
387
+ | `list` | GET | `/workflows/` | List workflows |
388
+ | `create` | POST | `/workflows/` | Create workflow |
389
+ | `get` | GET | `/workflows/${id}` | Get workflow |
390
+ | `update` | PUT | `/workflows/${id}` | Update workflow |
391
+ | `delete` | DELETE | `/workflows/${id}` | Delete workflow |
392
+ | `createNode` | POST | `/workflows/${id}/nodes` | Create workflow node |
393
+ | `updateNode` | PUT | `/workflows/nodes/${id}` | Update workflow node |
394
+ | `deleteNode` | DELETE | `/workflows/nodes/${id}` | Delete workflow node |
395
+ | `createEdge` | POST | `/workflows/${id}/edges` | Create workflow edge |
396
+ | `deleteEdge` | DELETE | `/workflows/edges/${id}` | Delete workflow edge |
397
+ | `listExecutions` | GET | `/workflows/${id}/executions` | List workflow executions |
398
+ | `getExecutionDetails` | GET | `/workflows/executions/${id}` | Get execution details |
399
+ | `execute` | POST | `/workflows/${id}/execute` | Execute workflow |
400
+ | `listNodeTypes` | GET | `/workflows/node-types` | List node types |
401
+
402
+ ### HealthAPI
403
+
404
+ | Method | HTTP | Path | Description |
405
+ |--------|------|------|-------------|
406
+ | `readinessProbeCoreServices` | GET | `/health` | Readiness probe for core services |
407
+ | `integrationSystemCheck` | GET | `/health/integration` | Integration system health check |
408
+ | `webhookDeliveryCheck` | GET | `/health/webhooks` | Webhook delivery health check |
409
+ | `billingServiceCheck` | GET | `/health/billing` | Billing service health check |
410
+ | `checkStoreCredential` | GET | `/health/credentials` | Check store credential health |
411
+ | `getAnalyticsStatus` | GET | `/health/analytics` | Get analytics health status |
412
+
413
+ ## Types
414
+
415
+ - `AuthOauthAuthorizationServerMetadataResponse`
416
+ - `AuthOpenidConnectDiscoveryMetadataResponse`
417
+ - `AuthRegisterUserInput`
418
+ - `AuthRegisterUserResponse`
419
+ - `AuthAuthenticateUserInput`
420
+ - `AuthAuthenticateUserResponse`
421
+ - `AuthLogOutUserResponse`
422
+ - `AuthResendEmailVerificationInput`
423
+ - `AuthResendEmailVerificationResponse`
424
+ - `AuthVerifyEmailAddressInput`
425
+ - `AuthVerifyEmailAddressResponse`
426
+ - `AuthRequestPasswordResetInput`
427
+ - `AuthRequestPasswordResetResponse`
428
+ - `AuthConfirmPasswordResetInput`
429
+ - `AuthConfirmPasswordResetResponse`
430
+ - `AuthSignSocialProviderInput`
431
+ - `AuthSignSocialProviderResponse`
432
+ - `OAuthRequestDeviceAuthorizationCodesInput`
433
+ - `OAuthRequestDeviceAuthorizationCodesResponse`
434
+ - `OAuthPollDeviceAuthorizationTokenInput`
435
+ - `OAuthPollDeviceAuthorizationTokenResponse`
436
+ - `OAuthGetDeviceAuthorizationStatusResponse`
437
+ - `OAuthApproveDeviceAuthorizationRequestInput`
438
+ - `OAuthApproveDeviceAuthorizationRequestResponse`
439
+ - `OAuthDenyDeviceAuthorizationRequestInput`
440
+ - `OAuthDenyDeviceAuthorizationRequestResponse`
441
+ - `OAuthOauth2AuthorizeEndpointResponse`
442
+ - `OAuthOauth2ConsentEndpointInput`
443
+ - `OAuthOauth2ConsentEndpointResponse`
444
+ - `OAuthOauth2ContinueEndpointInput`
445
+ - `OAuthOauth2ContinueEndpointResponse`
446
+ - `OAuthOauth2TokenEndpointInput`
447
+ - `OAuthOauth2TokenEndpointResponse`
448
+ - `OAuthOauth2TokenIntrospectionEndpointInput`
449
+ - `OAuthOauth2TokenIntrospectionEndpointResponse`
450
+ - `OAuthOauth2TokenRevocationEndpointInput`
451
+ - `OAuthOpenidConnectUserinfoEndpointResponse`
452
+ - `OAuthOpenidRpInitiatedLogoutEndpointResponse`
453
+ - `OAuthDynamicOauth2ClientRegistrationInput`
454
+ - `OAuthDynamicOauth2ClientRegistrationResponse`
455
+ - `OAuthCreateOauth2ClientInput`
456
+ - `OAuthCreateOauth2ClientResponse`
457
+ - `OAuthGetOauth2ClientResponse`
458
+ - `OAuthGetOauth2PublicClientResponse`
459
+ - `OAuthUpdateOauth2ClientInput`
460
+ - `OAuthUpdateOauth2ClientResponse`
461
+ - `OAuthRotateOauth2ClientSecretInput`
462
+ - `OAuthRotateOauth2ClientSecretResponse`
463
+ - `OAuthDeleteOauth2ClientInput`
464
+ - `OAuthGetOauth2ConsentResponse`
465
+ - `OAuthListOauth2ConsentsResponse`
466
+ - `OAuthUpdateOauth2ConsentInput`
467
+ - `OAuthUpdateOauth2ConsentResponse`
468
+ - `OAuthDeleteOauth2ConsentInput`
469
+ - `OAuthAdminCreateOauth2ClientInput`
470
+ - `OAuthAdminCreateOauth2ClientResponse`
471
+ - `OAuthAdminUpdateOauth2ClientInput`
472
+ - `OAuthAdminUpdateOauth2ClientResponse`
473
+ - `AuthGetUserResponse`
474
+ - `AuthGetOnboardingStatusResponse`
475
+ - `SessionsGetResponse`
476
+ - `SessionsListUserResponse`
477
+ - `SessionsRevokeResponse`
478
+ - `SessionsRevokeOtherResponse`
479
+ - `SessionsActivateResponse`
480
+ - `AdminUsersListItem`
481
+ - `AdminUsersCreateAccountInput`
482
+ - `AdminUsersCreateAccountResponse`
483
+ - `AdminUsersUpdateRoleInput`
484
+ - `AdminUsersUpdateRoleResponse`
485
+ - `AdminUsersBanAccountInput`
486
+ - `AdminUsersBanAccountResponse`
487
+ - `AdminUsersRemoveBanResponse`
488
+ - `AdminUsersListSessionsResponse`
489
+ - `AdminUsersRevokeSessionsResponse`
490
+ - `AdminUsersImpersonateResponse`
491
+ - `AdminUsersStopImpersonatingResponse`
492
+ - `AdminUsersDeleteAccountResponse`
493
+ - `TeamsListOrganizationItem`
494
+ - `TeamsCreateOrganizationInput`
495
+ - `TeamsCreateOrganizationResponse`
496
+ - `TeamsUpdateMetadataInput`
497
+ - `TeamsUpdateMetadataResponse`
498
+ - `TeamsSetSessionInput`
499
+ - `TeamsSetSessionResponse`
500
+ - `TeamsListMembersItem`
501
+ - `TeamsAddMemberInput`
502
+ - `TeamsAddMemberItem`
503
+ - `OrganizationsListAuthenticatedUserItem`
504
+ - `OrganizationsCreateInput`
505
+ - `OrganizationsCreateResponse`
506
+ - `OrganizationsGetResponse`
507
+ - `OrganizationsSetSessionInput`
508
+ - `OrganizationsSetSessionResponse`
509
+ - `OrganizationsGetResponse`
510
+ - `OrganizationsUpdateInput`
511
+ - `OrganizationsUpdateResponse`
512
+ - `OrganizationsListInvitationsItem`
513
+ - `OrganizationsListPendingInvitationsUserItem`
514
+ - `OrganizationsInviteMemberInput`
515
+ - `OrganizationsInviteMemberResponse`
516
+ - `OrganizationsListMembersItem`
517
+ - `OrganizationsGetMemberRoleResponse`
518
+ - `OrganizationsUpdateMemberRoleInput`
519
+ - `SettingsGetCombinedOrgUserResponse`
520
+ - `SettingsListOrgMergedSystemResponse`
521
+ - `SettingsPartiallyUpdateOrgPartialInput`
522
+ - `SettingsPartiallyUpdateOrgPartialResponse`
523
+ - `SettingsGetSingleOrgResponse`
524
+ - `SettingsResetOrgSystemDefaultResponse`
525
+ - `AppsListItem`
526
+ - `AppsCreateInput`
527
+ - `AppsCreateResponse`
528
+ - `AppsGetDetailsResponse`
529
+ - `AppsUpdateMetadataInput`
530
+ - `AppsUpdateMetadataResponse`
531
+ - `AppsGeneratePresignedUploadUrlInput`
532
+ - `AppsGeneratePresignedUploadUrlResponse`
533
+ - `AppsMarkArtifactUploadCompleteInput`
534
+ - `AppsMarkArtifactUploadCompleteResponse`
535
+ - `AppsGetPricingInformationResponse`
536
+ - `AppsUpdatePricingConfigurationResponse`
537
+ - `ReleasesListApplicationItem`
538
+ - `ReleasesCreateApplicationInput`
539
+ - `ReleasesCreateApplicationResponse`
540
+ - `ReleasesGetDetailsResponse`
541
+ - `ReleasesUpdateMetadataInput`
542
+ - `ReleasesUpdateMetadataResponse`
543
+ - `ReleasesSubmitReviewResponse`
544
+ - `ReleasesSchedulePublicationInput`
545
+ - `ReleasesSchedulePublicationResponse`
546
+ - `ReleasesRollbackResponse`
547
+ - `ReleasesAssignPipelineInput`
548
+ - `ReleasesAssignPipelineResponse`
549
+ - `ReleasesGetStageStateGateResponse`
550
+ - `ReleasesTransitionNextPipelineStageInput`
551
+ - `ReleasesTransitionNextPipelineStageResponse`
552
+ - `ReleasePipelinesListResponse`
553
+ - `ReleasePipelinesCreateInput`
554
+ - `ReleasePipelinesCreateResponse`
555
+ - `ReleasePipelinesGetResponse`
556
+ - `ReleasePipelinesUpdateInput`
557
+ - `ReleasePipelinesUpdateResponse`
558
+ - `ReleasePipelinesSetDefaultResponse`
559
+ - `ReleasePipelinesDryRunValidateInput`
560
+ - `ReleasePipelinesDryRunValidateResponse`
561
+ - `ArtifactsPrepareUploadInput`
562
+ - `ArtifactsPrepareUploadResponse`
563
+ - `ArtifactsFinalizeUploadInput`
564
+ - `ArtifactsFinalizeUploadResponse`
565
+ - `ArtifactsVerifyResponse`
566
+ - `ArtifactsGetBatchUploadStatusResponse`
567
+ - `ArtifactsGetUploadStatusResponse`
568
+ - `ArtifactsGetResponse`
569
+ - `ArtifactsCancelUploadResponse`
570
+ - `ArtifactsArchiveResponse`
571
+ - `ArtifactsCompareTwoApkResponse`
572
+ - `ArtifactsTriggerSyncResponse`
573
+ - `ArtifactsListItem`
574
+ - `AnalyticsGetOverviewResponse`
575
+ - `AnalyticsGetMetricDetailResponse`
576
+ - `AnalyticsGetMetricRegistryResponse`
577
+ - `AnalyticsTriggerJobInput`
578
+ - `AnalyticsTriggerJobResponse`
579
+ - `CredentialsListStoreOrganizationItem`
580
+ - `CredentialsGetResponse`
581
+ - `CredentialsUpdateMetadataInput`
582
+ - `CredentialsUpdateMetadataResponse`
583
+ - `CredentialsRevokeInput`
584
+ - `CredentialsRevokeResponse`
585
+ - `CredentialsCreateInput`
586
+ - `CredentialsCreateResponse`
587
+ - `CredentialsRotateSecretsInput`
588
+ - `CredentialsRotateSecretsResponse`
589
+ - `CredentialsMintFreshAccessTokenResponse`
590
+ - `BillingGetOverviewResponse`
591
+ - `BillingGetEntitlementsSummaryResponse`
592
+ - `BillingCancelSubscriptionInput`
593
+ - `BillingCancelSubscriptionResponse`
594
+ - `BillingGetPortalUrlResponse`
595
+ - `BillingUpdateEmailInput`
596
+ - `BillingUpdateEmailResponse`
597
+ - `BillingCreateCheckoutSessionInput`
598
+ - `BillingCreateCheckoutSessionResponse`
599
+ - `BillingListOrdersItem`
600
+ - `BillingGetOrderDetailsResponse`
601
+ - `IntegrationsListOrganizationResponse`
602
+ - `IntegrationsGetDetailsResponse`
603
+ - `IntegrationsInstallInput`
604
+ - `IntegrationsInstallResponse`
605
+ - `IntegrationsUninstallResponse`
606
+ - `IntegrationsEnableResponse`
607
+ - `IntegrationsDisableResponse`
608
+ - `IntegrationsListCatalogEntriesResponse`
609
+ - `IntegrationsGetCatalogEntryResponse`
610
+ - `IntegrationsSearchInstallationsResponse`
611
+ - `IntegrationsListOrgInstallationsResponse`
612
+ - `IntegrationsGetOrgEntitlementsResponse`
613
+ - `IntegrationsForceInstallInput`
614
+ - `IntegrationsForceInstallResponse`
615
+ - `IntegrationsForceUninstallInput`
616
+ - `IntegrationsForceUninstallResponse`
617
+ - `IntegrationsForceEnableInput`
618
+ - `IntegrationsForceEnableResponse`
619
+ - `IntegrationsForceDisableInput`
620
+ - `IntegrationsForceDisableResponse`
621
+ - `IntegrationsRevalidateResponse`
622
+ - `IntegrationsTriggerSyncResponse`
623
+ - `IntegrationsCreateAllowOverrideInput`
624
+ - `IntegrationsCreateAllowOverrideResponse`
625
+ - `IntegrationsCreateDenyOverrideInput`
626
+ - `IntegrationsCreateDenyOverrideResponse`
627
+ - `ShareLinksListItem`
628
+ - `ShareLinksCreateInput`
629
+ - `ShareLinksCreateResponse`
630
+ - `ShareLinksGetResponse`
631
+ - `ShareLinksUpdateInput`
632
+ - `ShareLinksUpdateResponse`
633
+ - `ShareLinksRevokeResponse`
634
+ - `ShareLinksRestoreResponse`
635
+ - `ShareLinksGetAnalyticsResponse`
636
+ - `ShareLinksGetDownloadHistoryItem`
637
+ - `ShareLinksBulkRevokeInput`
638
+ - `ShareLinksBulkRevokeResponse`
639
+ - `ShareLinksBulkExtendExpirationInput`
640
+ - `ShareLinksBulkExtendExpirationResponse`
641
+ - `ShareLinksExportDataEmailInput`
642
+ - `ShareLinksExportDataEmailResponse`
643
+ - `ShareLinksDeleteDataEmailInput`
644
+ - `ShareLinksDeleteDataEmailResponse`
645
+ - `ShareLinksRectifyEmailInput`
646
+ - `ShareLinksRectifyEmailResponse`
647
+ - `ShareLinksGetInfoResponse`
648
+ - `ShareLinksGetPublicMetadataResponse`
649
+ - `ShareLinksValidateAccessInput`
650
+ - `ShareLinksValidateAccessResponse`
651
+ - `ShareLinksRequestOtpInput`
652
+ - `ShareLinksRequestOtpResponse`
653
+ - `ShareLinksVerifyOtpInput`
654
+ - `ShareLinksVerifyOtpResponse`
655
+ - `ShareLinksDownloadArtifactInput`
656
+ - `ShareLinksDownloadArtifactResponse`
657
+ - `PoliciesEvaluateArtifactAgainstRulesInput`
658
+ - `PoliciesEvaluateArtifactAgainstRulesResponse`
659
+ - `PoliciesSimulateEvaluationInput`
660
+ - `PoliciesSimulateEvaluationResponse`
661
+ - `PoliciesListRulesResponse`
662
+ - `PoliciesCreateRuleInput`
663
+ - `PoliciesCreateRuleResponse`
664
+ - `PoliciesUpdateRuleInput`
665
+ - `PoliciesUpdateRuleResponse`
666
+ - `PoliciesActivateRuleResponse`
667
+ - `PoliciesDeactivateRuleResponse`
668
+ - `PoliciesGetRuleHistoryResponse`
669
+ - `PoliciesExportRulesResponse`
670
+ - `PoliciesImportRulesInput`
671
+ - `PoliciesImportRulesResponse`
672
+ - `PoliciesListEvaluationAuditsResponse`
673
+ - `PoliciesGetEvaluationAuditResponse`
674
+ - `PoliciesListStoresResponse`
675
+ - `PoliciesGetStoreResponse`
676
+ - `PoliciesListPlatformsResponse`
677
+ - `PoliciesGetPlatformResponse`
678
+ - `ApprovalsListItem`
679
+ - `ApprovalsCreateRequestInput`
680
+ - `ApprovalsCreateRequestResponse`
681
+ - `ApprovalsListRequestsAcrossOrganizationItem`
682
+ - `ApprovalsListApproversResourceResponse`
683
+ - `ApprovalsGrantUserRightsResourceInput`
684
+ - `ApprovalsGrantUserRightsResourceResponse`
685
+ - `ApprovalsListGrantsItem`
686
+ - `ApprovalsRevokeGrantInput`
687
+ - `ApprovalsRevokeGrantResponse`
688
+ - `ApprovalsExtendGrantInput`
689
+ - `ApprovalsExtendGrantResponse`
690
+ - `ApprovalsListPolicyTemplatesItem`
691
+ - `ApprovalsCreatePolicyTemplateInput`
692
+ - `ApprovalsCreatePolicyTemplateResponse`
693
+ - `ApprovalsUpdatePolicyTemplateInput`
694
+ - `ApprovalsUpdatePolicyTemplateResponse`
695
+ - `ApprovalsArchivePolicyTemplateInput`
696
+ - `ApprovalsArchivePolicyTemplateResponse`
697
+ - `ApprovalsListTemplateDefaultsItem`
698
+ - `ApprovalsUpsertTemplateDefaultInput`
699
+ - `ApprovalsUpsertTemplateDefaultResponse`
700
+ - `ApprovalsGetRequestResponse`
701
+ - `ApprovalsRecordDecisionInput`
702
+ - `ApprovalsRecordDecisionResponse`
703
+ - `ApprovalsCancelPendingRequestInput`
704
+ - `ApprovalsCancelPendingRequestResponse`
705
+ - `ApprovalsArchiveRequestResponse`
706
+ - `ApprovalsRefreshExpiredDriftedRequestInput`
707
+ - `ApprovalsRefreshExpiredDriftedRequestResponse`
708
+ - `WaitlistSignUpProductInput`
709
+ - `WaitlistSignUpProductResponse`
710
+ - `WaitlistGetCountProductResponse`
711
+ - `AuditLogsGetActivitySummaryResponse`
712
+ - `AuditLogsGetSecurityInsightsResponse`
713
+ - `AuditLogsGetUserActivityTimelineResponse`
714
+ - `AuditLogsGetResourceChangeHistoryResponse`
715
+ - `AuditLogsListResponse`
716
+ - `AuditLogsGetResponse`
717
+ - `AuditLogsExportInput`
718
+ - `AuditLogsExportResponse`
719
+ - `WebhooksReceiveExternalProviderResponse`
720
+ - `WebhooksWebhookHealthCheckResponse`
721
+ - `WebhooksListEndpointsItem`
722
+ - `WebhooksCreateEndpointInput`
723
+ - `WebhooksCreateEndpointResponse`
724
+ - `WebhooksGetEndpointResponse`
725
+ - `WebhooksUpdateEndpointStatusInput`
726
+ - `WebhooksUpdateEndpointStatusResponse`
727
+ - `WebhooksGetPayloadHistoryEndpointItem`
728
+ - `WebhooksListSubscriptionsItem`
729
+ - `WebhooksCreateSubscriptionInput`
730
+ - `WebhooksCreateSubscriptionResponse`
731
+ - `WebhooksGetSubscriptionResponse`
732
+ - `WebhooksUpdateSubscriptionInput`
733
+ - `WebhooksUpdateSubscriptionResponse`
734
+ - `WebhooksSendTestResponse`
735
+ - `WebhooksGetDeliveryHistorySubscriptionItem`
736
+ - `WebhooksReplayDeliveryResponse`
737
+ - `WorkflowsListItem`
738
+ - `WorkflowsCreateInput`
739
+ - `WorkflowsCreateResponse`
740
+ - `WorkflowsGetResponse`
741
+ - `WorkflowsUpdateInput`
742
+ - `WorkflowsUpdateResponse`
743
+ - `WorkflowsCreateNodeInput`
744
+ - `WorkflowsCreateNodeResponse`
745
+ - `WorkflowsUpdateNodeInput`
746
+ - `WorkflowsUpdateNodeResponse`
747
+ - `WorkflowsCreateEdgeInput`
748
+ - `WorkflowsCreateEdgeResponse`
749
+ - `WorkflowsListExecutionsItem`
750
+ - `WorkflowsGetExecutionDetailsResponse`
751
+ - `WorkflowsExecuteInput`
752
+ - `WorkflowsExecuteResponse`
753
+ - `WorkflowsListNodeTypesItem`
754
+ - `HealthReadinessProbeCoreServicesResponse`
755
+ - `HealthIntegrationSystemCheckResponse`
756
+ - `HealthWebhookDeliveryCheckResponse`
757
+ - `HealthBillingServiceCheckResponse`
758
+ - `HealthCheckStoreCredentialResponse`
759
+ - `HealthGetAnalyticsStatusResponse`
760
+ - `SettingsListUserMergedSystemResponse`
761
+ - `SettingsPartiallyUpdateUserPartialInput`
762
+ - `SettingsPartiallyUpdateUserPartialResponse`
763
+ - `SettingsGetSingleUserResponse`
764
+ - `SettingsResetUserSystemDefaultResponse`
765
+ - `GetAuthDeviceQuery` — Query parameters for getDeviceAuthorizationStatus
766
+ - `GetAuthOauth2AuthorizeQuery` — Query parameters for oauth2AuthorizeEndpoint
767
+ - `GetAuthOauth2EndSessionQuery` — Query parameters for openidRpInitiatedLogoutEndpoint
768
+ - `GetAuthOauth2GetClientQuery` — Query parameters for getOauth2Client
769
+ - `GetAuthOauth2PublicClientQuery` — Query parameters for getOauth2PublicClient
770
+ - `GetAuthOauth2GetConsentQuery` — Query parameters for getOauth2Consent
771
+ - `GetAdminAdminUsersQuery` — Query parameters for list
772
+ - `GetOrgsInvitationsPendingQuery` — Query parameters for listPendingInvitationsUser
773
+ - `GetOrgsMembersRoleQuery` — Query parameters for getMemberRole
774
+ - `GetOrgsByOrgIdSettingsQuery` — Query parameters for listOrgMergedSystem
775
+ - `GetUsersMeSettingsQuery` — Query parameters for listUserMergedSystem
776
+ - `GetAppsQuery` — Query parameters for list
777
+ - `GetAppsByAppIdPricingQuery` — Query parameters for getPricingInformation
778
+ - `GetAppsByAppIdReleasesQuery` — Query parameters for listApplication
779
+ - `GetArtifactsStatusQuery` — Query parameters for getBatchUploadStatus
780
+ - `GetArtifactsCompareQuery` — Query parameters for compareTwoApk
781
+ - `PostArtifactsSyncQuery` — Query parameters for triggerSync
782
+ - `GetArtifactsQuery` — Query parameters for list
783
+ - `GetAnalyticsOverviewQuery` — Query parameters for getOverview
784
+ - `GetAnalyticsMetricsByMetricKeyQuery` — Query parameters for getMetricDetail
785
+ - `GetAnalyticsRegistryQuery` — Query parameters for getMetricRegistry
786
+ - `GetCredentialsQuery` — Query parameters for listStoreOrganization
787
+ - `GetBillingPortalQuery` — Query parameters for getPortalUrl
788
+ - `GetBillingOrdersQuery` — Query parameters for listOrders
789
+ - `GetIntegrationsQuery` — Query parameters for listOrganization
790
+ - `GetAdminIntegrationsInstallationsQuery` — Query parameters for searchInstallations
791
+ - `GetShareLinksQuery` — Query parameters for list
792
+ - `GetShareLinksByShareLinkIdDownloadsQuery` — Query parameters for getDownloadHistory
793
+ - `GetPoliciesRulesQuery` — Query parameters for listRules
794
+ - `GetPoliciesRulesExportQuery` — Query parameters for exportRules
795
+ - `GetPoliciesAuditsQuery` — Query parameters for listEvaluationAudits
796
+ - `GetApprovalsQuery` — Query parameters for list
797
+ - `GetApprovalsRequestsQuery` — Query parameters for listRequestsAcrossOrganization
798
+ - `GetApprovalsApproversQuery` — Query parameters for listApproversResource
799
+ - `GetApprovalsGrantsQuery` — Query parameters for listGrants
800
+ - `GetApprovalsTemplatesQuery` — Query parameters for listPolicyTemplates
801
+ - `GetApprovalsTemplateDefaultsQuery` — Query parameters for listTemplateDefaults
802
+ - `GetAuditLogsSummaryQuery` — Query parameters for getActivitySummary
803
+ - `GetAuditLogsSecurityQuery` — Query parameters for getSecurityInsights
804
+ - `GetAuditLogsUsersByUserIdTimelineQuery` — Query parameters for getUserActivityTimeline
805
+ - `GetAuditLogsResourcesByResourceTypeByResourceIdHistoryQuery` — Query parameters for getResourceChangeHistory
806
+ - `GetAuditLogsQuery` — Query parameters for list
807
+ - `GetWebhooksEndpointsQuery` — Query parameters for listEndpoints
808
+ - `GetWebhooksEndpointsByIdPayloadsQuery` — Query parameters for getPayloadHistoryEndpoint
809
+ - `GetWebhooksSubscriptionsQuery` — Query parameters for listSubscriptions
810
+ - `GetWebhooksSubscriptionsByIdDeliveriesQuery` — Query parameters for getDeliveryHistorySubscription
811
+ - `GetWorkflowsQuery` — Query parameters for list
812
+ - `GetWorkflowsByIdExecutionsQuery` — Query parameters for listExecutions
813
+ - `GetWorkflowsNodeTypesQuery` — Query parameters for listNodeTypes
814
+ - `GetHealthCredentialsQuery` — Query parameters for checkStoreCredential
815
+
816
+ ## Error Handling
817
+
818
+ ```typescript
819
+ import { SDKError } from 'apollo-deploy-api-sdk';
820
+
821
+ try {
822
+ const result = await client.someApi.someMethod();
823
+ } catch (error) {
824
+ if (error instanceof SDKError) {
825
+ console.error(`Error ${error.status}: ${error.message} (${error.code})`);
826
+ }
827
+ }
828
+ ```