### Install Dependencies

Source: https://github.com/alienplatform/alien/blob/main/examples/full-stack-microservices/README.md

Install project dependencies from the examples workspace. Navigate to the alien/examples directory before running.

```bash
cd alien/examples
pnpm install
```

--------------------------------

### Install and Initialize Alien Project

Source: https://github.com/alienplatform/alien/blob/main/examples/README.md

Installs the Alien CLI, sets up the PATH, and initializes a new project from a template. Then, it starts the local development server.

```bash
# Install Alien
curl -fsSL https://alien.dev/install | sh
export PATH="$HOME/.local/bin:$PATH"

# Create a project from a template
alien init my-app

# Start local development
cd my-app
alien dev
```

--------------------------------

### DeploymentSetupPolicy Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetuppolicy.md

Demonstrates how to instantiate a DeploymentSetupPolicy object with allowed platforms and setup methods.

```typescript
import { DeploymentSetupPolicy } from "@alienplatform/platform-api/models";

let value: DeploymentSetupPolicy = {
  allowedPlatforms: [
    "test",
  ],
  allowedSetupMethods: [
    "cloudformation",
  ],
};
```

--------------------------------

### Install Dependencies and Run in Dev Mode

Source: https://github.com/alienplatform/alien/blob/main/examples/byoc-database/README.md

Install project dependencies and start the application in development mode. The stack will be available at http://localhost:8080.

```bash
npm install

alien dev
```

--------------------------------

### PreparedDeploymentStack Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/prepareddeploymentstack.md

Demonstrates how to instantiate and define a PreparedDeploymentStack object with platform, stack, and setup details.

```typescript
import { PreparedDeploymentStack } from "@alienplatform/platform-api/models";

let value: PreparedDeploymentStack = {
  platform: "aws",
  stack: {
    id: "<id>",
    resources: {},
  },
  setup: {
    target: "<value>",
    fingerprint: "<value>",
    version: 547972,
  },
};
```

--------------------------------

### SetupFingerprintInfo Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/setupfingerprintinfo.md

Demonstrates how to import and instantiate the SetupFingerprintInfo model in TypeScript. Ensure you have the correct package installed.

```typescript
import { SetupFingerprintInfo } from "@alienplatform/platform-api/models";

let value: SetupFingerprintInfo = {
  target: "<value>",
  fingerprint: "<value>",
  version: 572115,
};
```

--------------------------------

### Create Setup Registration Operation Request Network Create

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createsetupregistrationoperationrequestnetworkcreate.md

Example of how to import and initialize the CreateSetupRegistrationOperationRequestNetworkCreate model.

```typescript
import { CreateSetupRegistrationOperationRequestNetworkCreate } from "@alienplatform/platform-api/models";

let value: CreateSetupRegistrationOperationRequestNetworkCreate = {
  type: "create",
};
```

--------------------------------

### Setup Model Initialization

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/setup.md

Demonstrates how to initialize the Setup model with a project ID. This is a basic setup configuration.

```typescript
import { Setup } from "@alienplatform/platform-api/models/operations";

let value: Setup = {
  deploymentUrlProjectId: "prj_mcytp6z3j91f7tn5ryqsfwtr",
};
```

--------------------------------

### DeploymentInfo Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentinfo.md

Demonstrates how to construct a DeploymentInfo object with various properties including token type, deployment group, workspace, project, packages, install context, and supported regions. This is useful for setting up deployment configurations.

```typescript
import { DeploymentInfo } from "@alienplatform/platform-api/models";

let value: DeploymentInfo = {
  tokenType: "deployment-group",
  deploymentGroup: {
    id: "dg_r27ict8c7vcgsumpj90ackf7b",
    name: "<value>",
  },
  workspace: {
    id: "<id>",
    name: "<value>",
  },
  project: {
    name: "<value>",
    portal: {
      appearance: {},
    },
  },
  packages: {
    ready: true,
  },
  installContext: {
    targets: {
      "key": {
        platform: "gcp",
        managerUrl: "https://low-possession.com/",
      },
    },
  },
  supportedRegions: {
    aws: [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
    gcp: [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
    azure: [
      "<value 1>",
      "<value 2>",
      "<value 3>",
    ],
  },
};
```

--------------------------------

### ManagerRetryResponseSetup Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/managerretryresponsesetup.md

Demonstrates how to instantiate and populate the ManagerRetryResponseSetup model in TypeScript. This includes setting manager details, setup status, tokens, configuration, and deployment parameters.

```typescript
import { ManagerRetryResponseSetup } from "@alienplatform/platform-api/models";

let value: ManagerRetryResponseSetup = {
  managerId: "mgr_enxscjrqiiu2lrc672hwwuc5",
  setupStatus: "pending",
  setupToken: "<value>",
  setupTokenId: "<id>",
  deploymentLink: "<value>",
  setupConfig: {
    metadata: {
      "key": "<value>",
      "key1": "<value>",
      "key2": "<value>",
    },
    policy: {
      allowedPlatforms: [],
      allowedSetupMethods: [
        "google-oauth",
      ],
    },
    environmentVariables: [
      {
        name: "<value>",
        type: "secret",
        targetResources: null,
      },
    ],
  },
  setup: {
    method: "terraform",
    deploymentPortalUrl: "https://confused-majority.net/",
    managerUrl: "https://deadly-cruelty.org/",
    providerSource: "<value>",
    moduleSource: "<value>",
    moduleInputs: {},
    mainTf: "<value>",
    tfvars: "<value>",
    commands: "<value>",
    stackSettings: {},
  },
  mode: "setup",
};
```

--------------------------------

### TypeScript DeploymentDetailResponseGcpStackSettings Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentdetailresponsegcpstacksettings.md

Demonstrates how to import and instantiate the DeploymentDetailResponseGcpStackSettings model in TypeScript. Ensure the '@alienplatform/platform-api/models' package is installed.

```typescript
import { DeploymentDetailResponseGcpStackSettings } from "@alienplatform/platform-api/models";

let value: DeploymentDetailResponseGcpStackSettings = {
  certificateName: "<value>",
};
```

--------------------------------

### TypeScript SetupRegistrationOperationResponse Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/setupregistrationoperationresponse.md

Demonstrates how to define and initialize a SetupRegistrationOperationResponse object in TypeScript. This object represents the response of a setup or registration operation.

