release: 0.3.0

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.2.0"
+  ".": "0.3.0"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 115
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/xquik%2Fx-twitter-scraper-3b2c6c771ad1da0bbfeb0af115972929ed2c7fcd5e47a79556d66cd21431b224.yml
-openapi_spec_hash: de2890233b68387bf5f9b6d19e7d87dc
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/xquik%2Fx-twitter-scraper-93bb7d4f1475c8043af464ec88244a034456c549136c8477f284f0a33192e1c9.yml
+openapi_spec_hash: 74dca63c872249274ad99b111dea0833
 config_hash: 8894c96caeb6df84c9394518810221bd

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.3.0 (2026-04-01)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** api update ([f86e402](https://github.com/Xquik-dev/x-twitter-scraper-ruby/commit/f86e4024943bd72605879352d377f1a9527ce8c6))
+
 ## 0.2.0 (2026-04-01)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/Xquik-dev/x-twitter-scraper-ruby/compare/v0.1.0...v0.2.0)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    x-twitter-scraper (0.2.0)
+    x-twitter-scraper (0.3.0)
       cgi
       connection_pool
 

README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "x-twitter-scraper", "~> 0.2.0"
+gem "x-twitter-scraper", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->

lib/x_twitter_scraper/models/compose_create_response.rb

@@ -2,7 +2,40 @@
 
 module XTwitterScraper
   module Models
-    # @type [XTwitterScraper::Internal::Type::Converter]
-    ComposeCreateResponse = XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
+    # @see XTwitterScraper::Resources::Compose#create
+    class ComposeCreateResponse < XTwitterScraper::Internal::Type::BaseModel
+      # @!attribute feedback
+      #   AI feedback on the draft
+      #
+      #   @return [String, nil]
+      optional :feedback, String
+
+      # @!attribute score
+      #   Engagement score (0-100)
+      #
+      #   @return [Float, nil]
+      optional :score, Float
+
+      # @!attribute suggestions
+      #   Improvement suggestions
+      #
+      #   @return [Array<String>, nil]
+      optional :suggestions, XTwitterScraper::Internal::Type::ArrayOf[String]
+
+      # @!attribute text
+      #   Generated or refined tweet text
+      #
+      #   @return [String, nil]
+      optional :text, String
+
+      # @!method initialize(feedback: nil, score: nil, suggestions: nil, text: nil)
+      #   @param feedback [String] AI feedback on the draft
+      #
+      #   @param score [Float] Engagement score (0-100)
+      #
+      #   @param suggestions [Array<String>] Improvement suggestions
+      #
+      #   @param text [String] Generated or refined tweet text
+    end
   end
 end

lib/x_twitter_scraper/models/event_detail.rb

@@ -9,6 +9,7 @@ class EventDetail < XTwitterScraper::Internal::Type::BaseModel
       required :id, String
 
       # @!attribute data
+      #   Event payload — shape varies by event type (JSON)
       #
       #   @return [Hash{Symbol=>Object}]
       required :data, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -40,11 +41,17 @@ class EventDetail < XTwitterScraper::Internal::Type::BaseModel
 
       # @!method initialize(id:, data:, monitor_id:, occurred_at:, type:, username:, x_event_id: nil)
       #   @param id [String]
-      #   @param data [Hash{Symbol=>Object}]
+      #
+      #   @param data [Hash{Symbol=>Object}] Event payload — shape varies by event type (JSON)
+      #
       #   @param monitor_id [String]
+      #
       #   @param occurred_at [Time]
+      #
       #   @param type [Symbol, XTwitterScraper::Models::EventDetail::Type]
+      #
       #   @param username [String]
+      #
       #   @param x_event_id [String]
 
       # @see XTwitterScraper::Models::EventDetail#type

lib/x_twitter_scraper/models/event_retrieve_response.rb

@@ -10,6 +10,7 @@ class EventRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
       required :id, String
 
       # @!attribute data
+      #   Event payload — shape varies by event type (JSON)
       #
       #   @return [Hash{Symbol=>Object}]
       required :data, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -41,11 +42,17 @@ class EventRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
 
       # @!method initialize(id:, data:, monitor_id:, occurred_at:, type:, username:, x_event_id: nil)
       #   @param id [String]
-      #   @param data [Hash{Symbol=>Object}]
+      #
+      #   @param data [Hash{Symbol=>Object}] Event payload — shape varies by event type (JSON)
+      #
       #   @param monitor_id [String]
+      #
       #   @param occurred_at [Time]
+      #
       #   @param type [Symbol, XTwitterScraper::Models::EventRetrieveResponse::Type]
+      #
       #   @param username [String]
+      #
       #   @param x_event_id [String]
 
       # @see XTwitterScraper::Models::EventRetrieveResponse#type

lib/x_twitter_scraper/models/extraction_retrieve_response.rb

@@ -10,6 +10,7 @@ class ExtractionRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
       required :has_more, XTwitterScraper::Internal::Type::Boolean, api_name: :hasMore
 
       # @!attribute job
+      #   Extraction job metadata — shape varies by tool type (JSON)
       #
       #   @return [Hash{Symbol=>Object}]
       required :job, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -27,8 +28,11 @@ class ExtractionRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
 
       # @!method initialize(has_more:, job:, results:, next_cursor: nil)
       #   @param has_more [Boolean]
-      #   @param job [Hash{Symbol=>Object}]
+      #
+      #   @param job [Hash{Symbol=>Object}] Extraction job metadata — shape varies by tool type (JSON)
+      #
       #   @param results [Array<Hash{Symbol=>Object}>]
+      #
       #   @param next_cursor [String]
     end
   end

lib/x_twitter_scraper/models/integration.rb

@@ -9,6 +9,7 @@ class Integration < XTwitterScraper::Internal::Type::BaseModel
       required :id, String
 
       # @!attribute config
+      #   Integration config — shape varies by type (JSON)
       #
       #   @return [Hash{Symbol=>Object}]
       required :config, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -41,6 +42,7 @@ class Integration < XTwitterScraper::Internal::Type::BaseModel
       required :type, enum: -> { XTwitterScraper::Integration::Type }
 
       # @!attribute filters
+      #   Event filter rules (JSON)
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :filters, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -62,15 +64,25 @@ class Integration < XTwitterScraper::Internal::Type::BaseModel
 
       # @!method initialize(id:, config:, created_at:, event_types:, is_active:, name:, type:, filters: nil, message_template: nil, scope_all_monitors: nil, silent_push: nil)
       #   @param id [String]
-      #   @param config [Hash{Symbol=>Object}]
+      #
+      #   @param config [Hash{Symbol=>Object}] Integration config — shape varies by type (JSON)
+      #
       #   @param created_at [Time]
+      #
       #   @param event_types [Array<Symbol, XTwitterScraper::Models::Integration::EventType>]
+      #
       #   @param is_active [Boolean]
+      #
       #   @param name [String]
+      #
       #   @param type [Symbol, XTwitterScraper::Models::Integration::Type]
-      #   @param filters [Hash{Symbol=>Object}]
+      #
+      #   @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
+      #
       #   @param message_template [String]
+      #
       #   @param scope_all_monitors [Boolean]
+      #
       #   @param silent_push [Boolean]
 
       module EventType

lib/x_twitter_scraper/models/integration_create_response.rb

@@ -10,6 +10,7 @@ class IntegrationCreateResponse < XTwitterScraper::Internal::Type::BaseModel
       required :id, String
 
       # @!attribute config
+      #   Integration config — shape varies by type (JSON)
       #
       #   @return [Hash{Symbol=>Object}]
       required :config, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -42,6 +43,7 @@ class IntegrationCreateResponse < XTwitterScraper::Internal::Type::BaseModel
       required :type, enum: -> { XTwitterScraper::Models::IntegrationCreateResponse::Type }
 
       # @!attribute filters
+      #   Event filter rules (JSON)
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :filters, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -63,15 +65,25 @@ class IntegrationCreateResponse < XTwitterScraper::Internal::Type::BaseModel
 
       # @!method initialize(id:, config:, created_at:, event_types:, is_active:, name:, type:, filters: nil, message_template: nil, scope_all_monitors: nil, silent_push: nil)
       #   @param id [String]
-      #   @param config [Hash{Symbol=>Object}]
+      #
+      #   @param config [Hash{Symbol=>Object}] Integration config — shape varies by type (JSON)
+      #
       #   @param created_at [Time]
+      #
       #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationCreateResponse::EventType>]
+      #
       #   @param is_active [Boolean]
+      #
       #   @param name [String]
+      #
       #   @param type [Symbol, XTwitterScraper::Models::IntegrationCreateResponse::Type]
-      #   @param filters [Hash{Symbol=>Object}]
+      #
+      #   @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
+      #
       #   @param message_template [String]
+      #
       #   @param scope_all_monitors [Boolean]
+      #
       #   @param silent_push [Boolean]
 
       module EventType

lib/x_twitter_scraper/models/integration_list_response.rb

@@ -20,6 +20,7 @@ class Integration < XTwitterScraper::Internal::Type::BaseModel
         required :id, String
 
         # @!attribute config
+        #   Integration config — shape varies by type (JSON)
         #
         #   @return [Hash{Symbol=>Object}]
         required :config, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -52,6 +53,7 @@ class Integration < XTwitterScraper::Internal::Type::BaseModel
         required :type, enum: -> { XTwitterScraper::Models::IntegrationListResponse::Integration::Type }
 
         # @!attribute filters
+        #   Event filter rules (JSON)
         #
         #   @return [Hash{Symbol=>Object}, nil]
         optional :filters, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -73,15 +75,25 @@ class Integration < XTwitterScraper::Internal::Type::BaseModel
 
         # @!method initialize(id:, config:, created_at:, event_types:, is_active:, name:, type:, filters: nil, message_template: nil, scope_all_monitors: nil, silent_push: nil)
         #   @param id [String]
-        #   @param config [Hash{Symbol=>Object}]
+        #
+        #   @param config [Hash{Symbol=>Object}] Integration config — shape varies by type (JSON)
+        #
         #   @param created_at [Time]
+        #
         #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationListResponse::Integration::EventType>]
+        #
         #   @param is_active [Boolean]
+        #
         #   @param name [String]
+        #
         #   @param type [Symbol, XTwitterScraper::Models::IntegrationListResponse::Integration::Type]
-        #   @param filters [Hash{Symbol=>Object}]
+        #
+        #   @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
+        #
         #   @param message_template [String]
+        #
         #   @param scope_all_monitors [Boolean]
+        #
         #   @param silent_push [Boolean]
 
         module EventType

lib/x_twitter_scraper/models/integration_retrieve_response.rb

@@ -10,6 +10,7 @@ class IntegrationRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
       required :id, String
 
       # @!attribute config
+      #   Integration config — shape varies by type (JSON)
       #
       #   @return [Hash{Symbol=>Object}]
       required :config, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -42,6 +43,7 @@ class IntegrationRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
       required :type, enum: -> { XTwitterScraper::Models::IntegrationRetrieveResponse::Type }
 
       # @!attribute filters
+      #   Event filter rules (JSON)
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :filters, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -63,15 +65,25 @@ class IntegrationRetrieveResponse < XTwitterScraper::Internal::Type::BaseModel
 
       # @!method initialize(id:, config:, created_at:, event_types:, is_active:, name:, type:, filters: nil, message_template: nil, scope_all_monitors: nil, silent_push: nil)
       #   @param id [String]
-      #   @param config [Hash{Symbol=>Object}]
+      #
+      #   @param config [Hash{Symbol=>Object}] Integration config — shape varies by type (JSON)
+      #
       #   @param created_at [Time]
+      #
       #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationRetrieveResponse::EventType>]
+      #
       #   @param is_active [Boolean]
+      #
       #   @param name [String]
+      #
       #   @param type [Symbol, XTwitterScraper::Models::IntegrationRetrieveResponse::Type]
-      #   @param filters [Hash{Symbol=>Object}]
+      #
+      #   @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
+      #
       #   @param message_template [String]
+      #
       #   @param scope_all_monitors [Boolean]
+      #
       #   @param silent_push [Boolean]
 
       module EventType

lib/x_twitter_scraper/models/integration_update_params.rb

@@ -22,6 +22,7 @@ class IntegrationUpdateParams < XTwitterScraper::Internal::Type::BaseModel
                api_name: :eventTypes
 
       # @!attribute filters
+      #   Event filter rules (JSON)
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :filters, XTwitterScraper::Internal::Type::HashOf[XTwitterScraper::Internal::Type::Unknown]
@@ -32,6 +33,7 @@ class IntegrationUpdateParams < XTwitterScraper::Internal::Type::BaseModel
       optional :is_active, XTwitterScraper::Internal::Type::Boolean, api_name: :isActive
 
       # @!attribute message_template
+      #   Custom message template (JSON)
       #
       #   @return [Hash{Symbol=>Object}, nil]
       optional :message_template,
@@ -55,13 +57,21 @@ class IntegrationUpdateParams < XTwitterScraper::Internal::Type::BaseModel
 
       # @!method initialize(id:, event_types: nil, filters: nil, is_active: nil, message_template: nil, name: nil, scope_all_monitors: nil, silent_push: nil, request_options: {})
       #   @param id [String]
+      #
       #   @param event_types [Array<Symbol, XTwitterScraper::Models::IntegrationUpdateParams::EventType>]
-      #   @param filters [Hash{Symbol=>Object}]
+      #
+      #   @param filters [Hash{Symbol=>Object}] Event filter rules (JSON)
+      #
       #   @param is_active [Boolean]
-      #   @param message_template [Hash{Symbol=>Object}]
+      #
+      #   @param message_template [Hash{Symbol=>Object}] Custom message template (JSON)
+      #
       #   @param name [String]
+      #
       #   @param scope_all_monitors [Boolean]
+      #
       #   @param silent_push [Boolean]
+      #
       #   @param request_options [XTwitterScraper::RequestOptions, Hash{Symbol=>Object}]
 
       module EventType