mencoro 1.0.0

data/lib/mencoro/models/entitlements_resource.rb

@@ -0,0 +1,328 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  # What an organization's plan allows and what it has consumed
+  class EntitlementsResource < ApiModelBase
+    # \"none\" when the organization has never had a subscription contract.
+    attr_accessor :status
+
+    # Whether the organization may use paid features right now: an active contract, or a cancelled one still inside its paid grace window.
+    attr_accessor :is_entitled
+
+    # Checks the current cycle allows. Null when there is no plan on file, which is not the same as a budget of zero.
+    attr_accessor :check_budget
+
+    # Checks consumed so far in the current cycle. Null when there is no plan on file.
+    attr_accessor :checks_consumed
+
+    # Checks left in the current cycle. Null when there is no plan on file.
+    attr_accessor :checks_available
+
+    # How often the allowance renews. Null when there is no plan on file.
+    attr_accessor :billing_cycle_type
+
+    # Start of the current cycle. Null when there is no plan on file.
+    attr_accessor :billing_cycle_anchor
+
+    # When the check budget next resets. Null when there is no plan on file.
+    attr_accessor :next_reset_at
+
+    # When the subscription was terminally cancelled. Null while it has not been.
+    attr_accessor :cancelled_at
+
+    # When a scheduled cancellation takes effect, while the subscription is still running. Null when none is scheduled.
+    attr_accessor :scheduled_to_cancel_at
+
+    # When paid access ends after a cancellation. Null when the subscription has not been cancelled.
+    attr_accessor :grace_period_ends_at
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'status' => :'status',
+        :'is_entitled' => :'isEntitled',
+        :'check_budget' => :'checkBudget',
+        :'checks_consumed' => :'checksConsumed',
+        :'checks_available' => :'checksAvailable',
+        :'billing_cycle_type' => :'billingCycleType',
+        :'billing_cycle_anchor' => :'billingCycleAnchor',
+        :'next_reset_at' => :'nextResetAt',
+        :'cancelled_at' => :'cancelledAt',
+        :'scheduled_to_cancel_at' => :'scheduledToCancelAt',
+        :'grace_period_ends_at' => :'gracePeriodEndsAt'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'status' => :'String',
+        :'is_entitled' => :'Boolean',
+        :'check_budget' => :'Integer',
+        :'checks_consumed' => :'Integer',
+        :'checks_available' => :'Integer',
+        :'billing_cycle_type' => :'String',
+        :'billing_cycle_anchor' => :'Time',
+        :'next_reset_at' => :'Time',
+        :'cancelled_at' => :'Time',
+        :'scheduled_to_cancel_at' => :'Time',
+        :'grace_period_ends_at' => :'Time'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'check_budget',
+        :'checks_consumed',
+        :'checks_available',
+        :'billing_cycle_type',
+        :'billing_cycle_anchor',
+        :'next_reset_at',
+        :'cancelled_at',
+        :'scheduled_to_cancel_at',
+        :'grace_period_ends_at'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Mencoro::EntitlementsResource` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Mencoro::EntitlementsResource`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'is_entitled')
+        self.is_entitled = attributes[:'is_entitled']
+      else
+        self.is_entitled = nil
+      end
+
+      if attributes.key?(:'check_budget')
+        self.check_budget = attributes[:'check_budget']
+      end
+
+      if attributes.key?(:'checks_consumed')
+        self.checks_consumed = attributes[:'checks_consumed']
+      end
+
+      if attributes.key?(:'checks_available')
+        self.checks_available = attributes[:'checks_available']
+      end
+
+      if attributes.key?(:'billing_cycle_type')
+        self.billing_cycle_type = attributes[:'billing_cycle_type']
+      end
+
+      if attributes.key?(:'billing_cycle_anchor')
+        self.billing_cycle_anchor = attributes[:'billing_cycle_anchor']
+      end
+
+      if attributes.key?(:'next_reset_at')
+        self.next_reset_at = attributes[:'next_reset_at']
+      end
+
+      if attributes.key?(:'cancelled_at')
+        self.cancelled_at = attributes[:'cancelled_at']
+      end
+
+      if attributes.key?(:'scheduled_to_cancel_at')
+        self.scheduled_to_cancel_at = attributes[:'scheduled_to_cancel_at']
+      end
+
+      if attributes.key?(:'grace_period_ends_at')
+        self.grace_period_ends_at = attributes[:'grace_period_ends_at']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      if @is_entitled.nil?
+        invalid_properties.push('invalid value for "is_entitled", is_entitled cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @status.nil?
+      status_validator = EnumAttributeValidator.new('String', ["active", "inactive", "none"])
+      return false unless status_validator.valid?(@status)
+      return false if @is_entitled.nil?
+      billing_cycle_type_validator = EnumAttributeValidator.new('String', ["monthly", "yearly"])
+      return false unless billing_cycle_type_validator.valid?(@billing_cycle_type)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] status Object to be assigned
+    def status=(status)
+      validator = EnumAttributeValidator.new('String', ["active", "inactive", "none"])
+      unless validator.valid?(status)
+        fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
+      end
+      @status = status
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] is_entitled Value to be assigned
+    def is_entitled=(is_entitled)
+      if is_entitled.nil?
+        fail ArgumentError, 'is_entitled cannot be nil'
+      end
+
+      @is_entitled = is_entitled
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] billing_cycle_type Object to be assigned
+    def billing_cycle_type=(billing_cycle_type)
+      validator = EnumAttributeValidator.new('String', ["monthly", "yearly"])
+      unless validator.valid?(billing_cycle_type)
+        fail ArgumentError, "invalid value for \"billing_cycle_type\", must be one of #{validator.allowable_values}."
+      end
+      @billing_cycle_type = billing_cycle_type
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          status == o.status &&
+          is_entitled == o.is_entitled &&
+          check_budget == o.check_budget &&
+          checks_consumed == o.checks_consumed &&
+          checks_available == o.checks_available &&
+          billing_cycle_type == o.billing_cycle_type &&
+          billing_cycle_anchor == o.billing_cycle_anchor &&
+          next_reset_at == o.next_reset_at &&
+          cancelled_at == o.cancelled_at &&
+          scheduled_to_cancel_at == o.scheduled_to_cancel_at &&
+          grace_period_ends_at == o.grace_period_ends_at
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [status, is_entitled, check_budget, checks_consumed, checks_available, billing_cycle_type, billing_cycle_anchor, next_reset_at, cancelled_at, scheduled_to_cancel_at, grace_period_ends_at].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/mencoro/models/get_available_filters200_response.rb