```typescript
import { SetupRegistrationOperationResponse } from "@alienplatform/platform-api/models";

let value: SetupRegistrationOperationResponse = {
  id: "setupop_y41lqnfosxuwqkzmiax7",
  action: "delete",
  sourceKind: "helm",
  status: "succeeded",
  deploymentId: "dep_0c29fq4a2yjb7kx3smwdgxlc",
  physicalResourceId: "<id>",
  result: {
    deploymentId: "dep_0c29fq4a2yjb7kx3smwdgxlc",
    deploymentToken: "<value>",
    helmValues: "<value>",
  },
  error: {
    message: "<value>",
    retryable: false,
  },
};
```

--------------------------------

### Create Setup Registration Operation Request GCP Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createsetupregistrationoperationrequestgcp.md

Demonstrates how to import and instantiate the CreateSetupRegistrationOperationRequestGcp model in TypeScript. Ensure the model is imported from '@alienplatform/platform-api/models'.

```typescript
import { CreateSetupRegistrationOperationRequestGcp } from "@alienplatform/platform-api/models";

let value: CreateSetupRegistrationOperationRequestGcp = {
  certificateName: "<value>",
};
```

--------------------------------

### CreateManagerResponseSetupGoogleOauth Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createmanagerresponsesetupunion.md

Example structure for models.CreateManagerResponseSetupGoogleOauth. Use this for Google OAuth based setups.

```typescript
const value: models.CreateManagerResponseSetupGoogleOauth = {
  method: "google-oauth",
  deploymentPortalUrl: "https://inexperienced-programme.info/",
  managerUrl: "https://powerless-publicity.info",
  oauthStartUrl: "https://bony-exterior.net",
  region: "<value>",
  stackSettings: {},
};
```

--------------------------------

### Set up the database

Source: https://github.com/alienplatform/alien/blob/main/examples/github-agent/packages/dashboard/README.md

Install dependencies, push database schema changes, and seed the database.

```bash
pnpm install
pnpm db:push
pnpm db:seed
```

--------------------------------

### Start the dashboard

Source: https://github.com/alienplatform/alien/blob/main/examples/github-agent/packages/dashboard/README.md

Run this command to start the dashboard development server.

```bash
pnpm dev
# → Dashboard at http://localhost:3001
```

--------------------------------

### Deployments - GetSetupRegistrationOperation

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/README.md

Gets the status of a setup registration operation.

```APIDOC
## Deployments - GetSetupRegistrationOperation

### Description
Get setup registration operation status.

### Method
GET

### Endpoint
/deployments/{deploymentId}/setup-registration-operations/{operationId}
```

--------------------------------

### DataLocal1 Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/syncreconcilerequestdataunion1.md

Example of the DataLocal1 model for local storage, including path information and an unhealthy status due to missing installation.

```typescript
const value: models.DataLocal1 = {
  path: "/usr/lib",
  pathExists: false,
  status: {
    collectionIssues: [
      {
        message: "<value>",
        reason: "not-installed",
        severity: "error",
        source: "<value>",
      },
    ],
    health: "unhealthy",
    lifecycle: "stopping",
    partial: false,
    stale: true,
  },
  backend: "local",
};
```

--------------------------------

### CreateManagerResponseSetupConfig Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createmanagerresponsesetupconfig.md

Demonstrates how to import and instantiate the CreateManagerResponseSetupConfig model in TypeScript. This model is used to configure manager response setup.

```typescript
import { CreateManagerResponseSetupConfig } from "@alienplatform/platform-api/models";

let value: CreateManagerResponseSetupConfig = {
  metadata: {
    "key": "<value>",
    "key1": "<value>",
  },
  policy: {
    allowedPlatforms: [],
    allowedSetupMethods: [
      "google-oauth",
    ],
  },
  environmentVariables: [],
};
```

--------------------------------

### Create Setup Registration Operation Request Source

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createsetupregistrationoperationrequestsource.md

Example of how to create an instance of CreateSetupRegistrationOperationRequestSource. Ensure all required fields are populated correctly.

```typescript
import { CreateSetupRegistrationOperationRequestSource } from "@alienplatform/platform-api/models";

let value: CreateSetupRegistrationOperationRequestSource = {
  deploymentName: "<value>",
  resourcePrefix: "<value>",
  releaseId: "rel_WbhQgksrawSKIpEN0NAssHX9",
  platform: "test",
  region: "<value>",
  setupTarget: "<value>",
  setupImportFormatVersion: 234095,
  setupFingerprint: "<value>",
  setupFingerprintVersion: 363425,
  stackSettings: {},
  resources: [
    {
      id: "<id>",
      type: "<value>",
      importData: {
        "key": "<value>",
        "key1": "<value>",
        "key2": "<value>",
      },
    },
  ],
};
```

--------------------------------

### projectsGetTemplateUrls

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/README.md

Get template URLs for deploying setup stacks in this project.

```APIDOC
## projectsGetTemplateUrls

### Description
Get template URLs for deploying setup stacks in this project.

### Method
Not specified in source

### Endpoint
Not specified in source

### Parameters
Not specified in source

### Request Example
Not specified in source

### Response
Not specified in source
```

--------------------------------

### CreateProjectFromTemplateGithubSetup Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/createprojectfromtemplategithubsetup.md

Demonstrates how to instantiate the CreateProjectFromTemplateGithubSetup model with required URLs. Ensure the pullRequestUrl points to the Alien build workflow and workflowUrl points to the GitHub Actions workflow.

```typescript
import { CreateProjectFromTemplateGithubSetup } from "@alienplatform/platform-api/models/operations";

let value: CreateProjectFromTemplateGithubSetup = {
  pullRequestUrl: "https://colorless-volleyball.org/",
  workflowUrl: "https://pointless-puppet.name",
};
```

--------------------------------

### SDK Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/README.md

This example demonstrates how to initialize the Alien SDK client and retrieve the user's profile.

```APIDOC
## SDK Example Usage

### Description
This example demonstrates how to initialize the Alien SDK client and retrieve the user's profile.

### Method
```typescript
import { Alien } from "@alienplatform/platform-api";

const alien = new Alien({
  apiKey: process.env["ALIEN_API_KEY"] ?? "",
});

async function run() {
  const result = await alien.user.getProfile();

  console.log(result);
}

