x_api_scraper 0.1.0

data/lib/xapi_scraper/models/components/getdmhistoryv3query.rb

@@ -0,0 +1,94 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module XapiScraper
+  module Models
+    module Components
+      # Parameters for getting DM history via XChat v3
+      class GetDmHistoryV3Query
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # User id, @handle, conversationId a:b, or group g....
+        field(
+          :recipient,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("recipient"), required: true}}
+        )
+        # Twitter authentication cookie or Twitter auth_token, [how-to-get-twitter-cookie](https://youtube-promotion.pages.dev/how-to-get-twitter-cookie)
+        field(
+          :cookie,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("cookie"), required: true}}
+        )
+        # Identity PIN (default 1234).
+        field(
+          :pin,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("pin")}}
+        )
+        # Max events per page (10–200, default 50).
+        field(
+          :count,
+          Crystalline::Nilable.new(::Integer),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("count")}}
+        )
+        # Follow has_more and return every page.
+        field(
+          :all,
+          Crystalline::Nilable.new(Crystalline::Boolean.new),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("all")}}
+        )
+        # Oldest sequenceId for paging. Pass the previous page's oldest message sequence_id.
+        field(
+          :before,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("before")}}
+        )
+        # Optional HTTP proxy. Example: http://username:password@ip:port
+        field(
+          :proxy,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("proxy")}}
+        )
+
+        sig {
+          params(
+            recipient: ::String,
+            cookie: ::String,
+            pin: T.nilable(::String),
+            count: T.nilable(::Integer),
+            all: T.nilable(T::Boolean),
+            before: T.nilable(::String),
+            proxy: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(recipient:, cookie:, pin: nil, count: nil, all: nil, before: nil, proxy: nil)
+          @recipient = recipient
+          @cookie = cookie
+          @pin = pin
+          @count = count
+          @all = all
+          @before = before
+          @proxy = proxy
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @recipient == other.recipient
+          return false unless @cookie == other.cookie
+          return false unless @pin == other.pin
+          return false unless @count == other.count
+          return false unless @all == other.all
+          return false unless @before == other.before
+          return false unless @proxy == other.proxy
+          true
+        end
+      end
+    end
+  end
+end

data/lib/xapi_scraper/models/components/getdmhistoryv3query.rbi

@@ -0,0 +1,50 @@
+# typed: true
+# frozen_string_literal: true
+
+class XapiScraper::Models::Components::GetDmHistoryV3Query
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class XapiScraper::Models::Components::GetDmHistoryV3Query
+  def recipient
+  end
+
+  def recipient=(str_)
+  end
+
+  def cookie
+  end
+
+  def cookie=(str_)
+  end
+
+  def pin
+  end
+
+  def pin=(str_)
+  end
+
+  def count
+  end
+
+  def count=(str_)
+  end
+
+  def all
+  end
+
+  def all=(str_)
+  end
+
+  def before
+  end
+
+  def before=(str_)
+  end
+
+  def proxy
+  end
+
+  def proxy=(str_)
+  end
+end

data/lib/xapi_scraper/models/components/getdmhistoryv3response.rb

@@ -0,0 +1,47 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module XapiScraper
+  module Models
+    module Components
+      # Response for getting DM history via XChat v3
+      class GetDmHistoryV3Response
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Response code
+        field(
+          :code,
+          ::Integer,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("code"), required: true}}
+        )
+        # Response message
+        field :msg, ::String, {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("msg"), required: true}}
+        # DM history data
+        field(
+          :data,
+          Crystalline::Nilable.new(Models::Components::DmHistoryV3Data),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("data")}}
+        )
+
+        sig { params(code: ::Integer, msg: ::String, data: T.nilable(Models::Components::DmHistoryV3Data)).void }
+        def initialize(code:, msg:, data: nil)
+          @code = code
+          @msg = msg
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @code == other.code
+          return false unless @msg == other.msg
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

data/lib/xapi_scraper/models/components/getdmhistoryv3response.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class XapiScraper::Models::Components::GetDmHistoryV3Response
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class XapiScraper::Models::Components::GetDmHistoryV3Response
+  def code
+  end
+
+  def code=(str_)
+  end
+
+  def msg
+  end
+
+  def msg=(str_)
+  end
+
+  def data
+  end
+
+  def data=(str_)
+  end
+end

data/lib/xapi_scraper/models/components/getdmmediav3data.rb

