shipeasy-sdk 4.2.0 → 4.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (59) hide show
  1. checksums.yaml +4 -4
  2. data/lib/shipeasy/sdk/version.rb +1 -1
  3. data/lib/shipeasy_admin/api/flags_api.rb +9 -9
  4. data/lib/shipeasy_admin/api/killswitch_api.rb +1 -1
  5. data/lib/shipeasy_admin/api/ops_api.rb +127 -1
  6. data/lib/shipeasy_admin/api_client.rb +1 -1
  7. data/lib/shipeasy_admin/api_error.rb +1 -1
  8. data/lib/shipeasy_admin/api_model_base.rb +1 -1
  9. data/lib/shipeasy_admin/configuration.rb +1 -1
  10. data/lib/shipeasy_admin/models/add_to_gate_whitelist_request.rb +1 -1
  11. data/lib/shipeasy_admin/models/connector_data.rb +157 -0
  12. data/lib/shipeasy_admin/models/create_public_bug_request.rb +30 -2
  13. data/lib/shipeasy_admin/models/create_public_feature_request_request.rb +30 -2
  14. data/lib/shipeasy_admin/models/create_public_ticket_response.rb +1 -1
  15. data/lib/shipeasy_admin/models/env.rb +1 -1
  16. data/lib/shipeasy_admin/models/error.rb +1 -1
  17. data/lib/shipeasy_admin/models/error_code.rb +1 -1
  18. data/lib/shipeasy_admin/models/gate_whitelist.rb +1 -1
  19. data/lib/shipeasy_admin/models/gate_whitelist_attr.rb +1 -1
  20. data/lib/shipeasy_admin/models/github_connector_data.rb +170 -0
  21. data/lib/shipeasy_admin/models/github_connector_data_issue.rb +257 -0
  22. data/lib/shipeasy_admin/models/github_pr_link.rb +319 -0
  23. data/lib/shipeasy_admin/models/killswitch_value.rb +1 -1
  24. data/lib/shipeasy_admin/models/list_ops_items_response_inner.rb +593 -0
  25. data/lib/shipeasy_admin/models/measure_plan_resource.rb +228 -0
  26. data/lib/shipeasy_admin/models/measure_plan_step.rb +211 -0
  27. data/lib/shipeasy_admin/models/notification_target.rb +1 -1
  28. data/lib/shipeasy_admin/models/notification_target_slack_channel.rb +1 -1
  29. data/lib/shipeasy_admin/models/ops_alert_context.rb +350 -0
  30. data/lib/shipeasy_admin/models/ops_alert_metric_summary.rb +222 -0
  31. data/lib/shipeasy_admin/models/ops_alert_rule_summary.rb +298 -0
  32. data/lib/shipeasy_admin/models/ops_browser_context.rb +172 -0
  33. data/lib/shipeasy_admin/models/ops_error_context.rb +429 -0
  34. data/lib/shipeasy_admin/models/ops_investigation_state.rb +48 -0
  35. data/lib/shipeasy_admin/models/ops_item_context.rb +193 -0
  36. data/lib/shipeasy_admin/models/ops_item_context_error_chart.rb +222 -0
  37. data/lib/shipeasy_admin/models/ops_item_context_error_chart_series_inner.rb +193 -0
  38. data/lib/shipeasy_admin/models/ops_item_owner.rb +163 -0
  39. data/lib/shipeasy_admin/models/ops_item_owner_agent.rb +255 -0
  40. data/lib/shipeasy_admin/models/ops_item_owner_user.rb +206 -0
  41. data/lib/shipeasy_admin/models/ops_item_priority.rb +1 -1
  42. data/lib/shipeasy_admin/models/ops_item_status.rb +1 -1
  43. data/lib/shipeasy_admin/models/ops_measure_plan_context.rb +220 -0
  44. data/lib/shipeasy_admin/models/ops_reporter_context.rb +328 -0
  45. data/lib/shipeasy_admin/models/ops_reporter_experiment.rb +230 -0
  46. data/lib/shipeasy_admin/models/ops_reporter_flag.rb +193 -0
  47. data/lib/shipeasy_admin/models/ops_reporter_killswitch.rb +205 -0
  48. data/lib/shipeasy_admin/models/ops_run.rb +309 -0
  49. data/lib/shipeasy_admin/models/ops_run_action.rb +42 -0
  50. data/lib/shipeasy_admin/models/ops_run_action_or_null.rb +146 -0
  51. data/lib/shipeasy_admin/models/remove_from_gate_whitelist_request.rb +1 -1
  52. data/lib/shipeasy_admin/models/set_gate_whitelist_request.rb +1 -1
  53. data/lib/shipeasy_admin/models/slack_connector_data.rb +148 -0
  54. data/lib/shipeasy_admin/models/slack_connector_data_message.rb +203 -0
  55. data/lib/shipeasy_admin/models/toggle_killswitch_request.rb +1 -1
  56. data/lib/shipeasy_admin/models/toggle_killswitch_response.rb +1 -1
  57. data/lib/shipeasy_admin/version.rb +1 -1
  58. data/lib/shipeasy_admin.rb +30 -1
  59. metadata +35 -6
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 95ceaf83b490b3ead4d906afc230f980c1d0a19a922a1de60a1aadcbf711ba2d
4
- data.tar.gz: 04dd01e38421b5b765efd00778c3a9277ad4b5ee1969d991146d191311a27518
3
+ metadata.gz: b98a99a1e3d9f59d4c5e47a5915c7357d7f98c45b034e6ba6c93f1d501d899c4
4
+ data.tar.gz: 48f3bdc676beabcae9428d48c538ba98f04869eb677c068a41fefb3e108af688
5
5
  SHA512:
