shipeasy-sdk 3.8.0 → 4.1.0

data/lib/shipeasy_admin/models/create_public_feature_request_request.rb

@@ -0,0 +1,436 @@
+=begin
+#Shipeasy Admin API (server-SDK surface)
+
+#The slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Three capabilities, nothing else:  - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule.  Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
+
+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
+  # Body for `POST /ops/feature-request`. The same feature-request fields as `CreateFeatureRequestRequest`, minus the `type` discriminator — the path already says what is being filed, plus the public intake's own `dedupKey`.
+  class CreatePublicFeatureRequestRequest < ApiModelBase
+    # One-line feature-request title (no leading/trailing whitespace).
+    attr_accessor :title
+
+    # What the feature is.
+    attr_accessor :description
+
+    # Why it's needed / the use case.
+    attr_accessor :use_case
+
+    # Initial triage priority, or `null`.
+    attr_accessor :priority
+
+    # Initial lifecycle status; defaults to `open` when omitted.
+    attr_accessor :status
+
+    # The `users.id` of the person to assign as owner at creation, or `null`.
+    attr_accessor :assignee_id
+
+    # Emails of teammates to subscribe to this item's Slack pings at creation.
+    attr_accessor :subscribers
+
+    # Tag names to attach at creation (get-or-created by name, deduped case-insensitively).
+    attr_accessor :tags
+
+    # Email of the reporter, or `null`.
+    attr_accessor :reporter_email
+
+    # URL of the page the request relates to, or `null`.
+    attr_accessor :page_url
+
+    # Reporter's user-agent string, or `null`.
+    attr_accessor :user_agent
+
+    # Arbitrary capture context, or `null`.
+    attr_accessor :context
+
+    # Caller-chosen dedupe identity for this request, stored on the ticket. Behaves exactly as on `POST /ops/bug`: a repeat carrying the same key refreshes the open ticket already holding it (fields overwritten, a \"re-triggered\" comment appended) and returns `deduped: true` with `updated: true`, instead of filing a second one.
+    attr_accessor :dedup_key
+
+    # Where this request's completion notification lands.
+    attr_accessor :notify
+
+    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
+      {
+        :'title' => :'title',
+        :'description' => :'description',
+        :'use_case' => :'useCase',
+        :'priority' => :'priority',
+        :'status' => :'status',
+        :'assignee_id' => :'assigneeId',
+        :'subscribers' => :'subscribers',
+        :'tags' => :'tags',
+        :'reporter_email' => :'reporterEmail',
+        :'page_url' => :'pageUrl',
+        :'user_agent' => :'userAgent',
+        :'context' => :'context',
+        :'dedup_key' => :'dedupKey',
+        :'notify' => :'notify'
+      }
+    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
+      {
+        :'title' => :'String',
+        :'description' => :'String',
+        :'use_case' => :'String',
+        :'priority' => :'OpsItemPriority',
+        :'status' => :'OpsItemStatus',
+        :'assignee_id' => :'String',
+        :'subscribers' => :'Array<String>',
+        :'tags' => :'Array<String>',
+        :'reporter_email' => :'String',
+        :'page_url' => :'String',
+        :'user_agent' => :'String',
+        :'context' => :'Hash<String, Object>',
+        :'dedup_key' => :'String',
+        :'notify' => :'NotificationTarget'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'priority',
+        :'assignee_id',
+        :'reporter_email',
+        :'page_url',
+        :'user_agent',
+        :'context',
+        :'notify'
+      ])
+    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::CreatePublicFeatureRequestRequest` 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::CreatePublicFeatureRequestRequest`. 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?(:'title')
+        self.title = attributes[:'title']
+      else
+        self.title = nil
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      else
+        self.description = ''
+      end
+
+      if attributes.key?(:'use_case')
+        self.use_case = attributes[:'use_case']
+      else
+        self.use_case = ''
+      end
+
+      if attributes.key?(:'priority')
+        self.priority = attributes[:'priority']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      end
+
+      if attributes.key?(:'assignee_id')
+        self.assignee_id = attributes[:'assignee_id']
+      end
+
+      if attributes.key?(:'subscribers')
+        if (value = attributes[:'subscribers']).is_a?(Array)
+          self.subscribers = value
+        end
+      end
+
+      if attributes.key?(:'tags')
+        if (value = attributes[:'tags']).is_a?(Array)
+          self.tags = value
+        end
+      end
+
+      if attributes.key?(:'reporter_email')
+        self.reporter_email = attributes[:'reporter_email']
+      end
+
+      if attributes.key?(:'page_url')
+        self.page_url = attributes[:'page_url']
+      end
+
+      if attributes.key?(:'user_agent')
+        self.user_agent = attributes[:'user_agent']
+      end
+
+      if attributes.key?(:'context')
+        if (value = attributes[:'context']).is_a?(Hash)
+          self.context = value
+        end
+      end
+
+      if attributes.key?(:'dedup_key')
+        self.dedup_key = attributes[:'dedup_key']
+      end
+
+      if attributes.key?(:'notify')
+        self.notify = attributes[:'notify']
+      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 @title.nil?
+        invalid_properties.push('invalid value for "title", title cannot be nil.')
+      end
+
+      if @title.to_s.length > 200
+        invalid_properties.push('invalid value for "title", the character length must be smaller than or equal to 200.')
+      end
+
+      if @title.to_s.length < 1
+        invalid_properties.push('invalid value for "title", the character length must be greater than or equal to 1.')
+      end
+
+      pattern = Regexp.new(/^\S(.*\S)?$/)
+      if @title !~ pattern
+        invalid_properties.push("invalid value for \"title\", must conform to the pattern #{pattern}.")
+      end
+
+      if !@description.nil? && @description.to_s.length > 8000
+        invalid_properties.push('invalid value for "description", the character length must be smaller than or equal to 8000.')
+      end
+
+      if !@use_case.nil? && @use_case.to_s.length > 8000
+        invalid_properties.push('invalid value for "use_case", the character length must be smaller than or equal to 8000.')
+      end
+
+      if !@user_agent.nil? && @user_agent.to_s.length > 500
+        invalid_properties.push('invalid value for "user_agent", the character length must be smaller than or equal to 500.')
+      end
+
+      if !@dedup_key.nil? && @dedup_key.to_s.length > 200
+        invalid_properties.push('invalid value for "dedup_key", the character length must be smaller than or equal to 200.')
+      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 @title.nil?
+      return false if @title.to_s.length > 200
+      return false if @title.to_s.length < 1
+      return false if @title !~ Regexp.new(/^\S(.*\S)?$/)
+      return false if !@description.nil? && @description.to_s.length > 8000
+      return false if !@use_case.nil? && @use_case.to_s.length > 8000
+      return false if !@user_agent.nil? && @user_agent.to_s.length > 500
+      return false if !@dedup_key.nil? && @dedup_key.to_s.length > 200
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] title Value to be assigned
+    def title=(title)
+      if title.nil?
+        fail ArgumentError, 'title cannot be nil'
+      end
+
+      if title.to_s.length > 200
+        fail ArgumentError, 'invalid value for "title", the character length must be smaller than or equal to 200.'
+      end
+
+      if title.to_s.length < 1
+        fail ArgumentError, 'invalid value for "title", the character length must be greater than or equal to 1.'
+      end
+
+      pattern = Regexp.new(/^\S(.*\S)?$/)
+      if title !~ pattern
+        fail ArgumentError, "invalid value for \"title\", must conform to the pattern #{pattern}."
+      end
+
+      @title = title
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] description Value to be assigned
+    def description=(description)
+      if description.nil?
+        fail ArgumentError, 'description cannot be nil'
+      end
+
+      if description.to_s.length > 8000
+        fail ArgumentError, 'invalid value for "description", the character length must be smaller than or equal to 8000.'
+      end
+
+      @description = description
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] use_case Value to be assigned
+    def use_case=(use_case)
+      if use_case.nil?
+        fail ArgumentError, 'use_case cannot be nil'
+      end
+
+      if use_case.to_s.length > 8000
+        fail ArgumentError, 'invalid value for "use_case", the character length must be smaller than or equal to 8000.'
+      end
+
+      @use_case = use_case
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] user_agent Value to be assigned
+    def user_agent=(user_agent)
+      if !user_agent.nil? && user_agent.to_s.length > 500
+        fail ArgumentError, 'invalid value for "user_agent", the character length must be smaller than or equal to 500.'
+      end
+
+      @user_agent = user_agent
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] dedup_key Value to be assigned
+    def dedup_key=(dedup_key)
+      if dedup_key.nil?
+        fail ArgumentError, 'dedup_key cannot be nil'
+      end
+
+      if dedup_key.to_s.length > 200
+        fail ArgumentError, 'invalid value for "dedup_key", the character length must be smaller than or equal to 200.'
+      end
+
+      @dedup_key = dedup_key
+    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 &&
+          title == o.title &&
+          description == o.description &&
+          use_case == o.use_case &&
+          priority == o.priority &&
+          status == o.status &&
+          assignee_id == o.assignee_id &&
+          subscribers == o.subscribers &&
+          tags == o.tags &&
+          reporter_email == o.reporter_email &&
+          page_url == o.page_url &&
+          user_agent == o.user_agent &&
+          context == o.context &&
+          dedup_key == o.dedup_key &&
+          notify == o.notify
+    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
+      [title, description, use_case, priority, status, assignee_id, subscribers, tags, reporter_email, page_url, user_agent, context, dedup_key, notify].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/{file_error_ticket_response.rb → create_public_ticket_response.rb}