run();
```
```

--------------------------------

### createSetupRegistrationOperation

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/sdks/deployments/README.md

Starts a durable setup registration operation for CloudFormation, Terraform, or Helm.

```APIDOC
## POST /deployments/setup/register

### Description
Starts a durable setup registration operation for CloudFormation, Terraform, or Helm.

### Method
POST

### Endpoint
/deployments/setup/register

### Parameters
#### Request Body
- **request** (operations.ImportDeploymentRequest) - Required - The request object to use for the request.
- **options** (RequestOptions) - Optional - Used to set various options for making HTTP requests.
  - **options.fetchOptions** (RequestInit) - Optional - Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
  - **options.retries** (RetryConfig) - Optional - Enables retrying HTTP requests under certain failure conditions.

### Response
#### Success Response (200)
- **Promise** (models.Deployment) - The created deployment object.

### Errors
- **errors.APIError** (409) - application/json
- **errors.APIError** (500) - application/json
- **errors.AlienDefaultError** (4XX, 5XX) - */*
```

--------------------------------

### Create Setup Registration Operation Request Provider GKE Gateway 3

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createsetupregistrationoperationrequestprovidergkegateway3.md

Example of how to instantiate the CreateSetupRegistrationOperationRequestProviderGkeGateway3 model. Ensure the necessary import is included.

```typescript
import { CreateSetupRegistrationOperationRequestProviderGkeGateway3 } from "@alienplatform/platform-api/models";

let value: CreateSetupRegistrationOperationRequestProviderGkeGateway3 = {
  provider: "gkeGateway",
};
```

--------------------------------

### DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers3 Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicyproviderazureapplicationgatewayforcontainers3.md

Demonstrates how to instantiate and use the DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers3 model.

```typescript
import { DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers3 } from "@alienplatform/platform-api/models";

let value:
  DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers3 = {
      frontend: "<value>",
      provider: "azureApplicationGatewayForContainers",
    };
```

--------------------------------

### Cloudformation Retry Response Setup

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/managerretryresponsesetupunion.md

Example of configuring a Cloudformation retry response setup. Ensure all required fields like method, deploymentPortalUrl, templateUrl, stackName, and region are provided.

```typescript
const value: models.ManagerRetryResponseSetupCloudformation = {
  method: "cloudformation",
  deploymentPortalUrl: "https://judicious-scout.name/",
  launchUrl: "https://male-sanity.com",
  templateUrl: "https://far-off-corral.info/",
  stackName: "<value>",
  region: "<value>",
  stackSettings: {},
};
```

--------------------------------

### DeploymentProviderAwsAlb3 Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentproviderawsalb3.md

Shows how to import and initialize a DeploymentProviderAwsAlb3 object with required fields.

```typescript
import { DeploymentProviderAwsAlb3 } from "@alienplatform/platform-api/models";

let value: DeploymentProviderAwsAlb3 = {
  provider: "awsAlb",
  scheme: "<value>",
  targetType: "<value>",
};
```

--------------------------------

### Deployments - CreateSetupRegistrationOperation

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/README.md

Starts a durable setup registration operation for CloudFormation, Terraform, or Helm.

```APIDOC
## Deployments - CreateSetupRegistrationOperation

### Description
Start a durable setup registration operation for CloudFormation, Terraform, or Helm.

### Method
POST

### Endpoint
/deployments/{deploymentId}/setup-registration-operations
```

--------------------------------

### Install @alienplatform/testing

Source: https://github.com/alienplatform/alien/blob/main/packages/testing/README.md

Install the testing framework as a development dependency.

```bash
npm install --save-dev @alienplatform/testing
```

--------------------------------

### Get Setup Registration Operation

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/sdks/deployments/README.md

Retrieves a specific setup registration operation using the main Alien SDK instance. Ensure you have set up your Alien SDK instance with an API key.

```typescript
import { Alien } from "@alienplatform/platform-api";

const alien = new Alien({
  apiKey: process.env["ALIEN_API_KEY"] ?? "",
});

async function run() {
  const result = await alien.deployments.getSetupRegistrationOperation({
    id: "setupop_y41lqnfosxuwqkzmiax7",
    workspace: "my-workspace",
  });

  console.log(result);
}

run();

```

--------------------------------

### DeploymentDomainsKubernetes Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentdomainskubernetes.md

Example of how to instantiate the DeploymentDomainsKubernetes model with a TLS secret reference.

```typescript
import { DeploymentDomainsKubernetes } from "@alienplatform/platform-api/models";

let value: DeploymentDomainsKubernetes = {
  tlsSecretRef: {
    secretName: "<value>",
  },
};
```

--------------------------------

### DeploymentExposureCustom Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentexposurecustom.md

Demonstrates how to instantiate and use the DeploymentExposureCustom model in TypeScript. This includes setting the domain, mode, route, and certificate configuration.

```typescript
import { DeploymentExposureCustom } from "@alienplatform/platform-api/models";

let value: DeploymentExposureCustom = {
  certificate: {
    mode: "managedAcmImport",
  },
  domain: "bulky-toothpick.net",
  mode: "custom",
  route: {
    ingressClassName: "<value>",
    routeApi: "ingress",
  },
};
```

--------------------------------

### Example DeploymentInfoProvider Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentinfoprovider.md

Demonstrates how to instantiate and populate a DeploymentInfoProvider object in TypeScript. This includes defining the GPG public key, platform details, and the provider source.

```typescript
import { DeploymentInfoProvider } from "@alienplatform/platform-api/models";

let value: DeploymentInfoProvider = {
  gpgPublicKey: {
    asciiArmor: "<value>",
    keyId: "<id>",
  },
  platforms: {
    "key": {
      downloadUrl: "https://scornful-bonnet.net",
      filename: "example.file",
      shasum: "<value>",
      shasumsSignatureUrl: "https://our-soybean.biz/",
      shasumsUrl: "https://passionate-pop.org/",
      size: 227657,
    },
  },
  source: "<value>",
};
```

--------------------------------

### SyncReconcileResponseCertificateTLSSecretRef2 Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/syncreconcileresponsecertificatetlssecretref2.md

Demonstrates how to import and instantiate the SyncReconcileResponseCertificateTLSSecretRef2 model in TypeScript. Ensure you have the correct package installed.

