shipeasy-sdk 2.3.0 → 2.3.1

data/lib/shipeasy_admin/models/create_o_auth_connector_request.rb

@@ -0,0 +1,273 @@
+=begin
+#Shipeasy Admin API
+
+#REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  # Create an OAuth/app connector stub. The connector is created `enabled: false` with empty `config` and no credentials; the provider's OAuth flow then attaches credentials and enables it.
+  class CreateOAuthConnectorRequest < ApiModelBase
+    # OAuth/app connector destination.
+    attr_accessor :provider
+
+    # Human-readable connector label.
+    attr_accessor :name
+
+    # Events to subscribe to. At least one is required.
+    attr_accessor :events
+
+    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
+      {
+        :'provider' => :'provider',
+        :'name' => :'name',
+        :'events' => :'events'
+      }
+    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
+      {
+        :'provider' => :'String',
+        :'name' => :'String',
+        :'events' => :'Array<ConnectorEvent>'
+      }
+    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 `Shipeasy::Admin::Generated::CreateOAuthConnectorRequest` 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 `Shipeasy::Admin::Generated::CreateOAuthConnectorRequest`. 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?(:'provider')
+        self.provider = attributes[:'provider']
+      else
+        self.provider = nil
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      else
+        self.name = nil
+      end
+
+      if attributes.key?(:'events')
+        if (value = attributes[:'events']).is_a?(Array)
+          self.events = value
+        end
+      else
+        self.events = 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 @provider.nil?
+        invalid_properties.push('invalid value for "provider", provider cannot be nil.')
+      end
+
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name cannot be nil.')
+      end
+
+      if @name.to_s.length > 80
+        invalid_properties.push('invalid value for "name", the character length must be smaller than or equal to 80.')
+      end
+
+      if @name.to_s.length < 1
+        invalid_properties.push('invalid value for "name", the character length must be greater than or equal to 1.')
+      end
+
+      if @events.nil?
+        invalid_properties.push('invalid value for "events", events cannot be nil.')
+      end
+
+      if @events.length < 1
+        invalid_properties.push('invalid value for "events", number of items must be greater than or equal to 1.')
+      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 @provider.nil?
+      provider_validator = EnumAttributeValidator.new('String', ["google_sheets", "github", "slack"])
+      return false unless provider_validator.valid?(@provider)
+      return false if @name.nil?
+      return false if @name.to_s.length > 80
+      return false if @name.to_s.length < 1
+      return false if @events.nil?
+      return false if @events.length < 1
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] provider Object to be assigned
+    def provider=(provider)
+      validator = EnumAttributeValidator.new('String', ["google_sheets", "github", "slack"])
+      unless validator.valid?(provider)
+        fail ArgumentError, "invalid value for \"provider\", must be one of #{validator.allowable_values}."
+      end
+      @provider = provider
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] name Value to be assigned
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'name cannot be nil'
+      end
+
+      if name.to_s.length > 80
+        fail ArgumentError, 'invalid value for "name", the character length must be smaller than or equal to 80.'
+      end
+
+      if name.to_s.length < 1
+        fail ArgumentError, 'invalid value for "name", the character length must be greater than or equal to 1.'
+      end
+
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] events Value to be assigned
+    def events=(events)
+      if events.nil?
+        fail ArgumentError, 'events cannot be nil'
+      end
+
+      if events.length < 1
+        fail ArgumentError, 'invalid value for "events", number of items must be greater than or equal to 1.'
+      end
+
+      @events = events
+    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 &&
+          provider == o.provider &&
+          name == o.name &&
+          events == o.events
+    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
+      [provider, name, events].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/shipeasy_admin/models/create_ops_item_request.rb

@@ -3,7 +3,7 @@
 
 #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -16,7 +16,7 @@ require 'time'
 module Shipeasy::Admin::Generated
   # Body for `POST /api/admin/ops`. Files one queue item; `type` selects bug vs. feature request.
   class CreateOpsItemRequest < ApiModelBase
-    # Item type to file (`bug` or `feature_request`).
+    # Item type to file. Only the two user-fileable types are accepted here — `error` and `alert` tickets are auto-filed by the platform and cannot be created over the API.
     attr_accessor :type
 
     # One-line title of the bug or feature request.

data/lib/shipeasy_admin/models/create_ops_item_response.rb

@@ -3,7 +3,7 @@
 
 #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Shipeasy::Admin::Generated
-  # Response for the create endpoints.
+  # Response for `POST /api/admin/ops`.
   class CreateOpsItemResponse < ApiModelBase
     # Newly created item id.
     attr_accessor :id

data/lib/shipeasy_admin/models/create_universe_request.rb

@@ -3,7 +3,7 @@
 
 #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0
@@ -19,7 +19,7 @@ module Shipeasy::Admin::Generated
     # Stable universe key. Single segment or `folder.name`. Lowercase letters, digits, `_` or `-`; max 128 chars. Immutable after create.
     attr_accessor :name
 
-    # Optional folder name used to group items in the dashboard. Part of the SDK lookup key: an item in folder `checkout` named `new-cart` is referenced as `checkout/new-cart` from the SDK.
+    # Optional folder name grouping items in the dashboard. Alphanumeric, `_` or `-` (no `/`). Part of the SDK lookup key (`<folder>/<name>`).
     attr_accessor :folder
 
     # Unit of randomisation. Typically `user_id`. Use `account_id` to keep whole accounts in the same group across an experiment.
@@ -102,8 +102,6 @@ module Shipeasy::Admin::Generated
         if (value = attributes[:'holdout_range']).is_a?(Array)
           self.holdout_range = value
         end
-      else
-        self.holdout_range = nil
       end
     end
 
@@ -134,15 +132,11 @@ module Shipeasy::Admin::Generated
         invalid_properties.push("invalid value for \"folder\", must conform to the pattern #{pattern}.")
       end
 
-      if @unit_type.nil?
-        invalid_properties.push('invalid value for "unit_type", unit_type cannot be nil.')
-      end
-
-      if @holdout_range.length > 2
+      if !@holdout_range.nil? && @holdout_range.length > 2
         invalid_properties.push('invalid value for "holdout_range", number of items must be less than or equal to 2.')
       end
 
-      if @holdout_range.length < 2
+      if !@holdout_range.nil? && @holdout_range.length < 2
         invalid_properties.push('invalid value for "holdout_range", number of items must be greater than or equal to 2.')
       end
 
@@ -158,9 +152,8 @@ module Shipeasy::Admin::Generated
       return false if @name !~ Regexp.new(/^[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9_-]*[a-z0-9])?)?$/)
       return false if !@folder.nil? && @folder.to_s.length > 256
       return false if !@folder.nil? && @folder !~ Regexp.new(/^[a-zA-Z0-9_-]+$/)
-      return false if @unit_type.nil?
-      return false if @holdout_range.length > 2
-      return false if @holdout_range.length < 2
+      return false if !@holdout_range.nil? && @holdout_range.length > 2
+      return false if !@holdout_range.nil? && @holdout_range.length < 2
       true
     end
 
@@ -198,16 +191,6 @@ module Shipeasy::Admin::Generated
       @folder = folder
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] unit_type Value to be assigned
-    def unit_type=(unit_type)
-      if unit_type.nil?
-        fail ArgumentError, 'unit_type cannot be nil'
-      end
-
-      @unit_type = unit_type
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] holdout_range Value to be assigned
     def holdout_range=(holdout_range)

data/lib/shipeasy_admin/models/create_universe_response.rb

@@ -3,7 +3,7 @@
 
 #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0

data/lib/shipeasy_admin/models/cursor_trigger_config.rb

