AcquiaCloudApi\Endpoints\CodebaseEnvironments

Complexity

Total Complexity

8

Size/Duplication

Total Lines	118
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getById()	0	6	1
A	update()	0	13	1
A	disassociatePrivateNetwork()	0	6	1
A	associatePrivateNetwork()	0	13	1
A	getByPrivateNetwork()	0	6	1
A	getBySite()	0	6	1
A	get()	0	6	1
A	getAll()	0	6	1

<?php

namespace AcquiaCloudApi\Endpoints;

use AcquiaCloudApi\Response\CodebaseEnvironmentResponse;
use AcquiaCloudApi\Response\CodebaseEnvironmentsResponse;
use AcquiaCloudApi\Response\OperationResponse;

/**
 * Class CodebaseEnvironments
 *
 * @package AcquiaCloudApi\CloudApi
 */
class CodebaseEnvironments extends CloudApiBase
{
    /**
     * Returns a list of environments for a codebase.
     */
    public function getAll(string $codebaseId): CodebaseEnvironmentsResponse
    {
        return new CodebaseEnvironmentsResponse(
            $this->client->request(
                'get',
                "/codebases/$codebaseId/environments"
            )
        );
    }

    /**
     * Returns information about a specific environment for a codebase.
     */
    public function get(string $codebaseId, string $environmentId): CodebaseEnvironmentResponse
    {
        return new CodebaseEnvironmentResponse(
            $this->client->request(
                'get',
                "/codebases/$codebaseId/environments/$environmentId"
            )
        );
    }

    /**
     * Returns information about a specific environment by ID.
     */
    public function getById(string $environmentId): CodebaseEnvironmentResponse
    {
        return new CodebaseEnvironmentResponse(
            $this->client->request(
                'get',
                "/v3/environments/$environmentId"
            )
        );
    }

    /**
     * Updates the properties for an environment.
     *
     * @param array<string, mixed> $properties
     */
    public function update(string $environmentId, array $properties): OperationResponse
    {
        $options = [
            'json' => [
                'properties' => $properties
            ],
        ];

        return new OperationResponse(
            $this->client->request(
                'put',
                "/v3/environments/$environmentId",
                $options
            )
        );
    }

    /**
     * Associates an environment with a private network.
     */
    public function associatePrivateNetwork(string $environmentId, string $privateNetworkId): OperationResponse
    {
        $options = [
            'json' => [
                'private_network_id' => $privateNetworkId
            ],
        ];

        return new OperationResponse(
            $this->client->request(
                'put',
                "/v3/environments/$environmentId/private-network",
                $options
            )
        );
    }

    /**
     * Disassociates an environment from a private network.
     */
    public function disassociatePrivateNetwork(string $environmentId): OperationResponse
    {
        return new OperationResponse(
            $this->client->request(
                'delete',
                "/v3/environments/$environmentId/private-network"
            )
        );
    }

    /**
     * Gets environments associated with a private network.
     */
    public function getByPrivateNetwork(string $privateNetworkId): CodebaseEnvironmentsResponse
    {
        return new CodebaseEnvironmentsResponse(
            $this->client->request(
                'get',
                "/v3/private-networks/$privateNetworkId/environments"
            )
        );
    }

    /**
     * Gets environments associated with a site.
     */
    public function getBySite(string $siteId): CodebaseEnvironmentsResponse
    {
        return new CodebaseEnvironmentsResponse(
            $this->client->request(
                'get',
                "/sites/$siteId/environments"
            )
        );
    }
}