6
- metadata.gz: 8ae769272370dccfbe8e8a154bf79c6007e89ab909312d8ba86f8f9a3138b757978c475a1902e85a09edcdc71c186e2371953e2f20db7a2dda1fa13df486a462
7
- data.tar.gz: 167338e87bc545cf110b7f234c8b19576568e2125ccf87f71f89b203f11099c27a5b08562a96b059c30574e248baf5b07e556383e6f5c736a2d14209a3814368
6
+ metadata.gz: 14f28bc1276df857afca8cd9fbe44b10b6c0204aaac7d469dba8085f2c6346adc8a65ae069044fbc203585414b425c144d5d99c8f60807a085efab4f8fe97319
7
+ data.tar.gz: 889ddf65608b90921a57dc880b23ec58b97ba70dd870ad7decca1fe5f024b364136863542029d15895af2b83ce5bbf899e55e1fba253c9d11a862a165f885ffc
@@ -1,5 +1,5 @@
1
1
  module Shipeasy
2
2
  module SDK
3
- VERSION = "4.2.0"
3
+ VERSION = "4.4.0"
4
4
  end
5
5
  end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -21,7 +21,7 @@ module Shipeasy::Admin::Generated
21
21
  end
22
22
  # Add entries to a gate's whitelist
23
23
  # Adds identities to the gate's whitelist, creating the block if the gate doesn't have one yet. Entries already on the list are skipped, so the call is idempotent and safe to retry. Adding to a gate that already has a whitelist keyed on the other attribute is rejected (409) rather than silently re-keying the entries already there — use `PUT` to switch `attr` deliberately. **Use case:** Let one more customer into a private beta without reading the current list first.
24
- # @param id [String] Stable opaque gate id (`gate_…`) or the gate's `name`.
24
+ # @param id [String] Stable opaque gate id (`gat_…`) or the gate's `name`.
25
25
  # @param add_to_gate_whitelist_request [AddToGateWhitelistRequest]
26
26
  # @param [Hash] opts the optional parameters
27
27
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
@@ -33,7 +33,7 @@ module Shipeasy::Admin::Generated
33
33
 
34
34
  # Add entries to a gate's whitelist
35
35
  # Adds identities to the gate's whitelist, creating the block if the gate doesn't have one yet. Entries already on the list are skipped, so the call is idempotent and safe to retry. Adding to a gate that already has a whitelist keyed on the other attribute is rejected (409) rather than silently re-keying the entries already there — use `PUT` to switch `attr` deliberately. **Use case:** Let one more customer into a private beta without reading the current list first.
36
- # @param id [String] Stable opaque gate id (`gate_…`) or the gate's `name`.
36
+ # @param id [String] Stable opaque gate id (`gat_…`) or the gate's `name`.
37
37
  # @param add_to_gate_whitelist_request [AddToGateWhitelistRequest]
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
@@ -106,7 +106,7 @@ module Shipeasy::Admin::Generated
106
106
 
107
107
  # Read a gate's whitelist
108
108
  # Returns the gate's whitelist — the always-first allowlist that admits the listed identities before any targeting rule or percentage rollout is evaluated. A gate with no whitelist returns `entries: []` (and the default `attr`), never a 404 — so a caller can read-then-write without special-casing the empty gate. **Use case:** Check whether an account is already let through before adding it.
109
- # @param id [String] Stable opaque gate id (`gate_…`) or the gate's `name`.
109
+ # @param id [String] Stable opaque gate id (`gat_…`) or the gate's `name`.
110
110
  # @param [Hash] opts the optional parameters
111
111
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
112
112
  # @return [GateWhitelist]
@@ -117,7 +117,7 @@ module Shipeasy::Admin::Generated
117
117
 
118
118
  # Read a gate's whitelist
