ezero-apimatic-sdk 0.0.1

data/lib/env_zero_api/models/organization_api_project_permission.rb

@@ -0,0 +1,69 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # OrganizationApiProjectPermission Model.
+  class OrganizationApiProjectPermission < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :project_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :project_role
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['project_id'] = 'projectId'
+      @_hash['project_role'] = 'projectRole'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(project_id:, project_role:)
+      @project_id = project_id
+      @project_role = project_role
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      project_role = hash.key?('projectRole') ? hash['projectRole'] : nil
+
+      # Create object from extracted values.
+      OrganizationApiProjectPermission.new(project_id: project_id,
+                                           project_role: project_role)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} project_id: #{@project_id}, project_role: #{@project_role}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} project_id: #{@project_id.inspect}, project_role:"\
+      " #{@project_role.inspect}>"
+    end
+  end
+end

data/lib/env_zero_api/models/organization_role.rb

@@ -0,0 +1,36 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # OrganizationRole.
+  class OrganizationRole
+    ORGANIZATION_ROLE = [
+      # TODO: Write general description for ADMIN
+      ADMIN = 'Admin'.freeze,
+
+      # TODO: Write general description for USER
+      USER = 'User'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORGANIZATION_ROLE.include?(value)
+    end
+
+    def self.from_value(value, default_value = ADMIN)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'admin' then ADMIN
+      when 'user' then USER
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/env_zero_api/models/organization_user.rb

@@ -0,0 +1,77 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # OrganizationUser Model.
+  class OrganizationUser < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [User1]
+    attr_accessor :user
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :role
+
+    # TODO: Write general description for this method
+    # @return [OrganizationUserStatus]
+    attr_accessor :status
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['user'] = 'user'
+      @_hash['role'] = 'role'
+      @_hash['status'] = 'status'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      []
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(user:, role:, status:)
+      @user = user
+      @role = role
+      @status = status
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      user = User1.from_hash(hash['user']) if hash['user']
+      role = hash.key?('role') ? hash['role'] : nil
+      status = hash.key?('status') ? hash['status'] : nil
+
+      # Create object from extracted values.
+      OrganizationUser.new(user: user,
+                           role: role,
+                           status: status)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user: #{@user}, role: #{@role}, status: #{@status}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} user: #{@user.inspect}, role: #{@role.inspect}, status:"\
+      " #{@status.inspect}>"
+    end
+  end
+end

data/lib/env_zero_api/models/organization_user_status.rb

@@ -0,0 +1,36 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # OrganizationUserStatus.
+  class OrganizationUserStatus
+    ORGANIZATION_USER_STATUS = [
+      # TODO: Write general description for ACTIVE
+      ACTIVE = 'Active'.freeze,
+
+      # TODO: Write general description for INVITED
+      INVITED = 'Invited'.freeze
+    ].freeze
+
+    def self.validate(value)
+      return false if value.nil?
+
+      ORGANIZATION_USER_STATUS.include?(value)
+    end
+
+    def self.from_value(value, default_value = ACTIVE)
+      return default_value if value.nil?
+
+      str = value.to_s.strip
+
+      case str.downcase
+      when 'active' then ACTIVE
+      when 'invited' then INVITED
+      else
+        default_value
+      end
+    end
+  end
+end

data/lib/env_zero_api/models/output.rb

@@ -0,0 +1,153 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # Output Model.
+  class Output < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :environment_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :name
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_sensitive
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_deleted
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :project_id
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :environment_name
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :project_name
+
+    # TODO: Write general description for this method
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_archived_environment
+
+    # TODO: Write general description for this method
+    # @return [String]
+    attr_accessor :workflow_environment_name
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['id'] = 'id'
+      @_hash['environment_id'] = 'environmentId'
+      @_hash['name'] = 'name'
+      @_hash['is_sensitive'] = 'isSensitive'
+      @_hash['is_deleted'] = 'isDeleted'
+      @_hash['project_id'] = 'projectId'
+      @_hash['environment_name'] = 'environmentName'
+      @_hash['project_name'] = 'projectName'
+      @_hash['is_archived_environment'] = 'isArchivedEnvironment'
+      @_hash['workflow_environment_name'] = 'workflowEnvironmentName'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        id
+        is_deleted
+        workflow_environment_name
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(environment_id:, name:, is_sensitive:, project_id:,
+                   environment_name:, project_name:, is_archived_environment:,
+                   id: SKIP, is_deleted: SKIP, workflow_environment_name: SKIP)
+      @id = id unless id == SKIP
+      @environment_id = environment_id
+      @name = name
+      @is_sensitive = is_sensitive
+      @is_deleted = is_deleted unless is_deleted == SKIP
+      @project_id = project_id
+      @environment_name = environment_name
+      @project_name = project_name
+      @is_archived_environment = is_archived_environment
+      unless workflow_environment_name == SKIP
+        @workflow_environment_name =
+          workflow_environment_name
+      end
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      environment_id = hash.key?('environmentId') ? hash['environmentId'] : nil
+      name = hash.key?('name') ? hash['name'] : nil
+      is_sensitive = hash.key?('isSensitive') ? hash['isSensitive'] : nil
+      project_id = hash.key?('projectId') ? hash['projectId'] : nil
+      environment_name =
+        hash.key?('environmentName') ? hash['environmentName'] : nil
+      project_name = hash.key?('projectName') ? hash['projectName'] : nil
+      is_archived_environment =
+        hash.key?('isArchivedEnvironment') ? hash['isArchivedEnvironment'] : nil
+      id = hash.key?('id') ? hash['id'] : SKIP
+      is_deleted = hash.key?('isDeleted') ? hash['isDeleted'] : SKIP
+      workflow_environment_name =
+        hash.key?('workflowEnvironmentName') ? hash['workflowEnvironmentName'] : SKIP
+
+      # Create object from extracted values.
+      Output.new(environment_id: environment_id,
+                 name: name,
+                 is_sensitive: is_sensitive,
+                 project_id: project_id,
+                 environment_name: environment_name,
+                 project_name: project_name,
+                 is_archived_environment: is_archived_environment,
+                 id: id,
+                 is_deleted: is_deleted,
+                 workflow_environment_name: workflow_environment_name)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id}, environment_id: #{@environment_id}, name: #{@name},"\
+      " is_sensitive: #{@is_sensitive}, is_deleted: #{@is_deleted}, project_id: #{@project_id},"\
+      " environment_name: #{@environment_name}, project_name: #{@project_name},"\
+      " is_archived_environment: #{@is_archived_environment}, workflow_environment_name:"\
+      " #{@workflow_environment_name}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} id: #{@id.inspect}, environment_id: #{@environment_id.inspect}, name:"\
+      " #{@name.inspect}, is_sensitive: #{@is_sensitive.inspect}, is_deleted:"\
+      " #{@is_deleted.inspect}, project_id: #{@project_id.inspect}, environment_name:"\
+      " #{@environment_name.inspect}, project_name: #{@project_name.inspect},"\
+      " is_archived_environment: #{@is_archived_environment.inspect}, workflow_environment_name:"\
+      " #{@workflow_environment_name.inspect}>"
+    end
+  end
+end