@@ -0,0 +1,231 @@
+=begin
+#Shipeasy Admin API
+
+#REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
+
+The version of the OpenAPI document: 2.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.23.0
+
+=end
+
+require 'date'
+require 'time'
+
+module Shipeasy::Admin::Generated
+  # Non-secret config for a Cursor trigger.
+  class CursorTriggerConfig < ApiModelBase
+    # Repo the cloud agent runs against, e.g. `https://github.com/owner/repo`. Idempotency key for the connector.
+    attr_accessor :repo_url
+
+    # Optional git ref the run starts from.
+    attr_accessor :starting_ref
+
+    # Shipeasy project id the run targets.
+    attr_accessor :project_id
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'repo_url' => :'repoUrl',
+        :'starting_ref' => :'startingRef',
+        :'project_id' => :'projectId'
+      }
+    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
+      {
+        :'repo_url' => :'String',
+        :'starting_ref' => :'String',
+        :'project_id' => :'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 `Shipeasy::Admin::Generated::CursorTriggerConfig` 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 `Shipeasy::Admin::Generated::CursorTriggerConfig`. 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?(:'repo_url')
+        self.repo_url = attributes[:'repo_url']
+      else
+        self.repo_url = nil
+      end
+
+      if attributes.key?(:'starting_ref')
+        self.starting_ref = attributes[:'starting_ref']
+      end
+
+      if attributes.key?(:'project_id')
+        self.project_id = attributes[:'project_id']
+      else
+        self.project_id = 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 @repo_url.nil?
+        invalid_properties.push('invalid value for "repo_url", repo_url cannot be nil.')
+      end
+
+      if !@starting_ref.nil? && @starting_ref.to_s.length < 1
+        invalid_properties.push('invalid value for "starting_ref", the character length must be greater than or equal to 1.')
+      end
+
+      if @project_id.nil?
+        invalid_properties.push('invalid value for "project_id", project_id cannot be nil.')
+      end
+
+      if @project_id.to_s.length < 1
+        invalid_properties.push('invalid value for "project_id", the character length must be greater than or equal to 1.')
+      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 @repo_url.nil?
+      return false if !@starting_ref.nil? && @starting_ref.to_s.length < 1
+      return false if @project_id.nil?
+      return false if @project_id.to_s.length < 1
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] repo_url Value to be assigned
+    def repo_url=(repo_url)
+      if repo_url.nil?
+        fail ArgumentError, 'repo_url cannot be nil'
+      end
+
+      @repo_url = repo_url
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] starting_ref Value to be assigned
+    def starting_ref=(starting_ref)
+      if starting_ref.nil?
+        fail ArgumentError, 'starting_ref cannot be nil'
+      end
+
+      if starting_ref.to_s.length < 1
+        fail ArgumentError, 'invalid value for "starting_ref", the character length must be greater than or equal to 1.'
+      end
+
+      @starting_ref = starting_ref
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] project_id Value to be assigned
+    def project_id=(project_id)
+      if project_id.nil?
+        fail ArgumentError, 'project_id cannot be nil'
+      end
+
+      if project_id.to_s.length < 1
+        fail ArgumentError, 'invalid value for "project_id", the character length must be greater than or equal to 1.'
+      end
+
+      @project_id = project_id
+    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 &&
+          repo_url == o.repo_url &&
+          starting_ref == o.starting_ref &&
+          project_id == o.project_id
+    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
+      [repo_url, starting_ref, project_id].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/shipeasy_admin/models/delete_alert_rule_response.rb

@@ -3,7 +3,7 @@
 
 #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0

data/lib/shipeasy_admin/models/delete_config_response.rb

@@ -3,7 +3,7 @@
 
 #REST API for managing feature gates, experiments, configs, universes, and killswitches in a Shipeasy project. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Mint admin keys via `POST /api/admin/keys` with `type: \"admin\"`. Keys expire after 90 days; rotate with the `revoke` action.
 
-The version of the OpenAPI document: 1.0.0
+The version of the OpenAPI document: 2.0.0
 
 Generated by: https://openapi-generator.tech
 Generator version: 7.23.0