119
119
  # Returns the gate's whitelist — the always-first allowlist that admits the listed identities before any targeting rule or percentage rollout is evaluated. A gate with no whitelist returns `entries: []` (and the default `attr`), never a 404 — so a caller can read-then-write without special-casing the empty gate. **Use case:** Check whether an account is already let through before adding it.
120
- # @param id [String] Stable opaque gate id (`gate_…`) or the gate's `name`.
120
+ # @param id [String] Stable opaque gate id (`gat_…`) or the gate's `name`.
121
121
  # @param [Hash] opts the optional parameters
122
122
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
123
123
  # @return [Array<(GateWhitelist, Integer, Hash)>] GateWhitelist data, response status code and response headers
@@ -180,7 +180,7 @@ module Shipeasy::Admin::Generated
180
180
 
181
181
  # Remove entries from a gate's whitelist
182
182
  # Removes identities from the gate's whitelist. Entries that aren't on the list are skipped, so the call is idempotent. Removing the last entry leaves an empty whitelist block in place; to drop the block itself use `PUT` with `entries: []`. **Use case:** Revoke one beta tester's access without touching anyone else's.
183
- # @param id [String] Stable opaque gate id (&#x60;gate_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
183
+ # @param id [String] Stable opaque gate id (&#x60;gat_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
184
184
  # @param remove_from_gate_whitelist_request [RemoveFromGateWhitelistRequest]
185
185
  # @param [Hash] opts the optional parameters
186
186
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
@@ -192,7 +192,7 @@ module Shipeasy::Admin::Generated
192
192
 
193
193
  # Remove entries from a gate&#39;s whitelist
194
194
  # Removes identities from the gate&#39;s whitelist. Entries that aren&#39;t on the list are skipped, so the call is idempotent. Removing the last entry leaves an empty whitelist block in place; to drop the block itself use &#x60;PUT&#x60; with &#x60;entries: []&#x60;. **Use case:** Revoke one beta tester&#39;s access without touching anyone else&#39;s.
195
- # @param id [String] Stable opaque gate id (&#x60;gate_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
195
+ # @param id [String] Stable opaque gate id (&#x60;gat_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
196
196
  # @param remove_from_gate_whitelist_request [RemoveFromGateWhitelistRequest]
197
197
  # @param [Hash] opts the optional parameters
198
198
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
@@ -265,7 +265,7 @@ module Shipeasy::Admin::Generated
265
265
 
266
266
  # Replace a gate's whitelist
267
267
  # Replaces the gate's whole whitelist with `entries`, creating the block if the gate didn't have one. Idempotent — the same call twice leaves the same list. This is the only whitelist call that can switch `attr` (`email` ⇄ `user_id`) or clear the block: `entries: []` removes the whitelist from the gate entirely. **Use cases** - **Pin an exact list** — `{ \"entries\": [\"alice@acme.dev\", \"bob@acme.dev\"] }`. - **Switch to user ids** — `{ \"attr\": \"user_id\", \"entries\": [\"usr_123\"] }`. - **Drop the whitelist** — `{ \"entries\": [] }`.
268
- # @param id [String] Stable opaque gate id (&#x60;gate_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
268
+ # @param id [String] Stable opaque gate id (&#x60;gat_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
269
269
  # @param set_gate_whitelist_request [SetGateWhitelistRequest]
270
270
  # @param [Hash] opts the optional parameters
271
271
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
@@ -277,7 +277,7 @@ module Shipeasy::Admin::Generated
277
277
 
278
278
  # Replace a gate&#39;s whitelist
279
279
  # Replaces the gate&#39;s whole whitelist with &#x60;entries&#x60;, creating the block if the gate didn&#39;t have one. Idempotent — the same call twice leaves the same list. This is the only whitelist call that can switch &#x60;attr&#x60; (&#x60;email&#x60; ⇄ &#x60;user_id&#x60;) or clear the block: &#x60;entries: []&#x60; removes the whitelist from the gate entirely. **Use cases** - **Pin an exact list** — &#x60;{ \&quot;entries\&quot;: [\&quot;alice@acme.dev\&quot;, \&quot;bob@acme.dev\&quot;] }&#x60;. - **Switch to user ids** — &#x60;{ \&quot;attr\&quot;: \&quot;user_id\&quot;, \&quot;entries\&quot;: [\&quot;usr_123\&quot;] }&#x60;. - **Drop the whitelist** — &#x60;{ \&quot;entries\&quot;: [] }&#x60;.
280
- # @param id [String] Stable opaque gate id (&#x60;gate_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
280
+ # @param id [String] Stable opaque gate id (&#x60;gat_…&#x60;) or the gate&#39;s &#x60;name&#x60;.
281
281
  # @param set_gate_whitelist_request [SetGateWhitelistRequest]
282
282
  # @param [Hash] opts the optional parameters
283
283
  # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -154,5 +154,131 @@ module Shipeasy::Admin::Generated
