ezero-apimatic-sdk 0.0.1

data/lib/env_zero_api/models/environment_api_deploy_request_body.rb

@@ -0,0 +1,343 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # EnvironmentApiDeployRequestBody Model.
+  class EnvironmentApiDeployRequestBody < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :workflow_deployment_id
+
+    # TODO: Write general description for this method
+    # @return [DeploymentType1]
+    attr_accessor :deployment_type
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :blueprint_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :blueprint_revision
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :blueprint_repository
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [Object]
+    attr_accessor :configuration_changes
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [EnvironmentApiConfigurationSetChanges]
+    attr_accessor :configuration_set_changes
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [EnvironmentApiTtlRequest]
+    attr_accessor :ttl
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [String]
+    attr_accessor :env_name
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :user_requires_approval
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [Array[String]]
+    attr_accessor :targets
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [CustomEnv0EnvironmentVariables]
+    attr_accessor :custom_env0_environment_variables
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [GitUserData]
+    attr_accessor :git_user_data
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [String]
+    attr_accessor :comment
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [Object]
+    attr_accessor :trigger_name
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [String]
+    attr_accessor :upstream_environment_id
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [String]
+    attr_accessor :task_payload
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [Hash[String, WorkflowSubEnvironmentRequest]]
+    attr_accessor :sub_environments
+
+    # Manage variables in the environment. Either a single variable or an array
+    # of variables.
+    # @return [EnvironmentApiAutoDriftRemediationStrategy]
+    attr_accessor :auto_drift_remediation_strategy
+
+    # [Optional] Only applicable when running a Workflow Environment.
+    # Allows to run a partial Workflow, starting from a specific point in the
+    # pipeline.
+    # Or run a single sub-environment deploy/destroy.
+    # @return [WorkflowDeploymentOptions1]
+    attr_accessor :workflow_deployment_options
+
+    # [Optional] Only applicable when running a Workflow Environment.
+    # Allows to run a partial Workflow, starting from a specific point in the
+    # pipeline.
+    # Or run a single sub-environment deploy/destroy.
+    # @return [String]
+    attr_accessor :sub_environment_alias
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['workflow_deployment_id'] = 'workflowDeploymentId'
+      @_hash['deployment_type'] = 'deploymentType'
+      @_hash['blueprint_id'] = 'blueprintId'
+      @_hash['blueprint_revision'] = 'blueprintRevision'
+      @_hash['blueprint_repository'] = 'blueprintRepository'
+      @_hash['configuration_changes'] = 'configurationChanges'
+      @_hash['configuration_set_changes'] = 'configurationSetChanges'
+      @_hash['ttl'] = 'ttl'
+      @_hash['env_name'] = 'envName'
+      @_hash['user_requires_approval'] = 'userRequiresApproval'
+      @_hash['targets'] = 'targets'
+      @_hash['custom_env0_environment_variables'] =
+        'customEnv0EnvironmentVariables'
+      @_hash['git_user_data'] = 'gitUserData'
+      @_hash['comment'] = 'comment'
+      @_hash['trigger_name'] = 'triggerName'
+      @_hash['upstream_environment_id'] = 'upstreamEnvironmentId'
+      @_hash['task_payload'] = 'taskPayload'
+      @_hash['sub_environments'] = 'subEnvironments'
+      @_hash['auto_drift_remediation_strategy'] =
+        'autoDriftRemediationStrategy'
+      @_hash['workflow_deployment_options'] = 'workflowDeploymentOptions'
+      @_hash['sub_environment_alias'] = 'subEnvironmentAlias'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        workflow_deployment_id
+        deployment_type
+        blueprint_id
+        blueprint_revision
+        blueprint_repository
+        configuration_changes
+        configuration_set_changes
+        ttl
+        env_name
+        user_requires_approval
+        targets
+        custom_env0_environment_variables
+        git_user_data
+        comment
+        trigger_name
+        upstream_environment_id
+        task_payload
+        sub_environments
+        auto_drift_remediation_strategy
+        workflow_deployment_options
+        sub_environment_alias
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(workflow_deployment_id: SKIP, deployment_type: SKIP,
+                   blueprint_id: SKIP, blueprint_revision: SKIP,
+                   blueprint_repository: SKIP, configuration_changes: SKIP,
+                   configuration_set_changes: SKIP, ttl: SKIP, env_name: SKIP,
+                   user_requires_approval: SKIP, targets: SKIP,
+                   custom_env0_environment_variables: SKIP, git_user_data: SKIP,
+                   comment: SKIP, trigger_name: SKIP,
+                   upstream_environment_id: SKIP, task_payload: SKIP,
+                   sub_environments: SKIP,
+                   auto_drift_remediation_strategy: SKIP,
+                   workflow_deployment_options: SKIP,
+                   sub_environment_alias: SKIP)
+      @workflow_deployment_id = workflow_deployment_id unless workflow_deployment_id == SKIP
+      @deployment_type = deployment_type unless deployment_type == SKIP
+      @blueprint_id = blueprint_id unless blueprint_id == SKIP
+      @blueprint_revision = blueprint_revision unless blueprint_revision == SKIP
+      @blueprint_repository = blueprint_repository unless blueprint_repository == SKIP
+      @configuration_changes = configuration_changes unless configuration_changes == SKIP
+      unless configuration_set_changes == SKIP
+        @configuration_set_changes =
+          configuration_set_changes
+      end
+      @ttl = ttl unless ttl == SKIP
+      @env_name = env_name unless env_name == SKIP
+      @user_requires_approval = user_requires_approval unless user_requires_approval == SKIP
+      @targets = targets unless targets == SKIP
+      unless custom_env0_environment_variables == SKIP
+        @custom_env0_environment_variables =
+          custom_env0_environment_variables
+      end
+      @git_user_data = git_user_data unless git_user_data == SKIP
+      @comment = comment unless comment == SKIP
+      @trigger_name = trigger_name unless trigger_name == SKIP
+      @upstream_environment_id = upstream_environment_id unless upstream_environment_id == SKIP
+      @task_payload = task_payload unless task_payload == SKIP
+      @sub_environments = sub_environments unless sub_environments == SKIP
+      unless auto_drift_remediation_strategy == SKIP
+        @auto_drift_remediation_strategy =
+          auto_drift_remediation_strategy
+      end
+      unless workflow_deployment_options == SKIP
+        @workflow_deployment_options =
+          workflow_deployment_options
+      end
+      @sub_environment_alias = sub_environment_alias unless sub_environment_alias == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      workflow_deployment_id =
+        hash.key?('workflowDeploymentId') ? hash['workflowDeploymentId'] : SKIP
+      deployment_type =
+        hash.key?('deploymentType') ? hash['deploymentType'] : SKIP
+      blueprint_id = hash.key?('blueprintId') ? hash['blueprintId'] : SKIP
+      blueprint_revision =
+        hash.key?('blueprintRevision') ? hash['blueprintRevision'] : SKIP
+      blueprint_repository =
+        hash.key?('blueprintRepository') ? hash['blueprintRepository'] : SKIP
+      configuration_changes = hash.key?('configurationChanges') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:EnvironmentApiDeployRequestBodyConfigurationChanges), hash['configurationChanges']
+      ) : SKIP
+      if hash['configurationSetChanges']
+        configuration_set_changes = EnvironmentApiConfigurationSetChanges.from_hash(hash['configurationSetChanges'])
+      end
+      ttl = EnvironmentApiTtlRequest.from_hash(hash['ttl']) if hash['ttl']
+      env_name = hash.key?('envName') ? hash['envName'] : SKIP
+      user_requires_approval =
+        hash.key?('userRequiresApproval') ? hash['userRequiresApproval'] : SKIP
+      targets = hash.key?('targets') ? hash['targets'] : SKIP
+      if hash['customEnv0EnvironmentVariables']
+        custom_env0_environment_variables = CustomEnv0EnvironmentVariables.from_hash(hash['customEnv0EnvironmentVariables'])
+      end
+      git_user_data = GitUserData.from_hash(hash['gitUserData']) if hash['gitUserData']
+      comment = hash.key?('comment') ? hash['comment'] : SKIP
+      trigger_name = hash.key?('triggerName') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TriggerName), hash['triggerName']
+      ) : SKIP
+      upstream_environment_id =
+        hash.key?('upstreamEnvironmentId') ? hash['upstreamEnvironmentId'] : SKIP
+      task_payload = hash.key?('taskPayload') ? hash['taskPayload'] : SKIP
+      sub_environments = WorkflowSubEnvironmentRequest.from_hash(hash['subEnvironments']) if
+        hash['subEnvironments']
+
+      sub_environments = SKIP unless hash.key?('subEnvironments')
+      auto_drift_remediation_strategy =
+        hash.key?('autoDriftRemediationStrategy') ? hash['autoDriftRemediationStrategy'] : SKIP
+      if hash['workflowDeploymentOptions']
+        workflow_deployment_options = WorkflowDeploymentOptions1.from_hash(hash['workflowDeploymentOptions'])
+      end
+      sub_environment_alias =
+        hash.key?('subEnvironmentAlias') ? hash['subEnvironmentAlias'] : SKIP
+
+      # Create object from extracted values.
+      EnvironmentApiDeployRequestBody.new(workflow_deployment_id: workflow_deployment_id,
+                                          deployment_type: deployment_type,
+                                          blueprint_id: blueprint_id,
+                                          blueprint_revision: blueprint_revision,
+                                          blueprint_repository: blueprint_repository,
+                                          configuration_changes: configuration_changes,
+                                          configuration_set_changes: configuration_set_changes,
+                                          ttl: ttl,
+                                          env_name: env_name,
+                                          user_requires_approval: user_requires_approval,
+                                          targets: targets,
+                                          custom_env0_environment_variables: custom_env0_environment_variables,
+                                          git_user_data: git_user_data,
+                                          comment: comment,
+                                          trigger_name: trigger_name,
+                                          upstream_environment_id: upstream_environment_id,
+                                          task_payload: task_payload,
+                                          sub_environments: sub_environments,
+                                          auto_drift_remediation_strategy: auto_drift_remediation_strategy,
+                                          workflow_deployment_options: workflow_deployment_options,
+                                          sub_environment_alias: sub_environment_alias)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EnvironmentApiDeployRequestBody | Hash] The value against the validation is performed.
+    def self.validate(value)
+      return true if value.instance_of? self
+
+      return false unless value.instance_of? Hash
+
+      true
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} workflow_deployment_id: #{@workflow_deployment_id}, deployment_type:"\
+      " #{@deployment_type}, blueprint_id: #{@blueprint_id}, blueprint_revision:"\
+      " #{@blueprint_revision}, blueprint_repository: #{@blueprint_repository},"\
+      " configuration_changes: #{@configuration_changes}, configuration_set_changes:"\
+      " #{@configuration_set_changes}, ttl: #{@ttl}, env_name: #{@env_name},"\
+      " user_requires_approval: #{@user_requires_approval}, targets: #{@targets},"\
+      " custom_env0_environment_variables: #{@custom_env0_environment_variables}, git_user_data:"\
+      " #{@git_user_data}, comment: #{@comment}, trigger_name: #{@trigger_name},"\
+      " upstream_environment_id: #{@upstream_environment_id}, task_payload: #{@task_payload},"\
+      " sub_environments: #{@sub_environments}, auto_drift_remediation_strategy:"\
+      " #{@auto_drift_remediation_strategy}, workflow_deployment_options:"\
+      " #{@workflow_deployment_options}, sub_environment_alias: #{@sub_environment_alias}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} workflow_deployment_id: #{@workflow_deployment_id.inspect},"\
+      " deployment_type: #{@deployment_type.inspect}, blueprint_id: #{@blueprint_id.inspect},"\
+      " blueprint_revision: #{@blueprint_revision.inspect}, blueprint_repository:"\
+      " #{@blueprint_repository.inspect}, configuration_changes:"\
+      " #{@configuration_changes.inspect}, configuration_set_changes:"\
+      " #{@configuration_set_changes.inspect}, ttl: #{@ttl.inspect}, env_name:"\
+      " #{@env_name.inspect}, user_requires_approval: #{@user_requires_approval.inspect}, targets:"\
+      " #{@targets.inspect}, custom_env0_environment_variables:"\
+      " #{@custom_env0_environment_variables.inspect}, git_user_data: #{@git_user_data.inspect},"\
+      " comment: #{@comment.inspect}, trigger_name: #{@trigger_name.inspect},"\
+      " upstream_environment_id: #{@upstream_environment_id.inspect}, task_payload:"\
+      " #{@task_payload.inspect}, sub_environments: #{@sub_environments.inspect},"\
+      " auto_drift_remediation_strategy: #{@auto_drift_remediation_strategy.inspect},"\
+      " workflow_deployment_options: #{@workflow_deployment_options.inspect},"\
+      " sub_environment_alias: #{@sub_environment_alias.inspect}>"
+    end
+  end
+end