```typescript
import { SyncReconcileResponseCertificateTLSSecretRef2 } from "@alienplatform/platform-api/models";

let value: SyncReconcileResponseCertificateTLSSecretRef2 = {
  secretName: "<value>",
  mode: "tlsSecretRef",
};
```

--------------------------------

### TypeScript Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/syncreconcilerequestpreparedstackextendgcpgrant.md

Demonstrates how to import and initialize a SyncReconcileRequestPreparedStackExtendGcpGrant object in TypeScript. This is a basic setup for the model.

```typescript
import { SyncReconcileRequestPreparedStackExtendGcpGrant } from "@alienplatform/platform-api/models";

let value: SyncReconcileRequestPreparedStackExtendGcpGrant = {};
```

--------------------------------

### TypeScript Example for CreateProjectFromTemplateTerraformRequest

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/createprojectfromtemplateterraformrequest.md

Demonstrates how to instantiate the CreateProjectFromTemplateTerraformRequest object in TypeScript. Ensure the @alienplatform/platform-api library is installed.

```typescript
import { CreateProjectFromTemplateTerraformRequest } from "@alienplatform/platform-api/models/operations";

let value: CreateProjectFromTemplateTerraformRequest = {
  enabled: true,
};
```

--------------------------------

### CreateProjectGithubSetup Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/createprojectgithubsetup.md

Demonstrates how to instantiate and populate the CreateProjectGithubSetup model with required URLs for pull requests and GitHub Actions workflows.

```typescript
import { CreateProjectGithubSetup } from "@alienplatform/platform-api/models/operations";

let value: CreateProjectGithubSetup = {
  pullRequestUrl: "https://digital-icebreaker.info/",
  workflowUrl: "https://bitter-footrest.biz/",
};
```

--------------------------------

### Instantiate Cpu5 Model

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/cpu5.md

Example of how to instantiate the Cpu5 model in TypeScript. Ensure the @alienplatform/platform-api library is installed.

```typescript
import { Cpu5 } from "@alienplatform/platform-api/models/operations";

let value: Cpu5 = {
  unit: "count",
  value: 2235.79,
};
```

--------------------------------

### DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers4 Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicyproviderazureapplicationgatewayforcontainers4.md

Demonstrates how to import and initialize the DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers4 model.

```typescript
import { DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers4 } from "@alienplatform/platform-api/models";

let value:
  DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers4 = {
      frontend: "<value>",
      provider: "azureApplicationGatewayForContainers",
    };
```

--------------------------------

### Instantiate DeploymentSetupConfig

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupconfig.md

Example of how to create and initialize a DeploymentSetupConfig object in TypeScript. Ensure the necessary model is imported.

```typescript
import { DeploymentSetupConfig } from "@alienplatform/platform-api/models";

let value: DeploymentSetupConfig = {
  metadata: {
    "key": "<value>",
    "key1": "<value>",
    "key2": "<value>",
  },
  policy: {
    allowedPlatforms: [],
    allowedSetupMethods: [
      "google-oauth",
    ],
  },
  environmentVariables: [],
};
```

--------------------------------

### DaemonInstanceCpu Model Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/daemoninstancecpu.md

Example of how to import and instantiate the DaemonInstanceCpu model in TypeScript. Ensure the '@alienplatform/platform-api/models' is installed.

```typescript
import { DaemonInstanceCpu } from "@alienplatform/platform-api/models";

let value: DaemonInstanceCpu = {
  unit: "bytes",
  value: 4886.5,
};
```

--------------------------------

### TypeScript Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createsetupregistrationoperationrequestdomainskubernetes.md

Demonstrates how to instantiate the CreateSetupRegistrationOperationRequestDomainsKubernetes model in TypeScript. Ensure the necessary import is included.

```typescript
import { CreateSetupRegistrationOperationRequestDomainsKubernetes } from "@alienplatform/platform-api/models";

let value: CreateSetupRegistrationOperationRequestDomainsKubernetes = {
  tlsSecretRef: {
    secretName: "<value>",
  },
};
```

--------------------------------

### Deployment Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deployment.md

Instantiates a Deployment object with sample data. Ensure all required fields are populated correctly.

```typescript
import { Deployment } from "@alienplatform/platform-api/models";

let value: Deployment = {
  id: "dep_0c29fq4a2yjb7kx3smwdgxlc",
  name: "acme-prod",
  status: "update-pending",
  projectId: "prj_mcytp6z3j91f7tn5ryqsfwtr",
  platform: "aws",
  deploymentProtocolVersion: 447915,
  deploymentGroupId: "dg_r27ict8c7vcgsumpj90ackf7b",
  stackSettings: {},
  currentReleaseId: "rel_WbhQgksrawSKIpEN0NAssHX9",
  desiredReleaseId: "rel_WbhQgksrawSKIpEN0NAssHX9",
  pinnedReleaseId: "rel_WbhQgksrawSKIpEN0NAssHX9",
  retryRequested: true,
  createdAt: new Date("2024-07-02T17:29:04.075Z"),
  updatedAt: new Date("2026-07-09T12:57:49.283Z"),
  managerId: "mgr_enxscjrqiiu2lrc672hwwuc5",
  workspaceId: "ws_It13CUaGEhLLAB87simX0",
};
```

--------------------------------

### TypeScript ResourceHeartbeatDataKv Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/manager/typescript/docs/models/resourceheartbeatdatakv.md

Demonstrates how to create an instance of ResourceHeartbeatDataKv in TypeScript. Ensure the @alienplatform/manager-api/models package is installed.

```typescript
import { ResourceHeartbeatDataKv } from "@alienplatform/manager-api/models";

let value: ResourceHeartbeatDataKv = {
  data: {
    keySchema: [],
    name: "<value>",
    status: {
      collectionIssues: [
        {
          message: "<value>",
          reason: "forbidden",
          severity: "info",
          source: "<value>",
        },
      ],
      health: "degraded",
      lifecycle: "creating",
      partial: false,
      stale: false,
    },
    backend: "awsDynamoDb",
  },
  resourceType: "kv",
};
```

--------------------------------

### ResourceHeartbeatDataDaemon Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/manager/typescript/docs/models/resourceheartbeatdatadaemon.md

Demonstrates how to create and populate a ResourceHeartbeatDataDaemon object in TypeScript. Ensure the '@alienplatform/manager-api/models' package is installed.