@@ -1,7 +1,7 @@
 =begin
-#Shipeasy Admin API
+#Shipeasy Admin API (server-SDK surface)
 
-#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 slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Three capabilities, nothing else:  - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule.  Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
 
 The version of the OpenAPI document: 2.0.0
 
@@ -14,19 +14,27 @@ require 'date'
 require 'time'
 
 module Shipeasy::Admin::Generated
-  # The feedback ticket that tracks this error. Idempotent — if an open `error` ticket already tracks this fingerprint (hand- or auto-filed), the existing one is returned instead of creating a duplicate.
-  class FileErrorTicketResponse < ApiModelBase
-    # Feedback ticket id.
+  # Response for the public ticket intake. A fresh file returns `201` with `id` + `number`; a repeat of a report already tracked by an open ticket returns `200` with that ticket's `number` and `deduped: true` — plus `updated: true` when a `dedupKey` re-triggered it and its fields were refreshed.
+  class CreatePublicTicketResponse < ApiModelBase
+    # The new item's id. Absent on a deduped response — nothing was created, so there is no new id to report.
     attr_accessor :id
 
-    # Human-facing per-project ticket number.
+    # Per-project item number. On a deduped response this is the number of the OPEN ticket already tracking the report, which is what a caller should show the user either way.
     attr_accessor :number
 
