shipeasy-sdk 4.0.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f974f7f31df4a3c30015d2ec1149d32814f7e54a79fed06fd215bfe4c40bf84
-  data.tar.gz: c165ac01e2f01449538b7bdbaba217fd42c79b63481cacde1071fedaf2bd164e
+  metadata.gz: 54ea0b134073140b279ab8891d142a061e2164b3a31a0b6c7ec8d011e0877220
+  data.tar.gz: 3dcf6911b34004a46768b2205ee175557d073e3789cbbeeb32b7437ddccb13ae
 SHA512:
-  metadata.gz: 192d9656ff82682fccd90e94ece252f67ddb904e20faa50f13ea16ae291c6eb129aef61da23d3262c90b9b24edcc342ccd178e55c0aec639d4bbabad4a9458eb
-  data.tar.gz: ea186acc91a8dd5bb78956c013e298b8b3decbb9194a5432065ccd4c5d633385ea123998bd5845802b0c2b5e062a80865aa2a58fc3189855ecbba4040147fb23
+  metadata.gz: a793c67f011c56bd247f96f2824c074a50847c273e3b8541fd4da65900750b0f749d5d082630b4577b9af3be15c56842ef1bccf1549362c40f544c122d80ba06
+  data.tar.gz: b43aabff009ccd7ffdd5bd8a841fb27e786349fe3e40e421f3a4ddeeff86c3b5affce6d1e68a0c113daa3c7a09e1fe846d3077a1ceec3a84bb12de995cfe0dd2

data/README.md

@@ -128,4 +128,4 @@ More — the on-the-spot override helpers and a working example
 
 [Shipeasy-SAL 1.0](./LICENSE) — source-available, non-commercial-use, permitted
 as a Shipeasy client. Evaluation is tested against the cross-language