```typescript
import { ResourceHeartbeatDataDaemon } from "@alienplatform/manager-api/models";

let value: ResourceHeartbeatDataDaemon = {
  data: {
    assignedMachines: 351239,
    capacityGroup: "<value>",
    commandSupported: true,
    daemonInstances: [
      {
        name: "<value>",
        ready: true,
        replicaId: "<id>",
      },
    ],
    daemonName: "<value>",
    desiredMachines: 633734,
    events: [
      {
        message: "<value>",
        reason: "<value>",
      },
    ],
    healthyInstances: 102281,
    horizonClusterId: "<id>",
    horizonStatus: "<value>",
    latestUpdateTimestamp: "<value>",
    status: {
      collectionIssues: [],
      health: "unknown",
      lifecycle: "running",
      partial: false,
      stale: true,
    },
    unavailableInstances: 222122,
    backend: "azure",
  },
  resourceType: "daemon",
};
```

--------------------------------

### Instantiate Repository Model

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/repository.md

Demonstrates how to create an instance of the Repository model with sample data. Ensure the necessary import is included.

```typescript
import { Repository } from "@alienplatform/platform-api/models/operations";

let value: Repository = {
  createdAt: 4047.24,
  kmsKeyPresent: true,
  registryId: "<id>",
  repositoryArn: "<value>",
  repositoryName: "<value>",
  repositoryUri: "https://colorful-maestro.info",
};
```

--------------------------------

### TypeScript DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers1 Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicyproviderazureapplicationgatewayforcontainers1.md

Demonstrates how to import and instantiate the DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers1 model. Ensure the necessary model is imported from the Alien Platform SDK.

```typescript
import { DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers1 } from "@alienplatform/platform-api/models";

let value:
  DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers1 = 
    {
      frontend: "<value>",
      provider: "azureApplicationGatewayForContainers",
    };
```

--------------------------------

### Terraform Retry Response Setup

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/managerretryresponsesetupunion.md

Example of configuring a Terraform retry response setup. This configuration requires specifying the method, manager URLs, provider and module sources, and Terraform-specific inputs like mainTf and tfvars.

```typescript
const value: models.ManagerRetryResponseSetupTerraform = {
  method: "terraform",
  deploymentPortalUrl: "https://mixed-pronoun.name",
  managerUrl: "https://untimely-railway.biz",
  providerSource: "<value>",
  moduleSource: "<value>",
  moduleInputs: {},
  mainTf: "<value>",
  tfvars: "<value>",
  commands: "<value>",
  stackSettings: {},
};
```

--------------------------------

### Google OAuth Retry Response Setup

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/managerretryresponsesetupunion.md

Example of configuring a Google OAuth retry response setup. This includes the method, portal URLs, manager URL, and region. The stackSettings object can be used for additional configurations.

```typescript
const value: models.ManagerRetryResponseSetupGoogleOauth = {
  method: "google-oauth",
  deploymentPortalUrl: "https://astonishing-pigpen.name/",
  managerUrl: "https://downright-saw.org",
  oauthStartUrl: "https://soft-lace.net/",
  region: "<value>",
  stackSettings: {},
};
```

--------------------------------

### DeploymentSetupMethod1 Usage Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupmethod1.md

Demonstrates how to import and assign a value to the DeploymentSetupMethod1 type.

```typescript
import { DeploymentSetupMethod1 } from "@alienplatform/platform-api/models";

let value: DeploymentSetupMethod1 = "terraform";
```

--------------------------------

### Complete User Profile Setup (Class Method)

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/sdks/user/README.md

Use this method to complete the required beta intake and profile setup dialog using the Alien SDK class. Ensure you have initialized the Alien SDK with your API key.

```typescript
import { Alien } from "@alienplatform/platform-api";

const alien = new Alien({
  apiKey: process.env["ALIEN_API_KEY"] ?? "",
});

async function run() {
  const result = await alien.user.completeProfileSetup();

  console.log(result);
}

run();
```

--------------------------------

### Get Setup Registration Operation (Standalone Function)

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/sdks/deployments/README.md

Uses a standalone function for retrieving a setup registration operation, optimized for tree-shaking. This method requires an instance of AlienCore and handles success and error states explicitly.

```typescript
import { AlienCore } from "@alienplatform/platform-api/core.js";
import { deploymentsGetSetupRegistrationOperation } from "@alienplatform/platform-api/funcs/deploymentsGetSetupRegistrationOperation.js";

// Use `AlienCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const alien = new AlienCore({
  apiKey: process.env["ALIEN_API_KEY"] ?? "",
});

async function run() {
  const res = await deploymentsGetSetupRegistrationOperation(alien, {
    id: "setupop_y41lqnfosxuwqkzmiax7",
    workspace: "my-workspace",
  });
  if (res.ok) {
    const { value: result } = res;
    console.log(result);
  } else {
    console.log("deploymentsGetSetupRegistrationOperation failed:", res.error);
  }
}

run();

```

--------------------------------

### Instantiate DeploymentDetailResponsePreparedStack

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentdetailresponsepreparedstack.md

Demonstrates how to create an instance of the DeploymentDetailResponsePreparedStack model with sample resource data. Ensure the necessary import is included.

```typescript
import { DeploymentDetailResponsePreparedStack } from "@alienplatform/platform-api/models";

let value: DeploymentDetailResponsePreparedStack = {
  id: "<id>",
  resources: {
    "key": {
      config: {
        id: "<id>",
        type: "<value>",
      },
      dependencies: [],
      lifecycle: "frozen",
    },
  },
};
```

--------------------------------

### TypeScript Usage Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/targetreleaseprofileconditionstateresource.md

Demonstrates how to import and initialize a TargetReleaseProfileConditionStateResource object in TypeScript. Ensure the '@alienplatform/platform-api/models' package is installed.

```typescript
import { TargetReleaseProfileConditionStateResource } from "@alienplatform/platform-api/models";

let value: TargetReleaseProfileConditionStateResource = {
  expression: "<value>",
  title: "<value>",
};
```

--------------------------------

### TypeScript Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/syncreconcileresponsetlssecretref.md

Demonstrates how to import and instantiate the SyncReconcileResponseTlsSecretRef model in TypeScript. Ensure the '@alienplatform/platform-api/models' package is installed.

```typescript
import { SyncReconcileResponseTlsSecretRef } from "@alienplatform/platform-api/models";