154
154
  end
155
155
  return data, status_code, headers
156
156
  end
157
+
158
+ # List the operational queue
159
+ # Returns the unified ops queue (bugs, feature requests, errors, alerts, measurement plans) in work order — highest priority first, oldest first within a priority — so consumers work it top-down. Every filter is applied in SQL before paging, and filters combine with AND. Human-gated holding states (items awaiting human sign-off in the dashboard) are never returned by `all`/default status. **Filters:** `type` (one item type), `status` (one lifecycle status, or `unresolved` — everything not yet `resolved`/`wont_fix`), `priority` (one triage priority), `owner` (one person or agent), `reporter` (one filer's email), `closedSince` (drop items closed before a time), and `scope=ready` — the items ready to be picked up right now: `open`, with nobody working them (no open run), and either unowned or reopened (sent back to `open` after an earlier run finished). **Paging:** `limit` is the page size and `offset` the number of items to skip. The order is stable, so walk the queue with `offset += limit`; a page shorter than `limit` is the last one. **Use case:** Pull the open queue to triage — e.g. every `bug` still `open` — before working items down one by one.
160
+ # @param [Hash] opts the optional parameters
161
+ # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
162
+ # @option opts [String] :type Filter by item type, or &#x60;all&#x60; (the default). Every type a returned item can carry is filterable, including the auto-filed ones. (default to 'all')
163
+ # @option opts [String] :status Filter by one lifecycle status, &#x60;unresolved&#x60; for every status that is not &#x60;resolved&#x60; or &#x60;wont_fix&#x60;, or &#x60;all&#x60; for every status. Defaults to &#x60;all&#x60; over HTTP; the CLI and MCP tool default to &#x60;unresolved&#x60;, so pass &#x60;all&#x60; there to include resolved and won&#39;t-fix items. The human-gated holding state (&#x60;pending_approval&#x60;) is excluded from &#x60;unresolved&#x60; and &#x60;all&#x60;, and returned only when requested as the exact status. (default to 'all')
164
+ # @option opts [String] :priority Filter by triage priority, or &#x60;all&#x60; (the default). Items with no priority set are returned only under &#x60;all&#x60;. (default to 'all')
165
+ # @option opts [String] :scope &#x60;ready&#x60; narrows to the items ready to be picked up right now: status &#x60;open&#x60;, no open run (nobody has acked it and is still working), and either unowned (no person and no agent) or reopened (sent back to &#x60;open&#x60; after an earlier run finished). Leave &#x60;status&#x60; unset with it. &#x60;all&#x60; (the default) applies no such narrowing. (default to 'all')
166
+ # @option opts [String] :qa_questions &#x60;open&#x60; narrows to the items with at least one unanswered QA question — the backlog QA answers first (read each with &#x60;ops get&#x60;, answer with &#x60;ops qa-questions answer&#x60;). &#x60;all&#x60; (the default) applies no such narrowing. (default to 'all')
167
+ # @option opts [Integer] :limit Page size — max items to return (1–500). A page shorter than &#x60;limit&#x60; is the last one. (default to 200)
168
+ # @option opts [Integer] :offset Number of items to skip before the page starts. Defaults to 0. The order is stable, so &#x60;offset +&#x3D; limit&#x60; walks the queue page by page. (default to 0)
169
+ # @option opts [String] :owner Narrow to items owned by one person OR one agent. Matches a person by &#x60;users.id&#x60;, email, or display name, and an agent by connector id, display name, or kebab-case handle — e.g. &#x60;owner&#x3D;Claude&#x60; or &#x60;owner&#x3D;alice@acme.dev&#x60;. Case-insensitive exact match.
170
+ # @option opts [String] :reporter Narrow to items filed by one reporter — an email, matched case-insensitive and exact against &#x60;reporterEmail&#x60;. Items with no reporter never match. While set, &#x60;status&#x3D;all&#x60; also returns &#x60;pending_approval&#x60; items: public intake files every ticket as &#x60;pending_approval&#x60;, and a reporter must see the ticket they just filed.
171
+ # @option opts [Time] :closed_since ISO-8601 timestamp. Items still being worked are always returned; &#x60;resolved&#x60; and &#x60;wont_fix&#x60; items only when they closed at or after this time (see &#x60;closedAt&#x60;). Combines with &#x60;status&#x60; like any other filter.
172
+ # @return [Array<ListOpsItemsResponseInner>]
173
+ def list_ops_items(opts = {})
174
+ data, _status_code, _headers = list_ops_items_with_http_info(opts)
175
+ data
176
+ end
177
+
178
+ # List the operational queue
179
+ # Returns the unified ops queue (bugs, feature requests, errors, alerts, measurement plans) in work order — highest priority first, oldest first within a priority — so consumers work it top-down. Every filter is applied in SQL before paging, and filters combine with AND. Human-gated holding states (items awaiting human sign-off in the dashboard) are never returned by &#x60;all&#x60;/default status. **Filters:** &#x60;type&#x60; (one item type), &#x60;status&#x60; (one lifecycle status, or &#x60;unresolved&#x60; — everything not yet &#x60;resolved&#x60;/&#x60;wont_fix&#x60;), &#x60;priority&#x60; (one triage priority), &#x60;owner&#x60; (one person or agent), &#x60;reporter&#x60; (one filer&#39;s email), &#x60;closedSince&#x60; (drop items closed before a time), and &#x60;scope&#x3D;ready&#x60; — the items ready to be picked up right now: &#x60;open&#x60;, with nobody working them (no open run), and either unowned or reopened (sent back to &#x60;open&#x60; after an earlier run finished). **Paging:** &#x60;limit&#x60; is the page size and &#x60;offset&#x60; the number of items to skip. The order is stable, so walk the queue with &#x60;offset +&#x3D; limit&#x60;; a page shorter than &#x60;limit&#x60; is the last one. **Use case:** Pull the open queue to triage — e.g. every &#x60;bug&#x60; still &#x60;open&#x60; — before working items down one by one.
180
+ # @param [Hash] opts the optional parameters
181
+ # @option opts [String] :x_project_id Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).
182
+ # @option opts [String] :type Filter by item type, or &#x60;all&#x60; (the default). Every type a returned item can carry is filterable, including the auto-filed ones. (default to 'all')
183
+ # @option opts [String] :status Filter by one lifecycle status, &#x60;unresolved&#x60; for every status that is not &#x60;resolved&#x60; or &#x60;wont_fix&#x60;, or &#x60;all&#x60; for every status. Defaults to &#x60;all&#x60; over HTTP; the CLI and MCP tool default to &#x60;unresolved&#x60;, so pass &#x60;all&#x60; there to include resolved and won&#39;t-fix items. The human-gated holding state (&#x60;pending_approval&#x60;) is excluded from &#x60;unresolved&#x60; and &#x60;all&#x60;, and returned only when requested as the exact status. (default to 'all')
184
+ # @option opts [String] :priority Filter by triage priority, or &#x60;all&#x60; (the default). Items with no priority set are returned only under &#x60;all&#x60;. (default to 'all')
185
+ # @option opts [String] :scope &#x60;ready&#x60; narrows to the items ready to be picked up right now: status &#x60;open&#x60;, no open run (nobody has acked it and is still working), and either unowned (no person and no agent) or reopened (sent back to &#x60;open&#x60; after an earlier run finished). Leave &#x60;status&#x60; unset with it. &#x60;all&#x60; (the default) applies no such narrowing. (default to 'all')
186
+ # @option opts [String] :qa_questions &#x60;open&#x60; narrows to the items with at least one unanswered QA question — the backlog QA answers first (read each with &#x60;ops get&#x60;, answer with &#x60;ops qa-questions answer&#x60;). &#x60;all&#x60; (the default) applies no such narrowing. (default to 'all')
187
+ # @option opts [Integer] :limit Page size — max items to return (1–500). A page shorter than &#x60;limit&#x60; is the last one. (default to 200)
188
+ # @option opts [Integer] :offset Number of items to skip before the page starts. Defaults to 0. The order is stable, so &#x60;offset +&#x3D; limit&#x60; walks the queue page by page. (default to 0)
189
+ # @option opts [String] :owner Narrow to items owned by one person OR one agent. Matches a person by &#x60;users.id&#x60;, email, or display name, and an agent by connector id, display name, or kebab-case handle — e.g. &#x60;owner&#x3D;Claude&#x60; or &#x60;owner&#x3D;alice@acme.dev&#x60;. Case-insensitive exact match.
190
+ # @option opts [String] :reporter Narrow to items filed by one reporter — an email, matched case-insensitive and exact against &#x60;reporterEmail&#x60;. Items with no reporter never match. While set, &#x60;status&#x3D;all&#x60; also returns &#x60;pending_approval&#x60; items: public intake files every ticket as &#x60;pending_approval&#x60;, and a reporter must see the ticket they just filed.
191
+ # @option opts [Time] :closed_since ISO-8601 timestamp. Items still being worked are always returned; &#x60;resolved&#x60; and &#x60;wont_fix&#x60; items only when they closed at or after this time (see &#x60;closedAt&#x60;). Combines with &#x60;status&#x60; like any other filter.
192
+ # @return [Array<(Array<ListOpsItemsResponseInner>, Integer, Hash)>] Array<ListOpsItemsResponseInner> data, response status code and response headers
193
+ def list_ops_items_with_http_info(opts = {})
194
+ if @api_client.config.debugging
195
+ @api_client.config.logger.debug 'Calling API: OpsApi.list_ops_items ...'
196
+ end
197
+ allowable_values = ["bug", "feature_request", "error", "alert", "measure_plan", "all"]
198
+ if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
199
+ fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
200
+ end
201
+ allowable_values = ["open", "pending_approval", "investigating_by_ai", "in_progress", "blocked", "ready_for_qa", "resolved", "wont_fix", "unresolved", "all"]
202
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
203
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
204
+ end
205
+ allowable_values = ["nice_to_have", "medium", "high", "critical", "all"]
206
+ if @api_client.config.client_side_validation && opts[:'priority'] && !allowable_values.include?(opts[:'priority'])
207
+ fail ArgumentError, "invalid value for \"priority\", must be one of #{allowable_values}"
208
+ end
209
+ allowable_values = ["all", "ready"]
210
+ if @api_client.config.client_side_validation && opts[:'scope'] && !allowable_values.include?(opts[:'scope'])
211
+ fail ArgumentError, "invalid value for \"scope\", must be one of #{allowable_values}"
212
+ end
213
+ allowable_values = ["all", "open"]
214
+ if @api_client.config.client_side_validation && opts[:'qa_questions'] && !allowable_values.include?(opts[:'qa_questions'])
215
+ fail ArgumentError, "invalid value for \"qa_questions\", must be one of #{allowable_values}"
216
+ end
217
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
218
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OpsApi.list_ops_items, must be smaller than or equal to 500.'
219
+ end
220
+
221
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
222
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling OpsApi.list_ops_items, must be greater than or equal to 1.'
223
+ end
224
+
225
+ if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] > 100000
226
+ fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling OpsApi.list_ops_items, must be smaller than or equal to 100000.'
227
+ end
228
+
229
+ if @api_client.config.client_side_validation && !opts[:'offset'].nil? && opts[:'offset'] < 0
230
+ fail ArgumentError, 'invalid value for "opts[:"offset"]" when calling OpsApi.list_ops_items, must be greater than or equal to 0.'
231
+ end
232
+
233
+ # resource path
234
+ local_var_path = '/api/admin/ops'
235
+
236
+ # query parameters
237
+ query_params = opts[:query_params] || {}
238
+ query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
239
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
240
+ query_params[:'priority'] = opts[:'priority'] if !opts[:'priority'].nil?
241
+ query_params[:'scope'] = opts[:'scope'] if !opts[:'scope'].nil?
242
+ query_params[:'qaQuestions'] = opts[:'qa_questions'] if !opts[:'qa_questions'].nil?
243
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
244
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
245
+ query_params[:'owner'] = opts[:'owner'] if !opts[:'owner'].nil?
246
+ query_params[:'reporter'] = opts[:'reporter'] if !opts[:'reporter'].nil?
247
+ query_params[:'closedSince'] = opts[:'closed_since'] if !opts[:'closed_since'].nil?
248
+
249
+ # header parameters
250
+ header_params = opts[:header_params] || {}
251
+ # HTTP header 'Accept' (if needed)
252
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
253
+ header_params[:'X-Project-Id'] = opts[:'x_project_id'] if !opts[:'x_project_id'].nil?
254
+
255
+ # form parameters
256
+ form_params = opts[:form_params] || {}
257
+
258
+ # http body (model)
259
+ post_body = opts[:debug_body]
260
+
261
+ # return_type
262
+ return_type = opts[:debug_return_type] || 'Array<ListOpsItemsResponseInner>'
263
+
264
+ # auth_names
265
+ auth_names = opts[:debug_auth_names] || ['bearerSdkKey']
266
+
267
+ new_options = opts.merge(
268
+ :operation => :"OpsApi.list_ops_items",
269
+ :header_params => header_params,
270
+ :query_params => query_params,
271
+ :form_params => form_params,
272
+ :body => post_body,
273
+ :auth_names => auth_names,
274
+ :return_type => return_type
275
+ )
276
+
277
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
278
+ if @api_client.config.debugging
279
+ @api_client.config.logger.debug "API called: OpsApi#list_ops_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
280
+ end
281
+ return data, status_code, headers
282
+ end
157
283
  end