@@ -0,0 +1,77 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module XapiScraper
+  module Models
+    module Components
+
+      class GetDmMediaV3Data
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Playable media URL
+        field :url, ::String, {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("url"), required: true}}
+        # Media path on this API
+        field :path, ::String, {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("path"), required: true}}
+        # MIME type
+        field(
+          :content_type,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("content_type"), required: true}}
+        )
+        # File size in bytes
+        field(
+          :byte_length,
+          ::Integer,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("byte_length"), required: true}}
+        )
+        # Whether the media was already available
+        field(
+          :cached,
+          Crystalline::Boolean.new,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("cached"), required: true}}
+        )
+        # Suggested filename
+        field(
+          :filename,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("filename")}}
+        )
+
+        sig {
+          params(
+            url: ::String,
+            path: ::String,
+            content_type: ::String,
+            byte_length: ::Integer,
+            cached: T::Boolean,
+            filename: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(url:, path:, content_type:, byte_length:, cached:, filename: nil)
+          @url = url
+          @path = path
+          @content_type = content_type
+          @byte_length = byte_length
+          @cached = cached
+          @filename = filename
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @url == other.url
+          return false unless @path == other.path
+          return false unless @content_type == other.content_type
+          return false unless @byte_length == other.byte_length
+          return false unless @cached == other.cached
+          return false unless @filename == other.filename
+          true
+        end
+      end
+    end
+  end
+end

data/lib/xapi_scraper/models/components/getdmmediav3data.rbi

@@ -0,0 +1,44 @@
+# typed: true
+# frozen_string_literal: true
+
+class XapiScraper::Models::Components::GetDmMediaV3Data
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class XapiScraper::Models::Components::GetDmMediaV3Data
+  def url
+  end
+
+  def url=(str_)
+  end
+
+  def path
+  end
+
+  def path=(str_)
+  end
+
+  def content_type
+  end
+
+  def content_type=(str_)
+  end
+
+  def byte_length
+  end
+
+  def byte_length=(str_)
+  end
+
+  def cached
+  end
+
+  def cached=(str_)
+  end
+
+  def filename
+  end
+
+  def filename=(str_)
+  end
+end

data/lib/xapi_scraper/models/components/getdmmediav3query.rb

@@ -0,0 +1,112 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module XapiScraper
+  module Models
+    module Components
+      # Fetch one XChat media attachment and return a playable URL.
+      class GetDmMediaV3Query
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Conversation id from /v3/twitter/dm-history
+        field(
+          :conversation_id,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("conversation_id"), required: true}}
+        )
+        # Attachment media_hash_key from dm-history
+        field(
+          :media_hash_key,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("media_hash_key"), required: true}}
+        )
+        # Twitter authentication cookie or Twitter auth_token, [how-to-get-twitter-cookie](https://youtube-promotion.pages.dev/how-to-get-twitter-cookie)
+        field(
+          :cookie,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("cookie"), required: true}}
+        )
+        # Optional message key_version from dm-history (recommended).
+        field(
+          :key_version,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("key_version")}}
+        )
+        # Optional IMAGE/VIDEO/GIF hint
+        field(
+          :type_name,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("type_name")}}
+        )
+        # Optional filename hint
+        field(
+          :filename,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("filename")}}
+        )
+        # Identity PIN (default 1234).
+        field(
+          :pin,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("pin")}}
+        )
+        # Optional HTTP proxy. Example: http://username:password@ip:port
+        field(
+          :proxy,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("proxy")}}
+        )
+
+        sig {
+          params(
+            conversation_id: ::String,
+            media_hash_key: ::String,
+            cookie: ::String,
+            key_version: T.nilable(::String),
+            type_name: T.nilable(::String),
+            filename: T.nilable(::String),
+            pin: T.nilable(::String),
+            proxy: T.nilable(::String)
+          )
+            .void
+        }
+        def initialize(
+          conversation_id:,
+          media_hash_key:,
+          cookie:,
+          key_version: nil,
+          type_name: nil,
+          filename: nil,
+          pin: nil,
+          proxy: nil
+        )
+          @conversation_id = conversation_id
+          @media_hash_key = media_hash_key
+          @cookie = cookie
+          @key_version = key_version
+          @type_name = type_name
+          @filename = filename
+          @pin = pin
+          @proxy = proxy
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @conversation_id == other.conversation_id
+          return false unless @media_hash_key == other.media_hash_key
+          return false unless @cookie == other.cookie
+          return false unless @key_version == other.key_version
+          return false unless @type_name == other.type_name
+          return false unless @filename == other.filename
+          return false unless @pin == other.pin
+          return false unless @proxy == other.proxy
+          true
+        end
+      end
+    end
+  end
+end