-MurmurHash3 vectors in `experiment-platform/04-evaluation.md`.
+MurmurHash3 vectors in [Rollouts & bucketing](https://docs.shipeasy.ai/flags/gates/rollouts).

data/lib/shipeasy/sdk/version.rb

@@ -1,5 +1,5 @@
 module Shipeasy
   module SDK
-    VERSION = "4.0.0"
+    VERSION = "4.1.0"
   end
 end

data/lib/shipeasy_admin/api/ops_api.rb

@@ -20,7 +20,7 @@ module Shipeasy::Admin::Generated
       @api_client = api_client
     end
     # File a bug
-    # Files one bug onto a project's queue, awaiting human approval. This is the **public** intake: it authenticates with a *client* SDK key rather than an admin key, so it can be called from a CLI, an installer script, a devtools overlay, or any shipped code — the same places a client key already lives.  Three gates decide whether a ticket is filed, and nothing else the caller sends can widen them:  1. the key is a `client` key carrying the `tickets:public_create` scope, 2. the key's project has public ticket creation enabled, and 3. the item is filed as `pending_approval` — parked out of the work queue until a human promotes it in the dashboard.  The project is the key's own project; there is no `X-Project-Id` to pass and no way to file into someone else's queue. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again.  This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API — see `servers` below.  **Use case:** `shipeasy setup` fails on a customer's machine and self-reports the failure with the user's consent — `{ \"title\": \"Setup failed at Feature installs\", \"stepsToReproduce\": \"…\", \"actualResult\": \"…\" }`.
+    # Files one bug onto a project's queue, awaiting human approval. This is the **public** intake: it authenticates with a *client* SDK key rather than an admin key, so it can be called from a CLI, an installer script, a devtools overlay, or any shipped code — the same places a client key already lives.  Three gates decide whether a ticket is filed, and nothing else the caller sends can widen them:  1. the key is a `client` key carrying the `tickets:public_create` scope, 2. the key's project has public ticket creation enabled, and 3. the item is filed as `pending_approval` — parked out of the work queue until a human promotes it in the dashboard.  The project is the key's own project; there is no `X-Project-Id` to pass and no way to file into someone else's queue. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again.  Send a `dedupKey` to own that grain yourself — the same key from a monitor, a job, or a retried install re-triggers its open ticket: the ticket's fields are refreshed from the new payload and a \"re-triggered\" comment is appended (`200` with `deduped: true, updated: true`), so one recurring failure stays one ticket with its history intact.  This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API — see `servers` below.  **Use case:** `shipeasy setup` fails on a customer's machine and self-reports the failure with the user's consent — `{ \"title\": \"Setup failed at Feature installs\", \"stepsToReproduce\": \"…\", \"actualResult\": \"…\" }`.
     # @param create_public_bug_request [CreatePublicBugRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CreatePublicTicketResponse]
@@ -30,7 +30,7 @@ module Shipeasy::Admin::Generated
     end
 
     # File a bug
-    # Files one bug onto a project's queue, awaiting human approval. This is the **public** intake: it authenticates with a *client* SDK key rather than an admin key, so it can be called from a CLI, an installer script, a devtools overlay, or any shipped code — the same places a client key already lives.  Three gates decide whether a ticket is filed, and nothing else the caller sends can widen them:  1. the key is a `client` key carrying the `tickets:public_create` scope, 2. the key's project has public ticket creation enabled, and 3. the item is filed as `pending_approval` — parked out of the work queue until a human promotes it in the dashboard.  The project is the key's own project; there is no `X-Project-Id` to pass and no way to file into someone else's queue. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again.  This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API — see `servers` below.  **Use case:** `shipeasy setup` fails on a customer's machine and self-reports the failure with the user's consent — `{ \"title\": \"Setup failed at Feature installs\", \"stepsToReproduce\": \"…\", \"actualResult\": \"…\" }`.
+    # Files one bug onto a project's queue, awaiting human approval. This is the **public** intake: it authenticates with a *client* SDK key rather than an admin key, so it can be called from a CLI, an installer script, a devtools overlay, or any shipped code — the same places a client key already lives.  Three gates decide whether a ticket is filed, and nothing else the caller sends can widen them:  1. the key is a `client` key carrying the `tickets:public_create` scope, 2. the key's project has public ticket creation enabled, and 3. the item is filed as `pending_approval` — parked out of the work queue until a human promotes it in the dashboard.  The project is the key's own project; there is no `X-Project-Id` to pass and no way to file into someone else's queue. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again.  Send a `dedupKey` to own that grain yourself — the same key from a monitor, a job, or a retried install re-triggers its open ticket: the ticket's fields are refreshed from the new payload and a \"re-triggered\" comment is appended (`200` with `deduped: true, updated: true`), so one recurring failure stays one ticket with its history intact.  This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API — see `servers` below.  **Use case:** `shipeasy setup` fails on a customer's machine and self-reports the failure with the user's consent — `{ \"title\": \"Setup failed at Feature installs\", \"stepsToReproduce\": \"…\", \"actualResult\": \"…\" }`.
     # @param create_public_bug_request [CreatePublicBugRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreatePublicTicketResponse, Integer, Hash)>] CreatePublicTicketResponse data, response status code and response headers
@@ -88,7 +88,7 @@ module Shipeasy::Admin::Generated
     end
 
     # File a feature request
-    # Files one feature request onto a project's queue, awaiting human approval. The feature-request counterpart to `POST /ops/bug`, with the same three gates: a `client` key carrying `tickets:public_create`, a project that has opted in, and a `pending_approval` state forced server-side.  The project is the key's own project; there is no `X-Project-Id` to pass. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again.  This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API — see `servers` below.  **Use case:** An in-product \"request a feature\" form posts what the user asked for — `{ \"title\": \"Dark mode\", \"useCase\": \"Reduce eye strain at night\" }`.
+    # Files one feature request onto a project's queue, awaiting human approval. The feature-request counterpart to `POST /ops/bug`, with the same three gates: a `client` key carrying `tickets:public_create`, a project that has opted in, and a `pending_approval` state forced server-side.  The project is the key's own project; there is no `X-Project-Id` to pass. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns `200` with `deduped: true` instead of filing again. A `dedupKey` works exactly as on `POST /ops/bug`: a repeat carrying the same key refreshes the open ticket and comments that it was re-triggered.  This endpoint is served by the Shipeasy **edge worker** (`api.shipeasy.ai`), not the admin API — see `servers` below.  **Use case:** An in-product \"request a feature\" form posts what the user asked for — `{ \"title\": \"Dark mode\", \"useCase\": \"Reduce eye strain at night\" }`.
     # @param create_public_feature_request_request [CreatePublicFeatureRequestRequest] 
     # @param [Hash] opts the optional parameters
     # @return [CreatePublicTicketResponse]
@@ -98,7 +98,7 @@ module Shipeasy::Admin::Generated
     end
 
     # File a feature request
-    # Files one feature request onto a project&#39;s queue, awaiting human approval. The feature-request counterpart to &#x60;POST /ops/bug&#x60;, with the same three gates: a &#x60;client&#x60; key carrying &#x60;tickets:public_create&#x60;, a project that has opted in, and a &#x60;pending_approval&#x60; state forced server-side.  The project is the key&#39;s own project; there is no &#x60;X-Project-Id&#x60; to pass. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns &#x60;200&#x60; with &#x60;deduped: true&#x60; instead of filing again.  This endpoint is served by the Shipeasy **edge worker** (&#x60;api.shipeasy.ai&#x60;), not the admin API — see &#x60;servers&#x60; below.  **Use case:** An in-product \&quot;request a feature\&quot; form posts what the user asked for — &#x60;{ \&quot;title\&quot;: \&quot;Dark mode\&quot;, \&quot;useCase\&quot;: \&quot;Reduce eye strain at night\&quot; }&#x60;.
+    # Files one feature request onto a project&#39;s queue, awaiting human approval. The feature-request counterpart to &#x60;POST /ops/bug&#x60;, with the same three gates: a &#x60;client&#x60; key carrying &#x60;tickets:public_create&#x60;, a project that has opted in, and a &#x60;pending_approval&#x60; state forced server-side.  The project is the key&#39;s own project; there is no &#x60;X-Project-Id&#x60; to pass. Repeat submissions of the same title dedupe against the open ticket already tracking it, which returns &#x60;200&#x60; with &#x60;deduped: true&#x60; instead of filing again. A &#x60;dedupKey&#x60; works exactly as on &#x60;POST /ops/bug&#x60;: a repeat carrying the same key refreshes the open ticket and comments that it was re-triggered.  This endpoint is served by the Shipeasy **edge worker** (&#x60;api.shipeasy.ai&#x60;), not the admin API — see &#x60;servers&#x60; below.  **Use case:** An in-product \&quot;request a feature\&quot; form posts what the user asked for — &#x60;{ \&quot;title\&quot;: \&quot;Dark mode\&quot;, \&quot;useCase\&quot;: \&quot;Reduce eye strain at night\&quot; }&#x60;.
     # @param create_public_feature_request_request [CreatePublicFeatureRequestRequest] 
     # @param [Hash] opts the optional parameters
     # @return [Array<(CreatePublicTicketResponse, Integer, Hash)>] CreatePublicTicketResponse data, response status code and response headers

data/lib/shipeasy_admin/models/create_public_bug_request.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Shipeasy::Admin::Generated
-  # Body for `POST /ops/bug`. The same bug fields as `CreateBugRequest`, minus the `type` discriminator — the path already says what is being filed.
+  # Body for `POST /ops/bug`. The same bug fields as `CreateBugRequest`, minus the `type` discriminator — the path already says what is being filed, plus the public intake's own `dedupKey`.
   class CreatePublicBugRequest < ApiModelBase
     # One-line bug title (no leading/trailing whitespace).
     attr_accessor :title
@@ -58,6 +58,9 @@ module Shipeasy::Admin::Generated
     # Arbitrary capture context, or `null`.
     attr_accessor :context
 
+    # Caller-chosen dedupe identity for this report, stored on the ticket. A repeat submission carrying the same key does NOT file a second ticket: the open ticket already holding that key is refreshed from this payload (title and the report fields overwritten, a \"re-triggered\" comment appended) and returned with `deduped: true` and `updated: true`. Triage state a human owns — status, priority, assignee, tags — is left untouched, and a `resolved`/`wont_fix` ticket no longer holds the key, so a failure that comes back after being closed files a fresh ticket. Omit it to fall back to the derived (title + `context.step`) dedupe, whose repeats return the existing ticket unchanged.
+    attr_accessor :dedup_key
+
     # Where this bug's completion notification lands.
     attr_accessor :notify
 
@@ -100,6 +103,7 @@ module Shipeasy::Admin::Generated
         :'user_agent' => :'userAgent',
         :'viewport' => :'viewport',
         :'context' => :'context',
+        :'dedup_key' => :'dedupKey',
         :'notify' => :'notify'
       }
     end
