ezero-apimatic-sdk 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2311efd49ea90f87bca860e5c9de4241a6dc4832659533e06c40e2380f811213
+  data.tar.gz: ede3f9cf1a12c13597932bb4ce9561c67d27b995c233b7454a2de02979406528
+SHA512:
+  metadata.gz: '086acf8e81ee25d26ee9b4c3eea7140d7c760d11641f665dfbc23721770a2718aef47a661fa44580d9bba01fa31a17cf953dde91b7910f61c029a2010fef4a08'
+  data.tar.gz: a3ed0d2c9dbd34d8d10d177afb13685e92b07232b67c1808c45386e9066a1b3f5369aecffbca3113c73dbeafe536c9f02828493f63732f0328be1761ad2b464c

data/LICENSE

@@ -0,0 +1,28 @@
+License: 
+========
+The MIT License (MIT)
+http://opensource.org/licenses/MIT
+
+Copyright (c) 2014 - 2026 APIMATIC Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+Trade Mark:
+==========
+APIMATIC is a trade mark for APIMATIC Limited

data/README.md

@@ -0,0 +1,180 @@
+
+# Getting Started with env zero API
+
+## Introduction
+
+This document describes the resources that make up the official env zero REST API.
+
+### Base URL
+
+`https://api.env0.com`
+
+### Content types
+
+All requests should be in JSON format and include the `accept: application/json` header.
+
+### Authentication
+
+HTTP Basic authentication. Send the **API Key ID** as the username and the **API Key Secret** as the password. Keys are created under *Organization Settings -> API Keys* (Admin or User scope) or *Personal Settings -> API Keys* (Personal scope).
+
+### Scope of this document
+
+This specification covers the environment drift-governance surface of the env zero API and the environment, deployment, template, configuration and project endpoints that support it. It was reconstructed from the OpenAPI fragments published on https://docs.envzero.com and is a subset of the full API.
+
+### Error responses
+
+`401` and `403` responses return `{ "message": string }` and are documented on every operation. The upstream documentation does not define response bodies for other non-2xx status codes, so none are asserted here.
+
+## Install the Package
+
+Install the gem from the command line:
+
+```bash
+gem install ezero-apimatic-sdk -v 0.0.1
+```
+
+Or add the gem to your Gemfile and run `bundle`:
+
+```ruby
+gem 'ezero-apimatic-sdk', '0.0.1'
+```
+
+For additional gem details, see the [RubyGems page for the ezero-apimatic-sdk gem](https://rubygems.org/gems/ezero-apimatic-sdk/versions/0.0.1).
+
+## IRB Console Usage
+
+You can explore the SDK interactively using IRB in two ways
+
+### 1. Use IRB with Installed Gem
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and type the following command to start the irb console.
+
+```bash
+irb
+```
+
+Now you can load the SDK in the IRB
+
+```ruby
+require 'env_zero_api'
+include EnvZeroApi
+```
+
+### 2. Use IRB within SDK
+
+Open your system terminal (Command Prompt, Git Bash or macOS Terminal) and navigate to the root folder of SDK.
+
+```
+cd path/to/env_zero_api
+```
+
+Now you can start the preconfigured irb console by running the following command
+
+```bash
+ruby bin/console
+```
+
+**_Note:_** This automatically loads the SDK from lib/
+
+## Initialize the API Client
+
+**_Note:_** Documentation for the client can be found [here.](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/client.md)
+
+The following parameters are configurable for the API Client:
+
+| Parameter | Type | Description |
+|  --- | --- | --- |
+| connection | `Faraday::Connection` | The Faraday connection object passed by the SDK user for making requests |
+| adapter | `Faraday::Adapter` | The Faraday adapter object passed by the SDK user for performing http requests |
+| timeout | `Float` | The value to use for connection timeout. <br> **Default: 30** |
+| max_retries | `Integer` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
+| retry_interval | `Float` | Pause in seconds between retries. <br> **Default: 1** |
+| backoff_factor | `Float` | The amount to multiply each successive retry's interval amount by in order to provide backoff. <br> **Default: 2** |
+| retry_statuses | `Array` | A list of HTTP statuses to retry. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
+| retry_methods | `Array` | A list of HTTP methods to retry. <br> **Default: %i[get put]** |
+| http_callback | `HttpCallBack` | The Http CallBack allows defining callables for pre and post API calls. |
+| proxy_settings | [`ProxySettings`](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md) | Optional proxy configuration to route HTTP requests through a proxy server. |
+| logging_configuration | [`LoggingConfiguration`](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md) | The SDK logging configuration for API calls |
+| basic_auth_credentials | [`BasicAuthCredentials`](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md) | The credential object for Basic Authentication |
+
+The API client can be initialized as follows:
+
+### Code-Based Client Initialization
+
+```ruby
+require 'env_zero_api'
+include EnvZeroApi
+
+client = Client.new(
+  basic_auth_credentials: BasicAuthCredentials.new(
+    username: 'BasicAuthUserName',
+    password: 'BasicAuthPassword'
+  ),
+  logging_configuration: LoggingConfiguration.new(
+    log_level: Logger::INFO,
+    request_logging_config: RequestLoggingConfiguration.new(
+      log_body: true
+    ),
+    response_logging_config: ResponseLoggingConfiguration.new(
+      log_headers: true
+    )
+  )
+)
+```
+
+### Environment-Based Client Initialization
+
+```ruby
+require 'env_zero_api'
+include EnvZeroApi
+
+# Create client from environment
+client = Client.from_env
+```
+
+See the [`Environment-Based Client Initialization`](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md) section for details.
+
+## Authorization
+
+This API uses the following authentication schemes.
+
+* [`env0_API_Key (Basic Authentication)`](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/auth/basic-authentication.md)
+
+## List of APIs
+
+* [Bulk Operations](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/bulk-operations.md)
+* [Deployment Logs](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/deployment-logs.md)
+* [Approval Policy](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/approval-policy.md)
+* [Environment Outputs](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/environment-outputs.md)
+* [Environments](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/environments.md)
+* [Drift](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/drift.md)
+* [Scheduling](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/scheduling.md)
+* [Templates](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/templates.md)
+* [Configuration](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/configuration.md)
+* [Projects](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/projects.md)
+* [Organization](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/organization.md)
+* [Notifications](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/notifications.md)
+* [Credentials](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/controllers/credentials.md)
+
+## SDK Infrastructure
+
+### Configuration
+
+* [ProxySettings](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/proxy-settings.md)
+* [Environment-Based Client Initialization](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/environment-based-client-initialization.md)
+* [AbstractLogger](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/abstract-logger.md)
+* [LoggingConfiguration](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/logging-configuration.md)
+* [RequestLoggingConfiguration](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/request-logging-configuration.md)
+* [ResponseLoggingConfiguration](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/response-logging-configuration.md)
+
+### HTTP
+
+* [HttpResponse](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/http-response.md)
+* [HttpRequest](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/http-request.md)
+
+### Utilities
+
+* [ApiResponse](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/api-response.md)
+* [ApiHelper](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/api-helper.md)
+* [DateTimeHelper](https://www.github.com/sdks-io/ezero-apimatic-ruby-sdk/tree/0.0.1/doc/date-time-helper.md)
+

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+# Load the lib folder into Ruby's load path
+$LOAD_PATH.unshift(File.expand_path('../lib', __dir__))
+
+# Require the gem
+require 'env_zero_api'
+
+puts 'EnvZeroApi SDK loaded!'
+puts 'You can now create a client with: client = EnvZeroApi::Client.new'
+puts 'Or use from_env: client = EnvZeroApi::Client.from_env'
+
+# Start an interactive IRB session
+require 'irb'
+IRB.start

data/lib/env_zero_api/api_helper.rb

@@ -0,0 +1,10 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # API utility class
+  class APIHelper < CoreLibrary::ApiHelper
+  end
+end

data/lib/env_zero_api/apis/approval_policy_api.rb

@@ -0,0 +1,107 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # ApprovalPolicyApi
+  class ApprovalPolicyApi < BaseApi
+    # Assigns an approval policy to a scope, so deployments there are evaluated
+    # against it after the plan and cost estimation steps. `blueprintId`
+    # identifies the policy and `scope` with `scopeId` identifies the target.
+    # Returns the created assignment.
+    # @param [BlueprintApiAssignApprovalPolicyRequestBody] body Required
+    # parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def templates_assign_approval_policy(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/approval-policy/assignment',
+                                     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(BlueprintApiAssignApprovalPolicyResponse.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 approval policy assignments in force at the given scope, so a
+    # caller can tell whether a deployment it is about to trigger will require
+    # approval.
+    # @param [String] scope Required parameter: TODO: type description here
+    # @param [String] scope_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def templates_get_approval_policy_by_scope(scope,
+                                               scope_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/approval-policy/{scope}/{scopeId}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(scope, key: 'scope')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .template_param(new_parameter(scope_id, key: 'scopeId')
+                                    .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(BlueprintApiApprovalPolicyTemplateWithScope.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 all approval policies associated with an organization.
+    # @param [String] organization_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def templates_find_all_approval_policies(organization_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/approval-policies',
+                                     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(BlueprintApiFindAllApprovalPoliciesResponse.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/base_api.rb

@@ -0,0 +1,67 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # BaseApi.
+  class BaseApi
+    include CoreLibrary
+    attr_accessor :config, :http_call_back
+
+    def self.user_agent
+      'Ruby-SDK/0.0.1 (OS: {os-info}, Engine: {engine}/{engine-version})'
+    end
+
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
+      }
+    end
+
+    GLOBAL_ERRORS = {
+      'default' => ErrorCase.new
+                            .error_message('HTTP response not OK.')
+                            .exception_type(APIException)
+    }.freeze
+
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
+
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
+    end
+
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
+    end
+  end
+end