data/lib/xapi_scraper/models/components/getdmmediav3query.rbi

@@ -0,0 +1,56 @@
+# typed: true
+# frozen_string_literal: true
+
+class XapiScraper::Models::Components::GetDmMediaV3Query
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class XapiScraper::Models::Components::GetDmMediaV3Query
+  def conversation_id
+  end
+
+  def conversation_id=(str_)
+  end
+
+  def media_hash_key
+  end
+
+  def media_hash_key=(str_)
+  end
+
+  def cookie
+  end
+
+  def cookie=(str_)
+  end
+
+  def key_version
+  end
+
+  def key_version=(str_)
+  end
+
+  def type_name
+  end
+
+  def type_name=(str_)
+  end
+
+  def filename
+  end
+
+  def filename=(str_)
+  end
+
+  def pin
+  end
+
+  def pin=(str_)
+  end
+
+  def proxy
+  end
+
+  def proxy=(str_)
+  end
+end

data/lib/xapi_scraper/models/components/getdmmediav3response.rb

@@ -0,0 +1,47 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module XapiScraper
+  module Models
+    module Components
+
+      class GetDmMediaV3Response
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # Response code
+        field(
+          :code,
+          ::Integer,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("code"), required: true}}
+        )
+        # Response message
+        field :msg, ::String, {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("msg"), required: true}}
+        # Media info
+        field(
+          :data,
+          Crystalline::Nilable.new(Models::Components::GetDmMediaV3Data),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("data")}}
+        )
+
+        sig { params(code: ::Integer, msg: ::String, data: T.nilable(Models::Components::GetDmMediaV3Data)).void }
+        def initialize(code:, msg:, data: nil)
+          @code = code
+          @msg = msg
+          @data = data
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @code == other.code
+          return false unless @msg == other.msg
+          return false unless @data == other.data
+          true
+        end
+      end
+    end
+  end
+end

data/lib/xapi_scraper/models/components/getdmmediav3response.rbi

@@ -0,0 +1,26 @@
+# typed: true
+# frozen_string_literal: true
+
+class XapiScraper::Models::Components::GetDmMediaV3Response
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class XapiScraper::Models::Components::GetDmMediaV3Response
+  def code
+  end
+
+  def code=(str_)
+  end
+
+  def msg
+  end
+
+  def msg=(str_)
+  end
+
+  def data
+  end
+
+  def data=(str_)
+  end
+end

data/lib/xapi_scraper/models/components/getlistmemberscursorquery.rb

@@ -0,0 +1,43 @@
+# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+
+# typed: true
+# frozen_string_literal: true
+
+module XapiScraper
+  module Models
+    module Components
+
+      class GetListMembersCursorQuery
+        extend T::Sig
+        include Crystalline::MetadataFields
+
+        # The ID of the list to get members from.
+        field(
+          :list_id,
+          ::String,
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("list_id"), required: true}}
+        )
+        # Cursor returned by the previous page. Leave empty to fetch the first page.
+        field(
+          :next_cursor,
+          Crystalline::Nilable.new(::String),
+          {'format_json': {'letter_case': ::XapiScraper::Utils.field_name("next_cursor")}}
+        )
+
+        sig { params(list_id: ::String, next_cursor: T.nilable(::String)).void }
+        def initialize(list_id:, next_cursor: nil)
+          @list_id = list_id
+          @next_cursor = next_cursor
+        end
+
+        sig { params(other: T.untyped).returns(T::Boolean) }
+        def ==(other)
+          return false unless other.is_a?(self.class)
+          return false unless @list_id == other.list_id
+          return false unless @next_cursor == other.next_cursor
+          true
+        end
+      end
+    end
+  end
+end

data/lib/xapi_scraper/models/components/getlistmemberscursorquery.rbi

@@ -0,0 +1,20 @@
+# typed: true
+# frozen_string_literal: true
+
+class XapiScraper::Models::Components::GetListMembersCursorQuery
+  extend ::Crystalline::MetadataFields::ClassMethods
+end
+
+class XapiScraper::Models::Components::GetListMembersCursorQuery
+  def list_id
+  end
+
+  def list_id=(str_)
+  end
+
+  def next_cursor
+  end
+
+  def next_cursor=(str_)
+  end
+end