ezero-apimatic-sdk 0.0.1

data/lib/env_zero_api/apis/credentials_api.rb

@@ -0,0 +1,72 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # CredentialsApi
+  class CredentialsApi < BaseApi
+    # Creates an API key for an organization. `name` and `organizationId` are
+    # required; `permissions` scopes the key below organization admin and
+    # `readOnly` restricts it to reads. The response contains `apiKeySecret`,
+    # which is returned only on creation and cannot be retrieved afterwards.
+    # @param [CredentialsApiCreateApiKeyRequestBody] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def credentials_create_api_key(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/api-keys',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CredentialsApiCreateApiKeyResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Returns the API keys of an organization, with their roles, creators and
+    # last-used times. Key secrets are not returned.
+    # @param [String] organization_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def credentials_find_all_api_keys(organization_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/api-keys',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(organization_id, key: 'organizationId')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CredentialsApiApiKey.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/env_zero_api/apis/deployment_logs_api.rb

@@ -0,0 +1,79 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # DeploymentLogsApi
+  class DeploymentLogsApi < BaseApi
+    # Returns the steps of a deployment, such as variable initialisation, plan
+    # and apply. Use the step names returned here to fetch an individual step's
+    # log.
+    # @param [String] deployment_log_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def deployment_logs_find_by_deployment_log_id(deployment_log_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/deployments/{deploymentLogId}/steps',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(deployment_log_id, key: 'deploymentLogId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeploymentStepApiFindByDeploymentLogIdResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Returns the log events of one deployment step. The response carries
+    # `nextStartTime` and `hasMoreLogs`, so a step that is still running, or
+    # whose log is long, is read by repeating the call until `hasMoreLogs` is
+    # false.
+    # @param [String] name Required parameter: In order to fetch the available
+    # step names first use deployments/{deploymentLogId}/steps end point
+    # @param [String] deployment_log_id Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def deployment_logs_find_step_log(name,
+                                      deployment_log_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/deployments/{deploymentLogId}/steps/{name}/log',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(name, key: 'name')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(deployment_log_id, key: 'deploymentLogId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeploymentStepApiFindStepLogResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/env_zero_api/apis/drift_api.rb

@@ -0,0 +1,201 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # DriftApi
+  class DriftApi < BaseApi
+    # Returns the drift causes detected across an organization, grouped by root
+    # cause rather than by environment, so a single cause affecting many
+    # environments is reported once with the full list of environments it
+    # affects. Each group carries its `causeKind`, the `causeKeyParts`
+    # identifying what changed (the shape of which varies by kind), when it was
+    # first and last seen, and the affected environments. Narrow the result to
+    # specific projects with `projectIds`.
+    # @param [String] organization_id Required parameter: The organization id
+    # @param [String] project_ids Optional parameter: Optional comma-separated
+    # project ids to narrow the results to
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def drift_get_drift_causes(organization_id,
+                               project_ids: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/drift-causes',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(organization_id, key: 'organizationId')
+                                 .is_required(true))
+                   .query_param(new_parameter(project_ids, key: 'projectIds'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DriftApiGetDriftCausesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Returns how long drift causes have been taking to resolve across an
+    # organization: the median fix duration in milliseconds, the number of
+    # resolved causes the median was computed from, and the trailing window
+    # used. The window defaults to 90 days and is capped at 365.
+    # `medianFixDurationInMillis` is null when no causes closed within the
+    # window.
+    # @param [String] organization_id Required parameter: The organization id
+    # @param [String] project_ids Optional parameter: Optional comma-separated
+    # project ids to narrow the results to
+    # @param [String] window_days Optional parameter: Optional trailing window
+    # in days. Defaults to 90, capped at 365
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def drift_get_drift_fix_stats(organization_id,
+                                  project_ids: nil,
+                                  window_days: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/drift-causes/fix-stats',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(organization_id, key: 'organizationId')
+                                 .is_required(true))
+                   .query_param(new_parameter(project_ids, key: 'projectIds'))
+                   .query_param(new_parameter(window_days, key: 'windowDays'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DriftApiGetDriftFixStatsResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Returns the drift causes that have been marked as ignored for an
+    # organization, in the same grouped-by-cause form as `GET /drift-causes`.
+    # Ignoring is recorded per environment, so a cause appears here only for the
+    # environments where it was ignored.
+    # @param [String] organization_id Required parameter: The organization id
+    # @param [String] project_ids Optional parameter: Optional comma-separated
+    # project ids to narrow the results to
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def drift_get_ignored_drift_causes(organization_id,
+                                       project_ids: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/drift-causes/ignored',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(organization_id, key: 'organizationId')
+                                 .is_required(true))
+                   .query_param(new_parameter(project_ids, key: 'projectIds'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DriftApiGetIgnoredDriftCausesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Marks a drift cause as ignored on the given environments, so it stops
+    # being reported as outstanding. Ignoring applies per environment and does
+    # not expire: it does not silence the cause on environments not listed, and
+    # the cause returns if a new environment develops it. The response reports
+    # which environment ids were ignored and which were skipped, with a reason
+    # for each skip.
+    # @param [String] cause_id Required parameter: The drift cause id to
+    # ignore
+    # @param [DriftApiIgnoreDriftCauseRequestBody] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def drift_ignore_drift_cause(cause_id,
+                                 body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/drift-causes/{causeId}/ignore',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(cause_id, key: 'causeId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DriftApiIgnoreDriftCauseResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+
+    # Reverses an ignore, so the drift cause is reported as outstanding again on
+    # the given environments. The cause reappears after the next drift detection
+    # run confirms the drift is still present. The response reports which
+    # environment ids were un-ignored and which were skipped, with a reason for
+    # each skip.
+    # @param [String] cause_id Required parameter: The drift cause id to
+    # un-ignore
+    # @param [DriftApiUnIgnoreDriftCauseRequestBody] body Required parameter:
+    # TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def drift_un_ignore_drift_cause(cause_id,
+                                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/drift-causes/{causeId}/un-ignore',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(cause_id, key: 'causeId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DriftApiUnIgnoreDriftCauseResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+  end
+end

data/lib/env_zero_api/apis/environment_outputs_api.rb

@@ -0,0 +1,39 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # EnvironmentOutputsApi
+  class EnvironmentOutputsApi < BaseApi
+    # Describe which environments, or projects in the organization may access a
+    # given environment's state
+    # @param [String] environment_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def environment_outputs_get_state_access_config(environment_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/environment-state/{environmentId}/access-control',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(environment_id, key: 'environmentId')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('env0_API_Key')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(EnvironmentOutputsApiGetStateAccessConfigResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('401',
+                                 'Authentication failed - the API key ID or secret is missing or'\
+                                  ' invalid.',
+                                 ErrorException)
+                    .local_error('403',
+                                 'The authenticated key lacks permission for this resource, or'\
+                                  ' the route does not exist for the caller.',
+                                 ErrorException))
+        .execute
+    end
+  end
+end