whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/social_account_delete_params.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SocialAccounts#delete
+    class SocialAccountDeleteParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The Account that the social account is connected to. Provide either this or
+      #   user_id.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute user_id
+      #   The User that the social account is connected to. Provide either this or
+      #   account_id.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(id:, account_id: nil, user_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::SocialAccountDeleteParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param account_id [String] The Account that the social account is connected to. Provide either this or user
+      #
+      #   @param user_id [String] The User that the social account is connected to. Provide either this or account
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/social_account_delete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @type [WhopSDK::Internal::Type::Converter]
+    SocialAccountDeleteResponse = WhopSDK::Internal::Type::Boolean
+  end
+end

data/lib/whop_sdk/models/social_account_list_params.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SocialAccounts#list
+    class SocialAccountListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The Account that the social accounts are connected to. Provide either this or
+      #   user_id.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute after
+      #   Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute before
+      #   Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      #   @return [String, nil]
+      optional :before, String
+
+      # @!attribute direction
+      #   Sort direction.
+      #
+      #   @return [Symbol, WhopSDK::Models::SocialAccountListParams::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::SocialAccountListParams::Direction }
+
+      # @!attribute first
+      #   The number of social accounts to return.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute last
+      #   The number of social accounts to return from the end of the range.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer
+
+      # @!attribute order
+      #   The field to sort social accounts by.
+      #
+      #   @return [Symbol, WhopSDK::Models::SocialAccountListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::SocialAccountListParams::Order }
+
+      # @!attribute platform
+      #   Only return social accounts for the platform that is specified.
+      #
+      #   @return [Symbol, WhopSDK::Models::SocialAccountListParams::Platform, nil]
+      optional :platform, enum: -> { WhopSDK::SocialAccountListParams::Platform }
+
+      # @!attribute scopes
+      #   Only return social accounts that have these scopes.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::SocialAccountListParams::Scope>, nil]
+      optional :scopes, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::SocialAccountListParams::Scope] }
+
+      # @!attribute user_id
+      #   The User that the social accounts are connected to. Provide either this or
+      #   account_id.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!attribute verified
+      #   Only return social accounts that are verified on the platform.
+      #
+      #   @return [Boolean, nil]
+      optional :verified, WhopSDK::Internal::Type::Boolean
+
+      # @!method initialize(account_id: nil, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, platform: nil, scopes: nil, user_id: nil, verified: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::SocialAccountListParams} for more details.
+      #
+      #   @param account_id [String] The Account that the social accounts are connected to. Provide either this or us
+      #
+      #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @param before [String] Cursor to fetch the page before (from page_info.start_cursor).
+      #
+      #   @param direction [Symbol, WhopSDK::Models::SocialAccountListParams::Direction] Sort direction.
+      #
+      #   @param first [Integer] The number of social accounts to return.
+      #
+      #   @param last [Integer] The number of social accounts to return from the end of the range.
+      #
+      #   @param order [Symbol, WhopSDK::Models::SocialAccountListParams::Order] The field to sort social accounts by.
+      #
+      #   @param platform [Symbol, WhopSDK::Models::SocialAccountListParams::Platform] Only return social accounts for the platform that is specified.
+      #
+      #   @param scopes [Array<Symbol, WhopSDK::Models::SocialAccountListParams::Scope>] Only return social accounts that have these scopes.
+      #
+      #   @param user_id [String] The User that the social accounts are connected to. Provide either this or accou
+      #
+      #   @param verified [Boolean] Only return social accounts that are verified on the platform.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Sort direction.
+      module Direction
+        extend WhopSDK::Internal::Type::Enum
+
+        ASC = :asc
+        DESC = :desc
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The field to sort social accounts by.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        DISPLAY_ORDER = :display_order
+        CREATED_AT = :created_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Only return social accounts for the platform that is specified.
+      module Platform
+        extend WhopSDK::Internal::Type::Enum
+
+        X = :x
+        INSTAGRAM = :instagram
+        YOUTUBE = :youtube
+        TIKTOK = :tiktok
+        FACEBOOK = :facebook
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      module Scope
+        extend WhopSDK::Internal::Type::Enum
+
+        ADVERTISE = :advertise
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/social_account_post.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class SocialAccountPost < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The platform's own identifier for the post or media. Use it to reference the
+      #   post on an ad.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute call_to_action
+      #   The post's call-to-action button, for example shop_now (Facebook only; null for
+      #   Instagram).
+      #
+      #   @return [Symbol, WhopSDK::Models::SocialAccountPost::CallToAction, nil]
+      required :call_to_action, enum: -> { WhopSDK::SocialAccountPost::CallToAction }, nil?: true
+
+      # @!attribute destination_url
+      #   The URL the post's call-to-action drives to (Facebook only; null for Instagram).
+      #
+      #   @return [String, nil]
+      required :destination_url, String, nil?: true
+
+      # @!attribute media_url
+      #   The URL of the post's media — the image for image posts, the playable video file
+      #   for video posts. Meta signs these and they expire after roughly 24 hours, so
+      #   don't store them.
+      #
+      #   @return [String, nil]
+      required :media_url, String, nil?: true
+
+      # @!attribute thumbnail_url
+      #   Poster image for video posts; null for image posts, where media_url is already
+      #   the image. Signed and short-lived like media_url.
+      #
+      #   @return [String, nil]
+      required :thumbnail_url, String, nil?: true
+
+      # @!method initialize(id:, call_to_action:, destination_url:, media_url:, thumbnail_url:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::SocialAccountPost} for more details.
+      #
+      #   @param id [String] The platform's own identifier for the post or media. Use it to reference the pos
+      #
+      #   @param call_to_action [Symbol, WhopSDK::Models::SocialAccountPost::CallToAction, nil] The post's call-to-action button, for example shop_now (Facebook only; null for
+      #
+      #   @param destination_url [String, nil] The URL the post's call-to-action drives to (Facebook only; null for Instagram).
+      #
+      #   @param media_url [String, nil] The URL of the post's media — the image for image posts, the playable video file
+      #
+      #   @param thumbnail_url [String, nil] Poster image for video posts; null for image posts, where media_url is already t
+
+      # The post's call-to-action button, for example shop_now (Facebook only; null for
+      # Instagram).
+      #
+      # @see WhopSDK::Models::SocialAccountPost#call_to_action
+      module CallToAction
+        extend WhopSDK::Internal::Type::Enum
+
+        LEARN_MORE = :learn_more
+        SHOP_NOW = :shop_now
+        SIGN_UP = :sign_up
+        SUBSCRIBE = :subscribe
+        GET_STARTED = :get_started
+        BOOK_NOW = :book_now
+        APPLY_NOW = :apply_now
+        CONTACT_US = :contact_us
+        DOWNLOAD = :download
+        ORDER_NOW = :order_now
+        BUY_NOW = :buy_now
+        GET_QUOTE = :get_quote
+        MESSAGE_PAGE = :message_page
+        WHATSAPP_MESSAGE = :whatsapp_message
+        INSTAGRAM_MESSAGE = :instagram_message
+        CALL_NOW = :call_now
+        GET_DIRECTIONS = :get_directions
+        SEND_UPDATES = :send_updates
+        GET_OFFER = :get_offer
+        WATCH_MORE = :watch_more
+        LISTEN_NOW = :listen_now
+        PLAY_GAME = :play_game
+        OPEN_LINK = :open_link
+        NO_BUTTON = :no_button
+        GET_OFFER_VIEW = :get_offer_view
+        GET_EVENT_TICKETS = :get_event_tickets
+        SEE_MENU = :see_menu
+        REQUEST_TIME = :request_time
+        EVENT_RSVP = :event_rsvp
+        SEE_DETAILS = :see_details
+        VIEW_INSTAGRAM_PROFILE = :view_instagram_profile
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/social_account_posts_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SocialAccounts#posts
+    class SocialAccountPostsParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   The Account (a biz\_ identifier) the social account is connected to.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute after
+      #   Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @return [String, nil]
+      optional :after, String
+
+      # @!attribute first
+      #   The number of posts to return.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer
+
+      # @!attribute post_id
+      #   Return only the single post with this platform id, instead of the full list.
+      #
+      #   @return [String, nil]
+      optional :post_id, String
+
+      # @!method initialize(id:, account_id:, after: nil, first: nil, post_id: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param account_id [String] The Account (a biz\_ identifier) the social account is connected to.
+      #
+      #   @param after [String] Cursor to fetch the page after (from page_info.end_cursor).
+      #
+      #   @param first [Integer] The number of posts to return.
+      #
+      #   @param post_id [String] Return only the single post with this platform id, instead of the full list.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/social_account_posts_response.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SocialAccounts#posts
+    class SocialAccountPostsResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<WhopSDK::Models::SocialAccountPost>]
+      required :data, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::SocialAccountPost] }
+
+      # @!attribute page_info
+      #
+      #   @return [WhopSDK::Models::SocialAccountPostsResponse::PageInfo]
+      required :page_info, -> { WhopSDK::Models::SocialAccountPostsResponse::PageInfo }
+
+      # @!method initialize(data:, page_info:)
+      #   @param data [Array<WhopSDK::Models::SocialAccountPost>]
+      #   @param page_info [WhopSDK::Models::SocialAccountPostsResponse::PageInfo]
+
+      # @see WhopSDK::Models::SocialAccountPostsResponse#page_info
+      class PageInfo < WhopSDK::Internal::Type::BaseModel
+        # @!attribute end_cursor
+        #
+        #   @return [String, nil]
+        required :end_cursor, String, nil?: true
+
+        # @!attribute has_next_page
+        #
+        #   @return [Boolean]
+        required :has_next_page, WhopSDK::Internal::Type::Boolean
+
+        # @!method initialize(end_cursor:, has_next_page:)
+        #   @param end_cursor [String, nil]
+        #   @param has_next_page [Boolean]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/stat_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Stats#list
+    class StatListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/stat_list_response.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Stats#list
+    class StatListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute data
+      #   The available metrics.
+      #
+      #   @return [Array<WhopSDK::Models::StatListResponse::Data>]
+      required :data, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::StatListResponse::Data] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<WhopSDK::Models::StatListResponse::Data>] The available metrics.
+
+      class Data < WhopSDK::Internal::Type::BaseModel
+        # @!attribute description
+        #   A short description of what the metric measures.
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute key
+        #   The metric's key. Pass it to GET /stats/{metric} to query its values.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute name
+        #   Human-readable display name for the metric.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute properties
+        #   The properties you can use with this metric — pass one as a filter
+        #   (property=value) to narrow the series, or as breakdown_by=property to split it.
+        #
+        #   @return [Array<String>]
+        required :properties, WhopSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute unit
+        #   How to read the metric's values: count is an integer, currency is a decimal
+        #   amount, and percent is a number where 1.6 means 1.6%.
+        #
+        #   @return [Symbol, WhopSDK::Models::StatListResponse::Data::Unit]
+        required :unit, enum: -> { WhopSDK::Models::StatListResponse::Data::Unit }
+
+        # @!attribute windows
+        #   Snapshot metrics only: the trailing windows you can pass as snapshot_window, for
+        #   example 30d. Absent on live metrics, which use from/to instead.
+        #
+        #   @return [Array<String>, nil]
+        optional :windows, WhopSDK::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(description:, key:, name:, properties:, unit:, windows: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::StatListResponse::Data} for more details.
+        #
+        #   @param description [String] A short description of what the metric measures.
+        #
+        #   @param key [String] The metric's key. Pass it to GET /stats/{metric} to query its values.
+        #
+        #   @param name [String] Human-readable display name for the metric.
+        #
+        #   @param properties [Array<String>] The properties you can use with this metric — pass one as a filter (property=val
+        #
+        #   @param unit [Symbol, WhopSDK::Models::StatListResponse::Data::Unit] How to read the metric's values: count is an integer, currency is a decimal amou
+        #
+        #   @param windows [Array<String>] Snapshot metrics only: the trailing windows you can pass as snapshot_window, for
+
+        # How to read the metric's values: count is an integer, currency is a decimal
+        # amount, and percent is a number where 1.6 means 1.6%.
+        #
+        # @see WhopSDK::Models::StatListResponse::Data#unit
+        module Unit
+          extend WhopSDK::Internal::Type::Enum
+
+          COUNT = :count
+          CURRENCY = :currency
+          PERCENT = :percent
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end