@@ -131,6 +135,7 @@ module Shipeasy::Admin::Generated
         :'user_agent' => :'String',
         :'viewport' => :'String',
         :'context' => :'Hash<String, Object>',
+        :'dedup_key' => :'String',
         :'notify' => :'NotificationTarget'
       }
     end
@@ -235,6 +240,10 @@ module Shipeasy::Admin::Generated
         end
       end
 
+      if attributes.key?(:'dedup_key')
+        self.dedup_key = attributes[:'dedup_key']
+      end
+
       if attributes.key?(:'notify')
         self.notify = attributes[:'notify']
       end
@@ -282,6 +291,10 @@ module Shipeasy::Admin::Generated
         invalid_properties.push('invalid value for "viewport", the character length must be smaller than or equal to 40.')
       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
 
@@ -298,6 +311,7 @@ module Shipeasy::Admin::Generated
       return false if !@expected_result.nil? && @expected_result.to_s.length > 8000
       return false if !@user_agent.nil? && @user_agent.to_s.length > 500
       return false if !@viewport.nil? && @viewport.to_s.length > 40
+      return false if !@dedup_key.nil? && @dedup_key.to_s.length > 200
       true
     end
 
@@ -386,6 +400,20 @@ module Shipeasy::Admin::Generated
       @viewport = viewport
     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)