@@ -0,0 +1,173 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  class GetAvailableFilters200Response < ApiModelBase
+    # Engine codes, ready to pass as the engines filter
+    attr_accessor :engines
+
+    # ISO-3166 alpha-2 codes, ready to pass as the countries filter
+    attr_accessor :countries
+
+    attr_accessor :clusters
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'engines' => :'engines',
+        :'countries' => :'countries',
+        :'clusters' => :'clusters'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'engines' => :'Array<String>',
+        :'countries' => :'Array<String>',
+        :'clusters' => :'Array<GetAvailableFilters200ResponseClustersInner>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Mencoro::GetAvailableFilters200Response` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Mencoro::GetAvailableFilters200Response`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'engines')
+        if (value = attributes[:'engines']).is_a?(Array)
+          self.engines = value
+        end
+      end
+
+      if attributes.key?(:'countries')
+        if (value = attributes[:'countries']).is_a?(Array)
+          self.countries = value
+        end
+      end
+
+      if attributes.key?(:'clusters')
+        if (value = attributes[:'clusters']).is_a?(Array)
+          self.clusters = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          engines == o.engines &&
+          countries == o.countries &&
+          clusters == o.clusters
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [engines, countries, clusters].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end

data/lib/mencoro/models/get_available_filters200_response_clusters_inner.rb

@@ -0,0 +1,157 @@
+=begin
+#Mencoro API
+
+#Public API for Mencoro customers. Authenticate with an API key: `Authorization: Bearer mencoro_sk_...`.
+
+The version of the OpenAPI document: 1.0.0
+Contact: support@mencoro.com
+Generated by: https://openapi-generator.tech
+Generator version: 7.24.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Mencoro
+  class GetAvailableFilters200ResponseClustersInner < ApiModelBase
+    # Pass this in queryClusterIds, never the name
+    attr_accessor :id
+
+    attr_accessor :name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Mencoro::GetAvailableFilters200ResponseClustersInner` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Mencoro::GetAvailableFilters200ResponseClustersInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          id == o.id &&
+          name == o.name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [id, name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end