data/lib/env_zero_api/models/overwrites.rb

@@ -0,0 +1,206 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # Overwrites Model.
+  class Overwrites < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [ConfigurationScope]
+    attr_accessor :scope
+
+    # The ID of the entity of the provided `scope`. e.g. a project's ID when the
+    # provided `scope` is `PROJECT`.
+    # Inapplicable for `GLOBAL` scope, as it has no specific entity.
+    # @return [String]
+    attr_accessor :scope_id
+
+    # The ID of the entity of the provided `scope`. e.g. a project's ID when the
+    # provided `scope` is `PROJECT`.
+    # Inapplicable for `GLOBAL` scope, as it has no specific entity.
+    # @return [String]
+    attr_accessor :value
+
+    # * type?: "string"
+    # * format: HCL | JSON | ENVIRONMENT_OUTPUT # default: null
+    #     * ENVIRONMENT_OUTPUT is a special type used to indicate that the value
+    # is an output from the environment.
+    #   The value format is: ${env0:<environmentId>:<outputName>} it will be
+    # resolved before deployment.
+    # * enum?: ["option1", "option2"]
+    #     * Optional, for UI dropdown, works only without format. Note that if
+    # you want to update this list, you must provide the full updated list each
+    # time.
+    # @return [PartialJsonSchema72]
+    attr_accessor :schema
+
+    # * type?: "string"
+    # * format: HCL | JSON | ENVIRONMENT_OUTPUT # default: null
+    #     * ENVIRONMENT_OUTPUT is a special type used to indicate that the value
+    # is an output from the environment.
+    #   The value format is: ${env0:<environmentId>:<outputName>} it will be
+    # resolved before deployment.
+    # * enum?: ["option1", "option2"]
+    #     * Optional, for UI dropdown, works only without format. Note that if
+    # you want to update this list, you must provide the full updated list each
+    # time.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_readonly
+
+    # * type?: "string"
+    # * format: HCL | JSON | ENVIRONMENT_OUTPUT # default: null
+    #     * ENVIRONMENT_OUTPUT is a special type used to indicate that the value
+    # is an output from the environment.
+    #   The value format is: ${env0:<environmentId>:<outputName>} it will be
+    # resolved before deployment.
+    # * enum?: ["option1", "option2"]
+    #     * Optional, for UI dropdown, works only without format. Note that if
+    # you want to update this list, you must provide the full updated list each
+    # time.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_required
+
+    # * type?: "string"
+    # * format: HCL | JSON | ENVIRONMENT_OUTPUT # default: null
+    #     * ENVIRONMENT_OUTPUT is a special type used to indicate that the value
+    # is an output from the environment.
+    #   The value format is: ${env0:<environmentId>:<outputName>} it will be
+    # resolved before deployment.
+    # * enum?: ["option1", "option2"]
+    #     * Optional, for UI dropdown, works only without format. Note that if
+    # you want to update this list, you must provide the full updated list each
+    # time.
+    # @return [TrueClass | FalseClass]
+    attr_accessor :is_sensitive
+
+    # * type?: "string"
+    # * format: HCL | JSON | ENVIRONMENT_OUTPUT # default: null
+    #     * ENVIRONMENT_OUTPUT is a special type used to indicate that the value
+    # is an output from the environment.
+    #   The value format is: ${env0:<environmentId>:<outputName>} it will be
+    # resolved before deployment.
+    # * enum?: ["option1", "option2"]
+    #     * Optional, for UI dropdown, works only without format. Note that if
+    # you want to update this list, you must provide the full updated list each
+    # time.
+    # @return [String]
+    attr_accessor :regex
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['scope'] = 'scope'
+      @_hash['scope_id'] = 'scopeId'
+      @_hash['value'] = 'value'
+      @_hash['schema'] = 'schema'
+      @_hash['is_readonly'] = 'isReadonly'
+      @_hash['is_required'] = 'isRequired'
+      @_hash['is_sensitive'] = 'isSensitive'
+      @_hash['regex'] = 'regex'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        scope_id
+        value
+        schema
+        is_readonly
+        is_required
+        is_sensitive
+        regex
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(scope:, scope_id: SKIP, value: SKIP, schema: SKIP,
+                   is_readonly: SKIP, is_required: SKIP, is_sensitive: SKIP,
+                   regex: SKIP, additional_properties: nil)
+      # Add additional model properties to the instance
+      additional_properties = {} if additional_properties.nil?
+
+      @scope = scope
+      @scope_id = scope_id unless scope_id == SKIP
+      @value = value unless value == SKIP
+      @schema = schema unless schema == SKIP
+      @is_readonly = is_readonly unless is_readonly == SKIP
+      @is_required = is_required unless is_required == SKIP
+      @is_sensitive = is_sensitive unless is_sensitive == SKIP
+      @regex = regex unless regex == SKIP
+      @additional_properties = additional_properties
+    end
+
+    # Creates an instance of the object from a hash.
+    def self.from_hash(hash)
+      return nil unless hash
+
+      # Extract variables from the hash.
+      scope = hash.key?('scope') ? hash['scope'] : nil
+      scope_id = hash.key?('scopeId') ? hash['scopeId'] : SKIP
+      value = hash.key?('value') ? hash['value'] : SKIP
+      schema = PartialJsonSchema72.from_hash(hash['schema']) if hash['schema']
+      is_readonly = hash.key?('isReadonly') ? hash['isReadonly'] : SKIP
+      is_required = hash.key?('isRequired') ? hash['isRequired'] : SKIP
+      is_sensitive = hash.key?('isSensitive') ? hash['isSensitive'] : SKIP
+      regex = hash.key?('regex') ? hash['regex'] : SKIP
+
+      # Create a new hash for additional properties, removing known properties.
+      new_hash = hash.reject { |k, _| names.value?(k) }
+
+      additional_properties = APIHelper.get_additional_properties(
+        new_hash, proc { |value| value }
+      )
+
+      # Create object from extracted values.
+      Overwrites.new(scope: scope,
+                     scope_id: scope_id,
+                     value: value,
+                     schema: schema,
+                     is_readonly: is_readonly,
+                     is_required: is_required,
+                     is_sensitive: is_sensitive,
+                     regex: regex,
+                     additional_properties: additional_properties)
+    end
+
+    # Validates an instance of the object from a given value.
+    # @param [Overwrites | Hash] The value against the validation is performed.
+    def self.validate(value)
+      if value.instance_of? self
+        return APIHelper.valid_type?(value.scope,
+                                     ->(val) { ConfigurationScope.validate(val) })
+      end
+
+      return false unless value.instance_of? Hash
+
+      APIHelper.valid_type?(value['scope'],
+                            ->(val) { ConfigurationScope.validate(val) })
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scope: #{@scope}, scope_id: #{@scope_id}, value: #{@value}, schema:"\
+      " #{@schema}, is_readonly: #{@is_readonly}, is_required: #{@is_required}, is_sensitive:"\
+      " #{@is_sensitive}, regex: #{@regex}, additional_properties: #{@additional_properties}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} scope: #{@scope.inspect}, scope_id: #{@scope_id.inspect}, value:"\
+      " #{@value.inspect}, schema: #{@schema.inspect}, is_readonly: #{@is_readonly.inspect},"\
+      " is_required: #{@is_required.inspect}, is_sensitive: #{@is_sensitive.inspect}, regex:"\
+      " #{@regex.inspect}, additional_properties: #{@additional_properties}>"
+    end
+  end
+end