@@ -405,6 +433,7 @@ module Shipeasy::Admin::Generated
           user_agent == o.user_agent &&
           viewport == o.viewport &&
           context == o.context &&
+          dedup_key == o.dedup_key &&
           notify == o.notify
     end
 
@@ -417,7 +446,7 @@ module Shipeasy::Admin::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [title, steps_to_reproduce, actual_result, expected_result, priority, status, assignee_id, subscribers, tags, reporter_email, page_url, user_agent, viewport, context, notify].hash
+      [title, steps_to_reproduce, actual_result, expected_result, priority, status, assignee_id, subscribers, tags, reporter_email, page_url, user_agent, viewport, context, dedup_key, notify].hash
     end
 
     # Builds the object from hash

data/lib/shipeasy_admin/models/create_public_feature_request_request.rb

@@ -14,7 +14,7 @@ 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.
+  # 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
@@ -52,6 +52,9 @@ module Shipeasy::Admin::Generated
     # 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
 
@@ -92,6 +95,7 @@ module Shipeasy::Admin::Generated
         :'page_url' => :'pageUrl',
         :'user_agent' => :'userAgent',
         :'context' => :'context',
+        :'dedup_key' => :'dedupKey',
         :'notify' => :'notify'
       }
     end
@@ -121,6 +125,7 @@ module Shipeasy::Admin::Generated
         :'page_url' => :'String',
         :'user_agent' => :'String',
         :'context' => :'Hash<String, Object>',
+        :'dedup_key' => :'String',
         :'notify' => :'NotificationTarget'
       }
     end
@@ -214,6 +219,10 @@ module Shipeasy::Admin::Generated
         end
       end
 
+      if attributes.key?(:'dedup_key')
+        self.dedup_key = attributes[:'dedup_key']
+      end
+
       if attributes.key?(:'notify')
         self.notify = attributes[:'notify']
       end
@@ -253,6 +262,10 @@ module Shipeasy::Admin::Generated
         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
 
@@ -267,6 +280,7 @@ module Shipeasy::Admin::Generated
       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
 
@@ -331,6 +345,20 @@ module Shipeasy::Admin::Generated
       @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)
@@ -348,6 +376,7 @@ module Shipeasy::Admin::Generated
           page_url == o.page_url &&
           user_agent == o.user_agent &&
           context == o.context &&
+          dedup_key == o.dedup_key &&
           notify == o.notify
     end
 
@@ -360,7 +389,7 @@ module Shipeasy::Admin::Generated
     # 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, notify].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

data/lib/shipeasy_admin/models/create_public_ticket_response.rb

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module Shipeasy::Admin::Generated
-  # 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`.
+  # 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
@@ -25,12 +25,16 @@ module Shipeasy::Admin::Generated
     # `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',
-        :'deduped' => :'deduped'
+        :'deduped' => :'deduped',
+        :'updated' => :'updated'
       }
     end
 
@@ -49,7 +53,8 @@ module Shipeasy::Admin::Generated
       {
         :'id' => :'String',
         :'number' => :'Integer',
-        :'deduped' => :'Boolean'
+        :'deduped' => :'Boolean',
+        :'updated' => :'Boolean'
       }
     end
 
@@ -88,6 +93,10 @@ module Shipeasy::Admin::Generated
       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?
@@ -127,7 +136,8 @@ module Shipeasy::Admin::Generated
       self.class == o.class &&
           id == o.id &&
           number == o.number &&
-          deduped == o.deduped
+          deduped == o.deduped &&
+          updated == o.updated
     end
 
     # @see the `==` method
@@ -139,7 +149,7 @@ module Shipeasy::Admin::Generated
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, number, deduped].hash
+      [id, number, deduped, updated].hash
     end
 
     # Builds the object from hash

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shipeasy-sdk
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.1.0
 platform: ruby
 authors:
 - Shipeasy, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-07-27 00:00:00.000000000 Z
+date: 2026-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec