smplkit 2.0.13 → 2.0.14

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/create_subscription_body.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API request envelope for creating a subscription.
   class CreateSubscriptionBody < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/create_subscription_data.rb

@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Resource object for the create-subscription request.
   class CreateSubscriptionData < ApiModelBase
+    # Resource type; must be `subscription`.
     attr_accessor :type
 
     attr_accessor :attributes

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/email.rb

@@ -14,12 +14,14 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
-  # Contact-us email resource attributes.  This resource is a pure action — it is not persisted. The id returned in the response is a per-request uuid4 for correlation only.
+  # A contact-us submission. Sending the resource delivers a support ticket and an auto-response email; nothing is persisted. The `id` returned on the response is a per-request correlation identifier.
   class Email < ApiModelBase
     attr_accessor :topic
 
+    # Free-form text of the message. Trimmed before validation.
     attr_accessor :body
 
+    # When the message was accepted by the server.
     attr_accessor :sent_at
 
     class EnumAttributeValidator

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/email_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a contact-us submission.  `id` must not be specified for create requests (the server assigns it).
   class EmailResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/email_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for a contact-us message.
   class EmailResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment.rb

@@ -14,15 +14,21 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # A named deployment context — for example, `production`, `staging`, or `development`. Resources scoped to an environment (such as config items and feature flags) are evaluated against environment-specific values.
   class Environment < ApiModelBase
+    # Human-readable name for the environment.
     attr_accessor :name
 
+    # Display color used by the console to badge the environment. Accepts any CSS color string.
     attr_accessor :color
 
+    # `STANDARD` for environments the customer explicitly manages; `AD_HOC` for environments auto-created from SDK traffic. Case-insensitive on input.
     attr_accessor :classification
 
+    # When the environment was created.
     attr_accessor :created_at
 
+    # When the environment was last modified.
     attr_accessor :updated_at
 
     class EnumAttributeValidator

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for environments.
   class EnvironmentListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_request.rb