let value: SyncReconcileResponseTlsSecretRef = {
  secretName: "<value>",
};
```

--------------------------------

### DeploymentSetupStackSettingsPolicyProviderGkeGateway1 Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicyprovidergkegateway1.md

Demonstrates how to import and initialize the DeploymentSetupStackSettingsPolicyProviderGkeGateway1 model in TypeScript. Ensure the model is correctly imported from the platform API.

```typescript
import { DeploymentSetupStackSettingsPolicyProviderGkeGateway1 } from "@alienplatform/platform-api/models";

let value: DeploymentSetupStackSettingsPolicyProviderGkeGateway1 = {
  provider: "gkeGateway",
};
```

--------------------------------

### TypeScript Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/persistimporteddeploymentrequesttlssecretref.md

Demonstrates how to import and instantiate the PersistImportedDeploymentRequestTlsSecretRef model in TypeScript. Ensure the '@alienplatform/platform-api/models' package is installed.

```typescript
import { PersistImportedDeploymentRequestTlsSecretRef } from "@alienplatform/platform-api/models";

let value: PersistImportedDeploymentRequestTlsSecretRef = {
  secretName: "<value>",
};
```

--------------------------------

### DeploymentSetupStackSettingsPolicyNetworkByoVnetAzure Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicynetworkbyovnetazure.md

Demonstrates how to import and instantiate the DeploymentSetupStackSettingsPolicyNetworkByoVnetAzure model in TypeScript. Ensure you replace placeholder values with actual data.

```typescript
import { DeploymentSetupStackSettingsPolicyNetworkByoVnetAzure } from "@alienplatform/platform-api/models";

let value: DeploymentSetupStackSettingsPolicyNetworkByoVnetAzure = {
  privateSubnetName: "<value>",
  publicSubnetName: "<value>",
  type: "byo-vnet-azure",
  vnetResourceId: "<id>",
};
```

--------------------------------

### Memory1 Model Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/memory1.md

Example of how to instantiate and use the Memory1 model in TypeScript. Ensure the @alienplatform/platform-api package is installed.

```typescript
import { Memory1 } from "@alienplatform/platform-api/models/operations";

let value: Memory1 = {
  unit: "cores",
  value: 2788.3,
};
```

--------------------------------

### DataStatus21 Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/datastatus21.md

Demonstrates how to import and initialize a DataStatus21 object in TypeScript. Ensure the @alienplatform/platform-api package is installed.

```typescript
import { DataStatus21 } from "@alienplatform/platform-api/models/operations";

let value: DataStatus21 = {
  collectionIssues: [],
  health: "unknown",
  lifecycle: "stopped",
  partial: true,
  stale: true,
};
```

--------------------------------

### Create DeploymentSetupStackSettingsPolicyNetworkCreate

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicynetworkcreate.md

Example of how to instantiate and use the DeploymentSetupStackSettingsPolicyNetworkCreate model. Ensure the model is imported from the correct path.

```typescript
import { DeploymentSetupStackSettingsPolicyNetworkCreate } from "@alienplatform/platform-api/models";

let value: DeploymentSetupStackSettingsPolicyNetworkCreate = {
  type: "create",
};
```

--------------------------------

### TypeScript DataLocal8 Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/datalocal8.md

Demonstrates how to define and initialize a DataLocal8 object in TypeScript. Ensure the @alienplatform/platform-api library is installed.

```typescript
import { DataLocal8 } from "@alienplatform/platform-api/models/operations";

let value: DataLocal8 = {
  path: "/usr/local/src",
  pathExists: true,
  secretMetadataListed: false,
  status: {
    collectionIssues: [
      {
        message: "<value>",
        reason: "api-unavailable",
        severity: "error",
        source: "<value>",
      },
    ],
    health: "unknown",
    lifecycle: "failed",
    partial: true,
    stale: false,
  },
  backend: "local",
};
```

--------------------------------

### Instantiate DeploymentSetupStackSettingsPolicyProviderAwsAlb3

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicyproviderawsalb3.md

Demonstrates how to import and instantiate the DeploymentSetupStackSettingsPolicyProviderAwsAlb3 model with required fields.

```typescript
import { DeploymentSetupStackSettingsPolicyProviderAwsAlb3 } from "@alienplatform/platform-api/models";

let value: DeploymentSetupStackSettingsPolicyProviderAwsAlb3 = {
  provider: "awsAlb",
  scheme: "<value>",
  targetType: "<value>",
};
```

--------------------------------

### PreparedDeploymentStackOverrideAwResource Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/prepareddeploymentstackoverrideawresource.md

Demonstrates how to instantiate the PreparedDeploymentStackOverrideAwResource model with a list of resource ARNs.

```typescript
import { PreparedDeploymentStackOverrideAwResource } from "@alienplatform/platform-api/models";

let value: PreparedDeploymentStackOverrideAwResource = {
  resources: [
    "<value 1>",
    "<value 2>",
    "<value 3>",
  ],
};
```

--------------------------------

### HeartbeatStatus33 Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/heartbeatstatus33.md

Demonstrates how to import and initialize a HeartbeatStatus33 object in TypeScript. Ensure the @alienplatform/platform-api/models package is installed.

```typescript
import { HeartbeatStatus33 } from "@alienplatform/platform-api/models";

let value: HeartbeatStatus33 = {
  collectionIssues: [],
  health: "unknown",
  lifecycle: "running",
  partial: true,
  stale: false,
};
```

--------------------------------

### TypeScript Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicycertificatetlssecretref2.md

Demonstrates how to instantiate and use the DeploymentSetupStackSettingsPolicyCertificateTLSSecretRef2 model in TypeScript. Ensure the necessary import is included.

```typescript
import { DeploymentSetupStackSettingsPolicyCertificateTLSSecretRef2 } from "@alienplatform/platform-api/models";