+    # `true` when an open ticket already tracked this report and nothing was filed (HTTP 200). Absent on a fresh file (HTTP 201).
+    attr_accessor :deduped
+
+    # `true` when the deduped ticket was REFRESHED from this payload and got a \"re-triggered\" comment — only ever set alongside `deduped` on a submission that carried a `dedupKey`. Absent when the existing ticket was returned untouched.
+    attr_accessor :updated
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'id' => :'id',
-        :'number' => :'number'
+        :'number' => :'number',
+        :'deduped' => :'deduped',
+        :'updated' => :'updated'
       }
     end
 
@@ -44,7 +52,9 @@ module Shipeasy::Admin::Generated
     def self.openapi_types
       {
         :'id' => :'String',
-        :'number' => :'Integer'
+        :'number' => :'Integer',
+        :'deduped' => :'Boolean',
+        :'updated' => :'Boolean'
       }
     end
 
@@ -58,22 +68,20 @@ module Shipeasy::Admin::Generated
     # @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::FileErrorTicketResponse` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::CreatePublicTicketResponse` 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::FileErrorTicketResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::CreatePublicTicketResponse`. 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']
-      else
-        self.id = nil
       end
 
       if attributes.key?(:'number')
@@ -81,6 +89,14 @@ module Shipeasy::Admin::Generated
       else
         self.number = nil
       end
+
+      if attributes.key?(:'deduped')
+        self.deduped = attributes[:'deduped']
+      end
+
+      if attributes.key?(:'updated')
+        self.updated = attributes[:'updated']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -88,10 +104,6 @@ module Shipeasy::Admin::Generated
     def list_invalid_properties
       warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
       if @number.nil?
         invalid_properties.push('invalid value for "number", number cannot be nil.')
       end
@@ -103,21 +115,10 @@ module Shipeasy::Admin::Generated
     # @return true if the model is valid
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
-      return false if @id.nil?
       return false if @number.nil?
       true
     end
 
-    # Custom attribute writer method with validation
-    # @param [Object] id Value to be assigned
-    def id=(id)
-      if id.nil?
-        fail ArgumentError, 'id cannot be nil'
-      end
-
-      @id = id
-    end
-
     # Custom attribute writer method with validation
     # @param [Object] number Value to be assigned
     def number=(number)
@@ -134,7 +135,9 @@ module Shipeasy::Admin::Generated
       return true if self.equal?(o)
       self.class == o.class &&
           id == o.id &&
-          number == o.number
+          number == o.number &&
+          deduped == o.deduped &&
+          updated == o.updated
     end
 
     # @see the `==` method
@@ -146,7 +149,7 @@ module Shipeasy::Admin::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, number].hash
+      [id, number, deduped, updated].hash
     end
 
     # Builds the object from hash

data/lib/shipeasy_admin/models/env.rb

@@ -1,7 +1,7 @@
 =begin
-#Shipeasy Admin API
+#Shipeasy Admin API (server-SDK surface)
 
-#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 slice of the Shipeasy admin API that the published server SDKs expose as their optional `AdminClient`. Authenticate with an admin SDK key (`Authorization: Bearer sdk_admin_…`) and scope every request to a project via the `X-Project-Id` header.  Three capabilities, nothing else:  - **File a public ticket** — a bug or a feature request onto the project's ops queue. - **Toggle a kill switch** — flip the switch itself, or one of its named sub-switches, on one environment. - **Manage a flag's whitelist** — read, replace, add to, or remove from the allowlist that admits specific identities ahead of every targeting rule.  Everything else in the admin API is reachable through the Shipeasy CLI and MCP server, which speak the complete contract (`openapi.yaml`).
 
 The version of the OpenAPI document: 2.0.0