@@ -0,0 +1,165 @@
+=begin
+#smplkit API
+
+#API for the smplkit platform.
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.22.0
+
+=end
+
+require 'date'
+require 'time'
+
+module SmplkitGeneratedClient::App
+  # JSON:API request envelope for creating or updating an environment.
+  class EnvironmentRequest < ApiModelBase
+    attr_accessor :data
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data'
+      }
+    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
+      {
+        :'data' => :'EnvironmentResource'
+      }
+    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 `SmplkitGeneratedClient::App::EnvironmentRequest` 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 `SmplkitGeneratedClient::App::EnvironmentRequest`. 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?(:'data')
+        self.data = attributes[:'data']
+      else
+        self.data = 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 @data.nil?
+        invalid_properties.push('invalid value for "data", data 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 @data.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] data Value to be assigned
+    def data=(data)
+      if data.nil?
+        fail ArgumentError, 'data cannot be nil'
+      end
+
+      @data = data
+    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 &&
+          data == o.data
+    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
+      [data].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/smplkit/_generated/app/lib/smplkit_app_client/models/environment_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for an environment.  `id` must not be specified for create requests (the server assigns it).
   class EnvironmentResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/environment_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for an environment.
   class EnvironmentResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation.rb

@@ -14,25 +14,36 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # An invitation for a person to join an account.  Invitations carry a time-limited token; the recipient redeems the token to become a member of the inviting account at the assigned role.
   class Invitation < ApiModelBase
+    # Email address the invitation was sent to.
     attr_accessor :email
 
+    # Role to assign on acceptance. One of `ADMIN`, `MEMBER`, or `VIEWER`.
     attr_accessor :role
 
+    # Lifecycle state of the invitation. One of `PENDING`, `ACCEPTED`, `REVOKED`, or `EXPIRED`.
     attr_accessor :status
 
+    # UUID of the user who sent the invitation.
     attr_accessor :invited_by
 
+    # Name of the account the recipient is being invited to join.
     attr_accessor :account_name
 
+    # Display name of the user who sent the invitation.
     attr_accessor :inviter_display_name
 
+    # Single-use token that the recipient redeems to accept the invitation. Echoed on responses so the inviting client can construct the acceptance link.
     attr_accessor :token
 
+    # When the invitation token stops being redeemable.
     attr_accessor :expires_at
 
+    # When the invitation was issued.
     attr_accessor :created_at
 
+    # When the invitation record was last modified.
     attr_accessor :updated_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_accept_request.rb

@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Body for the invitation-accept endpoint.
   class InvitationAcceptRequest < ApiModelBase
+    # Invitation token from the email link.
     attr_accessor :token
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_bulk_create_request.rb

@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Bulk-create request body for the invitations endpoint.
   class InvitationBulkCreateRequest < ApiModelBase
+    # One to fifty invitations to send in a single request.
     attr_accessor :invitations
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_create_item.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # One invitation in a bulk-create request.
   class InvitationCreateItem < ApiModelBase
+    # Email address to send the invitation to.
     attr_accessor :email
 
+    # Role to assign on acceptance. One of `ADMIN`, `MEMBER`, or `VIEWER`. `OWNER` cannot be assigned via invitation. Case-insensitive on input.
     attr_accessor :role
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for invitations.
   class InvitationListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for an invitation.  `id` must not be specified for create requests (the server assigns it).
   class InvitationResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invitation_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for an invitation.
   class InvitationResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice.rb

@@ -14,29 +14,42 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # A billing invoice issued for the account.
   class Invoice < ApiModelBase
+    # Invoice number assigned by the billing provider.
     attr_accessor :number
 
+    # Invoice lifecycle state, e.g. `draft`, `open`, `paid`, `uncollectible`, `void`.
     attr_accessor :status
 
+    # Amount owed on the invoice in the smallest currency unit (e.g. cents).
     attr_accessor :amount_due
 
+    # Amount paid against the invoice in the smallest currency unit.
     attr_accessor :amount_paid
 
+    # ISO 4217 currency code, e.g. `usd`.
     attr_accessor :currency
 
+    # Human-readable summary of the invoice's line items.
     attr_accessor :description
 
+    # Start of the service period the invoice covers (ISO 8601).
     attr_accessor :period_start
 
+    # End of the service period the invoice covers (ISO 8601).
     attr_accessor :period_end
 
+    # When the invoice was created (ISO 8601).
     attr_accessor :created_at
 
+    # When the invoice was paid in full (ISO 8601), or `null` if unpaid.
     attr_accessor :paid_at
 
+    # Link to the hosted invoice page.
     attr_accessor :hosted_invoice_url
 
+    # Link to the PDF rendering of the invoice.
     attr_accessor :invoice_pdf
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for invoices.
   class InvoiceListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for an invoice.
   class InvoiceResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/invoice_single_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API single-resource response envelope for an invoice.
   class InvoiceSingleResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/limit_definition.rb

@@ -14,13 +14,18 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Description of a single metered limit on a product.
   class LimitDefinition < ApiModelBase
+    # Human-readable name for the limit.
     attr_accessor :display_name
 
+    # Long-form description of what the limit controls.
     attr_accessor :description
 
+    # Unit the limit is measured in, e.g. `flags`, `events`.
     attr_accessor :unit
 
+    # Optional formatter hint for rendering the limit value in customer-facing UI.
     attr_accessor :display_format
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/login_request.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Body for the email + password login endpoint.
   class LoginRequest < ApiModelBase
+    # Email address of the user signing in.
     attr_accessor :email
 
+    # Password supplied for authentication.
     attr_accessor :password
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_attributes.rb

@@ -14,19 +14,26 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # A pre-aggregated metric data point recorded for the account.
   class MetricAttributes < ApiModelBase
+    # Metric series name, e.g. `flags.evaluations`. Dot-separated.
     attr_accessor :name
 
     attr_accessor :value
 
+    # Unit the value is expressed in, e.g. `evaluations`, `ms`, `bytes`.
     attr_accessor :unit
 
+    # Length of the aggregation window in seconds (e.g. `60` for a one-minute roll-up).
     attr_accessor :period_seconds
 
+    # Optional dimension keys that scope the data point, e.g. `environment`, `service`. Used as filter targets on the list endpoint via `filter[dimensions.<key>]=...`.
     attr_accessor :dimensions
 
+    # Start of the aggregation window this data point covers.
     attr_accessor :recorded_at
 
+    # When the data point was ingested.
     attr_accessor :created_at
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_bulk_request.rb

@@ -14,7 +14,9 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Bulk-ingest request envelope for metric data points.
   class MetricBulkRequest < ApiModelBase
+    # Metric data points to ingest in a single request.
     attr_accessor :data
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for metric data points.
   class MetricListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_name_item.rb

@@ -14,9 +14,12 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # One distinct metric name with a representative unit.
   class MetricNameItem < ApiModelBase
+    # Distinct metric series name.
     attr_accessor :name
 
+    # Representative unit observed for this series.
     attr_accessor :unit
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_names_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Plain-JSON response listing distinct metric names for the account.
   class MetricNamesResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a metric data point.  `id` must not be specified for create requests (the server assigns it).
   class MetricResource < ApiModelBase
     attr_accessor :id
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_attributes.rb

@@ -14,15 +14,21 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # An aggregated metric value over a fixed-size time bucket.
   class MetricRollupAttributes < ApiModelBase
+    # Metric series name the rollup is computed from.
     attr_accessor :name
 
+    # Sum of the underlying metric values over the bucket.
     attr_accessor :value
 
+    # Unit the value is expressed in.
     attr_accessor :unit
 
+    # Start of the time bucket this rollup covers.
     attr_accessor :bucket
 
+    # Rollup interval. One of `1m`, `5m`, `15m`, `1h`, `6h`, `1d`.
     attr_accessor :rollup
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_list_response.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API collection response for metric rollups.
   class MetricRollupListResponse < ApiModelBase
     attr_accessor :data
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/metric_rollup_resource.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # JSON:API resource envelope for a metric rollup.
   class MetricRollupResource < ApiModelBase
     attr_accessor :type
 

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/next_tier_meta.rb

@@ -14,11 +14,15 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Information about the next volume-discount tier.
   class NextTierMeta < ApiModelBase
+    # Number of additional subscribed products needed to reach the next tier.
     attr_accessor :products_needed
 
+    # Discount percentage that would apply at the next tier.
     attr_accessor :discount_pct
 
+    # Additional monthly savings in cents at the next tier.
     attr_accessor :additional_savings_cents
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/smplkit/_generated/app/lib/smplkit_app_client/models/page_meta.rb

@@ -14,17 +14,18 @@ require 'date'
 require 'time'
 
 module SmplkitGeneratedClient::App
+  # Pagination metadata returned with a collection response.
   class PageMeta < ApiModelBase
-    # Page size used for this response
+    # Page size used for this response.
     attr_accessor :size
 
-    # 1-based page number returned
+    # 1-based page number returned.
     attr_accessor :number
 
-    # Total number of matching items across all pages
+    # Total number of matching items across all pages.
     attr_accessor :total_items
 
-    # Total number of pages at the current page size
+    # Total number of pages at the current page size.
     attr_accessor :total_pages
 
     # Attribute mapping from ruby-style variable name to JSON key.