scrapebadger 0.1.0

data/spec/api/tik_tok_api_spec.rb

@@ -0,0 +1,413 @@
+=begin
+#ScrapeBadger API
+
+#Unified credit-based scraping API. https://docs.scrapebadger.com
+
+The version of the OpenAPI document: 0.1.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.10.0
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for ScrapeBadger::TikTokApi
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe 'TikTokApi' do
+  before do
+    # run before each test
+    @api_instance = ScrapeBadger::TikTokApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of TikTokApi' do
+    it 'should create an instance of TikTokApi' do
+      expect(@api_instance).to be_instance_of(ScrapeBadger::TikTokApi)
+    end
+  end
+
+  # unit tests for tiktok_general_search
+  # General search
+  # General TikTok search — video results from the Top feed.
+  # @param query Search keyword
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Composite pagination cursor (offset.search_id) from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_general_search test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_comment_replies
+  # Get comment replies
+  # Get replies to a TikTok comment (best-effort).
+  # @param comment_id 
+  # @param video_id Parent video id
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Pagination cursor from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_get_comment_replies test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_comments
+  # Get comments
+  # Get top-level comments on a TikTok video.
+  # @param video_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Pagination cursor from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_get_comments test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_followers_deprecated
+  # Get followers (deprecated)
+  # DEPRECATED — TikTok followers require an authenticated account session. Returns HTTP 410.
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_get_followers_deprecated test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_following_deprecated
+  # Get following (deprecated)
+  # DEPRECATED — TikTok following requires an authenticated account session. Returns HTTP 410.
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_get_following_deprecated test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_hashtag_detail
+  # Get hashtag detail
+  # Get TikTok hashtag/challenge detail.
+  # @param name 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @return [Object]
+  describe 'tiktok_get_hashtag_detail test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_hashtag_videos
+  # Get hashtag videos
+  # Get videos tagged with a TikTok hashtag.
+  # @param name 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Pagination cursor from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_get_hashtag_videos test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_liked_videos_deprecated
+  # Get liked videos (deprecated)
+  # DEPRECATED — TikTok liked videos require an authenticated account session. Returns HTTP 410.
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_get_liked_videos_deprecated test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_music_sound_detail
+  # Get music/sound detail
+  # Get TikTok sound/music detail.
+  # @param music_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @return [Object]
+  describe 'tiktok_get_music_sound_detail test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_music_videos
+  # Get music videos
+  # Get videos using a given TikTok sound.
+  # @param music_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Pagination cursor from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_get_music_videos test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_oembed_metadata
+  # Get oEmbed metadata
+  # Get cheap unauthenticated oEmbed metadata for a TikTok URL.
+  # @param url Full TikTok video or profile URL
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @return [Object]
+  describe 'tiktok_get_oembed_metadata test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_related_videos
+  # Get related videos
+  # Get TikTok's related videos for a given video.
+  # @param video_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_get_related_videos test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_reposts
+  # Get reposts
+  # Get videos a TikTok user has reposted.
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_get_reposts test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_transcript
+  # Get transcript
+  # Get subtitle/caption tracks for a TikTok video.
+  # @param video_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @return [Object]
+  describe 'tiktok_get_transcript test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_user_profile
+  # Get user profile
+  # Get a TikTok user's full profile.
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region Content region (ISO 3166-1 alpha-2)
+  # @return [Object]
+  describe 'tiktok_get_user_profile test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_user_videos
+  # Get user videos
+  # Get a TikTok user's posted videos.
+  # @param username 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Pagination cursor from a prior page's `pagination.cursor` (signer path only).
+  # @return [Object]
+  describe 'tiktok_get_user_videos test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_get_video_detail
+  # Get video detail
+  # Get full metadata for a single TikTok video/post.
+  # @param video_id 
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [String] :username Author handle (skips oEmbed lookup)
+  # @return [Object]
+  describe 'tiktok_get_video_detail test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_health_check
+  # Health check
+  # Check health of the TikTok scraper service.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'tiktok_health_check test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_health_check_head
+  # Health check
+  # Check health of the TikTok scraper service.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'tiktok_health_check_head test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_list_regions
+  # List regions
+  # List supported TikTok content regions.
+  # @param [Hash] opts the optional parameters
+  # @return [Object]
+  describe 'tiktok_list_regions test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_search_hashtags
+  # Search hashtags
+  # Search TikTok hashtags by keyword.
+  # @param query Search keyword
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Composite pagination cursor (offset.search_id) from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_search_hashtags test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_search_the_tiktok_ad_library
+  # Search the TikTok Ad Library
+  # Search TikTok's Commercial Content Library (ad transparency) by keyword or advertiser.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :query Keyword (ignored when advertiser_id is set)
+  # @option opts [String] :advertiser_id Advertiser business id(s) for advertiser search
+  # @option opts [String] :region EU region code (the Ad Library is EU-only)
+  # @option opts [Integer] :days 
+  # @option opts [String] :sort 
+  # @option opts [Integer] :offset 
+  # @option opts [String] :search_id 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_search_the_tiktok_ad_library test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_search_users
+  # Search users
+  # Search TikTok users by keyword.
+  # @param query Search keyword
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Composite pagination cursor (offset.search_id) from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_search_users test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_search_videos
+  # Search videos
+  # Search TikTok videos by keyword.
+  # @param query Search keyword
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @option opts [String] :cursor Composite pagination cursor (offset.search_id) from a prior page's pagination.cursor
+  # @return [Object]
+  describe 'tiktok_search_videos test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_trending_hashtags
+  # Trending hashtags
+  # Get trending hashtags (mobile Discover surface — view_count + creators).
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :period 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_trending_hashtags test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_trending_songs
+  # Trending songs
+  # Get trending songs/sounds (mobile hot-music feed — ranked by usage).
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :period 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_trending_songs test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+  # unit tests for tiktok_trending_videos
+  # Trending videos
+  # Get trending videos from the TikTok Explore feed.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :region 
+  # @option opts [Integer] :count 
+  # @return [Object]
+  describe 'tiktok_trending_videos test' do
+    it 'should work' do
+      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
+    end
+  end
+
+end