Apollo Deploy API SDK

Apollo Deploy platform API specification

This SDK was automatically generated by sdk-forge.

Installation

npm install apollo-deploy-api-sdk

Quick Start

import { createApolloDeployApiClient } from 'apollo-deploy-api-sdk';

const client = createApolloDeployApiClient({
  baseUrl: 'http://localhost:3000',
  cookieAuthValue: 'your-cookie-auth-credential',
  bearerAuthToken: 'your-bearer-auth-credential',
  oAuth2AccessToken: 'your-o-auth2-credential',
});

API Reference

GeneralAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | listMetrics | GET | /metrics | - |

AuthAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | oauthAuthorizationServerMetadata | GET | /.well-known/oauth-authorization-server | OAuth Authorization Server Metadata | | openidConnectDiscoveryMetadata | GET | /.well-known/openid-configuration | OpenID Connect Discovery Metadata | | registerUser | POST | /auth/register | Register a new user | | authenticateUser | POST | /auth/login | Authenticate a user | | logOutUser | POST | /auth/logout | Log out the current user | | resendEmailVerification | POST | /auth/resend-verification | Resend email verification | | verifyEmailAddress | POST | /auth/verify-email | Verify email address | | requestPasswordReset | POST | /auth/password/reset/request | Request a password reset | | confirmPasswordReset | POST | /auth/password/reset/confirm | Confirm a password reset | | signSocialProvider | POST | /auth/social/login | Sign in with a social provider | | getUser | GET | /auth/me | Get the current user | | getOnboardingStatus | GET | /auth/onboarding/check | Get onboarding status |

OAuthAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | oauth2AuthorizeEndpoint | GET | /auth/oauth2/authorize | OAuth2 authorize endpoint | | oauth2ConsentEndpoint | POST | /auth/oauth2/consent | OAuth2 consent endpoint | | oauth2ContinueEndpoint | POST | /auth/oauth2/continue | OAuth2 continue endpoint | | oauth2TokenEndpoint | POST | /auth/oauth2/token | OAuth2 token endpoint | | oauth2TokenIntrospectionEndpoint | POST | /auth/oauth2/introspect | OAuth2 token introspection endpoint | | oauth2TokenRevocationEndpoint | POST | /auth/oauth2/revoke | OAuth2 token revocation endpoint | | openidConnectUserinfoEndpoint | GET | /auth/oauth2/userinfo | OpenID Connect userinfo endpoint | | openidRpInitiatedLogoutEndpoint | GET | /auth/oauth2/end-session | OpenID RP-initiated logout endpoint | | createOauth2Client | POST | /auth/oauth2/create-client | Create OAuth2 client | | getOauth2Client | GET | /auth/oauth2/get-client | Get OAuth2 client | | getOauth2PublicClient | GET | /auth/oauth2/public-client | Get OAuth2 public client details | | listOauth2Clients | GET | /auth/oauth2/get-clients | List OAuth2 clients | | updateOauth2Client | POST | /auth/oauth2/update-client | Update OAuth2 client | | rotateOauth2ClientSecret | POST | /auth/oauth2/client/rotate-secret | Rotate OAuth2 client secret | | deleteOauth2Client | POST | /auth/oauth2/delete-client | Delete OAuth2 client | | adminCreateOauth2Client | POST | /auth/admin/oauth2/create-client | Admin create OAuth2 client | | adminUpdateOauth2Client | PATCH | /auth/admin/oauth2/update-client | Admin update OAuth2 client |

SessionsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | get | GET | /sessions/current | Get current active session | | listUser | GET | /sessions/ | List all user sessions | | revoke | DELETE | /sessions/${sessionToken} | Revoke a specific session | | revokeOther | DELETE | /sessions/others | Revoke all other sessions | | activate | POST | /sessions/${sessionToken}/activate | Activate a session |

AdminUsersAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | list | GET | /admin/admin/users | List all users | | createAccount | POST | /admin/admin/users | Create a new user account | | updateRole | PATCH | /admin/admin/users/${userId}/role | Update user role | | banAccount | POST | /admin/admin/users/${userId}/ban | Ban a user account | | removeBan | DELETE | /admin/admin/users/${userId}/ban | Remove user ban | | listSessions | GET | /admin/admin/users/${userId}/sessions | List user sessions | | revokeSessions | DELETE | /admin/admin/users/${userId}/sessions | Revoke all user sessions | | impersonate | POST | /admin/admin/users/${userId}/impersonate | Impersonate a user | | stopImpersonating | POST | /admin/admin/users/impersonate/stop | Stop impersonating | | deleteAccount | DELETE | /admin/admin/users/${userId} | Delete a user account |

TeamsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | listOrganization | GET | /teams/ | List teams for the active organization | | createOrganization | POST | /teams/ | Create a new team within the active organization | | updateMetadata | PATCH | /teams/${teamId} | Update a team's metadata | | deleteOrganization | DELETE | /teams/${teamId} | Delete a team from the active organization | | setSession | POST | /teams/active | Set the active team for the current session | | listMembers | GET | /teams/${teamId}/members | List team members | | addMember | POST | /teams/${teamId}/members | Add a member to a team | | removeMember | DELETE | /teams/${teamId}/members/${userId} | Remove a member from a team |

OrganizationsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | listAuthenticatedUser | GET | /orgs/ | List organizations for the authenticated user | | create | POST | /orgs/ | Create a new organization | | getActive | GET | /orgs/active | Get the currently active organization | | setSession | POST | /orgs/active | Set the active organization for the current session | | getOrgId | GET | /orgs/${orgId} | Get organization by ID | | update | PATCH | /orgs/${orgId} | Update organization | | delete | DELETE | /orgs/${orgId} | Delete organization | | listInvitations | GET | /orgs/invitations | List invitations for the active organization | | listPendingInvitationsUser | GET | /orgs/invitations/pending | List pending invitations for a user | | cancelPendingInvitation | DELETE | /orgs/invitations/${invitationId} | Cancel a pending invitation | | rejectInvitation | POST | /orgs/invitations/${invitationId}/reject | Reject an invitation | | inviteMember | POST | /orgs/invite | Invite a member | | listMembers | GET | /orgs/members | List organization members | | removeMember | DELETE | /orgs/members/${memberId} | Remove organization member | | leave | POST | /orgs/leave | Leave organization | | getMemberRole | GET | /orgs/members/role | Get active member role | | updateMemberRole | POST | /orgs/members/role | Update member role |

SettingsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | getCombinedOrgUser | GET | /orgs/${orgId}/settings/all | Get combined org and user settings for the current user context | | listOrgMergedSystem | GET | /orgs/${orgId}/settings | List org settings merged with system defaults | | partiallyUpdateOrgPartial | PATCH | /orgs/${orgId}/settings | Partially update org settings with partial success | | listRegistryOrganizationPlan | GET | /orgs/${orgId}/settings/registry | List settings registry for current organization plan | | getSingleOrg | GET | /orgs/${orgId}/settings/${key} | Get a single org setting | | resetOrgSystemDefault | DELETE | /orgs/${orgId}/settings/${key} | Reset an org setting to system default | | listUserMergedSystem | GET | /users/me/settings | List user settings merged with system defaults | | partiallyUpdateUserPartial | PATCH | /users/me/settings | Partially update user settings with partial success | | getSingleUser | GET | /users/me/settings/${key} | Get a single user setting | | resetUserSystemDefault | DELETE | /users/me/settings/${key} | Reset a user setting to system default |

AppsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | list | GET | /apps/ | List all applications | | create | POST | /apps/ | Create a new application | | getDetails | GET | /apps/${appId} | Get application details | | updateMetadata | PATCH | /apps/${appId} | Update application metadata | | delete | DELETE | /apps/${appId} | Delete an application | | generatePresignedUploadUrl | POST | /apps/${appId}/artifacts/presign | Generate a presigned upload URL for an artifact | | markArtifactUploadComplete | POST | /apps/${appId}/artifacts/${artifactId}/complete | Mark an artifact upload as complete | | getPricingInformation | GET | /apps/${appId}/pricing | Retrieve pricing information for an application |

ReleasesAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | listApplication | GET | /apps/${appId}/releases | List releases for an application | | createApplication | POST | /apps/${appId}/releases | Create a release for an application | | getDetails | GET | /apps/${appId}/releases/${releaseId} | Retrieve release details | | updateMetadata | PATCH | /apps/${appId}/releases/${releaseId} | Update release metadata | | submitReview | POST | /apps/${appId}/releases/${releaseId}/submit | Submit a release for review | | schedulePublication | POST | /apps/${appId}/releases/${releaseId}/schedule | Schedule a release for publication | | rollback | POST | /apps/${appId}/releases/${releaseId}/rollback | Rollback a release | | assignPipeline | POST | /apps/${appId}/releases/${releaseId}/assign-pipeline | Assign a release pipeline to a release | | getStageStateGate | GET | /apps/${appId}/releases/${releaseId}/stage | Get release stage state and gate status | | transitionNextPipelineStage | POST | /apps/${appId}/releases/${releaseId}/stage/transition | Transition release to the next pipeline stage |

ReleasePipelinesAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | list | GET | /apps/${appId}/release-pipelines | List release pipelines | | create | POST | /apps/${appId}/release-pipelines | Create release pipeline | | get | GET | /apps/${appId}/release-pipelines/${pipelineId} | Get release pipeline | | update | PATCH | /apps/${appId}/release-pipelines/${pipelineId} | Update release pipeline | | softDelete | DELETE | /apps/${appId}/release-pipelines/${pipelineId} | Soft delete release pipeline | | listVersions | GET | /apps/${appId}/release-pipelines/${pipelineId}/versions | List release pipeline versions | | setDefault | POST | /apps/${appId}/release-pipelines/${pipelineId}/set-default | Set default release pipeline | | dryRunValidate | POST | /apps/${appId}/release-pipelines/${pipelineId}/validate | Dry-run validate release pipeline |

ArtifactsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | prepareUpload | POST | /apps/${appId}/artifacts/prepare | Prepare artifact upload | | finalizeUpload | POST | /apps/${appId}/artifacts/finalize | Finalize artifact upload | | verify | POST | /apps/${appId}/artifacts/${artifactId}/verify | Verify artifact | | getBatchUploadStatus | GET | /artifacts/status | Get batch upload status | | getUploadStatus | GET | /artifacts/${artifactId}/status | Get upload status | | get | GET | /artifacts/${artifactId} | Get artifact by ID | | download | GET | /artifacts/${artifactId}/download | Download artifact | | cancelUpload | POST | /artifacts/${artifactId}/cancel | Cancel artifact upload | | archive | POST | /artifacts/${artifactId}/archive | Archive artifact | | compareTwoApk | GET | /artifacts/compare | Compare two APK artifacts | | triggerSync | POST | /artifacts/sync | Trigger artifact sync | | list | GET | /artifacts/ | List artifacts |

AnalyticsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | getOverview | GET | /analytics/overview | Get analytics overview | | getMetricDetail | GET | /analytics/metrics/${metricKey} | Get metric detail | | getMetricRegistry | GET | /analytics/registry | Get metric registry | | triggerJob | POST | /analytics/trigger | Trigger analytics job |

BillingAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | getOverview | GET | /billing/overview | Get billing overview | | getEntitlementsSummary | GET | /billing/entitlements | Get entitlements summary | | cancelSubscription | POST | /billing/subscriptions/cancel | Cancel subscription | | getPortalUrl | GET | /billing/portal | Get billing portal URL | | updateEmail | PATCH | /billing/email | Update billing email | | createCheckoutSession | POST | /billing/checkout | Create checkout session | | listOrders | GET | /billing/orders | List orders | | getOrderDetails | GET | /billing/orders/${orderId} | Get order details |

ShareLinksAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | list | GET | /share-links/ | List share links | | create | POST | /share-links/ | Create share link | | get | GET | /share-links/${shareLinkId} | Get share link | | update | PATCH | /share-links/${shareLinkId} | Update share link | | delete | DELETE | /share-links/${shareLinkId} | Delete share link | | revoke | POST | /share-links/${shareLinkId}/revoke | Revoke share link | | restore | POST | /share-links/${shareLinkId}/restore | Restore share link | | getAnalytics | GET | /share-links/${shareLinkId}/analytics | Get share link analytics | | getDownloadHistory | GET | /share-links/${shareLinkId}/downloads | Get download history | | bulkRevoke | POST | /share-links/bulk/revoke | Bulk revoke share links | | bulkExtendExpiration | POST | /share-links/bulk/extend | Bulk extend expiration | | exportDataEmail | POST | /share-links/gdpr/export | Export data by email (GDPR) | | deleteDataEmail | POST | /share-links/gdpr/delete | Delete data by email (GDPR) | | rectifyEmail | PATCH | /share-links/gdpr/rectify | Rectify email (GDPR) | | getInfo | GET | /s/${shortCode} | Get share link info | | getPublicMetadata | GET | /s/${shortCode}/metadata | Get public metadata | | validateAccess | POST | /s/${shortCode}/validate | Validate access | | requestOtp | POST | /s/${shortCode}/request-otp | Request OTP | | verifyOtp | POST | /s/${shortCode}/verify-otp | Verify OTP | | downloadArtifact | POST | /s/${shortCode}/download | Download artifact |

PoliciesAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | evaluateArtifactAgainstRules | POST | /policies/evaluate | Evaluate artifact against policy rules | | simulateEvaluation | POST | /policies/simulate | Simulate policy evaluation | | listRules | GET | /policies/rules | List policy rules | | createRule | POST | /policies/rules | Create policy rule | | updateRule | PATCH | /policies/rules/${ruleId} | Update policy rule | | activateRule | POST | /policies/rules/${ruleId}/activate | Activate policy rule | | deactivateRule | POST | /policies/rules/${ruleId}/deactivate | Deactivate policy rule | | getRuleHistory | GET | /policies/rules/${ruleId}/history | Get policy rule history | | exportRules | GET | /policies/rules/export | Export policy rules | | importRules | POST | /policies/rules/import | Import policy rules | | listEvaluationAudits | GET | /policies/audits | List policy evaluation audits | | getEvaluationAudit | GET | /policies/audits/${auditId} | Get policy evaluation audit | | listStores | GET | /policies/stores | List policy stores | | getStore | GET | /policies/stores/${code} | Get policy store | | listPlatforms | GET | /policies/platforms | List policy platforms | | getPlatform | GET | /policies/platforms/${code} | Get policy platform |

ApprovalsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | list | GET | /approvals/ | List approvals by resource | | createRequest | POST | /approvals/ | Create an approval request | | listRequestsAcrossOrganization | GET | /approvals/requests | List approval requests across organization | | listApproversResource | GET | /approvals/approvers | List approvers for a resource | | grantUserRightsResource | POST | /approvals/approvers | Grant a user approval rights for a resource | | listGrants | GET | /approvals/grants | List approval grants | | revokeGrant | POST | /approvals/grants/${id}/revoke | Revoke an approval grant | | extendGrant | POST | /approvals/grants/${id}/extend | Extend an approval grant | | listPolicyTemplates | GET | /approvals/templates | List approval policy templates | | createPolicyTemplate | POST | /approvals/templates | Create approval policy template | | updatePolicyTemplate | PATCH | /approvals/templates/${id} | Update approval policy template | | archivePolicyTemplate | POST | /approvals/templates/${id}/archive | Archive approval policy template | | listTemplateDefaults | GET | /approvals/template-defaults | List approval template defaults | | upsertTemplateDefault | PUT | /approvals/template-defaults/${actionType}/${riskLevel} | Upsert approval template default | | getRequest | GET | /approvals/${id} | Get an approval request | | recordDecision | POST | /approvals/${id}/decisions | Record an approval decision (approve or reject) | | cancelPendingRequest | POST | /approvals/${id}/cancel | Cancel a pending approval request | | archiveRequest | POST | /approvals/${id}/archive | Archive an approval request | | refreshExpiredDriftedRequest | POST | /approvals/${id}/refresh | Refresh an expired or drifted approval request |

WaitlistAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | signUpProduct | POST | /waitlist/ | Sign up for a product waitlist | | getCountProduct | GET | /waitlist/${productId}/count | Get waitlist count for a product |

AuditLogsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | getActivitySummary | GET | /audit-logs/summary | Get activity summary | | getSecurityInsights | GET | /audit-logs/security | Get security insights | | getUserActivityTimeline | GET | /audit-logs/users/${userId}/timeline | Get user activity timeline | | getResourceChangeHistory | GET | /audit-logs/resources/${resourceType}/${resourceId}/history | Get resource change history | | list | GET | /audit-logs/ | List audit logs | | get | GET | /audit-logs/${id} | Get audit log by ID | | export | POST | /audit-logs/export | Export audit logs |

IntegrationsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | listAvailable | GET | /integrations/available | List available integrations | | listInstalled | GET | /integrations/installed | List installed integrations | | install | POST | /integrations/install | Install an integration | | uninstall | DELETE | /integrations/${integrationKey} | Uninstall an integration | | initiateOauthAuthorisation | POST | /integrations/oauth/init | Initiate OAuth authorisation | | completeOauthAuthorisation | POST | /integrations/oauth/callback | Complete OAuth authorisation | | listConnectionsProvider | GET | /integrations/connections/${provider} | List connections for a provider | | revokeConnection | DELETE | /integrations/connections/${connectionId} | Revoke a connection | | refreshConnectionTokens | POST | /integrations/connections/${connectionId}/refresh | Refresh connection tokens | | submitCredentials | POST | /integrations/credentials/submit | Submit integration credentials | | listAppConfigs | GET | /integrations/apps/${appId}/configs | List app integration configs | | createAppConfig | POST | /integrations/apps/${appId}/configs | Create app integration config | | updateAppConfig | PATCH | /integrations/apps/${appId}/configs/${configId} | Update app integration config | | deleteAppConfig | DELETE | /integrations/apps/${appId}/configs/${configId} | Delete app integration config |

IntegrationsAdminAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | listEntitlementOverridesOrganisation | GET | /integrations/entitlements/${orgId} | List entitlement overrides for an organisation | | createEntitlementOverride | POST | /integrations/entitlements | Create entitlement override | | deleteEntitlementOverride | DELETE | /integrations/entitlements/${overrideId} | Delete entitlement override |

WebhooksAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | receiveExternalProvider | POST | /webhooks/inbound/${provider}/${endpointId} | Receive webhook from external provider | | webhookHealthCheck | GET | /webhooks/inbound/health | Webhook health check | | listEndpoints | GET | /webhooks/endpoints | List webhook endpoints | | createEndpoint | POST | /webhooks/endpoints | Create webhook endpoint | | getEndpoint | GET | /webhooks/endpoints/${id} | Get webhook endpoint | | updateEndpointStatus | PATCH | /webhooks/endpoints/${id} | Update webhook endpoint status | | deleteEndpoint | DELETE | /webhooks/endpoints/${id} | Delete webhook endpoint | | getPayloadHistoryEndpoint | GET | /webhooks/endpoints/${id}/payloads | Get payload history for endpoint | | listSubscriptions | GET | /webhooks/subscriptions | List webhook subscriptions | | createSubscription | POST | /webhooks/subscriptions | Create webhook subscription | | getSubscription | GET | /webhooks/subscriptions/${id} | Get webhook subscription | | updateSubscription | PATCH | /webhooks/subscriptions/${id} | Update webhook subscription | | deleteSubscription | DELETE | /webhooks/subscriptions/${id} | Delete webhook subscription | | sendTest | POST | /webhooks/subscriptions/${id}/test | Send test webhook | | getDeliveryHistorySubscription | GET | /webhooks/subscriptions/${id}/deliveries | Get delivery history for subscription | | replayDelivery | POST | /webhooks/deliveries/${id}/replay | Replay a webhook delivery |

WorkflowsAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | list | GET | /workflows/ | List workflows | | create | POST | /workflows/ | Create workflow | | get | GET | /workflows/${id} | Get workflow | | update | PUT | /workflows/${id} | Update workflow | | delete | DELETE | /workflows/${id} | Delete workflow | | createNode | POST | /workflows/${id}/nodes | Create workflow node | | updateNode | PUT | /workflows/nodes/${id} | Update workflow node | | deleteNode | DELETE | /workflows/nodes/${id} | Delete workflow node | | createEdge | POST | /workflows/${id}/edges | Create workflow edge | | deleteEdge | DELETE | /workflows/edges/${id} | Delete workflow edge | | listExecutions | GET | /workflows/${id}/executions | List workflow executions | | getExecutionDetails | GET | /workflows/executions/${id} | Get execution details | | execute | POST | /workflows/${id}/execute | Execute workflow | | listNodeTypes | GET | /workflows/node-types | List node types |

HealthAPI

| Method | HTTP | Path | Description | |--------|------|------|-------------| | readinessProbeCoreServices | GET | /health | Readiness probe for core services | | integrationSystemCheck | GET | /health/integration | Integration system health check | | webhookDeliveryCheck | GET | /health/webhooks | Webhook delivery health check | | billingServiceCheck | GET | /health/billing | Billing service health check | | getAnalyticsStatus | GET | /health/analytics | Get analytics health status |

Types