data/lib/env_zero_api/models/environment_api_deploy_request_on_create_flow.rb

@@ -0,0 +1,154 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # EnvironmentApiDeployRequestOnCreateFlow Model.
+  class EnvironmentApiDeployRequestOnCreateFlow < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :blueprint_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :blueprint_revision
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :comment
+
+    # TODO: Write general description for this method
+    # @return [Object]
+    attr_accessor :trigger_name
+
+    # TODO: Write general description for this method
+    # @return [Hash[String, WorkflowSubEnvironmentRequest]]
+    attr_accessor :sub_environments
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :targets
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :blueprint_repository
+
+    # TODO: Write general description for this method
+    # @return [GitUserData]
+    attr_accessor :git_user_data
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['blueprint_id'] = 'blueprintId'
+      @_hash['blueprint_revision'] = 'blueprintRevision'
+      @_hash['comment'] = 'comment'
+      @_hash['trigger_name'] = 'triggerName'
+      @_hash['sub_environments'] = 'subEnvironments'
+      @_hash['targets'] = 'targets'
+      @_hash['blueprint_repository'] = 'blueprintRepository'
+      @_hash['git_user_data'] = 'gitUserData'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        blueprint_revision
+        comment
+        trigger_name
+        sub_environments
+        targets
+        blueprint_repository
+        git_user_data
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(blueprint_id:, blueprint_revision: SKIP, comment: SKIP,
+                   trigger_name: SKIP, sub_environments: SKIP, targets: SKIP,
+                   blueprint_repository: SKIP, git_user_data: SKIP)
+      @blueprint_id = blueprint_id
+      @blueprint_revision = blueprint_revision unless blueprint_revision == SKIP
+      @comment = comment unless comment == SKIP
+      @trigger_name = trigger_name unless trigger_name == SKIP
+      @sub_environments = sub_environments unless sub_environments == SKIP
+      @targets = targets unless targets == SKIP
+      @blueprint_repository = blueprint_repository unless blueprint_repository == SKIP
+      @git_user_data = git_user_data unless git_user_data == SKIP
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      blueprint_id = hash.key?('blueprintId') ? hash['blueprintId'] : nil
+      blueprint_revision =
+        hash.key?('blueprintRevision') ? hash['blueprintRevision'] : SKIP
+      comment = hash.key?('comment') ? hash['comment'] : SKIP
+      trigger_name = hash.key?('triggerName') ? APIHelper.deserialize_union_type(
+        UnionTypeLookUp.get(:TriggerName), hash['triggerName']
+      ) : SKIP
+      sub_environments = WorkflowSubEnvironmentRequest.from_hash(hash['subEnvironments']) if
+        hash['subEnvironments']
+
+      sub_environments = SKIP unless hash.key?('subEnvironments')
+      targets = hash.key?('targets') ? hash['targets'] : SKIP
+      blueprint_repository =
+        hash.key?('blueprintRepository') ? hash['blueprintRepository'] : SKIP
+      git_user_data = GitUserData.from_hash(hash['gitUserData']) if hash['gitUserData']
+
+      # Create object from extracted values.
+      EnvironmentApiDeployRequestOnCreateFlow.new(blueprint_id: blueprint_id,
+                                                  blueprint_revision: blueprint_revision,
+                                                  comment: comment,
+                                                  trigger_name: trigger_name,
+                                                  sub_environments: sub_environments,
+                                                  targets: targets,
+                                                  blueprint_repository: blueprint_repository,
+                                                  git_user_data: git_user_data)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [EnvironmentApiDeployRequestOnCreateFlow | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.blueprint_id,
+                                     ->(val) { val.instance_of? String })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['blueprintId'],
+                            ->(val) { val.instance_of? String })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} blueprint_id: #{@blueprint_id}, blueprint_revision: #{@blueprint_revision},"\
+      " comment: #{@comment}, trigger_name: #{@trigger_name}, sub_environments:"\
+      " #{@sub_environments}, targets: #{@targets}, blueprint_repository:"\
+      " #{@blueprint_repository}, git_user_data: #{@git_user_data}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} blueprint_id: #{@blueprint_id.inspect}, blueprint_revision:"\
+      " #{@blueprint_revision.inspect}, comment: #{@comment.inspect}, trigger_name:"\
+      " #{@trigger_name.inspect}, sub_environments: #{@sub_environments.inspect}, targets:"\
+      " #{@targets.inspect}, blueprint_repository: #{@blueprint_repository.inspect},"\
+      " git_user_data: #{@git_user_data.inspect}>"
+    end
+  end
+end