let value: DeploymentSetupStackSettingsPolicyCertificateTLSSecretRef2 = {
  secretName: "<value>",
  mode: "tlsSecretRef",
};
```

--------------------------------

### Create GCP Setup Registration Operation Request

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createsetupregistrationoperationrequestgcpunion.md

Example of creating a CreateSetupRegistrationOperationRequestGcp object. Ensure the certificateName is provided.

```typescript
const value: models.CreateSetupRegistrationOperationRequestGcp = {
  certificateName: "<value>",
};
```

--------------------------------

### Build and Run Example Script

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/manager/typescript/examples/README.md

Build the project and execute an example TypeScript file using tsx.

```bash
npm run build && npx tsx example.ts
```

--------------------------------

### CpuAllocatable Model Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/cpuallocatable.md

Example of how to import and instantiate the CpuAllocatable model in TypeScript. Ensure the '@alienplatform/platform-api/models' package is installed.

```typescript
import { CpuAllocatable } from "@alienplatform/platform-api/models";

let value: CpuAllocatable = {
  unit: "milliseconds",
  value: 8636.96,
};
```

--------------------------------

### DeploymentInfoCloudformation Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentinfocloudformation.md

Demonstrates how to import and instantiate the DeploymentInfoCloudformation model with sample data.

```typescript
import { DeploymentInfoCloudformation } from "@alienplatform/platform-api/models";

let value: DeploymentInfoCloudformation = {
  status: "ready",
  mode: "outputs",
  launchUrl: "https://bulky-metal.net",
};
```

--------------------------------

### ContainerUnitCpu Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/containerunitcpu.md

Demonstrates how to import and instantiate the ContainerUnitCpu model in TypeScript. Ensure the '@alienplatform/platform-api/models' package is installed.

```typescript
import { ContainerUnitCpu } from "@alienplatform/platform-api/models";

let value: ContainerUnitCpu = {
  unit: "requests-per-second",
  value: 7042.75,
};
```

--------------------------------

### ManagerRetryResponseSetupConfig Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/managerretryresponsesetupconfig.md

Demonstrates how to instantiate and configure a ManagerRetryResponseSetupConfig object.

```typescript
import { ManagerRetryResponseSetupConfig } from "@alienplatform/platform-api/models";

let value: ManagerRetryResponseSetupConfig = {
  metadata: {
    "key": "<value>",
    "key1": "<value>",
  },
  policy: {
    allowedPlatforms: [],
    allowedSetupMethods: [
      "google-oauth",
    ],
  },
  environmentVariables: [],
};
```

--------------------------------

### Instantiate DeploymentDetailResponseEnvironmentInfoAzure

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentdetailresponseenvironmentinfoazure.md

Example of how to create an instance of the DeploymentDetailResponseEnvironmentInfoAzure model. Ensure you have imported the necessary type from the SDK.

```typescript
import { DeploymentDetailResponseEnvironmentInfoAzure } from "@alienplatform/platform-api/models";

let value: DeploymentDetailResponseEnvironmentInfoAzure = {
  location: "<value>",
  subscriptionId: "<id>",
  tenantId: "<id>",
  platform: "azure",
};
```

--------------------------------

### QueueHeartbeatStatus Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/manager/typescript/docs/models/queueheartbeatstatus.md

Demonstrates how to import and instantiate the QueueHeartbeatStatus model in TypeScript. Ensure the @alienplatform/manager-api package is installed.

```typescript
import { QueueHeartbeatStatus } from "@alienplatform/manager-api/models";

let value: QueueHeartbeatStatus = {
  collectionIssues: [],
  health: "unhealthy",
  lifecycle: "scaling",
  partial: true,
  stale: true,
};
```

--------------------------------

### CommandStatusResponse Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/manager/typescript/docs/models/commandstatusresponse.md

Demonstrates how to import and create an instance of CommandStatusResponse in TypeScript. Ensure the @alienplatform/manager-api package is installed.

```typescript
import { CommandStatusResponse } from "@alienplatform/manager-api/models";

let value: CommandStatusResponse = {
  attempt: 289238,
  commandId: "<id>",
  state: "DISPATCHED",
};
```

--------------------------------

### DataBuild Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/databuild.md

Demonstrates how to instantiate and populate the DataBuild model with sample data. Ensure the necessary import is included.

```typescript
import { DataBuild } from "@alienplatform/platform-api/models";

let value: DataBuild = {
  data: {
    encryptionKeyPresent: false,
    environmentVariableCount: 19119,
    projectName: "<value>",
    serviceRolePresent: true,
    status: {
      collectionIssues: [
        {
          message: "<value>",
          reason: "api-unavailable",
          severity: "error",
          source: "<value>",
        },
      ],
      health: "degraded",
      lifecycle: "unknown",
      partial: false,
      stale: true,
    },
    backend: "awsCodeBuild",
  },
  resourceType: "build",
};
```

--------------------------------

### DeploymentSetupStackSettingsPolicyNetworkByoVpcGcp Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicynetworkbyovpcgcp.md

Demonstrates how to import and initialize a DeploymentSetupStackSettingsPolicyNetworkByoVpcGcp object in TypeScript. Ensure you replace placeholder values with your actual network and subnet details.

```typescript
import { DeploymentSetupStackSettingsPolicyNetworkByoVpcGcp } from "@alienplatform/platform-api/models";

let value: DeploymentSetupStackSettingsPolicyNetworkByoVpcGcp = {
  networkName: "<value>",
  region: "<value>",
  subnetName: "<value>",
  type: "byo-vpc-gcp",
};
```

--------------------------------

### InvolvedObjectUnion9 with operations.InvolvedObject9

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/involvedobjectunion9.md

Example of using the InvolvedObjectUnion9 type with the operations.InvolvedObject9 variant. No specific setup is required beyond type inference.

```typescript
const value: operations.InvolvedObject9 = {};
```

--------------------------------

### Instantiate InstallContextTargets

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/installcontexttargets.md

Demonstrates how to create an instance of the InstallContextTargets model with platform and manager URL. Ensure the necessary import is included.

```typescript
import { InstallContextTargets } from "@alienplatform/platform-api/models";

let value: InstallContextTargets = {
  platform: "local",
  managerUrl: "https://gripping-draw.info/",
};
```

--------------------------------

### TypeScript Example Usage

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/getprojectgcpoauthproviderrequest.md

Demonstrates how to instantiate and use the GetProjectGcpOAuthProviderRequest model in TypeScript. Ensure you have the necessary SDK package installed.

```typescript
import { GetProjectGcpOAuthProviderRequest } from "@alienplatform/platform-api/models/operations";