158
284
  end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -0,0 +1,157 @@
1
+ =begin
2
+ #Shipeasy Admin API (server-SDK surface)
3
+
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
+
6
+ The version of the OpenAPI document: 2.0.0
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.23.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Shipeasy::Admin::Generated
17
+ # Connector linkage for one queue item, keyed by provider. Each provider's driver deep-merges its own trace into this blob, so any subset of providers may be present. Unknown/future providers may appear as additional keys.
18
+ class ConnectorData < ApiModelBase
19
+ attr_accessor :github
20
+
21
+ attr_accessor :slack
22
+
23
+ # Attribute mapping from ruby-style variable name to JSON key.
24
+ def self.attribute_map
25
+ {
26
+ :'github' => :'github',
27
+ :'slack' => :'slack'
28
+ }
29
+ end
30
+
31
+ # Returns attribute mapping this model knows about
32
+ def self.acceptable_attribute_map
33
+ attribute_map
34
+ end
35
+
36
+ # Returns all the JSON keys this model knows about
37
+ def self.acceptable_attributes
38
+ acceptable_attribute_map.values
39
+ end
40
+
41
+ # Attribute type mapping.
42
+ def self.openapi_types
43
+ {
44
+ :'github' => :'GithubConnectorData',
45
+ :'slack' => :'SlackConnectorData'
46
+ }
47
+ end
48
+
49
+ # List of attributes with nullable: true
50
+ def self.openapi_nullable
51
+ Set.new([
52
+ ])
53
+ end
54
+
55
+ # Initializes the object
56
+ # @param [Hash] attributes Model attributes in the form of hash
57
+ def initialize(attributes = {})
58
+ if (!attributes.is_a?(Hash))
59
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Shipeasy::Admin::Generated::ConnectorData` initialize method"
60
+ end
61
+
62
+ # check to see if the attribute exists and convert string to symbol for hash key
63
+ acceptable_attribute_map = self.class.acceptable_attribute_map
64
+ attributes = attributes.each_with_object({}) { |(k, v), h|
65
+ if (!acceptable_attribute_map.key?(k.to_sym))
66
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Shipeasy::Admin::Generated::ConnectorData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
67
+ end
68
+ h[k.to_sym] = v
69
+ }
70
+
71
+ if attributes.key?(:'github')
72
+ self.github = attributes[:'github']
73
+ end
74
+
75
+ if attributes.key?(:'slack')
76
+ self.slack = attributes[:'slack']
77
+ end
78
+ end
79
+
80
+ # Show invalid properties with the reasons. Usually used together with valid?
81
+ # @return Array for valid properties with the reasons
82
+ def list_invalid_properties
83
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
84
+ invalid_properties = Array.new
85
+ invalid_properties
86
+ end
87
+
88
+ # Check to see if the all the properties in the model are valid
89
+ # @return true if the model is valid
90
+ def valid?
91
+ warn '[DEPRECATED] the `valid?` method is obsolete'
92
+ true
93
+ end
94
+
95
+ # Checks equality by comparing each attribute.
96
+ # @param [Object] Object to be compared
97
+ def ==(o)
98
+ return true if self.equal?(o)
99
+ self.class == o.class &&
100
+ github == o.github &&
101
+ slack == o.slack
102
+ end
103
+
104
+ # @see the `==` method
105
+ # @param [Object] Object to be compared
106
+ def eql?(o)
107
+ self == o
108
+ end
109
+
110
+ # Calculates hash code according to all attributes.
111
+ # @return [Integer] Hash code
112
+ def hash
113
+ [github, slack].hash
114
+ end
115
+
116
+ # Builds the object from hash
117
+ # @param [Hash] attributes Model attributes in the form of hash
118
+ # @return [Object] Returns the model itself
119
+ def self.build_from_hash(attributes)
120
+ return nil unless attributes.is_a?(Hash)
121
+ attributes = attributes.transform_keys(&:to_sym)
122
+ transformed_hash = {}
123
+ openapi_types.each_pair do |key, type|
124
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
125
+ transformed_hash["#{key}"] = nil
126
+ elsif type =~ /\AArray<(.*)>/i
127
+ # check to ensure the input is an array given that the attribute
128
+ # is documented as an array but the input is not
129
+ if attributes[attribute_map[key]].is_a?(Array)
130
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
131
+ end
132
+ elsif !attributes[attribute_map[key]].nil?
133
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
134
+ end
135
+ end
136
+ new(transformed_hash)
137
+ end
138
+
139
+ # Returns the object in the form of hash
140
+ # @return [Hash] Returns the object in the form of hash
141
+ def to_hash
142
+ hash = {}
143
+ self.class.attribute_map.each_pair do |attr, param|
144
+ value = self.send(attr)
145
+ if value.nil?
146
+ is_nullable = self.class.openapi_nullable.include?(attr)
147
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
148
+ end
149
+
150
+ hash[param] = _to_hash(value)
151
+ end
152
+ hash
153
+ end
154
+
155
+ end
156
+
157
+ end
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #Shipeasy Admin API (server-SDK surface)
3
3
 
4
- #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`).
4
+ #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. Four capabilities, nothing else: - **List the ops queue** — read the project's tickets, filtered by type, status, priority, owner, reporter (`reporter`) and close time (`closedSince`). - **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`).
5
5
 