data/lib/env_zero_api/models/partial_json_schema7.rb

@@ -0,0 +1,81 @@
+# env_zero_api
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module EnvZeroApi
+  # PartialJsonSchema7 Model.
+  class PartialJsonSchema7 < BaseModel
+    SKIP = Object.new
+    private_constant :SKIP
+
+    # TODO: Write general description for this method
+    # @return [Type]
+    attr_accessor :type
+
+    # TODO: Write general description for this method
+    # @return [Array[String]]
+    attr_accessor :enum
+
+    # TODO: Write general description for this method
+    # @return [Format]
+    attr_accessor :format
+
+    # A mapping from model property names to API property names.
+    def self.names
+      @_hash = {} if @_hash.nil?
+      @_hash['type'] = 'type'
+      @_hash['enum'] = 'enum'
+      @_hash['format'] = 'format'
+      @_hash
+    end
+
+    # An array for optional fields
+    def self.optionals
+      %w[
+        type
+        enum
+        format
+      ]
+    end
+
+    # An array for nullable fields
+    def self.nullables
+      []
+    end
+
+    def initialize(type: SKIP, enum: SKIP, format: SKIP)
+      @type = type unless type == SKIP
+      @enum = enum unless enum == SKIP
+      @format = format unless format == 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.
+      type = hash.key?('type') ? hash['type'] : SKIP
+      enum = hash.key?('enum') ? hash['enum'] : SKIP
+      format = hash.key?('format') ? hash['format'] : SKIP
+
+      # Create object from extracted values.
+      PartialJsonSchema7.new(type: type,
+                             enum: enum,
+                             format: format)
+    end
+
+    # Provides a human-readable string representation of the object.
+    def to_s
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type}, enum: #{@enum}, format: #{@format}>"
+    end
+
+    # Provides a debugging-friendly string with detailed object information.
+    def inspect
+      class_name = self.class.name.split('::').last
+      "<#{class_name} type: #{@type.inspect}, enum: #{@enum.inspect}, format:"\
+      " #{@format.inspect}>"
+    end
+  end
+end