let value: GetProjectGcpOAuthProviderRequest = {
  idOrName: "my-project",
  workspace: "my-workspace",
};
```

--------------------------------

### CertificateTLSSecretRef2 Usage Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/certificatetlssecretref2.md

Demonstrates how to import and instantiate the CertificateTLSSecretRef2 model in TypeScript. Ensure you have the necessary SDK package installed.

```typescript
import { CertificateTLSSecretRef2 } from "@alienplatform/platform-api/models/operations";

let value: CertificateTLSSecretRef2 = {
  secretName: "<value>",
  mode: "tlsSecretRef",
};
```

--------------------------------

### Instantiate DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers2

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicyproviderazureapplicationgatewayforcontainers2.md

Demonstrates how to import and instantiate the DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers2 model. Ensure the necessary model is imported from the platform-api package.

```typescript
import { DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers2 } from "@alienplatform/platform-api/models";

let value:
  DeploymentSetupStackSettingsPolicyProviderAzureApplicationGatewayForContainers2 =
    {
      frontend: "<value>",
      provider: "azureApplicationGatewayForContainers",
    };
```

--------------------------------

### CancelManagerSetupRequest Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/cancelmanagersetuprequest.md

Demonstrates how to import and instantiate a CancelManagerSetupRequest object in TypeScript. This is useful for setting up requests to cancel a manager setup.

```typescript
import { CancelManagerSetupRequest } from "@alienplatform/platform-api/models/operations";

let value: CancelManagerSetupRequest = {
  id: "mgr_enxscjrqiiu2lrc672hwwuc5",
  workspace: "my-workspace",
};
```

--------------------------------

### SetupRegistrationOperationResult Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/setupregistrationoperationresult.md

Demonstrates how to import and instantiate the SetupRegistrationOperationResult model in TypeScript. Ensure the necessary model is imported from the platform-api.

```typescript
import { SetupRegistrationOperationResult } from "@alienplatform/platform-api/models";

let value: SetupRegistrationOperationResult = {
  deploymentId: "dep_0c29fq4a2yjb7kx3smwdgxlc",
  deploymentToken: "<value>",
  helmValues: "<value>",
};
```

--------------------------------

### TypeScript CancelManagerSetupResponse Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/cancelmanagersetupresponse.md

Demonstrates how to import and instantiate the CancelManagerSetupResponse model in TypeScript. This is used when a manager setup is successfully canceled.

```typescript
import { CancelManagerSetupResponse } from "@alienplatform/platform-api/models/operations";

let value: CancelManagerSetupResponse = {
  message: "<value>",
};
```

--------------------------------

### DataGcpPubSub Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/operations/datagcppubsub.md

Demonstrates how to instantiate and populate the DataGcpPubSub model with various configuration options.

```typescript
import { DataGcpPubSub } from "@alienplatform/platform-api/models/operations";

let value: DataGcpPubSub = {
  messageStorageAllowedPersistenceRegions: [
    "<value 1>",
    "<value 2>",
  ],
  status: {
    collectionIssues: [],
    health: "healthy",
    lifecycle: "failed",
    partial: true,
    stale: true,
  },
  subscriptionLabels: {
    "key": "<value>",
  },
  subscriptionPushAttributes: {},
  topicLabels: {
    "key": "<value>",
    "key1": "<value>",
    "key2": "<value>",
  },
  topicName: "<value>",
  backend: "gcpPubSub",
};
```

--------------------------------

### TypeScript Example Usage of ManagerRetryResponseTlsSecretRef1

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/managerretryresponsetlssecretref1.md

Demonstrates how to import and instantiate the ManagerRetryResponseTlsSecretRef1 model in TypeScript. Ensure the '@alienplatform/platform-api/models' package is installed.

```typescript
import { ManagerRetryResponseTlsSecretRef1 } from "@alienplatform/platform-api/models";

let value: ManagerRetryResponseTlsSecretRef1 = {
  secretName: "<value>",
};
```

--------------------------------

### Instantiate DataPreparingEnvironment

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/datapreparingenvironment.md

Demonstrates how to create an instance of the DataPreparingEnvironment model. Ensure the 'strategyName' and 'type' fields are correctly populated.

```typescript
import { DataPreparingEnvironment } from "@alienplatform/platform-api/models";

let value: DataPreparingEnvironment = {
  strategyName: "<value>",
  type: "PreparingEnvironment",
};
```

--------------------------------

### CreateManagerResponseCertificateTLSSecretRef4 Usage Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/createmanagerresponsecertificatetlssecretref4.md

Demonstrates how to import and instantiate the CreateManagerResponseCertificateTLSSecretRef4 model in TypeScript. Ensure you have the necessary SDK package installed.

```typescript
import { CreateManagerResponseCertificateTLSSecretRef4 } from "@alienplatform/platform-api/models";

let value: CreateManagerResponseCertificateTLSSecretRef4 = {
  secretName: "<value>",
  mode: "tlsSecretRef",
};
```

--------------------------------

### DeploymentResponse Model Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/manager/typescript/docs/models/deploymentresponse.md

Demonstrates how to instantiate and use the DeploymentResponse model. Ensure the necessary import is included.

```typescript
import { DeploymentResponse } from "@alienplatform/manager-api/models";

let value: DeploymentResponse = {
  createdAt: "1726644984201",
  deploymentGroupId: "<id>",
  id: "<id>",
  name: "<value>",
  platform: "azure",
  retryRequested: true,
  status: "<value>",
};
```

--------------------------------

### DeploymentSetupStackSettingsPolicyExposureCustom Example

Source: https://github.com/alienplatform/alien/blob/main/client-sdks/platform/typescript/docs/models/deploymentsetupstacksettingspolicyexposurecustom.md

Demonstrates how to instantiate and use the DeploymentSetupStackSettingsPolicyExposureCustom model in TypeScript. Ensure you have the necessary models imported.

```typescript
import { DeploymentSetupStackSettingsPolicyExposureCustom } from "@alienplatform/platform-api/models";

let value: DeploymentSetupStackSettingsPolicyExposureCustom = {
  certificate: {
    secretName: "<value>",
    mode: "tlsSecretRef",
  },
  domain: "round-fog.com",
  mode: "custom",
  route: {
    gatewayClassName: "<value>",
    listenerPort: 53529,
    routeApi: "gateway",
  },
};
```