openlayer 0.14.1 → 0.16.0

data/lib/openlayer/models/governance/frameworks/document_retrieve_response.rb

@@ -0,0 +1,561 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      module Frameworks
+        # @see Openlayer::Resources::Governance::Frameworks::Documents#retrieve
+        class DocumentRetrieveResponse < Openlayer::Internal::Type::BaseModel
+          # @!attribute title
+          #   The document title.
+          #
+          #   @return [String]
+          required :title, String
+
+          response_only do
+            # @!attribute id
+            #   The document id.
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute date_created
+            #   The creation date.
+            #
+            #   @return [Time]
+            required :date_created, Time, api_name: :dateCreated
+
+            # @!attribute date_updated
+            #   The last update date.
+            #
+            #   @return [Time]
+            required :date_updated, Time, api_name: :dateUpdated
+
+            # @!attribute framework_id
+            #   The framework the document belongs to.
+            #
+            #   @return [String]
+            required :framework_id, String, api_name: :frameworkId
+
+            # @!attribute sections
+            #   The document's sections, in display order. Only returned when retrieving a
+            #   single document.
+            #
+            #   @return [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section>, nil]
+            optional :sections,
+                     -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section] }
+          end
+
+          # @!method initialize(id:, date_created:, date_updated:, framework_id:, title:, sections: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse} for more
+          #   details.
+          #
+          #   @param id [String] The document id.
+          #
+          #   @param date_created [Time] The creation date.
+          #
+          #   @param date_updated [Time] The last update date.
+          #
+          #   @param framework_id [String] The framework the document belongs to.
+          #
+          #   @param title [String] The document title.
+          #
+          #   @param sections [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section>] The document's sections, in display order. Only returned when retrieving a singl
+
+          class Section < Openlayer::Internal::Type::BaseModel
+            # @!attribute number
+            #   The section number as it appears in the source standard.
+            #
+            #   @return [String]
+            required :number, String
+
+            # @!attribute sort_order
+            #   The position of the section within the document.
+            #
+            #   @return [Integer]
+            required :sort_order, Integer, api_name: :sortOrder
+
+            # @!attribute title
+            #   The section title.
+            #
+            #   @return [String]
+            required :title, String
+
+            # @!attribute text
+            #   The section text.
+            #
+            #   @return [String, nil]
+            optional :text, String, nil?: true
+
+            response_only do
+              # @!attribute id
+              #   The section id.
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute document_id
+              #   The document the section belongs to.
+              #
+              #   @return [String]
+              required :document_id, String, api_name: :documentId
+
+              # @!attribute rule_count
+              #   How many rules are linked to this section, including its subsections. Use it to
+              #   decide whether to fetch the section's rules.
+              #
+              #   @return [Integer, nil]
+              optional :rule_count, Integer, api_name: :ruleCount
+
+              # @!attribute rules
+              #   The rules linked directly to this section.
+              #
+              #   @return [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule>, nil]
+              optional :rules,
+                       -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule] }
+
+              # @!attribute subsections
+              #   The section's subsections, in display order.
+              #
+              #   @return [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection>, nil]
+              optional :subsections,
+                       -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection] }
+            end
+
+            # @!method initialize(id:, document_id:, number:, sort_order:, title:, rule_count: nil, rules: nil, subsections: nil, text: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section}
+            #   for more details.
+            #
+            #   @param id [String] The section id.
+            #
+            #   @param document_id [String] The document the section belongs to.
+            #
+            #   @param number [String] The section number as it appears in the source standard.
+            #
+            #   @param sort_order [Integer] The position of the section within the document.
+            #
+            #   @param title [String] The section title.
+            #
+            #   @param rule_count [Integer] How many rules are linked to this section, including its subsections. Use it to
+            #
+            #   @param rules [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule>] The rules linked directly to this section.
+            #
+            #   @param subsections [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection>] The section's subsections, in display order.
+            #
+            #   @param text [String, nil] The section text.
+
+            class Rule < Openlayer::Internal::Type::BaseModel
+              # @!attribute name
+              #   The rule name.
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!attribute scope
+              #   Whether the rule is evaluated once for the whole workspace, or once per project
+              #   the rule's frameworks apply to.
+              #
+              #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Scope]
+              required :scope,
+                       enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Scope }
+
+              # @!attribute type
+              #   `platform` rules are evaluated automatically from the state of your Openlayer
+              #   workspace. `evidence` rules are satisfied by attaching evidence.
+              #
+              #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Type]
+              required :type,
+                       enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Type }
+
+              # @!attribute automation_params
+              #   Configuration for the platform check, when the automation takes parameters.
+              #
+              #   @return [Hash{Symbol=>Object}, nil]
+              optional :automation_params,
+                       Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
+                       api_name: :automationParams,
+                       nil?: true
+
+              # @!attribute automation_type
+              #   Which workspace signal a platform rule checks, for example
+              #   `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
+              #   evidence rules.
+              #
+              #   @return [String, nil]
+              optional :automation_type, String, api_name: :automationType, nil?: true
+
+              # @!attribute deactivated
+              #   Whether the rule is excluded from compliance calculations.
+              #
+              #   @return [Boolean, nil]
+              optional :deactivated, Openlayer::Internal::Type::Boolean
+
+              # @!attribute description
+              #   What the rule requires.
+              #
+              #   @return [String, nil]
+              optional :description, String, nil?: true
+
+              # @!attribute evidence_type
+              #   The kind of evidence that satisfies the rule. `null` for platform rules.
+              #
+              #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::EvidenceType, nil]
+              optional :evidence_type,
+                       enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::EvidenceType },
+                       api_name: :evidenceType,
+                       nil?: true
+
+              # @!attribute renewal_cadence_days
+              #   How often evidence must be renewed, in days. Once evidence is older than this,
+              #   the rule result becomes `due_soon` and then `failing`.
+              #
+              #   @return [Integer, nil]
+              optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true
+
+              response_only do
+                # @!attribute id
+                #   The rule id.
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute date_created
+                #   The creation date.
+                #
+                #   @return [Time, nil]
+                optional :date_created, Time, api_name: :dateCreated
+
+                # @!attribute date_updated
+                #   The last update date.
+                #
+                #   @return [Time, nil]
+                optional :date_updated, Time, api_name: :dateUpdated
+
+                # @!attribute immutable
+                #   Whether the rule is managed by Openlayer and cannot be edited.
+                #
+                #   @return [Boolean, nil]
+                optional :immutable, Openlayer::Internal::Type::Boolean
+              end
+
+              # @!method initialize(id:, name:, scope:, type:, automation_params: nil, automation_type: nil, date_created: nil, date_updated: nil, deactivated: nil, description: nil, evidence_type: nil, immutable: nil, renewal_cadence_days: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule}
+              #   for more details.
+              #
+              #   @param id [String] The rule id.
+              #
+              #   @param name [String] The rule name.
+              #
+              #   @param scope [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
+              #
+              #   @param type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
+              #
+              #   @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters.
+              #
+              #   @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
+              #
+              #   @param date_created [Time] The creation date.
+              #
+              #   @param date_updated [Time] The last update date.
+              #
+              #   @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
+              #
+              #   @param description [String, nil] What the rule requires.
+              #
+              #   @param evidence_type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule::EvidenceType, nil] The kind of evidence that satisfies the rule. `null` for platform rules.
+              #
+              #   @param immutable [Boolean] Whether the rule is managed by Openlayer and cannot be edited.
+              #
+              #   @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
+
+              # Whether the rule is evaluated once for the whole workspace, or once per project
+              # the rule's frameworks apply to.
+              #
+              # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule#scope
+              module Scope
+                extend Openlayer::Internal::Type::Enum
+
+                PROJECT = :project
+                WORKSPACE = :workspace
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # `platform` rules are evaluated automatically from the state of your Openlayer
+              # workspace. `evidence` rules are satisfied by attaching evidence.
+              #
+              # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule#type
+              module Type
+                extend Openlayer::Internal::Type::Enum
+
+                PLATFORM = :platform
+                EVIDENCE = :evidence
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+
+              # The kind of evidence that satisfies the rule. `null` for platform rules.
+              #
+              # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Rule#evidence_type
+              module EvidenceType
+                extend Openlayer::Internal::Type::Enum
+
+                DOCUMENT = :document
+                TEXT = :text
+                URL = :url
+                CATEGORY_VALUE = :categoryValue
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class Subsection < Openlayer::Internal::Type::BaseModel
+              # @!attribute number
+              #   The subsection number as it appears in the source standard.
+              #
+              #   @return [String]
+              required :number, String
+
+              # @!attribute sort_order
+              #   The position of the subsection within its section.
+              #
+              #   @return [Integer]
+              required :sort_order, Integer, api_name: :sortOrder
+
+              # @!attribute title
+              #   The subsection title.
+              #
+              #   @return [String]
+              required :title, String
+
+              # @!attribute text
+              #   The subsection text. This is the requirement your rules are mapped against.
+              #
+              #   @return [String, nil]
+              optional :text, String, nil?: true
+
+              response_only do
+                # @!attribute id
+                #   The subsection id.
+                #
+                #   @return [String]
+                required :id, String
+
+                # @!attribute section_id
+                #   The section the subsection belongs to.
+                #
+                #   @return [String]
+                required :section_id, String, api_name: :sectionId
+
+                # @!attribute rule_count
+                #   How many rules are linked to this subsection.
+                #
+                #   @return [Integer, nil]
+                optional :rule_count, Integer, api_name: :ruleCount
+
+                # @!attribute rules
+                #   The rules linked to this subsection.
+                #
+                #   @return [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule>, nil]
+                optional :rules,
+                         -> { Openlayer::Internal::Type::ArrayOf[Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule] }
+              end
+
+              # @!method initialize(id:, number:, section_id:, sort_order:, title:, rule_count: nil, rules: nil, text: nil)
+              #   @param id [String] The subsection id.
+              #
+              #   @param number [String] The subsection number as it appears in the source standard.
+              #
+              #   @param section_id [String] The section the subsection belongs to.
+              #
+              #   @param sort_order [Integer] The position of the subsection within its section.
+              #
+              #   @param title [String] The subsection title.
+              #
+              #   @param rule_count [Integer] How many rules are linked to this subsection.
+              #
+              #   @param rules [Array<Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule>] The rules linked to this subsection.
+              #
+              #   @param text [String, nil] The subsection text. This is the requirement your rules are mapped against.
+
+              class Rule < Openlayer::Internal::Type::BaseModel
+                # @!attribute name
+                #   The rule name.
+                #
+                #   @return [String]
+                required :name, String
+
+                # @!attribute scope
+                #   Whether the rule is evaluated once for the whole workspace, or once per project
+                #   the rule's frameworks apply to.
+                #
+                #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Scope]
+                required :scope,
+                         enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Scope }
+
+                # @!attribute type
+                #   `platform` rules are evaluated automatically from the state of your Openlayer
+                #   workspace. `evidence` rules are satisfied by attaching evidence.
+                #
+                #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Type]
+                required :type,
+                         enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Type }
+
+                # @!attribute automation_params
+                #   Configuration for the platform check, when the automation takes parameters.
+                #
+                #   @return [Hash{Symbol=>Object}, nil]
+                optional :automation_params,
+                         Openlayer::Internal::Type::HashOf[Openlayer::Internal::Type::Unknown],
+                         api_name: :automationParams,
+                         nil?: true
+
+                # @!attribute automation_type
+                #   Which workspace signal a platform rule checks, for example
+                #   `monitoring_mode_enabled`, `test_setup`, or `project_owner_set`. `null` for
+                #   evidence rules.
+                #
+                #   @return [String, nil]
+                optional :automation_type, String, api_name: :automationType, nil?: true
+
+                # @!attribute deactivated
+                #   Whether the rule is excluded from compliance calculations.
+                #
+                #   @return [Boolean, nil]
+                optional :deactivated, Openlayer::Internal::Type::Boolean
+
+                # @!attribute description
+                #   What the rule requires.
+                #
+                #   @return [String, nil]
+                optional :description, String, nil?: true
+
+                # @!attribute evidence_type
+                #   The kind of evidence that satisfies the rule. `null` for platform rules.
+                #
+                #   @return [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::EvidenceType, nil]
+                optional :evidence_type,
+                         enum: -> { Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::EvidenceType },
+                         api_name: :evidenceType,
+                         nil?: true
+
+                # @!attribute renewal_cadence_days
+                #   How often evidence must be renewed, in days. Once evidence is older than this,
+                #   the rule result becomes `due_soon` and then `failing`.
+                #
+                #   @return [Integer, nil]
+                optional :renewal_cadence_days, Integer, api_name: :renewalCadenceDays, nil?: true
+
+                response_only do
+                  # @!attribute id
+                  #   The rule id.
+                  #
+                  #   @return [String]
+                  required :id, String
+
+                  # @!attribute date_created
+                  #   The creation date.
+                  #
+                  #   @return [Time, nil]
+                  optional :date_created, Time, api_name: :dateCreated
+
+                  # @!attribute date_updated
+                  #   The last update date.
+                  #
+                  #   @return [Time, nil]
+                  optional :date_updated, Time, api_name: :dateUpdated
+
+                  # @!attribute immutable
+                  #   Whether the rule is managed by Openlayer and cannot be edited.
+                  #
+                  #   @return [Boolean, nil]
+                  optional :immutable, Openlayer::Internal::Type::Boolean
+                end
+
+                # @!method initialize(id:, name:, scope:, type:, automation_params: nil, automation_type: nil, date_created: nil, date_updated: nil, deactivated: nil, description: nil, evidence_type: nil, immutable: nil, renewal_cadence_days: nil)
+                #   Some parameter documentations has been truncated, see
+                #   {Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule}
+                #   for more details.
+                #
+                #   @param id [String] The rule id.
+                #
+                #   @param name [String] The rule name.
+                #
+                #   @param scope [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Scope] Whether the rule is evaluated once for the whole workspace, or once per project
+                #
+                #   @param type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::Type] `platform` rules are evaluated automatically from the state of your Openlayer wo
+                #
+                #   @param automation_params [Hash{Symbol=>Object}, nil] Configuration for the platform check, when the automation takes parameters.
+                #
+                #   @param automation_type [String, nil] Which workspace signal a platform rule checks, for example `monitoring_mode_enab
+                #
+                #   @param date_created [Time] The creation date.
+                #
+                #   @param date_updated [Time] The last update date.
+                #
+                #   @param deactivated [Boolean] Whether the rule is excluded from compliance calculations.
+                #
+                #   @param description [String, nil] What the rule requires.
+                #
+                #   @param evidence_type [Symbol, Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule::EvidenceType, nil] The kind of evidence that satisfies the rule. `null` for platform rules.
+                #
+                #   @param immutable [Boolean] Whether the rule is managed by Openlayer and cannot be edited.
+                #
+                #   @param renewal_cadence_days [Integer, nil] How often evidence must be renewed, in days. Once evidence is older than this, t
+
+                # Whether the rule is evaluated once for the whole workspace, or once per project
+                # the rule's frameworks apply to.
+                #
+                # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule#scope
+                module Scope
+                  extend Openlayer::Internal::Type::Enum
+
+                  PROJECT = :project
+                  WORKSPACE = :workspace
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+
+                # `platform` rules are evaluated automatically from the state of your Openlayer
+                # workspace. `evidence` rules are satisfied by attaching evidence.
+                #
+                # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule#type
+                module Type
+                  extend Openlayer::Internal::Type::Enum
+
+                  PLATFORM = :platform
+                  EVIDENCE = :evidence
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+
+                # The kind of evidence that satisfies the rule. `null` for platform rules.
+                #
+                # @see Openlayer::Models::Governance::Frameworks::DocumentRetrieveResponse::Section::Subsection::Rule#evidence_type
+                module EvidenceType
+                  extend Openlayer::Internal::Type::Enum
+
+                  DOCUMENT = :document
+                  TEXT = :text
+                  URL = :url
+                  CATEGORY_VALUE = :categoryValue
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openlayer/models/governance/frameworks/section_list_rules_params.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+module Openlayer
+  module Models
+    module Governance
+      module Frameworks
+        # @see Openlayer::Resources::Governance::Frameworks::Sections#list_rules
+        class SectionListRulesParams < Openlayer::Internal::Type::BaseModel
+          extend Openlayer::Internal::Type::RequestParameters::Converter
+          include Openlayer::Internal::Type::RequestParameters
+
+          # @!attribute framework_id
+          #
+          #   @return [String]
+          required :framework_id, String
+
+          # @!attribute section_id
+          #
+          #   @return [String]
+          required :section_id, String
+
+          # @!attribute include_results
+          #   Whether to include each rule's results inline, in a `results` array.
+          #
+          #   @return [Boolean, nil]
+          optional :include_results, Openlayer::Internal::Type::Boolean
+
+          # @!attribute include_subsection_rules
+          #   Whether to also include the rules mapped to the section's subsections.
+          #
+          #   @return [Boolean, nil]
+          optional :include_subsection_rules, Openlayer::Internal::Type::Boolean
+
+          # @!attribute page
+          #   The page to return in a paginated query.
+          #
+          #   @return [Integer, nil]
+          optional :page, Integer
+
+          # @!attribute per_page
+          #   Maximum number of items to return per page.
+          #
+          #   @return [Integer, nil]
+          optional :per_page, Integer
+
+          # @!attribute project_id
+          #   Only include items that apply to this project.
+          #
+          #   @return [String, nil]
+          optional :project_id, String
+
+          # @!attribute status
+          #   Only include items whose rule result has this compliance status.
+          #
+          #   @return [Symbol, Openlayer::Models::Governance::Frameworks::SectionListRulesParams::Status, nil]
+          optional :status, enum: -> { Openlayer::Governance::Frameworks::SectionListRulesParams::Status }
+
+          # @!method initialize(framework_id:, section_id:, include_results: nil, include_subsection_rules: nil, page: nil, per_page: nil, project_id: nil, status: nil, request_options: {})
+          #   @param framework_id [String]
+          #
+          #   @param section_id [String]
+          #
+          #   @param include_results [Boolean] Whether to include each rule's results inline, in a `results` array.
+          #
+          #   @param include_subsection_rules [Boolean] Whether to also include the rules mapped to the section's subsections.
+          #
+          #   @param page [Integer] The page to return in a paginated query.
+          #
+          #   @param per_page [Integer] Maximum number of items to return per page.
+          #
+          #   @param project_id [String] Only include items that apply to this project.
+          #
+          #   @param status [Symbol, Openlayer::Models::Governance::Frameworks::SectionListRulesParams::Status] Only include items whose rule result has this compliance status.
+          #
+          #   @param request_options [Openlayer::RequestOptions, Hash{Symbol=>Object}]
+
+          # Only include items whose rule result has this compliance status.
+          module Status
+            extend Openlayer::Internal::Type::Enum
+
+            RUNNING = :running
+            PASSING = :passing
+            FAILING = :failing
+            SKIPPED = :skipped
+            ERROR = :error
+            PENDING = :pending
+            DUE_SOON = :due_soon
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end