6
6
  The version of the OpenAPI document: 2.0.0
7
7
 
@@ -58,6 +58,9 @@ module Shipeasy::Admin::Generated
58
58
  # Arbitrary capture context, or `null`.
59
59
  attr_accessor :context
60
60
 
61
+ # The reporter's SDK identity — the same user attribute object your app passes to the Shipeasy SDK to evaluate flags (`user_id`, `anonymous_id`, `email`, plus any targeting attributes). When present, Shipeasy evaluates every feature flag, kill switch and running experiment for this user at filing time and stores the result on the ticket as `context.reporter`, so triage (and any agent working the ticket) sees exactly which features the reporter had on. The browser and React Native devtools attach the identified user automatically. Omit it (or send `null`) to file without a feature snapshot.
62
+ attr_accessor :user
63
+
61
64
  # 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.
62
65
  attr_accessor :dedup_key
63
66
 
@@ -103,6 +106,7 @@ module Shipeasy::Admin::Generated
103
106
  :'user_agent' => :'userAgent',
104
107
  :'viewport' => :'viewport',
105
108
  :'context' => :'context',
109
+ :'user' => :'user',
106
110
  :'dedup_key' => :'dedupKey',
107
111
  :'notify' => :'notify'
108
112
  }
@@ -135,6 +139,7 @@ module Shipeasy::Admin::Generated
135
139
  :'user_agent' => :'String',
