mencoro 1.0.0

data/lib/mencoro/models/submitted_checks_resource.rb

@@ -0,0 +1,195 @@
+=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
+  # The tracked queries submitted for an immediate check
+  class SubmittedChecksResource < ApiModelBase
+    # How many tracked queries were submitted. Zero is a valid answer: it means nothing in the project was eligible.
+    attr_accessor :submitted
+
+    # The tracked queries submitted, in the order they were submitted (least recently checked first). Poll these to follow progress.
+    attr_accessor :tracked_query_ids
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'submitted' => :'submitted',
+        :'tracked_query_ids' => :'trackedQueryIds'
+      }
+    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
+      {
+        :'submitted' => :'Integer',
+        :'tracked_query_ids' => :'Array<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::SubmittedChecksResource` 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::SubmittedChecksResource`. 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?(:'submitted')
+        self.submitted = attributes[:'submitted']
+      else
+        self.submitted = nil
+      end
+
+      if attributes.key?(:'tracked_query_ids')
+        if (value = attributes[:'tracked_query_ids']).is_a?(Array)
+          self.tracked_query_ids = value
+        end
+      else
+        self.tracked_query_ids = nil
+      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 @submitted.nil?
+        invalid_properties.push('invalid value for "submitted", submitted cannot be nil.')
+      end
+
+      if @tracked_query_ids.nil?
+        invalid_properties.push('invalid value for "tracked_query_ids", tracked_query_ids 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 @submitted.nil?
+      return false if @tracked_query_ids.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] submitted Value to be assigned
+    def submitted=(submitted)
+      if submitted.nil?
+        fail ArgumentError, 'submitted cannot be nil'
+      end
+
+      @submitted = submitted
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] tracked_query_ids Value to be assigned
+    def tracked_query_ids=(tracked_query_ids)
+      if tracked_query_ids.nil?
+        fail ArgumentError, 'tracked_query_ids cannot be nil'
+      end
+
+      @tracked_query_ids = tracked_query_ids
+    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 &&
+          submitted == o.submitted &&
+          tracked_query_ids == o.tracked_query_ids
+    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
+      [submitted, tracked_query_ids].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/subscription_resource.rb

@@ -0,0 +1,362 @@
+=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
+  # The current subscription contract of an organization
+  class SubscriptionResource < ApiModelBase
+    # Contract state. \"none\" when the organization has never held a subscription.
+    attr_accessor :status
+
+    # Public tier identifier derived from the check budget.
+    attr_accessor :tier_code
+
+    # Billing interval of the contract.
+    attr_accessor :billing_cycle_type
+
+    # Instant the billing cycle is anchored to.
+    attr_accessor :billing_cycle_anchor
+
+    # Checks the current cycle grants. Null when there is no subscription, never a stand-in for zero.
+    attr_accessor :check_budget
+
+    # Checks consumed so far in the current cycle. Null when there is no subscription; zero means none consumed yet.
+    attr_accessor :checks_consumed
+
+    # Checks still available in the current cycle. Null when there is no subscription; zero means the budget is exhausted.
+    attr_accessor :checks_available
+
+    # When the check budget resets next.
+    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 is not cancelled.
+    attr_accessor :grace_period_ends_at
+
+    # Why the subscription is currently inactive. Null for an active subscription, and meaningless once \"cancelledAt\" is set - the cancellation supersedes it.
+    attr_accessor :deactivation_reason
+
+    # Whether the organization may use paid features right now: active, or cancelled but still inside its paid grace window.
+    attr_accessor :is_entitled
+
+    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',
+        :'tier_code' => :'tierCode',
+        :'billing_cycle_type' => :'billingCycleType',
+        :'billing_cycle_anchor' => :'billingCycleAnchor',
+        :'check_budget' => :'checkBudget',
+        :'checks_consumed' => :'checksConsumed',
+        :'checks_available' => :'checksAvailable',
+        :'next_reset_at' => :'nextResetAt',
+        :'cancelled_at' => :'cancelledAt',
+        :'scheduled_to_cancel_at' => :'scheduledToCancelAt',
+        :'grace_period_ends_at' => :'gracePeriodEndsAt',
+        :'deactivation_reason' => :'deactivationReason',
+        :'is_entitled' => :'isEntitled'
+      }
+    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',
+        :'tier_code' => :'String',
+        :'billing_cycle_type' => :'String',
+        :'billing_cycle_anchor' => :'Time',
+        :'check_budget' => :'Integer',
+        :'checks_consumed' => :'Integer',
+        :'checks_available' => :'Integer',
+        :'next_reset_at' => :'Time',
+        :'cancelled_at' => :'Time',
+        :'scheduled_to_cancel_at' => :'Time',
+        :'grace_period_ends_at' => :'Time',
+        :'deactivation_reason' => :'String',
+        :'is_entitled' => :'Boolean'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'tier_code',
+        :'billing_cycle_type',
+        :'billing_cycle_anchor',
+        :'check_budget',
+        :'checks_consumed',
+        :'checks_available',
+        :'next_reset_at',
+        :'cancelled_at',
+        :'scheduled_to_cancel_at',
+        :'grace_period_ends_at',
+        :'deactivation_reason',
+      ])
+    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::SubscriptionResource` 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::SubscriptionResource`. 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?(:'tier_code')
+        self.tier_code = attributes[:'tier_code']
+      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?(:'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?(:'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
+
+      if attributes.key?(:'deactivation_reason')
+        self.deactivation_reason = attributes[:'deactivation_reason']
+      end
+
+      if attributes.key?(:'is_entitled')
+        self.is_entitled = attributes[:'is_entitled']
+      else
+        self.is_entitled = nil
+      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)
+      billing_cycle_type_validator = EnumAttributeValidator.new('String', ["monthly", "yearly"])
+      return false unless billing_cycle_type_validator.valid?(@billing_cycle_type)
+      deactivation_reason_validator = EnumAttributeValidator.new('String', ["payment_failed", "paused", "incomplete", "other"])
+      return false unless deactivation_reason_validator.valid?(@deactivation_reason)
+      return false if @is_entitled.nil?
+      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 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
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] deactivation_reason Object to be assigned
+    def deactivation_reason=(deactivation_reason)
+      validator = EnumAttributeValidator.new('String', ["payment_failed", "paused", "incomplete", "other"])
+      unless validator.valid?(deactivation_reason)
+        fail ArgumentError, "invalid value for \"deactivation_reason\", must be one of #{validator.allowable_values}."
+      end
+      @deactivation_reason = deactivation_reason
+    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
+
+    # 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 &&
+          tier_code == o.tier_code &&
+          billing_cycle_type == o.billing_cycle_type &&
+          billing_cycle_anchor == o.billing_cycle_anchor &&
+          check_budget == o.check_budget &&
+          checks_consumed == o.checks_consumed &&
+          checks_available == o.checks_available &&
+          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 &&
+          deactivation_reason == o.deactivation_reason &&
+          is_entitled == o.is_entitled
+    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, tier_code, billing_cycle_type, billing_cycle_anchor, check_budget, checks_consumed, checks_available, next_reset_at, cancelled_at, scheduled_to_cancel_at, grace_period_ends_at, deactivation_reason, is_entitled].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