• AuthOauthAuthorizationServerMetadataResponse
• AuthOpenidConnectDiscoveryMetadataResponse
• OAuthOauth2AuthorizeEndpointResponse
• OAuthOauth2ConsentEndpointInput
• OAuthOauth2ConsentEndpointResponse
• OAuthOauth2ContinueEndpointInput
• OAuthOauth2ContinueEndpointResponse
• OAuthOauth2TokenEndpointInput
• OAuthOauth2TokenEndpointResponse
• OAuthOauth2TokenIntrospectionEndpointInput
• OAuthOauth2TokenIntrospectionEndpointResponse
• OAuthOauth2TokenRevocationEndpointInput
• OAuthOpenidConnectUserinfoEndpointResponse
• OAuthOpenidRpInitiatedLogoutEndpointResponse
• OAuthCreateOauth2ClientInput
• OAuthCreateOauth2ClientResponse
• OAuthGetOauth2ClientResponse
• OAuthGetOauth2PublicClientResponse
• OAuthUpdateOauth2ClientInput
• OAuthUpdateOauth2ClientResponse
• OAuthRotateOauth2ClientSecretInput
• OAuthRotateOauth2ClientSecretResponse
• OAuthDeleteOauth2ClientInput
• OAuthAdminCreateOauth2ClientInput
• OAuthAdminCreateOauth2ClientResponse
• OAuthAdminUpdateOauth2ClientInput
• OAuthAdminUpdateOauth2ClientResponse
• AuthRegisterUserInput
• AuthRegisterUserResponse
• AuthAuthenticateUserInput
• AuthAuthenticateUserResponse
• AuthLogOutUserResponse
• AuthResendEmailVerificationInput
• AuthResendEmailVerificationResponse
• AuthVerifyEmailAddressInput
• AuthVerifyEmailAddressResponse
• AuthRequestPasswordResetInput
• AuthRequestPasswordResetResponse
• AuthConfirmPasswordResetInput
• AuthConfirmPasswordResetResponse
• AuthSignSocialProviderInput
• AuthSignSocialProviderResponse
• AuthGetUserResponse
• AuthGetOnboardingStatusResponse
• SessionsGetResponse
• SessionsListUserResponse
• SessionsRevokeResponse
• SessionsRevokeOtherResponse
• SessionsActivateResponse
• AdminUsersListItem
• AdminUsersCreateAccountInput
• AdminUsersCreateAccountResponse
• AdminUsersUpdateRoleInput
• AdminUsersUpdateRoleResponse
• AdminUsersBanAccountInput
• AdminUsersBanAccountResponse
• AdminUsersRemoveBanResponse
• AdminUsersListSessionsResponse
• AdminUsersRevokeSessionsResponse
• AdminUsersImpersonateResponse
• AdminUsersStopImpersonatingResponse
• AdminUsersDeleteAccountResponse
• TeamsListOrganizationItem
• TeamsCreateOrganizationInput
• TeamsCreateOrganizationResponse
• TeamsUpdateMetadataInput
• TeamsUpdateMetadataResponse
• TeamsSetSessionInput
• TeamsSetSessionResponse
• TeamsListMembersItem
• TeamsAddMemberInput
• TeamsAddMemberItem
• OrganizationsListAuthenticatedUserItem
• OrganizationsCreateInput
• OrganizationsCreateResponse
• OrganizationsGetResponse
• OrganizationsSetSessionInput
• OrganizationsSetSessionResponse
• OrganizationsGetResponse
• OrganizationsUpdateInput
• OrganizationsUpdateResponse
• OrganizationsListInvitationsItem
• OrganizationsListPendingInvitationsUserItem
• OrganizationsInviteMemberInput
• OrganizationsInviteMemberResponse
• OrganizationsListMembersItem
• OrganizationsGetMemberRoleResponse
• OrganizationsUpdateMemberRoleInput
• SettingsGetCombinedOrgUserResponse
• SettingsListOrgMergedSystemResponse
• SettingsPartiallyUpdateOrgPartialInput
• SettingsPartiallyUpdateOrgPartialResponse
• SettingsListRegistryOrganizationPlanResponse
• SettingsGetSingleOrgResponse
• SettingsResetOrgSystemDefaultResponse
• AppsListItem
• AppsCreateInput
• AppsCreateResponse
• AppsGetDetailsResponse
• AppsUpdateMetadataInput
• AppsUpdateMetadataResponse
• AppsGeneratePresignedUploadUrlInput
• AppsGeneratePresignedUploadUrlResponse
• AppsMarkArtifactUploadCompleteInput
• AppsMarkArtifactUploadCompleteResponse
• AppsGetPricingInformationResponse
• ReleasesListApplicationItem
• ReleasesCreateApplicationInput
• ReleasesCreateApplicationResponse
• ReleasesGetDetailsResponse
• ReleasesUpdateMetadataInput
• ReleasesUpdateMetadataResponse
• ReleasesSubmitReviewResponse
• ReleasesSchedulePublicationInput
• ReleasesSchedulePublicationResponse
• ReleasesRollbackResponse
• ReleasesAssignPipelineInput
• ReleasesAssignPipelineResponse
• ReleasesGetStageStateGateResponse
• ReleasesTransitionNextPipelineStageInput
• ReleasesTransitionNextPipelineStageResponse
• ReleasePipelinesListResponse
• ReleasePipelinesCreateInput
• ReleasePipelinesCreateResponse
• ReleasePipelinesGetResponse
• ReleasePipelinesUpdateInput
• ReleasePipelinesUpdateResponse
• ReleasePipelinesListVersionsResponse
• ReleasePipelinesSetDefaultResponse
• ReleasePipelinesDryRunValidateInput
• ReleasePipelinesDryRunValidateResponse
• ArtifactsPrepareUploadInput
• ArtifactsPrepareUploadResponse
• ArtifactsFinalizeUploadInput
• ArtifactsFinalizeUploadResponse
• ArtifactsVerifyResponse
• ArtifactsGetBatchUploadStatusResponse
• ArtifactsGetUploadStatusResponse
• ArtifactsGetResponse
• ArtifactsCancelUploadResponse
• ArtifactsArchiveResponse
• ArtifactsCompareTwoApkResponse
• ArtifactsTriggerSyncResponse
• ArtifactsListItem
• AnalyticsGetOverviewResponse
• AnalyticsGetMetricDetailResponse
• AnalyticsGetMetricRegistryResponse
• AnalyticsTriggerJobInput
• AnalyticsTriggerJobResponse
• BillingGetOverviewResponse
• BillingGetEntitlementsSummaryResponse
• BillingCancelSubscriptionInput
• BillingCancelSubscriptionResponse
• BillingGetPortalUrlResponse
• BillingUpdateEmailInput
• BillingUpdateEmailResponse
• BillingCreateCheckoutSessionInput
• BillingCreateCheckoutSessionResponse
• BillingListOrdersItem
• BillingGetOrderDetailsResponse
• ShareLinksListItem
• ShareLinksCreateInput
• ShareLinksCreateResponse
• ShareLinksGetResponse
• ShareLinksUpdateInput
• ShareLinksUpdateResponse
• ShareLinksRevokeResponse
• ShareLinksRestoreResponse
• ShareLinksGetAnalyticsResponse
• ShareLinksGetDownloadHistoryItem
• ShareLinksBulkRevokeInput
• ShareLinksBulkRevokeResponse
• ShareLinksBulkExtendExpirationInput
• ShareLinksBulkExtendExpirationResponse
• ShareLinksExportDataEmailInput
• ShareLinksExportDataEmailResponse
• ShareLinksDeleteDataEmailInput
• ShareLinksDeleteDataEmailResponse
• ShareLinksRectifyEmailInput
• ShareLinksRectifyEmailResponse
• ShareLinksGetInfoResponse
• ShareLinksGetPublicMetadataResponse
• ShareLinksValidateAccessInput
• ShareLinksValidateAccessResponse
• ShareLinksRequestOtpInput
• ShareLinksRequestOtpResponse
• ShareLinksVerifyOtpInput
• ShareLinksVerifyOtpResponse
• ShareLinksDownloadArtifactInput
• ShareLinksDownloadArtifactResponse
• PoliciesEvaluateArtifactAgainstRulesInput
• PoliciesEvaluateArtifactAgainstRulesResponse
• PoliciesSimulateEvaluationInput
• PoliciesSimulateEvaluationResponse
• PoliciesListRulesResponse
• PoliciesCreateRuleInput
• PoliciesCreateRuleResponse
• PoliciesUpdateRuleInput
• PoliciesUpdateRuleResponse
• PoliciesActivateRuleResponse
• PoliciesDeactivateRuleResponse
• PoliciesGetRuleHistoryResponse
• PoliciesExportRulesResponse
• PoliciesImportRulesInput
• PoliciesImportRulesResponse
• PoliciesListEvaluationAuditsResponse
• PoliciesGetEvaluationAuditResponse
• PoliciesListStoresResponse
• PoliciesGetStoreResponse
• PoliciesListPlatformsResponse
• PoliciesGetPlatformResponse
• ApprovalsListItem
• ApprovalsCreateRequestInput
• ApprovalsCreateRequestResponse
• ApprovalsListRequestsAcrossOrganizationItem
• ApprovalsListApproversResourceResponse
• ApprovalsGrantUserRightsResourceInput
• ApprovalsGrantUserRightsResourceResponse
• ApprovalsListGrantsItem
• ApprovalsRevokeGrantInput
• ApprovalsRevokeGrantResponse
• ApprovalsExtendGrantInput
• ApprovalsExtendGrantResponse
• ApprovalsListPolicyTemplatesItem
• ApprovalsCreatePolicyTemplateInput
• ApprovalsCreatePolicyTemplateResponse
• ApprovalsUpdatePolicyTemplateInput
• ApprovalsUpdatePolicyTemplateResponse
• ApprovalsArchivePolicyTemplateInput
• ApprovalsArchivePolicyTemplateResponse
• ApprovalsListTemplateDefaultsItem
• ApprovalsUpsertTemplateDefaultInput
• ApprovalsUpsertTemplateDefaultResponse
• ApprovalsGetRequestResponse
• ApprovalsRecordDecisionInput
• ApprovalsRecordDecisionResponse
• ApprovalsCancelPendingRequestInput
• ApprovalsCancelPendingRequestResponse
• ApprovalsArchiveRequestResponse
• ApprovalsRefreshExpiredDriftedRequestInput
• ApprovalsRefreshExpiredDriftedRequestResponse
• WaitlistSignUpProductInput
• WaitlistSignUpProductResponse
• WaitlistGetCountProductResponse
• AuditLogsGetActivitySummaryResponse
• AuditLogsGetSecurityInsightsResponse
• AuditLogsGetUserActivityTimelineResponse
• AuditLogsGetResourceChangeHistoryResponse
• AuditLogsListResponse
• AuditLogsGetResponse
• AuditLogsExportInput
• AuditLogsExportResponse
• IntegrationsListAvailableResponse
• IntegrationsListInstalledResponse
• IntegrationsInstallInput
• IntegrationsInstallResponse
• IntegrationsUninstallResponse
• IntegrationsInitiateOauthAuthorisationInput
• IntegrationsInitiateOauthAuthorisationResponse
• IntegrationsCompleteOauthAuthorisationInput
• IntegrationsCompleteOauthAuthorisationResponse
• IntegrationsListConnectionsProviderResponse
• IntegrationsRevokeConnectionResponse
• IntegrationsRefreshConnectionTokensResponse
• IntegrationsSubmitCredentialsInput
• IntegrationsSubmitCredentialsResponse
• IntegrationsListAppConfigsResponse
• IntegrationsCreateAppConfigInput
• IntegrationsCreateAppConfigResponse
• IntegrationsUpdateAppConfigInput
• IntegrationsUpdateAppConfigResponse
• IntegrationsDeleteAppConfigResponse
• IntegrationsAdminListEntitlementOverridesOrganisationResponse
• IntegrationsAdminCreateEntitlementOverrideInput
• IntegrationsAdminCreateEntitlementOverrideResponse
• IntegrationsAdminDeleteEntitlementOverrideResponse
• WebhooksReceiveExternalProviderResponse
• WebhooksWebhookHealthCheckResponse
• WebhooksListEndpointsItem
• WebhooksCreateEndpointInput
• WebhooksCreateEndpointResponse
• WebhooksGetEndpointResponse
• WebhooksUpdateEndpointStatusInput
• WebhooksUpdateEndpointStatusResponse
• WebhooksGetPayloadHistoryEndpointItem
• WebhooksListSubscriptionsItem
• WebhooksCreateSubscriptionInput
• WebhooksCreateSubscriptionResponse
• WebhooksGetSubscriptionResponse
• WebhooksUpdateSubscriptionInput
• WebhooksUpdateSubscriptionResponse
• WebhooksSendTestResponse
• WebhooksGetDeliveryHistorySubscriptionItem
• WebhooksReplayDeliveryResponse
• WorkflowsListItem
• WorkflowsCreateInput
• WorkflowsCreateResponse
• WorkflowsGetResponse
• WorkflowsUpdateInput
• WorkflowsUpdateResponse
• WorkflowsCreateNodeInput
• WorkflowsCreateNodeResponse
• WorkflowsUpdateNodeInput
• WorkflowsUpdateNodeResponse
• WorkflowsCreateEdgeInput
• WorkflowsCreateEdgeResponse
• WorkflowsListExecutionsItem
• WorkflowsGetExecutionDetailsResponse
• WorkflowsExecuteInput
• WorkflowsExecuteResponse
• WorkflowsListNodeTypesItem
• HealthReadinessProbeCoreServicesResponse
• HealthIntegrationSystemCheckResponse
• HealthWebhookDeliveryCheckResponse
• HealthBillingServiceCheckResponse
• HealthGetAnalyticsStatusResponse
• SettingsListUserMergedSystemResponse
• SettingsPartiallyUpdateUserPartialInput
• SettingsPartiallyUpdateUserPartialResponse
• SettingsGetSingleUserResponse
• SettingsResetUserSystemDefaultResponse
• GetAuthOauth2AuthorizeQuery — Query parameters for oauth2AuthorizeEndpoint
• GetAuthOauth2EndSessionQuery — Query parameters for openidRpInitiatedLogoutEndpoint
• GetAuthOauth2GetClientQuery — Query parameters for getOauth2Client
• GetAuthOauth2PublicClientQuery — Query parameters for getOauth2PublicClient
• GetAdminAdminUsersQuery — Query parameters for list
• GetOrgsInvitationsPendingQuery — Query parameters for listPendingInvitationsUser
• GetOrgsMembersRoleQuery — Query parameters for getMemberRole
• GetOrgsByOrgIdSettingsQuery — Query parameters for listOrgMergedSystem
• GetUsersMeSettingsQuery — Query parameters for listUserMergedSystem
• GetAppsQuery — Query parameters for list
• GetAppsByAppIdPricingQuery — Query parameters for getPricingInformation
• GetAppsByAppIdReleasesQuery — Query parameters for listApplication
• GetArtifactsStatusQuery — Query parameters for getBatchUploadStatus
• GetArtifactsCompareQuery — Query parameters for compareTwoApk
• PostArtifactsSyncQuery — Query parameters for triggerSync
• GetArtifactsQuery — Query parameters for list
• GetAnalyticsOverviewQuery — Query parameters for getOverview
• GetAnalyticsMetricsByMetricKeyQuery — Query parameters for getMetricDetail
• GetAnalyticsRegistryQuery — Query parameters for getMetricRegistry
• GetBillingPortalQuery — Query parameters for getPortalUrl
• GetBillingOrdersQuery — Query parameters for listOrders
• GetShareLinksQuery — Query parameters for list
• GetShareLinksByShareLinkIdDownloadsQuery — Query parameters for getDownloadHistory
• GetPoliciesRulesQuery — Query parameters for listRules
• GetPoliciesRulesExportQuery — Query parameters for exportRules
• GetPoliciesAuditsQuery — Query parameters for listEvaluationAudits
• GetApprovalsQuery — Query parameters for list
• GetApprovalsRequestsQuery — Query parameters for listRequestsAcrossOrganization
• GetApprovalsApproversQuery — Query parameters for listApproversResource
• GetApprovalsGrantsQuery — Query parameters for listGrants
• GetApprovalsTemplatesQuery — Query parameters for listPolicyTemplates
• GetApprovalsTemplateDefaultsQuery — Query parameters for listTemplateDefaults
• GetAuditLogsSummaryQuery — Query parameters for getActivitySummary
• GetAuditLogsSecurityQuery — Query parameters for getSecurityInsights
• GetAuditLogsUsersByUserIdTimelineQuery — Query parameters for getUserActivityTimeline
• GetAuditLogsResourcesByResourceTypeByResourceIdHistoryQuery — Query parameters for getResourceChangeHistory
• GetAuditLogsQuery — Query parameters for list
• GetIntegrationsAvailableQuery — Query parameters for listAvailable
• GetWebhooksEndpointsQuery — Query parameters for listEndpoints
• GetWebhooksEndpointsByIdPayloadsQuery — Query parameters for getPayloadHistoryEndpoint
• GetWebhooksSubscriptionsQuery — Query parameters for listSubscriptions
• GetWebhooksSubscriptionsByIdDeliveriesQuery — Query parameters for getDeliveryHistorySubscription
• GetWorkflowsQuery — Query parameters for list
• GetWorkflowsByIdExecutionsQuery — Query parameters for listExecutions
• GetWorkflowsNodeTypesQuery — Query parameters for listNodeTypes

Error Handling

import { SDKError } from 'apollo-deploy-api-sdk';

try {
  const result = await client.someApi.someMethod();
} catch (error) {
  if (error instanceof SDKError) {
    console.error(`Error ${error.status}: ${error.message} (${error.code})`);
  }
}