136
140
  :'viewport' => :'String',
137
141
  :'context' => :'Hash<String, Object>',
142
+ :'user' => :'Hash<String, Object>',
138
143
  :'dedup_key' => :'String',
139
144
  :'notify' => :'NotificationTarget'
140
145
  }
@@ -150,6 +155,7 @@ module Shipeasy::Admin::Generated
150
155
  :'user_agent',
151
156
  :'viewport',
152
157
  :'context',
158
+ :'user',
153
159
  :'notify'
154
160
  ])
155
161
  end
@@ -240,6 +246,12 @@ module Shipeasy::Admin::Generated
240
246
  end
241
247
  end
242
248
 
249
+ if attributes.key?(:'user')
250
+ if (value = attributes[:'user']).is_a?(Hash)
251
+ self.user = value
252
+ end
253
+ end
254
+
243
255
  if attributes.key?(:'dedup_key')
244
256
  self.dedup_key = attributes[:'dedup_key']
245
257
  end
@@ -295,6 +307,10 @@ module Shipeasy::Admin::Generated
295
307
  invalid_properties.push('invalid value for "viewport", the character length must be smaller than or equal to 40.')
296
308
  end
297
309
 
310
+ if !@user.nil? && @user.length > 50
311
+ invalid_properties.push('invalid value for "user", number of items must be less than or equal to 50.')
312
+ end
313
+
298
314
  if !@dedup_key.nil? && @dedup_key.to_s.length > 200
299
315
  invalid_properties.push('invalid value for "dedup_key", the character length must be smaller than or equal to 200.')
300
316
  end
@@ -316,6 +332,7 @@ module Shipeasy::Admin::Generated
316
332
  return false if !@tags.nil? && @tags.length > 50
317
333
  return false if !@user_agent.nil? && @user_agent.to_s.length > 500
318
334
  return false if !@viewport.nil? && @viewport.to_s.length > 40
335
+ return false if !@user.nil? && @user.length > 50
319
336
  return false if !@dedup_key.nil? && @dedup_key.to_s.length > 200
320
337
  true
321
338
  end
@@ -419,6 +436,16 @@ module Shipeasy::Admin::Generated
419
436
  @viewport = viewport
420
437
  end
421
438
 
439
+ # Custom attribute writer method with validation
440
+ # @param [Object] user Value to be assigned
441
+ def user=(user)
442
+ if !user.nil? && user.length > 50
443
+ fail ArgumentError, 'invalid value for "user", number of items must be less than or equal to 50.'
444
+ end
445
+
446
+ @user = user
447
+ end
448
+
422
449
  # Custom attribute writer method with validation
423
450
  # @param [Object] dedup_key Value to be assigned
424
451
  def dedup_key=(dedup_key)
@@ -452,6 +479,7 @@ module Shipeasy::Admin::Generated
452
479
  user_agent == o.user_agent &&
453
480
  viewport == o.viewport &&
454
481
  context == o.context &&
482
+ user == o.user &&
455
483
  dedup_key == o.dedup_key &&
456
484
  notify == o.notify
457
485
  end
@@ -465,7 +493,7 @@ module Shipeasy::Admin::Generated
465
493
  # Calculates hash code according to all attributes.
466
494
  # @return [Integer] Hash code
467
495
  def hash
468
- [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
496
+ [title, steps_to_reproduce, actual_result, expected_result, priority, status, assignee_id, subscribers, tags, reporter_email, page_url, user_agent, viewport, context, user, dedup_key, notify].hash
469
497
  end
470
498
 
471
499
  # Builds the object from hash