diff --git a/.stats.yml b/.stats.yml index 330fae47..59ea20e2 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1 +1 @@ -configured_endpoints: 271 +configured_endpoints: 272 diff --git a/Gemfile.lock b/Gemfile.lock index 6ab022b6..73c4b4a5 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -14,6 +14,8 @@ PATH whop_sdk (0.0.41) cgi connection_pool + jwt + openssl standardwebhooks GEM @@ -73,6 +75,8 @@ GEM concurrent-ruby (~> 1.0) io-event (1.11.2) json (2.15.2) + jwt (2.10.2) + base64 language_server-protocol (3.17.0.5) lint_roller (1.1.0) listen (3.9.0) @@ -91,6 +95,7 @@ GEM minitest (~> 5.0) mutex_m (0.3.0) netrc (0.11.0) + openssl (3.2.0) parallel (1.27.0) parser (3.3.10.0) ast (~> 2.4.1) @@ -207,11 +212,13 @@ PLATFORMS DEPENDENCIES async + jwt minitest minitest-focus minitest-hooks minitest-proveit minitest-rg + openssl rake rbs redcarpet diff --git a/lib/whop_sdk.rb b/lib/whop_sdk.rb index 24d79ac6..fc12e23b 100644 --- a/lib/whop_sdk.rb +++ b/lib/whop_sdk.rb @@ -429,6 +429,18 @@ require_relative "whop_sdk/models/notification_create_response" require_relative "whop_sdk/models/notification_preferences" require_relative "whop_sdk/models/page_info" +require_relative "whop_sdk/models/partner_create_params" +require_relative "whop_sdk/models/partner_create_response" +require_relative "whop_sdk/models/partner_leaderboard_params" +require_relative "whop_sdk/models/partner_leaderboard_response" +require_relative "whop_sdk/models/partner_referred_users_params" +require_relative "whop_sdk/models/partner_referred_users_response" +require_relative "whop_sdk/models/partners/businesses/earning_list_params" +require_relative "whop_sdk/models/partners/businesses/earning_list_response" +require_relative "whop_sdk/models/partners/business_list_params" +require_relative "whop_sdk/models/partners/business_list_response" +require_relative "whop_sdk/models/partners/business_retrieve_params" +require_relative "whop_sdk/models/partners/business_retrieve_response" require_relative "whop_sdk/models/payment" require_relative "whop_sdk/models/payment_created_webhook_event" require_relative "whop_sdk/models/payment_create_params" @@ -502,18 +514,6 @@ require_relative "whop_sdk/models/reaction_retrieve_params" require_relative "whop_sdk/models/receipt_status" require_relative "whop_sdk/models/receipt_tax_behavior" -require_relative "whop_sdk/models/referral_referred_users_params" -require_relative "whop_sdk/models/referral_referred_users_response" -require_relative "whop_sdk/models/referrals/businesses/earning_list_params" -require_relative "whop_sdk/models/referrals/businesses/earning_list_response" -require_relative "whop_sdk/models/referrals/business_leaderboard_params" -require_relative "whop_sdk/models/referrals/business_leaderboard_response" -require_relative "whop_sdk/models/referrals/business_list_params" -require_relative "whop_sdk/models/referrals/business_list_response" -require_relative "whop_sdk/models/referrals/business_retrieve_params" -require_relative "whop_sdk/models/referrals/business_retrieve_response" -require_relative "whop_sdk/models/referrals/partner_create_params" -require_relative "whop_sdk/models/referrals/partner_create_response" require_relative "whop_sdk/models/refund_created_webhook_event" require_relative "whop_sdk/models/refund_list_params" require_relative "whop_sdk/models/refund_list_response" @@ -604,6 +604,8 @@ require_relative "whop_sdk/models/user_check_access_params" require_relative "whop_sdk/models/user_check_access_response" require_relative "whop_sdk/models/user_list_params" +require_relative "whop_sdk/models/user_recommend_actions_params" +require_relative "whop_sdk/models/user_recommend_actions_response" require_relative "whop_sdk/models/user_retrieve_params" require_relative "whop_sdk/models/user_update_me_params" require_relative "whop_sdk/models/user_update_params" @@ -697,6 +699,9 @@ require_relative "whop_sdk/resources/memberships" require_relative "whop_sdk/resources/messages" require_relative "whop_sdk/resources/notifications" +require_relative "whop_sdk/resources/partners" +require_relative "whop_sdk/resources/partners/businesses" +require_relative "whop_sdk/resources/partners/businesses/earnings" require_relative "whop_sdk/resources/payment_methods" require_relative "whop_sdk/resources/payments" require_relative "whop_sdk/resources/payout_accounts" @@ -707,10 +712,6 @@ require_relative "whop_sdk/resources/products" require_relative "whop_sdk/resources/promo_codes" require_relative "whop_sdk/resources/reactions" -require_relative "whop_sdk/resources/referrals" -require_relative "whop_sdk/resources/referrals/businesses" -require_relative "whop_sdk/resources/referrals/businesses/earnings" -require_relative "whop_sdk/resources/referrals/partners" require_relative "whop_sdk/resources/refunds" require_relative "whop_sdk/resources/resolution_center_cases" require_relative "whop_sdk/resources/reviews" diff --git a/lib/whop_sdk/client.rb b/lib/whop_sdk/client.rb index ee72f561..062ea1ef 100644 --- a/lib/whop_sdk/client.rb +++ b/lib/whop_sdk/client.rb @@ -288,14 +288,14 @@ class Client < WhopSDK::Internal::Transport::BaseClient # @return [WhopSDK::Resources::Payouts] attr_reader :payouts - # The Referrals API covers your Whop partner activity: the users you referred onto + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # # Use it to enroll as a Whop partner, list the users you referred, list your # referred businesses and review their earnings, and see the partner leaderboard. - # @return [WhopSDK::Resources::Referrals] - attr_reader :referrals + # @return [WhopSDK::Resources::Partners] + attr_reader :partners # Cards represent Whop-issued virtual payment cards that spend from an account or # user balance. Cards can be assigned to cardholders and configured with spending @@ -550,7 +550,7 @@ def initialize( @financial_activity = WhopSDK::Resources::FinancialActivity.new(client: self) @stats = WhopSDK::Resources::Stats.new(client: self) @payouts = WhopSDK::Resources::Payouts.new(client: self) - @referrals = WhopSDK::Resources::Referrals.new(client: self) + @partners = WhopSDK::Resources::Partners.new(client: self) @cards = WhopSDK::Resources::Cards.new(client: self) @swaps = WhopSDK::Resources::Swaps.new(client: self) @deposits = WhopSDK::Resources::Deposits.new(client: self) diff --git a/lib/whop_sdk/models.rb b/lib/whop_sdk/models.rb index 6df246fa..3d3b1dbc 100644 --- a/lib/whop_sdk/models.rb +++ b/lib/whop_sdk/models.rb @@ -601,6 +601,14 @@ module WhopSDK PageInfo = WhopSDK::Models::PageInfo + PartnerCreateParams = WhopSDK::Models::PartnerCreateParams + + PartnerLeaderboardParams = WhopSDK::Models::PartnerLeaderboardParams + + PartnerReferredUsersParams = WhopSDK::Models::PartnerReferredUsersParams + + Partners = WhopSDK::Models::Partners + Payment = WhopSDK::Models::Payment PaymentCreatedWebhookEvent = WhopSDK::Models::PaymentCreatedWebhookEvent @@ -711,10 +719,6 @@ module WhopSDK ReceiptTaxBehavior = WhopSDK::Models::ReceiptTaxBehavior - ReferralReferredUsersParams = WhopSDK::Models::ReferralReferredUsersParams - - Referrals = WhopSDK::Models::Referrals - RefundCreatedWebhookEvent = WhopSDK::Models::RefundCreatedWebhookEvent RefundListParams = WhopSDK::Models::RefundListParams @@ -849,6 +853,8 @@ module WhopSDK UserListParams = WhopSDK::Models::UserListParams + UserRecommendActionsParams = WhopSDK::Models::UserRecommendActionsParams + UserRetrieveParams = WhopSDK::Models::UserRetrieveParams UserUpdateMeParams = WhopSDK::Models::UserUpdateMeParams diff --git a/lib/whop_sdk/models/account.rb b/lib/whop_sdk/models/account.rb index d6f29d06..b4151592 100644 --- a/lib/whop_sdk/models/account.rb +++ b/lib/whop_sdk/models/account.rb @@ -723,14 +723,13 @@ class RecommendedAction < WhopSDK::Internal::Type::BaseModel required :icon_url, String, nil?: true # @!attribute impact_score - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked # # @return [Integer, nil] required :impact_score, Integer, nil?: true # @!attribute reasoning - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` # # @return [String, nil] required :reasoning, String, nil?: true @@ -768,9 +767,9 @@ class RecommendedAction < WhopSDK::Internal::Type::BaseModel # # @param icon_url [String, nil] Illustration icon URL, or `null` # - # @param impact_score [Integer, nil] Estimated revenue impact from 0-100, comparable across accounts, or `null` when + # @param impact_score [Integer, nil] Estimated impact from 0-100, or `null` when not ranked # - # @param reasoning [String, nil] Why this action was recommended for this account, or `null` + # @param reasoning [String, nil] Why this action was recommended, or `null` # # @param status [Symbol, WhopSDK::Models::Account::RecommendedAction::Status] Always optional — never blocking # diff --git a/lib/whop_sdk/models/account_recommend_actions_response.rb b/lib/whop_sdk/models/account_recommend_actions_response.rb index 3867fca0..fa5b6051 100644 --- a/lib/whop_sdk/models/account_recommend_actions_response.rb +++ b/lib/whop_sdk/models/account_recommend_actions_response.rb @@ -51,14 +51,13 @@ class Data < WhopSDK::Internal::Type::BaseModel required :icon_url, String, nil?: true # @!attribute impact_score - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked # # @return [Integer, nil] required :impact_score, Integer, nil?: true # @!attribute reasoning - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` # # @return [String, nil] required :reasoning, String, nil?: true @@ -91,9 +90,9 @@ class Data < WhopSDK::Internal::Type::BaseModel # # @param icon_url [String, nil] Illustration icon URL, or `null` # - # @param impact_score [Integer, nil] Estimated revenue impact from 0-100, comparable across accounts, or `null` when + # @param impact_score [Integer, nil] Estimated impact from 0-100, or `null` when not ranked # - # @param reasoning [String, nil] Why this action was recommended for this account, or `null` + # @param reasoning [String, nil] Why this action was recommended, or `null` # # @param status [Symbol, WhopSDK::Models::AccountRecommendActionsResponse::Data::Status] Always optional — never blocking # diff --git a/lib/whop_sdk/models/ad_group.rb b/lib/whop_sdk/models/ad_group.rb index 4b5c8aaf..052d65c2 100644 --- a/lib/whop_sdk/models/ad_group.rb +++ b/lib/whop_sdk/models/ad_group.rb @@ -201,6 +201,15 @@ class AdGroup < WhopSDK::Internal::Type::BaseModel # @return [Float, nil] required :desired_cost_per_result, Float, nil?: true + # @!attribute detailed_targeting + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where demographics type is one of + # life_events, industries, income, family_statuses. Incompatible with + # demographics.automatic (Advantage+) and Special Ad Category campaigns. + # + # @return [Object] + required :detailed_targeting, WhopSDK::Internal::Type::Unknown + # @!attribute devices # Device targeting: platforms and operating systems. # @@ -295,8 +304,10 @@ class AdGroup < WhopSDK::Internal::Type::BaseModel required :reach, Float # @!attribute regions - # Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g. - # US-CA), cities, zips. + # Geo targeting: include/exclude countries, country_groups (include-only Meta + # groups like worldwide — global reach), regions (ISO 3166-2 states, e.g. US-CA), + # cities, zips, and custom_locations (pin + radius: { latitude, longitude, radius, + # distance_unit, name }). # # @return [Object] required :regions, WhopSDK::Internal::Type::Unknown @@ -398,7 +409,7 @@ class AdGroup < WhopSDK::Internal::Type::BaseModel # @return [Float] required :viewed_contents, Float - # @!method initialize(id:, ad_campaign:, added_to_carts:, audiences:, bid_type:, budget_amount:, budget_type:, click_through_rate:, clicks:, completed_registrations:, contacts:, conversion_event:, conversion_location:, cost_per_added_to_cart:, cost_per_click:, cost_per_completed_registration:, cost_per_contact:, cost_per_lead:, cost_per_mille:, cost_per_purchase:, cost_per_result:, cost_per_schedule:, cost_per_submitted_application:, cost_per_viewed_content:, created_at:, custom_conversions:, custom_event_counts:, delivery_status:, demographics:, desired_cost_per_result:, devices:, dynamic_creative:, ends_at:, frequency:, frequency_cap:, impressions:, issues:, languages:, leads:, message_apps:, minimum_daily_spend:, optimization_goal:, placements:, purchase_value:, purchases:, reach:, regions:, result_event:, result_event_name:, results:, return_on_ad_spend:, schedules:, spend:, spend_currency:, starts_at:, status:, submitted_applications:, title:, unique_click_through_rate:, unique_clicks:, updated_at:, viewed_contents:) + # @!method initialize(id:, ad_campaign:, added_to_carts:, audiences:, bid_type:, budget_amount:, budget_type:, click_through_rate:, clicks:, completed_registrations:, contacts:, conversion_event:, conversion_location:, cost_per_added_to_cart:, cost_per_click:, cost_per_completed_registration:, cost_per_contact:, cost_per_lead:, cost_per_mille:, cost_per_purchase:, cost_per_result:, cost_per_schedule:, cost_per_submitted_application:, cost_per_viewed_content:, created_at:, custom_conversions:, custom_event_counts:, delivery_status:, demographics:, desired_cost_per_result:, detailed_targeting:, devices:, dynamic_creative:, ends_at:, frequency:, frequency_cap:, impressions:, issues:, languages:, leads:, message_apps:, minimum_daily_spend:, optimization_goal:, placements:, purchase_value:, purchases:, reach:, regions:, result_event:, result_event_name:, results:, return_on_ad_spend:, schedules:, spend:, spend_currency:, starts_at:, status:, submitted_applications:, title:, unique_click_through_rate:, unique_clicks:, updated_at:, viewed_contents:) # Some parameter documentations has been truncated, see {WhopSDK::Models::AdGroup} # for more details. # @@ -462,6 +473,8 @@ class AdGroup < WhopSDK::Internal::Type::BaseModel # # @param desired_cost_per_result [Float, nil] Target/cap cost for average_target / maximum_target. # + # @param detailed_targeting [Object] Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], demograp + # # @param devices [Object] Device targeting: platforms and operating systems. # # @param dynamic_creative [Boolean] Whether ads within this ad group have their creatives and copy dynamically AB te @@ -494,7 +507,7 @@ class AdGroup < WhopSDK::Internal::Type::BaseModel # # @param reach [Float] The number of unique people who saw this. # - # @param regions [Object] Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g. US-CA + # @param regions [Object] Geo targeting: include/exclude countries, country_groups (include-only Meta grou # # @param result_event [Symbol, WhopSDK::Models::AdGroup::ResultEvent, nil] The Whop pixel conversion event whose attributed count represents results — the # diff --git a/lib/whop_sdk/models/ad_group_create_params.rb b/lib/whop_sdk/models/ad_group_create_params.rb index ba3d9dad..52205b23 100644 --- a/lib/whop_sdk/models/ad_group_create_params.rb +++ b/lib/whop_sdk/models/ad_group_create_params.rb @@ -65,6 +65,17 @@ class AdGroupCreateParams < WhopSDK::Internal::Type::BaseModel # @return [Float, nil] optional :desired_cost_per_result, Float + # @!attribute detailed_targeting + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + # + # @return [Object, nil] + optional :detailed_targeting, WhopSDK::Internal::Type::Unknown + # @!attribute devices # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. # @@ -137,8 +148,12 @@ class AdGroupCreateParams < WhopSDK::Internal::Type::BaseModel optional :placements, WhopSDK::Internal::Type::Unknown # @!attribute regions - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. # # @return [Object, nil] optional :regions, WhopSDK::Internal::Type::Unknown @@ -161,7 +176,7 @@ class AdGroupCreateParams < WhopSDK::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(ad_campaign_id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, dynamic_creative: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) + # @!method initialize(ad_campaign_id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, detailed_targeting: nil, devices: nil, dynamic_creative: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) # Some parameter documentations has been truncated, see # {WhopSDK::Models::AdGroupCreateParams} for more details. # @@ -183,6 +198,8 @@ class AdGroupCreateParams < WhopSDK::Internal::Type::BaseModel # # @param desired_cost_per_result [Float] Target/cap cost for average_target / maximum_target. # + # @param detailed_targeting [Object] Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], demograp + # # @param devices [Object] Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. # # @param dynamic_creative [Boolean] Run Meta dynamic (Advantage+) creative for this ad set. Set at creation; immutab @@ -201,7 +218,7 @@ class AdGroupCreateParams < WhopSDK::Internal::Type::BaseModel # # @param placements [Object] 'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to # - # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/pr + # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups (in # # @param starts_at [String] Schedule start, ISO 8601. # diff --git a/lib/whop_sdk/models/ad_group_update_params.rb b/lib/whop_sdk/models/ad_group_update_params.rb index b2f0e2d7..b37da426 100644 --- a/lib/whop_sdk/models/ad_group_update_params.rb +++ b/lib/whop_sdk/models/ad_group_update_params.rb @@ -64,6 +64,17 @@ class AdGroupUpdateParams < WhopSDK::Internal::Type::BaseModel # @return [Float, nil] optional :desired_cost_per_result, Float + # @!attribute detailed_targeting + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + # + # @return [Object, nil] + optional :detailed_targeting, WhopSDK::Internal::Type::Unknown + # @!attribute devices # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. # @@ -129,8 +140,12 @@ class AdGroupUpdateParams < WhopSDK::Internal::Type::BaseModel optional :placements, WhopSDK::Internal::Type::Unknown # @!attribute regions - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. # # @return [Object, nil] optional :regions, WhopSDK::Internal::Type::Unknown @@ -153,7 +168,7 @@ class AdGroupUpdateParams < WhopSDK::Internal::Type::BaseModel # @return [String, nil] optional :title, String - # @!method initialize(id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) + # @!method initialize(id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, detailed_targeting: nil, devices: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) # Some parameter documentations has been truncated, see # {WhopSDK::Models::AdGroupUpdateParams} for more details. # @@ -175,6 +190,8 @@ class AdGroupUpdateParams < WhopSDK::Internal::Type::BaseModel # # @param desired_cost_per_result [Float] Target/cap cost for average_target / maximum_target. # + # @param detailed_targeting [Object] Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], demograp + # # @param devices [Object] Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. # # @param ends_at [String] Schedule end, ISO 8601. @@ -191,7 +208,7 @@ class AdGroupUpdateParams < WhopSDK::Internal::Type::BaseModel # # @param placements [Object] 'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to # - # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/pr + # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups (in # # @param starts_at [String] Schedule start, ISO 8601. # diff --git a/lib/whop_sdk/models/event_create_params.rb b/lib/whop_sdk/models/event_create_params.rb index a599fb3e..3603556a 100644 --- a/lib/whop_sdk/models/event_create_params.rb +++ b/lib/whop_sdk/models/event_create_params.rb @@ -14,10 +14,14 @@ class EventCreateParams < WhopSDK::Internal::Type::BaseModel required :account_id, String # @!attribute event_name - # The type of conversion or engagement event + # The type of event. # - # @return [Symbol, WhopSDK::Models::EventCreateParams::EventName] - required :event_name, enum: -> { WhopSDK::EventCreateParams::EventName } + # Use a standard event (lead, submit_application, contact, complete_registration, + # schedule, view_content, add_to_cart) or pass your own name directly for a custom + # event. + # + # @return [String] + required :event_name, String # @!attribute action_source # The channel where an event originated @@ -122,7 +126,7 @@ class EventCreateParams < WhopSDK::Internal::Type::BaseModel # # @param account_id [String] The account to associate with this event. # - # @param event_name [Symbol, WhopSDK::Models::EventCreateParams::EventName] The type of conversion or engagement event + # @param event_name [String] The type of event. # # @param action_source [Symbol, WhopSDK::Models::EventCreateParams::ActionSource, nil] The channel where an event originated # @@ -158,24 +162,6 @@ class EventCreateParams < WhopSDK::Internal::Type::BaseModel # # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}] - # The type of conversion or engagement event - module EventName - extend WhopSDK::Internal::Type::Enum - - LEAD = :lead - SUBMIT_APPLICATION = :submit_application - CONTACT = :contact - COMPLETE_REGISTRATION = :complete_registration - SCHEDULE = :schedule - VIEW_CONTENT = :view_content - ADD_TO_CART = :add_to_cart - CUSTOM = :custom - PAGE = :page - - # @!method self.values - # @return [Array] - end - # The channel where an event originated module ActionSource extend WhopSDK::Internal::Type::Enum diff --git a/lib/whop_sdk/models/invoice.rb b/lib/whop_sdk/models/invoice.rb index 6165b051..ac5ba64f 100644 --- a/lib/whop_sdk/models/invoice.rb +++ b/lib/whop_sdk/models/invoice.rb @@ -42,6 +42,12 @@ class Invoice < WhopSDK::Internal::Type::BaseModel # @return [String] required :fetch_invoice_token, String + # @!attribute line_items + # Optional line items that break down the invoice total into individual charges. + # + # @return [Array] + required :line_items, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Invoice::LineItem] } + # @!attribute number # The sequential invoice number for display purposes. # @@ -61,7 +67,7 @@ class Invoice < WhopSDK::Internal::Type::BaseModel # @return [WhopSDK::Models::Invoice::User, nil] required :user, -> { WhopSDK::Invoice::User }, nil?: true - # @!method initialize(id:, created_at:, current_plan:, due_date:, email_address:, fetch_invoice_token:, number:, status:, user:) + # @!method initialize(id:, created_at:, current_plan:, due_date:, email_address:, fetch_invoice_token:, line_items:, number:, status:, user:) # Some parameter documentations has been truncated, see {WhopSDK::Models::Invoice} # for more details. # @@ -81,6 +87,8 @@ class Invoice < WhopSDK::Internal::Type::BaseModel # # @param fetch_invoice_token [String] A signed token that allows fetching invoice data publicly without authentication # + # @param line_items [Array] Optional line items that break down the invoice total into individual charges. + # # @param number [String] The sequential invoice number for display purposes. # # @param status [Symbol, WhopSDK::Models::InvoiceStatus] The current payment status of the invoice, such as draft, open, paid, or void. @@ -121,6 +129,52 @@ class CurrentPlan < WhopSDK::Internal::Type::BaseModel # @param formatted_price [String] The formatted price (including currency) for the plan. end + class LineItem < WhopSDK::Internal::Type::BaseModel + # @!attribute label + # The label or description for this line item. + # + # @return [String] + required :label, String + + # @!attribute position + # The display order of this line item within the invoice. + # + # @return [Integer] + required :position, Integer + + # @!attribute quantity + # The quantity of this line item. + # + # @return [Float] + required :quantity, Float + + # @!attribute total + # The computed total for this line item (quantity \* unit_price). + # + # @return [Float] + required :total, Float + + # @!attribute unit_price + # The unit price for this line item. + # + # @return [Float] + required :unit_price, Float + + # @!method initialize(label:, position:, quantity:, total:, unit_price:) + # A line item on an invoice, representing a single charge with a label, quantity, + # and unit price. + # + # @param label [String] The label or description for this line item. + # + # @param position [Integer] The display order of this line item within the invoice. + # + # @param quantity [Float] The quantity of this line item. + # + # @param total [Float] The computed total for this line item (quantity \* unit_price). + # + # @param unit_price [Float] The unit price for this line item. + end + # @see WhopSDK::Models::Invoice#user class User < WhopSDK::Internal::Type::BaseModel # @!attribute id diff --git a/lib/whop_sdk/models/invoice_list_item.rb b/lib/whop_sdk/models/invoice_list_item.rb index ee564803..d637ac6c 100644 --- a/lib/whop_sdk/models/invoice_list_item.rb +++ b/lib/whop_sdk/models/invoice_list_item.rb @@ -42,6 +42,12 @@ class InvoiceListItem < WhopSDK::Internal::Type::BaseModel # @return [String] required :fetch_invoice_token, String + # @!attribute line_items + # Optional line items that break down the invoice total into individual charges. + # + # @return [Array] + required :line_items, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::InvoiceListItem::LineItem] } + # @!attribute number # The sequential invoice number for display purposes. # @@ -61,7 +67,7 @@ class InvoiceListItem < WhopSDK::Internal::Type::BaseModel # @return [WhopSDK::Models::InvoiceListItem::User, nil] required :user, -> { WhopSDK::InvoiceListItem::User }, nil?: true - # @!method initialize(id:, created_at:, current_plan:, due_date:, email_address:, fetch_invoice_token:, number:, status:, user:) + # @!method initialize(id:, created_at:, current_plan:, due_date:, email_address:, fetch_invoice_token:, line_items:, number:, status:, user:) # Some parameter documentations has been truncated, see # {WhopSDK::Models::InvoiceListItem} for more details. # @@ -81,6 +87,8 @@ class InvoiceListItem < WhopSDK::Internal::Type::BaseModel # # @param fetch_invoice_token [String] A signed token that allows fetching invoice data publicly without authentication # + # @param line_items [Array] Optional line items that break down the invoice total into individual charges. + # # @param number [String] The sequential invoice number for display purposes. # # @param status [Symbol, WhopSDK::Models::InvoiceStatus] The current payment status of the invoice, such as draft, open, paid, or void. @@ -121,6 +129,52 @@ class CurrentPlan < WhopSDK::Internal::Type::BaseModel # @param formatted_price [String] The formatted price (including currency) for the plan. end + class LineItem < WhopSDK::Internal::Type::BaseModel + # @!attribute label + # The label or description for this line item. + # + # @return [String] + required :label, String + + # @!attribute position + # The display order of this line item within the invoice. + # + # @return [Integer] + required :position, Integer + + # @!attribute quantity + # The quantity of this line item. + # + # @return [Float] + required :quantity, Float + + # @!attribute total + # The computed total for this line item (quantity \* unit_price). + # + # @return [Float] + required :total, Float + + # @!attribute unit_price + # The unit price for this line item. + # + # @return [Float] + required :unit_price, Float + + # @!method initialize(label:, position:, quantity:, total:, unit_price:) + # A line item on an invoice, representing a single charge with a label, quantity, + # and unit price. + # + # @param label [String] The label or description for this line item. + # + # @param position [Integer] The display order of this line item within the invoice. + # + # @param quantity [Float] The quantity of this line item. + # + # @param total [Float] The computed total for this line item (quantity \* unit_price). + # + # @param unit_price [Float] The unit price for this line item. + end + # @see WhopSDK::Models::InvoiceListItem#user class User < WhopSDK::Internal::Type::BaseModel # @!attribute id diff --git a/lib/whop_sdk/models/partner_create_params.rb b/lib/whop_sdk/models/partner_create_params.rb new file mode 100644 index 00000000..068fc59c --- /dev/null +++ b/lib/whop_sdk/models/partner_create_params.rb @@ -0,0 +1,14 @@ +# frozen_string_literal: true + +module WhopSDK + module Models + # @see WhopSDK::Resources::Partners#create + class PartnerCreateParams < 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 diff --git a/lib/whop_sdk/models/partner_create_response.rb b/lib/whop_sdk/models/partner_create_response.rb new file mode 100644 index 00000000..3cbd731a --- /dev/null +++ b/lib/whop_sdk/models/partner_create_response.rb @@ -0,0 +1,29 @@ +# frozen_string_literal: true + +module WhopSDK + module Models + # @see WhopSDK::Resources::Partners#create + class PartnerCreateResponse < WhopSDK::Internal::Type::BaseModel + # @!attribute referral_link + # The caller's referral link — businesses that sign up through it are attributed + # to the caller. + # + # @return [String] + required :referral_link, String + + # @!attribute whop_partner_enabled_at + # When the caller became a Whop partner. + # + # @return [Time] + required :whop_partner_enabled_at, Time + + # @!method initialize(referral_link:, whop_partner_enabled_at:) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerCreateResponse} for more details. + # + # @param referral_link [String] The caller's referral link — businesses that sign up through it are attributed t + # + # @param whop_partner_enabled_at [Time] When the caller became a Whop partner. + end + end +end diff --git a/lib/whop_sdk/models/partner_leaderboard_params.rb b/lib/whop_sdk/models/partner_leaderboard_params.rb new file mode 100644 index 00000000..f0a1c023 --- /dev/null +++ b/lib/whop_sdk/models/partner_leaderboard_params.rb @@ -0,0 +1,43 @@ +# frozen_string_literal: true + +module WhopSDK + module Models + # @see WhopSDK::Resources::Partners#leaderboard + class PartnerLeaderboardParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + # @!attribute period + # Time window for the rankings. `day`, `month`, and `year` count earnings since + # the start of the current calendar day, month, or year; `last_30_days` counts + # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. + # + # @return [Symbol, WhopSDK::Models::PartnerLeaderboardParams::Period, nil] + optional :period, enum: -> { WhopSDK::PartnerLeaderboardParams::Period } + + # @!method initialize(period: nil, request_options: {}) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerLeaderboardParams} for more details. + # + # @param period [Symbol, WhopSDK::Models::PartnerLeaderboardParams::Period] Time window for the rankings. `day`, `month`, and `year` count earnings since th + # + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}] + + # Time window for the rankings. `day`, `month`, and `year` count earnings since + # the start of the current calendar day, month, or year; `last_30_days` counts + # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. + module Period + extend WhopSDK::Internal::Type::Enum + + DAY = :day + MONTH = :month + YEAR = :year + LAST_30_DAYS = :last_30_days + ALL_TIME = :all_time + + # @!method self.values + # @return [Array] + end + end + end +end diff --git a/lib/whop_sdk/models/partner_leaderboard_response.rb b/lib/whop_sdk/models/partner_leaderboard_response.rb new file mode 100644 index 00000000..60609970 --- /dev/null +++ b/lib/whop_sdk/models/partner_leaderboard_response.rb @@ -0,0 +1,278 @@ +# frozen_string_literal: true + +module WhopSDK + module Models + # @see WhopSDK::Resources::Partners#leaderboard + class PartnerLeaderboardResponse < WhopSDK::Internal::Type::BaseModel + # @!attribute leaders + # The top referrers by total earnings, best first. + # + # @return [Array] + required :leaders, + -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PartnerLeaderboardResponse::Leader] } + + # @!attribute me + # The caller's own standing; null when the caller has no referral earnings. + # + # @return [WhopSDK::Models::PartnerLeaderboardResponse::Me, nil] + required :me, -> { WhopSDK::Models::PartnerLeaderboardResponse::Me }, nil?: true + + # @!method initialize(leaders:, me:) + # @param leaders [Array] The top referrers by total earnings, best first. + # + # @param me [WhopSDK::Models::PartnerLeaderboardResponse::Me, nil] The caller's own standing; null when the caller has no referral earnings. + + class Leader < WhopSDK::Internal::Type::BaseModel + # @!attribute first_referral_started_at + # When the referrer's earliest partner business became active. + # + # @return [Time] + required :first_referral_started_at, Time + + # @!attribute rank + # 1-based leaderboard position. + # + # @return [Integer] + required :rank, Integer + + # @!attribute total_earnings_usd + # The referrer's pending + completed earnings across all referred businesses, in + # USD. + # + # @return [String] + required :total_earnings_usd, String + + # @!attribute total_volume_usd + # Credited GMV across all the referrer's referred businesses, in USD. + # + # @return [String] + required :total_volume_usd, String + + # @!attribute user + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + # + # @return [WhopSDK::Models::PartnerLeaderboardResponse::Leader::User, nil] + required :user, -> { WhopSDK::Models::PartnerLeaderboardResponse::Leader::User }, nil?: true + + # @!method initialize(first_referral_started_at:, rank:, total_earnings_usd:, total_volume_usd:, user:) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerLeaderboardResponse::Leader} for more details. + # + # @param first_referral_started_at [Time] When the referrer's earliest partner business became active. + # + # @param rank [Integer] 1-based leaderboard position. + # + # @param total_earnings_usd [String] The referrer's pending + completed earnings across all referred businesses, in U + # + # @param total_volume_usd [String] Credited GMV across all the referrer's referred businesses, in USD. + # + # @param user [WhopSDK::Models::PartnerLeaderboardResponse::Leader::User, nil] The ranked referrer. Identity fields (id, name, username, profile_picture) are r + + # @see WhopSDK::Models::PartnerLeaderboardResponse::Leader#user + class User < WhopSDK::Internal::Type::BaseModel + # @!attribute city + # The city where the referrer is located, derived from their IP address. Null if + # location sharing is disabled. + # + # @return [String, nil] + required :city, String, nil?: true + + # @!attribute country + # The country where the referrer is located, derived from their IP address. Null + # if location sharing is disabled. + # + # @return [String, nil] + required :country, String, nil?: true + + # @!attribute id + # User ID, prefixed `user_`. Present only on the caller's own entry. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # The user's display name. Present only on the caller's own entry. + # + # @return [String, nil] + optional :name, String, nil?: true + + # @!attribute profile_picture + # The user's profile picture. Present only on the caller's own entry. + # + # @return [WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture, nil] + optional :profile_picture, + -> { WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture } + + # @!attribute username + # The user's unique username. Present only on the caller's own entry. + # + # @return [String, nil] + optional :username, String + + # @!method initialize(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerLeaderboardResponse::Leader::User} for more details. + # + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + # + # @param city [String, nil] The city where the referrer is located, derived from their IP address. Null if l + # + # @param country [String, nil] The country where the referrer is located, derived from their IP address. Null i + # + # @param id [String] User ID, prefixed `user_`. Present only on the caller's own entry. + # + # @param name [String, nil] The user's display name. Present only on the caller's own entry. + # + # @param profile_picture [WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture] The user's profile picture. Present only on the caller's own entry. + # + # @param username [String] The user's unique username. Present only on the caller's own entry. + + # @see WhopSDK::Models::PartnerLeaderboardResponse::Leader::User#profile_picture + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + # @!attribute url + # The user's profile picture URL. + # + # @return [String] + required :url, String + + # @!method initialize(url:) + # The user's profile picture. Present only on the caller's own entry. + # + # @param url [String] The user's profile picture URL. + end + end + end + + # @see WhopSDK::Models::PartnerLeaderboardResponse#me + class Me < WhopSDK::Internal::Type::BaseModel + # @!attribute first_referral_started_at + # When the referrer's earliest partner business became active. + # + # @return [Time] + required :first_referral_started_at, Time + + # @!attribute rank + # 1-based leaderboard position. + # + # @return [Integer] + required :rank, Integer + + # @!attribute total_earnings_usd + # The referrer's pending + completed earnings across all referred businesses, in + # USD. + # + # @return [String] + required :total_earnings_usd, String + + # @!attribute total_volume_usd + # Credited GMV across all the referrer's referred businesses, in USD. + # + # @return [String] + required :total_volume_usd, String + + # @!attribute user + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + # + # @return [WhopSDK::Models::PartnerLeaderboardResponse::Me::User, nil] + required :user, -> { WhopSDK::Models::PartnerLeaderboardResponse::Me::User }, nil?: true + + # @!method initialize(first_referral_started_at:, rank:, total_earnings_usd:, total_volume_usd:, user:) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerLeaderboardResponse::Me} for more details. + # + # The caller's own standing; null when the caller has no referral earnings. + # + # @param first_referral_started_at [Time] When the referrer's earliest partner business became active. + # + # @param rank [Integer] 1-based leaderboard position. + # + # @param total_earnings_usd [String] The referrer's pending + completed earnings across all referred businesses, in U + # + # @param total_volume_usd [String] Credited GMV across all the referrer's referred businesses, in USD. + # + # @param user [WhopSDK::Models::PartnerLeaderboardResponse::Me::User, nil] The ranked referrer. Identity fields (id, name, username, profile_picture) are r + + # @see WhopSDK::Models::PartnerLeaderboardResponse::Me#user + class User < WhopSDK::Internal::Type::BaseModel + # @!attribute city + # The city where the referrer is located, derived from their IP address. Null if + # location sharing is disabled. + # + # @return [String, nil] + required :city, String, nil?: true + + # @!attribute country + # The country where the referrer is located, derived from their IP address. Null + # if location sharing is disabled. + # + # @return [String, nil] + required :country, String, nil?: true + + # @!attribute id + # User ID, prefixed `user_`. Present only on the caller's own entry. + # + # @return [String, nil] + optional :id, String + + # @!attribute name + # The user's display name. Present only on the caller's own entry. + # + # @return [String, nil] + optional :name, String, nil?: true + + # @!attribute profile_picture + # The user's profile picture. Present only on the caller's own entry. + # + # @return [WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture, nil] + optional :profile_picture, -> { WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture } + + # @!attribute username + # The user's unique username. Present only on the caller's own entry. + # + # @return [String, nil] + optional :username, String + + # @!method initialize(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerLeaderboardResponse::Me::User} for more details. + # + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + # + # @param city [String, nil] The city where the referrer is located, derived from their IP address. Null if l + # + # @param country [String, nil] The country where the referrer is located, derived from their IP address. Null i + # + # @param id [String] User ID, prefixed `user_`. Present only on the caller's own entry. + # + # @param name [String, nil] The user's display name. Present only on the caller's own entry. + # + # @param profile_picture [WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture] The user's profile picture. Present only on the caller's own entry. + # + # @param username [String] The user's unique username. Present only on the caller's own entry. + + # @see WhopSDK::Models::PartnerLeaderboardResponse::Me::User#profile_picture + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + # @!attribute url + # The user's profile picture URL. + # + # @return [String] + required :url, String + + # @!method initialize(url:) + # The user's profile picture. Present only on the caller's own entry. + # + # @param url [String] The user's profile picture URL. + end + end + end + end + end +end diff --git a/lib/whop_sdk/models/referral_referred_users_params.rb b/lib/whop_sdk/models/partner_referred_users_params.rb similarity index 91% rename from lib/whop_sdk/models/referral_referred_users_params.rb rename to lib/whop_sdk/models/partner_referred_users_params.rb index d6f489bd..36243acd 100644 --- a/lib/whop_sdk/models/referral_referred_users_params.rb +++ b/lib/whop_sdk/models/partner_referred_users_params.rb @@ -2,8 +2,8 @@ module WhopSDK module Models - # @see WhopSDK::Resources::Referrals#referred_users - class ReferralReferredUsersParams < WhopSDK::Internal::Type::BaseModel + # @see WhopSDK::Resources::Partners#referred_users + class PartnerReferredUsersParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters @@ -46,7 +46,7 @@ class ReferralReferredUsersParams < WhopSDK::Internal::Type::BaseModel # @!method initialize(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::ReferralReferredUsersParams} for more details. + # {WhopSDK::Models::PartnerReferredUsersParams} for more details. # # @param after [String] Cursor to fetch the page after (from page_info.end_cursor). # diff --git a/lib/whop_sdk/models/referral_referred_users_response.rb b/lib/whop_sdk/models/partner_referred_users_response.rb similarity index 68% rename from lib/whop_sdk/models/referral_referred_users_response.rb rename to lib/whop_sdk/models/partner_referred_users_response.rb index b14fa31e..ebadfed3 100644 --- a/lib/whop_sdk/models/referral_referred_users_response.rb +++ b/lib/whop_sdk/models/partner_referred_users_response.rb @@ -2,22 +2,22 @@ module WhopSDK module Models - # @see WhopSDK::Resources::Referrals#referred_users - class ReferralReferredUsersResponse < WhopSDK::Internal::Type::BaseModel + # @see WhopSDK::Resources::Partners#referred_users + class PartnerReferredUsersResponse < WhopSDK::Internal::Type::BaseModel # @!attribute data # - # @return [Array] + # @return [Array] required :data, - -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::ReferralReferredUsersResponse::Data] } + -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PartnerReferredUsersResponse::Data] } # @!attribute page_info # - # @return [WhopSDK::Models::ReferralReferredUsersResponse::PageInfo] - required :page_info, -> { WhopSDK::Models::ReferralReferredUsersResponse::PageInfo } + # @return [WhopSDK::Models::PartnerReferredUsersResponse::PageInfo] + required :page_info, -> { WhopSDK::Models::PartnerReferredUsersResponse::PageInfo } # @!method initialize(data:, page_info:) - # @param data [Array] - # @param page_info [WhopSDK::Models::ReferralReferredUsersResponse::PageInfo] + # @param data [Array] + # @param page_info [WhopSDK::Models::PartnerReferredUsersResponse::PageInfo] class Data < WhopSDK::Internal::Type::BaseModel # @!attribute total_earnings_usd @@ -32,15 +32,15 @@ class Data < WhopSDK::Internal::Type::BaseModel # @!attribute user # - # @return [WhopSDK::Models::ReferralReferredUsersResponse::Data::User] - required :user, -> { WhopSDK::Models::ReferralReferredUsersResponse::Data::User } + # @return [WhopSDK::Models::PartnerReferredUsersResponse::Data::User] + required :user, -> { WhopSDK::Models::PartnerReferredUsersResponse::Data::User } # @!method initialize(total_earnings_usd:, total_volume_usd:, user:) # @param total_earnings_usd [String] # @param total_volume_usd [String] - # @param user [WhopSDK::Models::ReferralReferredUsersResponse::Data::User] + # @param user [WhopSDK::Models::PartnerReferredUsersResponse::Data::User] - # @see WhopSDK::Models::ReferralReferredUsersResponse::Data#user + # @see WhopSDK::Models::PartnerReferredUsersResponse::Data#user class User < WhopSDK::Internal::Type::BaseModel # @!attribute id # @@ -69,9 +69,9 @@ class User < WhopSDK::Internal::Type::BaseModel # @!attribute profile_picture # - # @return [WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture, nil] + # @return [WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture, nil] optional :profile_picture, - -> { WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture } + -> { WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture } # @!method initialize(id:, username:, city: nil, country: nil, name: nil, profile_picture: nil) # @param id [String] @@ -79,9 +79,9 @@ class User < WhopSDK::Internal::Type::BaseModel # @param city [String, nil] # @param country [String, nil] # @param name [String, nil] - # @param profile_picture [WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture] + # @param profile_picture [WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture] - # @see WhopSDK::Models::ReferralReferredUsersResponse::Data::User#profile_picture + # @see WhopSDK::Models::PartnerReferredUsersResponse::Data::User#profile_picture class ProfilePicture < WhopSDK::Internal::Type::BaseModel # @!attribute url # @@ -94,7 +94,7 @@ class ProfilePicture < WhopSDK::Internal::Type::BaseModel end end - # @see WhopSDK::Models::ReferralReferredUsersResponse#page_info + # @see WhopSDK::Models::PartnerReferredUsersResponse#page_info class PageInfo < WhopSDK::Internal::Type::BaseModel # @!attribute end_cursor # diff --git a/lib/whop_sdk/models/referrals/business_list_params.rb b/lib/whop_sdk/models/partners/business_list_params.rb similarity index 69% rename from lib/whop_sdk/models/referrals/business_list_params.rb rename to lib/whop_sdk/models/partners/business_list_params.rb index ae2bb082..a1dc4655 100644 --- a/lib/whop_sdk/models/referrals/business_list_params.rb +++ b/lib/whop_sdk/models/partners/business_list_params.rb @@ -2,8 +2,8 @@ module WhopSDK module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Businesses#list + module Partners + # @see WhopSDK::Resources::Partners::Businesses#list class BusinessListParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters @@ -21,13 +21,13 @@ class BusinessListParams < WhopSDK::Internal::Type::BaseModel optional :before, String # @!attribute created_after - # Only return business referrals created after this timestamp. + # Only return partner businesses created after this timestamp. # # @return [String, nil] optional :created_after, String # @!attribute created_before - # Only return business referrals created before this timestamp. + # Only return partner businesses created before this timestamp. # # @return [String, nil] optional :created_before, String @@ -35,11 +35,11 @@ class BusinessListParams < WhopSDK::Internal::Type::BaseModel # @!attribute direction # Sort direction. # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Direction, nil] - optional :direction, enum: -> { WhopSDK::Referrals::BusinessListParams::Direction } + # @return [Symbol, WhopSDK::Models::Partners::BusinessListParams::Direction, nil] + optional :direction, enum: -> { WhopSDK::Partners::BusinessListParams::Direction } # @!attribute first - # Number of business referrals to return from the start of the window. + # Number of partner businesses to return from the start of the window. # # @return [Integer, nil] optional :first, Integer @@ -52,16 +52,16 @@ class BusinessListParams < WhopSDK::Internal::Type::BaseModel optional :has_earnings, WhopSDK::Internal::Type::Boolean # @!attribute last - # Number of business referrals to return from the end of the window. + # Number of partner businesses to return from the end of the window. # # @return [Integer, nil] optional :last, Integer # @!attribute order - # The field to sort business referrals by. + # The field to sort partner businesses by. # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Order, nil] - optional :order, enum: -> { WhopSDK::Referrals::BusinessListParams::Order } + # @return [Symbol, WhopSDK::Models::Partners::BusinessListParams::Order, nil] + optional :order, enum: -> { WhopSDK::Partners::BusinessListParams::Order } # @!attribute referred_user_id # Filter to referrals attributed to this user. For first-tier referrals, this is @@ -81,44 +81,44 @@ class BusinessListParams < WhopSDK::Internal::Type::BaseModel # @!attribute status # Filter by referral status. # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Status, nil] - optional :status, enum: -> { WhopSDK::Referrals::BusinessListParams::Status } + # @return [Symbol, WhopSDK::Models::Partners::BusinessListParams::Status, nil] + optional :status, enum: -> { WhopSDK::Partners::BusinessListParams::Status } # @!attribute tier # Filter to only first-tier referrals or only second-tier referrals. # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Tier, nil] - optional :tier, enum: -> { WhopSDK::Referrals::BusinessListParams::Tier } + # @return [Symbol, WhopSDK::Models::Partners::BusinessListParams::Tier, nil] + optional :tier, enum: -> { WhopSDK::Partners::BusinessListParams::Tier } # @!method initialize(after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, has_earnings: nil, last: nil, order: nil, referred_user_id: nil, referred_username: nil, status: nil, tier: nil, request_options: {}) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessListParams} for more details. + # {WhopSDK::Models::Partners::BusinessListParams} for more details. # # @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 created_after [String] Only return business referrals created after this timestamp. + # @param created_after [String] Only return partner businesses created after this timestamp. # - # @param created_before [String] Only return business referrals created before this timestamp. + # @param created_before [String] Only return partner businesses created before this timestamp. # - # @param direction [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Direction] Sort direction. + # @param direction [Symbol, WhopSDK::Models::Partners::BusinessListParams::Direction] Sort direction. # - # @param first [Integer] Number of business referrals to return from the start of the window. + # @param first [Integer] Number of partner businesses to return from the start of the window. # # @param has_earnings [Boolean] When true, only businesses with pending or completed earnings paid to the caller # - # @param last [Integer] Number of business referrals to return from the end of the window. + # @param last [Integer] Number of partner businesses to return from the end of the window. # - # @param order [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Order] The field to sort business referrals by. + # @param order [Symbol, WhopSDK::Models::Partners::BusinessListParams::Order] The field to sort partner businesses by. # # @param referred_user_id [String] Filter to referrals attributed to this user. For first-tier referrals, this is t # # @param referred_username [String] Filter by the referred user's exact username. Ignored when `referred_user_id` is # - # @param status [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Status] Filter by referral status. + # @param status [Symbol, WhopSDK::Models::Partners::BusinessListParams::Status] Filter by referral status. # - # @param tier [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Tier] Filter to only first-tier referrals or only second-tier referrals. + # @param tier [Symbol, WhopSDK::Models::Partners::BusinessListParams::Tier] Filter to only first-tier referrals or only second-tier referrals. # # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}] @@ -133,7 +133,7 @@ module Direction # @return [Array] end - # The field to sort business referrals by. + # The field to sort partner businesses by. module Order extend WhopSDK::Internal::Type::Enum diff --git a/lib/whop_sdk/models/referrals/business_list_response.rb b/lib/whop_sdk/models/partners/business_list_response.rb similarity index 67% rename from lib/whop_sdk/models/referrals/business_list_response.rb rename to lib/whop_sdk/models/partners/business_list_response.rb index b4768f9f..4cb1edfc 100644 --- a/lib/whop_sdk/models/referrals/business_list_response.rb +++ b/lib/whop_sdk/models/partners/business_list_response.rb @@ -2,11 +2,11 @@ module WhopSDK module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Businesses#list + module Partners + # @see WhopSDK::Resources::Partners::Businesses#list class BusinessListResponse < WhopSDK::Internal::Type::BaseModel # @!attribute id - # Business referral ID. + # Partner business ID. # # @return [String] required :id, String @@ -14,46 +14,46 @@ class BusinessListResponse < WhopSDK::Internal::Type::BaseModel # @!attribute account # Referred account. # - # @return [WhopSDK::Models::Referrals::BusinessListResponse::Account, nil] - required :account, -> { WhopSDK::Models::Referrals::BusinessListResponse::Account }, nil?: true + # @return [WhopSDK::Models::Partners::BusinessListResponse::Account, nil] + required :account, -> { WhopSDK::Models::Partners::BusinessListResponse::Account }, nil?: true # @!attribute created_at - # When the business referral was created. + # When the partner business was created. # # @return [Time] required :created_at, Time # @!attribute earnings_usd # - # @return [WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd] - required :earnings_usd, -> { WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd } + # @return [WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd] + required :earnings_usd, -> { WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd } # @!attribute first_tier_partner # The partner who referred the business owner onto Whop (first tier). Null if # there is no active first-tier partner. # - # @return [WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner, nil] + # @return [WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner, nil] required :first_tier_partner, - -> { WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner }, + -> { WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner }, nil?: true # @!attribute my_partner_tier # Which tier the caller earns on for this business: `first` (they referred the # owner) or `second` (they referred the first-tier partner). # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier] - required :my_partner_tier, enum: -> { WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier } + # @return [Symbol, WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier] + required :my_partner_tier, enum: -> { WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier } # @!attribute object # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessListResponse::Object] - required :object, enum: -> { WhopSDK::Models::Referrals::BusinessListResponse::Object } + # @return [Symbol, WhopSDK::Models::Partners::BusinessListResponse::Object] + required :object, enum: -> { WhopSDK::Models::Partners::BusinessListResponse::Object } # @!attribute owner # The owner of the referred business. # - # @return [WhopSDK::Models::Referrals::BusinessListResponse::Owner, nil] - required :owner, -> { WhopSDK::Models::Referrals::BusinessListResponse::Owner }, nil?: true + # @return [WhopSDK::Models::Partners::BusinessListResponse::Owner, nil] + required :owner, -> { WhopSDK::Models::Partners::BusinessListResponse::Owner }, nil?: true # @!attribute payout_percentage # Referrer's share of Whop gross profit, as a fraction (0.3 = 30%). Second-tier @@ -77,33 +77,33 @@ class BusinessListResponse < WhopSDK::Internal::Type::BaseModel # @!attribute status # Current referral status. # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessListResponse::Status] - required :status, enum: -> { WhopSDK::Models::Referrals::BusinessListResponse::Status } + # @return [Symbol, WhopSDK::Models::Partners::BusinessListResponse::Status] + required :status, enum: -> { WhopSDK::Models::Partners::BusinessListResponse::Status } # @!attribute volume_usd # - # @return [WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd] - required :volume_usd, -> { WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd } + # @return [WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd] + required :volume_usd, -> { WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd } # @!method initialize(id:, account:, created_at:, earnings_usd:, first_tier_partner:, my_partner_tier:, object:, owner:, payout_percentage:, referral_expires_at:, referral_started_at:, status:, volume_usd:) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessListResponse} for more details. + # {WhopSDK::Models::Partners::BusinessListResponse} for more details. # - # @param id [String] Business referral ID. + # @param id [String] Partner business ID. # - # @param account [WhopSDK::Models::Referrals::BusinessListResponse::Account, nil] Referred account. + # @param account [WhopSDK::Models::Partners::BusinessListResponse::Account, nil] Referred account. # - # @param created_at [Time] When the business referral was created. + # @param created_at [Time] When the partner business was created. # - # @param earnings_usd [WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd] + # @param earnings_usd [WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd] # - # @param first_tier_partner [WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner, nil] The partner who referred the business owner onto Whop (first tier). Null if ther + # @param first_tier_partner [WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner, nil] The partner who referred the business owner onto Whop (first tier). Null if ther # - # @param my_partner_tier [Symbol, WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier] Which tier the caller earns on for this business: `first` (they referred the own + # @param my_partner_tier [Symbol, WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier] Which tier the caller earns on for this business: `first` (they referred the own # - # @param object [Symbol, WhopSDK::Models::Referrals::BusinessListResponse::Object] + # @param object [Symbol, WhopSDK::Models::Partners::BusinessListResponse::Object] # - # @param owner [WhopSDK::Models::Referrals::BusinessListResponse::Owner, nil] The owner of the referred business. + # @param owner [WhopSDK::Models::Partners::BusinessListResponse::Owner, nil] The owner of the referred business. # # @param payout_percentage [Float] Referrer's share of Whop gross profit, as a fraction (0.3 = 30%). Second-tier re # @@ -111,11 +111,11 @@ class BusinessListResponse < WhopSDK::Internal::Type::BaseModel # # @param referral_started_at [Time, nil] When the referral became active. # - # @param status [Symbol, WhopSDK::Models::Referrals::BusinessListResponse::Status] Current referral status. + # @param status [Symbol, WhopSDK::Models::Partners::BusinessListResponse::Status] Current referral status. # - # @param volume_usd [WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd] + # @param volume_usd [WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd] - # @see WhopSDK::Models::Referrals::BusinessListResponse#account + # @see WhopSDK::Models::Partners::BusinessListResponse#account class Account < WhopSDK::Internal::Type::BaseModel # @!attribute id # Referred account ID. @@ -153,7 +153,7 @@ class Account < WhopSDK::Internal::Type::BaseModel # @param title [String] Referred account display name. end - # @see WhopSDK::Models::Referrals::BusinessListResponse#earnings_usd + # @see WhopSDK::Models::Partners::BusinessListResponse#earnings_usd class EarningsUsd < WhopSDK::Internal::Type::BaseModel # @!attribute completed # Commission already paid out, in USD. @@ -181,7 +181,7 @@ class EarningsUsd < WhopSDK::Internal::Type::BaseModel # @param total [String] Pending + completed commission, in USD. end - # @see WhopSDK::Models::Referrals::BusinessListResponse#first_tier_partner + # @see WhopSDK::Models::Partners::BusinessListResponse#first_tier_partner class FirstTierPartner < WhopSDK::Internal::Type::BaseModel # @!attribute id # User ID, prefixed `user_`. @@ -198,9 +198,9 @@ class FirstTierPartner < WhopSDK::Internal::Type::BaseModel # @!attribute profile_picture # The user's profile picture. # - # @return [WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture] + # @return [WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture] required :profile_picture, - -> { WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture } + -> { WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture } # @!attribute username # The user's unique username. @@ -216,11 +216,11 @@ class FirstTierPartner < WhopSDK::Internal::Type::BaseModel # # @param name [String, nil] The user's display name. # - # @param profile_picture [WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture] The user's profile picture. + # @param profile_picture [WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture] The user's profile picture. # # @param username [String] The user's unique username. - # @see WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner#profile_picture + # @see WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner#profile_picture class ProfilePicture < WhopSDK::Internal::Type::BaseModel # @!attribute url # The user's profile picture URL. @@ -238,7 +238,7 @@ class ProfilePicture < WhopSDK::Internal::Type::BaseModel # Which tier the caller earns on for this business: `first` (they referred the # owner) or `second` (they referred the first-tier partner). # - # @see WhopSDK::Models::Referrals::BusinessListResponse#my_partner_tier + # @see WhopSDK::Models::Partners::BusinessListResponse#my_partner_tier module MyPartnerTier extend WhopSDK::Internal::Type::Enum @@ -249,17 +249,17 @@ module MyPartnerTier # @return [Array] end - # @see WhopSDK::Models::Referrals::BusinessListResponse#object + # @see WhopSDK::Models::Partners::BusinessListResponse#object module Object extend WhopSDK::Internal::Type::Enum - BUSINESS_REFERRAL = :business_referral + PARTNER_BUSINESS = :partner_business # @!method self.values # @return [Array] end - # @see WhopSDK::Models::Referrals::BusinessListResponse#owner + # @see WhopSDK::Models::Partners::BusinessListResponse#owner class Owner < WhopSDK::Internal::Type::BaseModel # @!attribute id # User ID, prefixed `user_`. @@ -276,8 +276,8 @@ class Owner < WhopSDK::Internal::Type::BaseModel # @!attribute profile_picture # The user's profile picture. # - # @return [WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture] - required :profile_picture, -> { WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture } + # @return [WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture] + required :profile_picture, -> { WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture } # @!attribute username # The user's unique username. @@ -292,11 +292,11 @@ class Owner < WhopSDK::Internal::Type::BaseModel # # @param name [String, nil] The user's display name. # - # @param profile_picture [WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture] The user's profile picture. + # @param profile_picture [WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture] The user's profile picture. # # @param username [String] The user's unique username. - # @see WhopSDK::Models::Referrals::BusinessListResponse::Owner#profile_picture + # @see WhopSDK::Models::Partners::BusinessListResponse::Owner#profile_picture class ProfilePicture < WhopSDK::Internal::Type::BaseModel # @!attribute url # The user's profile picture URL. @@ -313,7 +313,7 @@ class ProfilePicture < WhopSDK::Internal::Type::BaseModel # Current referral status. # - # @see WhopSDK::Models::Referrals::BusinessListResponse#status + # @see WhopSDK::Models::Partners::BusinessListResponse#status module Status extend WhopSDK::Internal::Type::Enum @@ -324,7 +324,7 @@ module Status # @return [Array] end - # @see WhopSDK::Models::Referrals::BusinessListResponse#volume_usd + # @see WhopSDK::Models::Partners::BusinessListResponse#volume_usd class VolumeUsd < WhopSDK::Internal::Type::BaseModel # @!attribute attributed # Credited GMV (awaiting_settlement + settled); excludes canceled and reversed, in @@ -347,7 +347,7 @@ class VolumeUsd < WhopSDK::Internal::Type::BaseModel # @!method initialize(attributed:, awaiting_settlement:, settled:) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd} for more details. + # {WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd} for more details. # # @param attributed [String] Credited GMV (awaiting_settlement + settled); excludes canceled and reversed, in # diff --git a/lib/whop_sdk/models/referrals/business_retrieve_params.rb b/lib/whop_sdk/models/partners/business_retrieve_params.rb similarity index 86% rename from lib/whop_sdk/models/referrals/business_retrieve_params.rb rename to lib/whop_sdk/models/partners/business_retrieve_params.rb index 6f392a37..c28e5d6f 100644 --- a/lib/whop_sdk/models/referrals/business_retrieve_params.rb +++ b/lib/whop_sdk/models/partners/business_retrieve_params.rb @@ -2,8 +2,8 @@ module WhopSDK module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Businesses#retrieve + module Partners + # @see WhopSDK::Resources::Partners::Businesses#retrieve class BusinessRetrieveParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters diff --git a/lib/whop_sdk/models/referrals/business_retrieve_response.rb b/lib/whop_sdk/models/partners/business_retrieve_response.rb similarity index 62% rename from lib/whop_sdk/models/referrals/business_retrieve_response.rb rename to lib/whop_sdk/models/partners/business_retrieve_response.rb index 480925f4..e71fdab7 100644 --- a/lib/whop_sdk/models/referrals/business_retrieve_response.rb +++ b/lib/whop_sdk/models/partners/business_retrieve_response.rb @@ -2,11 +2,11 @@ module WhopSDK module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Businesses#retrieve + module Partners + # @see WhopSDK::Resources::Partners::Businesses#retrieve class BusinessRetrieveResponse < WhopSDK::Internal::Type::BaseModel # @!attribute id - # Business referral ID. + # Partner business ID. # # @return [String] required :id, String @@ -14,47 +14,46 @@ class BusinessRetrieveResponse < WhopSDK::Internal::Type::BaseModel # @!attribute account # Referred account. # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account, nil] - required :account, -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account }, nil?: true + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::Account, nil] + required :account, -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account }, nil?: true # @!attribute created_at - # When the business referral was created. + # When the partner business was created. # # @return [Time] required :created_at, Time # @!attribute earnings_usd # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd] - required :earnings_usd, -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd } + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd] + required :earnings_usd, -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd } # @!attribute first_tier_partner # The partner who referred the business owner onto Whop (first tier). Null if # there is no active first-tier partner. # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner, nil] + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner, nil] required :first_tier_partner, - -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner }, + -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner }, nil?: true # @!attribute my_partner_tier # Which tier the caller earns on for this business: `first` (they referred the # owner) or `second` (they referred the first-tier partner). # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier] - required :my_partner_tier, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier } + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier] + required :my_partner_tier, enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier } # @!attribute object # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object] - required :object, enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object } + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Object] + required :object, enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Object } # @!attribute owner # The owner of the referred business. # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner, nil] - required :owner, -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner }, nil?: true + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner, nil] + required :owner, -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner }, nil?: true # @!attribute payout_percentage # Referrer's share of Whop gross profit, as a fraction (0.3 = 30%). Second-tier @@ -78,33 +77,33 @@ class BusinessRetrieveResponse < WhopSDK::Internal::Type::BaseModel # @!attribute status # Current referral status. # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status] - required :status, enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status } + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Status] + required :status, enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Status } # @!attribute volume_usd # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd] - required :volume_usd, -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd } + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd] + required :volume_usd, -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd } # @!method initialize(id:, account:, created_at:, earnings_usd:, first_tier_partner:, my_partner_tier:, object:, owner:, payout_percentage:, referral_expires_at:, referral_started_at:, status:, volume_usd:) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessRetrieveResponse} for more details. + # {WhopSDK::Models::Partners::BusinessRetrieveResponse} for more details. # - # @param id [String] Business referral ID. + # @param id [String] Partner business ID. # - # @param account [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account, nil] Referred account. + # @param account [WhopSDK::Models::Partners::BusinessRetrieveResponse::Account, nil] Referred account. # - # @param created_at [Time] When the business referral was created. + # @param created_at [Time] When the partner business was created. # - # @param earnings_usd [WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd] + # @param earnings_usd [WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd] # - # @param first_tier_partner [WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner, nil] The partner who referred the business owner onto Whop (first tier). Null if ther + # @param first_tier_partner [WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner, nil] The partner who referred the business owner onto Whop (first tier). Null if ther # - # @param my_partner_tier [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier] Which tier the caller earns on for this business: `first` (they referred the own + # @param my_partner_tier [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier] Which tier the caller earns on for this business: `first` (they referred the own # - # @param object [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object] + # @param object [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Object] # - # @param owner [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner, nil] The owner of the referred business. + # @param owner [WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner, nil] The owner of the referred business. # # @param payout_percentage [Float] Referrer's share of Whop gross profit, as a fraction (0.3 = 30%). Second-tier re # @@ -112,11 +111,11 @@ class BusinessRetrieveResponse < WhopSDK::Internal::Type::BaseModel # # @param referral_started_at [Time, nil] When the referral became active. # - # @param status [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status] Current referral status. + # @param status [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Status] Current referral status. # - # @param volume_usd [WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd] + # @param volume_usd [WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd] - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#account + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#account class Account < WhopSDK::Internal::Type::BaseModel # @!attribute id # Referred account ID. @@ -126,9 +125,9 @@ class Account < WhopSDK::Internal::Type::BaseModel # @!attribute capabilities # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities, nil] + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities, nil] required :capabilities, - -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities }, + -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities }, nil?: true # @!attribute logo_url @@ -140,17 +139,17 @@ class Account < WhopSDK::Internal::Type::BaseModel # @!attribute recommended_actions # Optional actions that unlock capabilities or grow the referred account. # - # @return [Array, nil] + # @return [Array, nil] required :recommended_actions, - -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction] }, + -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction] }, nil?: true # @!attribute required_actions # Actions the referred account owner must take to unblock capabilities. # - # @return [Array, nil] + # @return [Array, nil] required :required_actions, - -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction] }, + -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction] }, nil?: true # @!attribute route @@ -170,123 +169,123 @@ class Account < WhopSDK::Internal::Type::BaseModel # # @param id [String] Referred account ID. # - # @param capabilities [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities, nil] + # @param capabilities [WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities, nil] # # @param logo_url [String, nil] Referred account logo URL. # - # @param recommended_actions [Array, nil] Optional actions that unlock capabilities or grow the referred account. + # @param recommended_actions [Array, nil] Optional actions that unlock capabilities or grow the referred account. # - # @param required_actions [Array, nil] Actions the referred account owner must take to unblock capabilities. + # @param required_actions [Array, nil] Actions the referred account owner must take to unblock capabilities. # # @param route [String] Referred account route. # # @param title [String] Referred account display name. - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account#capabilities + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account#capabilities class Capabilities < WhopSDK::Internal::Type::BaseModel # @!attribute accept_bank_payments # Bank payins: debits, transfers, and local bank rails # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments] required :accept_bank_payments, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments } # @!attribute accept_bnpl_payments # Buy-now-pay-later payins; requires approval # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments] required :accept_bnpl_payments, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments } # @!attribute accept_card_payments # Card payins, including Apple Pay and Google Pay # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments] required :accept_card_payments, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments } # @!attribute bank_deposit # Deposits by bank wire or ACH to the account's virtual bank account # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit] required :bank_deposit, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit } # @!attribute card_deposit # Balance top-ups by charging a stored payment method # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit] required :card_deposit, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit } # @!attribute card_issuing # Issuing Whop cards; requires card application approval # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing] required :card_issuing, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing } # @!attribute crypto_deposit # On-chain deposits to the account's crypto wallet # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit] required :crypto_deposit, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit } # @!attribute crypto_payout # On-chain payouts to a crypto wallet # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout] required :crypto_payout, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout } # @!attribute instant_payout # Instant payouts to an eligible payout destination # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout] required :instant_payout, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout } # @!attribute standard_payout # Standard payouts to an external payout destination # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout] required :standard_payout, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout } # @!attribute transfer # Transfers to other accounts # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer] required :transfer, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer } # @!method initialize(accept_bank_payments:, accept_bnpl_payments:, accept_card_payments:, bank_deposit:, card_deposit:, card_issuing:, crypto_deposit:, crypto_payout:, instant_payout:, standard_payout:, transfer:) - # @param accept_bank_payments [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments] Bank payins: debits, transfers, and local bank rails + # @param accept_bank_payments [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments] Bank payins: debits, transfers, and local bank rails # - # @param accept_bnpl_payments [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments] Buy-now-pay-later payins; requires approval + # @param accept_bnpl_payments [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments] Buy-now-pay-later payins; requires approval # - # @param accept_card_payments [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments] Card payins, including Apple Pay and Google Pay + # @param accept_card_payments [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments] Card payins, including Apple Pay and Google Pay # - # @param bank_deposit [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit] Deposits by bank wire or ACH to the account's virtual bank account + # @param bank_deposit [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit] Deposits by bank wire or ACH to the account's virtual bank account # - # @param card_deposit [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit] Balance top-ups by charging a stored payment method + # @param card_deposit [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit] Balance top-ups by charging a stored payment method # - # @param card_issuing [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing] Issuing Whop cards; requires card application approval + # @param card_issuing [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing] Issuing Whop cards; requires card application approval # - # @param crypto_deposit [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit] On-chain deposits to the account's crypto wallet + # @param crypto_deposit [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit] On-chain deposits to the account's crypto wallet # - # @param crypto_payout [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout] On-chain payouts to a crypto wallet + # @param crypto_payout [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout] On-chain payouts to a crypto wallet # - # @param instant_payout [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout] Instant payouts to an eligible payout destination + # @param instant_payout [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout] Instant payouts to an eligible payout destination # - # @param standard_payout [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout] Standard payouts to an external payout destination + # @param standard_payout [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout] Standard payouts to an external payout destination # - # @param transfer [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer] Transfers to other accounts + # @param transfer [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer] Transfers to other accounts # Bank payins: debits, transfers, and local bank rails # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#accept_bank_payments + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#accept_bank_payments module AcceptBankPayments extend WhopSDK::Internal::Type::Enum @@ -300,7 +299,7 @@ module AcceptBankPayments # Buy-now-pay-later payins; requires approval # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#accept_bnpl_payments + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#accept_bnpl_payments module AcceptBnplPayments extend WhopSDK::Internal::Type::Enum @@ -314,7 +313,7 @@ module AcceptBnplPayments # Card payins, including Apple Pay and Google Pay # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#accept_card_payments + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#accept_card_payments module AcceptCardPayments extend WhopSDK::Internal::Type::Enum @@ -328,7 +327,7 @@ module AcceptCardPayments # Deposits by bank wire or ACH to the account's virtual bank account # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#bank_deposit + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#bank_deposit module BankDeposit extend WhopSDK::Internal::Type::Enum @@ -342,7 +341,7 @@ module BankDeposit # Balance top-ups by charging a stored payment method # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#card_deposit + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#card_deposit module CardDeposit extend WhopSDK::Internal::Type::Enum @@ -356,7 +355,7 @@ module CardDeposit # Issuing Whop cards; requires card application approval # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#card_issuing + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#card_issuing module CardIssuing extend WhopSDK::Internal::Type::Enum @@ -370,7 +369,7 @@ module CardIssuing # On-chain deposits to the account's crypto wallet # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#crypto_deposit + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#crypto_deposit module CryptoDeposit extend WhopSDK::Internal::Type::Enum @@ -384,7 +383,7 @@ module CryptoDeposit # On-chain payouts to a crypto wallet # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#crypto_payout + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#crypto_payout module CryptoPayout extend WhopSDK::Internal::Type::Enum @@ -398,7 +397,7 @@ module CryptoPayout # Instant payouts to an eligible payout destination # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#instant_payout + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#instant_payout module InstantPayout extend WhopSDK::Internal::Type::Enum @@ -412,7 +411,7 @@ module InstantPayout # Standard payouts to an external payout destination # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#standard_payout + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#standard_payout module StandardPayout extend WhopSDK::Internal::Type::Enum @@ -426,7 +425,7 @@ module StandardPayout # Transfers to other accounts # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities#transfer + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities#transfer module Transfer extend WhopSDK::Internal::Type::Enum @@ -444,9 +443,9 @@ class RecommendedAction < WhopSDK::Internal::Type::BaseModel # The recommendation; new values may be added, so handle unknown actions # gracefully # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action] required :action, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action } # @!attribute blocked_capabilities # @@ -478,14 +477,13 @@ class RecommendedAction < WhopSDK::Internal::Type::BaseModel required :icon_url, String, nil?: true # @!attribute impact_score - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked # # @return [Integer, nil] required :impact_score, Integer, nil?: true # @!attribute reasoning - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` # # @return [String, nil] required :reasoning, String, nil?: true @@ -493,9 +491,9 @@ class RecommendedAction < WhopSDK::Internal::Type::BaseModel # @!attribute status # Always optional — never blocking # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status] required :status, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status } # @!attribute title # Headline for the recommendation @@ -505,10 +503,10 @@ class RecommendedAction < WhopSDK::Internal::Type::BaseModel # @!method initialize(action:, blocked_capabilities:, cta:, cta_label:, description:, icon_url:, impact_score:, reasoning:, status:, title:) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction} + # {WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction} # for more details. # - # @param action [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action] The recommendation; new values may be added, so handle unknown actions gracefull + # @param action [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action] The recommendation; new values may be added, so handle unknown actions gracefull # # @param blocked_capabilities [Array] # @@ -520,18 +518,18 @@ class RecommendedAction < WhopSDK::Internal::Type::BaseModel # # @param icon_url [String, nil] Illustration icon URL, or `null` # - # @param impact_score [Integer, nil] Estimated revenue impact from 0-100, comparable across accounts, or `null` when + # @param impact_score [Integer, nil] Estimated impact from 0-100, or `null` when not ranked # - # @param reasoning [String, nil] Why this action was recommended for this account, or `null` + # @param reasoning [String, nil] Why this action was recommended, or `null` # - # @param status [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status] Always optional — never blocking + # @param status [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status] Always optional — never blocking # # @param title [String] Headline for the recommendation # The recommendation; new values may be added, so handle unknown actions # gracefully # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction#action + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction#action module Action extend WhopSDK::Internal::Type::Enum @@ -557,7 +555,7 @@ module Action # Always optional — never blocking # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction#status + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction#status module Status extend WhopSDK::Internal::Type::Enum @@ -573,9 +571,9 @@ class RequiredAction < WhopSDK::Internal::Type::BaseModel # What the holder must do; new values may be added, so handle unknown actions # gracefully # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action] required :action, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action } # @!attribute blocked_capabilities # @@ -609,9 +607,9 @@ class RequiredAction < WhopSDK::Internal::Type::BaseModel # @!attribute status # required (act now) or pending (under review) # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status] + # @return [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status] required :status, - enum: -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status } + enum: -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status } # @!attribute title # Headline for the action @@ -621,10 +619,10 @@ class RequiredAction < WhopSDK::Internal::Type::BaseModel # @!method initialize(action:, blocked_capabilities:, cta:, cta_label:, description:, icon_url:, status:, title:) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction} + # {WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction} # for more details. # - # @param action [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action] What the holder must do; new values may be added, so handle unknown actions grac + # @param action [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action] What the holder must do; new values may be added, so handle unknown actions grac # # @param blocked_capabilities [Array] # @@ -636,14 +634,14 @@ class RequiredAction < WhopSDK::Internal::Type::BaseModel # # @param icon_url [String, nil] The URL of the action's illustration icon, or null if it has none # - # @param status [Symbol, WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status] required (act now) or pending (under review) + # @param status [Symbol, WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status] required (act now) or pending (under review) # # @param title [String] Headline for the action # What the holder must do; new values may be added, so handle unknown actions # gracefully # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction#action + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction#action module Action extend WhopSDK::Internal::Type::Enum @@ -658,7 +656,7 @@ module Action # required (act now) or pending (under review) # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction#status + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction#status module Status extend WhopSDK::Internal::Type::Enum @@ -671,7 +669,7 @@ module Status end end - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#earnings_usd + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#earnings_usd class EarningsUsd < WhopSDK::Internal::Type::BaseModel # @!attribute completed # Commission already paid out, in USD. @@ -699,7 +697,7 @@ class EarningsUsd < WhopSDK::Internal::Type::BaseModel # @param total [String] Pending + completed commission, in USD. end - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#first_tier_partner + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#first_tier_partner class FirstTierPartner < WhopSDK::Internal::Type::BaseModel # @!attribute id # User ID, prefixed `user_`. @@ -716,9 +714,9 @@ class FirstTierPartner < WhopSDK::Internal::Type::BaseModel # @!attribute profile_picture # The user's profile picture. # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture] + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture] required :profile_picture, - -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture } + -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture } # @!attribute username # The user's unique username. @@ -734,11 +732,11 @@ class FirstTierPartner < WhopSDK::Internal::Type::BaseModel # # @param name [String, nil] The user's display name. # - # @param profile_picture [WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture] The user's profile picture. + # @param profile_picture [WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture] The user's profile picture. # # @param username [String] The user's unique username. - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner#profile_picture + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner#profile_picture class ProfilePicture < WhopSDK::Internal::Type::BaseModel # @!attribute url # The user's profile picture URL. @@ -756,7 +754,7 @@ class ProfilePicture < WhopSDK::Internal::Type::BaseModel # Which tier the caller earns on for this business: `first` (they referred the # owner) or `second` (they referred the first-tier partner). # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#my_partner_tier + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#my_partner_tier module MyPartnerTier extend WhopSDK::Internal::Type::Enum @@ -767,17 +765,17 @@ module MyPartnerTier # @return [Array] end - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#object + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#object module Object extend WhopSDK::Internal::Type::Enum - BUSINESS_REFERRAL = :business_referral + PARTNER_BUSINESS = :partner_business # @!method self.values # @return [Array] end - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#owner + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#owner class Owner < WhopSDK::Internal::Type::BaseModel # @!attribute id # User ID, prefixed `user_`. @@ -794,9 +792,9 @@ class Owner < WhopSDK::Internal::Type::BaseModel # @!attribute profile_picture # The user's profile picture. # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture] + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture] required :profile_picture, - -> { WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture } + -> { WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture } # @!attribute username # The user's unique username. @@ -811,11 +809,11 @@ class Owner < WhopSDK::Internal::Type::BaseModel # # @param name [String, nil] The user's display name. # - # @param profile_picture [WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture] The user's profile picture. + # @param profile_picture [WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture] The user's profile picture. # # @param username [String] The user's unique username. - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner#profile_picture + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner#profile_picture class ProfilePicture < WhopSDK::Internal::Type::BaseModel # @!attribute url # The user's profile picture URL. @@ -832,7 +830,7 @@ class ProfilePicture < WhopSDK::Internal::Type::BaseModel # Current referral status. # - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#status + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#status module Status extend WhopSDK::Internal::Type::Enum @@ -843,7 +841,7 @@ module Status # @return [Array] end - # @see WhopSDK::Models::Referrals::BusinessRetrieveResponse#volume_usd + # @see WhopSDK::Models::Partners::BusinessRetrieveResponse#volume_usd class VolumeUsd < WhopSDK::Internal::Type::BaseModel # @!attribute attributed # Credited GMV (awaiting_settlement + settled); excludes canceled and reversed, in @@ -866,7 +864,7 @@ class VolumeUsd < WhopSDK::Internal::Type::BaseModel # @!method initialize(attributed:, awaiting_settlement:, settled:) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd} for more + # {WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd} for more # details. # # @param attributed [String] Credited GMV (awaiting_settlement + settled); excludes canceled and reversed, in diff --git a/lib/whop_sdk/models/referrals/businesses/earning_list_params.rb b/lib/whop_sdk/models/partners/businesses/earning_list_params.rb similarity index 75% rename from lib/whop_sdk/models/referrals/businesses/earning_list_params.rb rename to lib/whop_sdk/models/partners/businesses/earning_list_params.rb index 12daab8e..3c8bba12 100644 --- a/lib/whop_sdk/models/referrals/businesses/earning_list_params.rb +++ b/lib/whop_sdk/models/partners/businesses/earning_list_params.rb @@ -2,9 +2,9 @@ module WhopSDK module Models - module Referrals + module Partners module Businesses - # @see WhopSDK::Resources::Referrals::Businesses::Earnings#list + # @see WhopSDK::Resources::Partners::Businesses::Earnings#list class EarningListParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters @@ -39,8 +39,8 @@ class EarningListParams < WhopSDK::Internal::Type::BaseModel # @!attribute direction # Sort direction. # - # @return [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Direction, nil] - optional :direction, enum: -> { WhopSDK::Referrals::Businesses::EarningListParams::Direction } + # @return [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Direction, nil] + optional :direction, enum: -> { WhopSDK::Partners::Businesses::EarningListParams::Direction } # @!attribute first # @@ -55,14 +55,14 @@ class EarningListParams < WhopSDK::Internal::Type::BaseModel # @!attribute order # The field to sort earnings by. # - # @return [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Order, nil] - optional :order, enum: -> { WhopSDK::Referrals::Businesses::EarningListParams::Order } + # @return [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Order, nil] + optional :order, enum: -> { WhopSDK::Partners::Businesses::EarningListParams::Order } # @!attribute status # Filter by earning status. # - # @return [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Status, nil] - optional :status, enum: -> { WhopSDK::Referrals::Businesses::EarningListParams::Status } + # @return [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Status, nil] + optional :status, enum: -> { WhopSDK::Partners::Businesses::EarningListParams::Status } # @!method initialize(id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, status: nil, request_options: {}) # @param id [String] @@ -75,15 +75,15 @@ class EarningListParams < WhopSDK::Internal::Type::BaseModel # # @param created_before [String] Only return earnings created before this timestamp. # - # @param direction [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Direction] Sort direction. + # @param direction [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Direction] Sort direction. # # @param first [Integer] # # @param last [Integer] # - # @param order [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Order] The field to sort earnings by. + # @param order [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Order] The field to sort earnings by. # - # @param status [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Status] Filter by earning status. + # @param status [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Status] Filter by earning status. # # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}] diff --git a/lib/whop_sdk/models/referrals/businesses/earning_list_response.rb b/lib/whop_sdk/models/partners/businesses/earning_list_response.rb similarity index 71% rename from lib/whop_sdk/models/referrals/businesses/earning_list_response.rb rename to lib/whop_sdk/models/partners/businesses/earning_list_response.rb index b0e2815e..29064d51 100644 --- a/lib/whop_sdk/models/referrals/businesses/earning_list_response.rb +++ b/lib/whop_sdk/models/partners/businesses/earning_list_response.rb @@ -2,9 +2,9 @@ module WhopSDK module Models - module Referrals + module Partners module Businesses - # @see WhopSDK::Resources::Referrals::Businesses::Earnings#list + # @see WhopSDK::Resources::Partners::Businesses::Earnings#list class EarningListResponse < WhopSDK::Internal::Type::BaseModel # @!attribute id # @@ -14,8 +14,8 @@ class EarningListResponse < WhopSDK::Internal::Type::BaseModel # @!attribute account # Referred account. # - # @return [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account, nil] - required :account, -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account }, nil?: true + # @return [WhopSDK::Models::Partners::Businesses::EarningListResponse::Account, nil] + required :account, -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::Account }, nil?: true # @!attribute cancelation_reason # Why the earning was canceled or reversed, if applicable. @@ -38,15 +38,15 @@ class EarningListResponse < WhopSDK::Internal::Type::BaseModel # Income and cost lines behind this earning's commission. Null for earnings # settled before this data was recorded. # - # @return [Array, nil] + # @return [Array, nil] required :financial_activity, - -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity] }, + -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity] }, nil?: true # @!attribute object # - # @return [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object] - required :object, enum: -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object } + # @return [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::Object] + required :object, enum: -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::Object } # @!attribute payout_at # @@ -62,15 +62,15 @@ class EarningListResponse < WhopSDK::Internal::Type::BaseModel # @!attribute product # - # @return [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product, nil] - required :product, -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product }, nil?: true + # @return [WhopSDK::Models::Partners::Businesses::EarningListResponse::Product, nil] + required :product, -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::Product }, nil?: true # @!attribute resource # The resource that generated the affiliate earning. # - # @return [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource, nil] + # @return [WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource, nil] required :resource, - -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource }, + -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource }, nil?: true # @!attribute second_tier @@ -82,8 +82,8 @@ class EarningListResponse < WhopSDK::Internal::Type::BaseModel # @!attribute status # Current status of the earning. # - # @return [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status] - required :status, enum: -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status } + # @return [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::Status] + required :status, enum: -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::Status } # @!attribute transaction_amount_usd # The sale amount the commission is calculated from, in USD. @@ -93,11 +93,11 @@ class EarningListResponse < WhopSDK::Internal::Type::BaseModel # @!method initialize(id:, account:, cancelation_reason:, commission_amount_usd:, created_at:, financial_activity:, object:, payout_at:, payout_percentage:, product:, resource:, second_tier:, status:, transaction_amount_usd:) # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::Businesses::EarningListResponse} for more details. + # {WhopSDK::Models::Partners::Businesses::EarningListResponse} for more details. # # @param id [String, nil] # - # @param account [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account, nil] Referred account. + # @param account [WhopSDK::Models::Partners::Businesses::EarningListResponse::Account, nil] Referred account. # # @param cancelation_reason [String, nil] Why the earning was canceled or reversed, if applicable. # @@ -105,25 +105,25 @@ class EarningListResponse < WhopSDK::Internal::Type::BaseModel # # @param created_at [Time] # - # @param financial_activity [Array, nil] Income and cost lines behind this earning's commission. Null for earnings settle + # @param financial_activity [Array, nil] Income and cost lines behind this earning's commission. Null for earnings settle # - # @param object [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object] + # @param object [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::Object] # # @param payout_at [Time, nil] # # @param payout_percentage [Float, nil] The referrer's share of Whop's gross profit, as a fraction (0.3 = 30%). Null unt # - # @param product [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product, nil] + # @param product [WhopSDK::Models::Partners::Businesses::EarningListResponse::Product, nil] # - # @param resource [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource, nil] The resource that generated the affiliate earning. + # @param resource [WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource, nil] The resource that generated the affiliate earning. # # @param second_tier [Boolean] Whether this earning is a second-tier (grandparent) commission. # - # @param status [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status] Current status of the earning. + # @param status [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::Status] Current status of the earning. # # @param transaction_amount_usd [String] The sale amount the commission is calculated from, in USD. - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse#account + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse#account class Account < WhopSDK::Internal::Type::BaseModel # @!attribute id # Referred account ID. @@ -194,9 +194,9 @@ class FinancialActivity < WhopSDK::Internal::Type::BaseModel # @!attribute type # Whether the line is income Whop collected or a cost Whop paid. # - # @return [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type] + # @return [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type] required :type, - enum: -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type } + enum: -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type } # @!method initialize(amount:, amount_usd:, category:, created_at:, currency:, type:) # @param amount [String] Line amount in its native currency. @@ -209,11 +209,11 @@ class FinancialActivity < WhopSDK::Internal::Type::BaseModel # # @param currency [String] Currency of the native amount. # - # @param type [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type] Whether the line is income Whop collected or a cost Whop paid. + # @param type [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type] Whether the line is income Whop collected or a cost Whop paid. # Whether the line is income Whop collected or a cost Whop paid. # - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity#type + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity#type module Type extend WhopSDK::Internal::Type::Enum @@ -225,17 +225,17 @@ module Type end end - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse#object + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse#object module Object extend WhopSDK::Internal::Type::Enum - BUSINESS_REFERRAL_EARNING = :business_referral_earning + PARTNER_BUSINESS_EARNING = :partner_business_earning # @!method self.values # @return [Array] end - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse#product + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse#product class Product < WhopSDK::Internal::Type::BaseModel # @!attribute id # @@ -258,7 +258,7 @@ class Product < WhopSDK::Internal::Type::BaseModel # @param title [String] end - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse#resource + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse#resource class Resource < WhopSDK::Internal::Type::BaseModel # @!attribute id # @@ -267,9 +267,9 @@ class Resource < WhopSDK::Internal::Type::BaseModel # @!attribute alternative_payment_method # - # @return [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod, nil] + # @return [WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod, nil] required :alternative_payment_method, - -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod }, + -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod }, nil?: true # @!attribute brand @@ -294,9 +294,9 @@ class Resource < WhopSDK::Internal::Type::BaseModel # @!attribute object # - # @return [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object] + # @return [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object] required :object, - enum: -> { WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object } + enum: -> { WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object } # @!attribute payment_method_type # @@ -312,16 +312,16 @@ class Resource < WhopSDK::Internal::Type::BaseModel # The resource that generated the affiliate earning. # # @param id [String] - # @param alternative_payment_method [WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod, nil] + # @param alternative_payment_method [WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod, nil] # @param brand [String, nil] # @param created_at [Time] # @param currency [String] # @param last4 [String, nil] - # @param object [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object] + # @param object [Symbol, WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object] # @param payment_method_type [String, nil] # @param processor [String, nil] - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource#alternative_payment_method + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource#alternative_payment_method class AlternativePaymentMethod < WhopSDK::Internal::Type::BaseModel # @!attribute image_url # @@ -338,7 +338,7 @@ class AlternativePaymentMethod < WhopSDK::Internal::Type::BaseModel # @param name [String] end - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource#object + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource#object module Object extend WhopSDK::Internal::Type::Enum @@ -351,7 +351,7 @@ module Object # Current status of the earning. # - # @see WhopSDK::Models::Referrals::Businesses::EarningListResponse#status + # @see WhopSDK::Models::Partners::Businesses::EarningListResponse#status module Status extend WhopSDK::Internal::Type::Enum diff --git a/lib/whop_sdk/models/payout_create_response.rb b/lib/whop_sdk/models/payout_create_response.rb index e61ea76a..1a0d42b5 100644 --- a/lib/whop_sdk/models/payout_create_response.rb +++ b/lib/whop_sdk/models/payout_create_response.rb @@ -173,6 +173,7 @@ module Status REQUESTED = :requested IN_TRANSIT = :in_transit + DENIED = :denied COMPLETED = :completed FAILED = :failed CANCELED = :canceled diff --git a/lib/whop_sdk/models/product.rb b/lib/whop_sdk/models/product.rb index a70e992b..f5322dd7 100644 --- a/lib/whop_sdk/models/product.rb +++ b/lib/whop_sdk/models/product.rb @@ -257,6 +257,12 @@ class GalleryImage < WhopSDK::Internal::Type::BaseModel # @return [String] required :id, String + # @!attribute content_type + # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + # + # @return [String, nil] + required :content_type, String, nil?: true + # @!attribute url # A pre-optimized URL for rendering this attachment on the client. This should be # used for displaying attachments in apps. @@ -264,7 +270,7 @@ class GalleryImage < WhopSDK::Internal::Type::BaseModel # @return [String, nil] required :url, String, nil?: true - # @!method initialize(id:, url:) + # @!method initialize(id:, content_type:, url:) # Some parameter documentations has been truncated, see # {WhopSDK::Models::Product::GalleryImage} for more details. # @@ -272,6 +278,8 @@ class GalleryImage < WhopSDK::Internal::Type::BaseModel # # @param id [String] Represents a unique identifier that is Base64 obfuscated. It is often used to re # + # @param content_type [String, nil] Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + # # @param url [String, nil] A pre-optimized URL for rendering this attachment on the client. This should be end diff --git a/lib/whop_sdk/models/product_list_item.rb b/lib/whop_sdk/models/product_list_item.rb index 6714645e..01d18679 100644 --- a/lib/whop_sdk/models/product_list_item.rb +++ b/lib/whop_sdk/models/product_list_item.rb @@ -22,6 +22,12 @@ class ProductListItem < WhopSDK::Internal::Type::BaseModel # @return [String, nil] required :external_identifier, String, nil?: true + # @!attribute gallery_images + # The gallery images for this product, ordered by position. + # + # @return [Array] + required :gallery_images, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::ProductListItem::GalleryImage] } + # @!attribute headline # A short marketing headline displayed prominently on the product's product page. # @@ -82,7 +88,7 @@ class ProductListItem < WhopSDK::Internal::Type::BaseModel # @return [Symbol, WhopSDK::Models::Visibility] required :visibility, enum: -> { WhopSDK::Visibility } - # @!method initialize(id:, created_at:, external_identifier:, headline:, member_count:, metadata:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:) + # @!method initialize(id:, created_at:, external_identifier:, gallery_images:, headline:, member_count:, metadata:, published_reviews_count:, route:, title:, updated_at:, verified:, visibility:) # Some parameter documentations has been truncated, see # {WhopSDK::Models::ProductListItem} for more details. # @@ -95,6 +101,8 @@ class ProductListItem < WhopSDK::Internal::Type::BaseModel # # @param external_identifier [String, nil] External identifier for the product. Providing it on a product creation endpoint # + # @param gallery_images [Array] The gallery images for this product, ordered by position. + # # @param headline [String, nil] A short marketing headline displayed prominently on the product's product page. # # @param member_count [Integer] Active memberships for this product. Returns `0` if the account has disabled pub @@ -112,6 +120,43 @@ class ProductListItem < WhopSDK::Internal::Type::BaseModel # @param verified [Boolean] Whether this company has been verified by Whop's trust and safety team. # # @param visibility [Symbol, WhopSDK::Models::Visibility] Controls whether the product is visible to customers. When set to 'hidden', the + + class GalleryImage < WhopSDK::Internal::Type::BaseModel + # @!attribute id + # Represents a unique identifier that is Base64 obfuscated. It is often used to + # refetch an object or as key for a cache. The ID type appears in a JSON response + # as a String; however, it is not intended to be human-readable. When expected as + # an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) + # input value will be accepted as an ID. + # + # @return [String] + required :id, String + + # @!attribute content_type + # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + # + # @return [String, nil] + required :content_type, String, nil?: true + + # @!attribute url + # A pre-optimized URL for rendering this attachment on the client. This should be + # used for displaying attachments in apps. + # + # @return [String, nil] + required :url, String, nil?: true + + # @!method initialize(id:, content_type:, url:) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::ProductListItem::GalleryImage} for more details. + # + # Represents an image attachment + # + # @param id [String] Represents a unique identifier that is Base64 obfuscated. It is often used to re + # + # @param content_type [String, nil] Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + # + # @param url [String, nil] A pre-optimized URL for rendering this attachment on the client. This should be + end end end end diff --git a/lib/whop_sdk/models/referrals/business_leaderboard_params.rb b/lib/whop_sdk/models/referrals/business_leaderboard_params.rb deleted file mode 100644 index 345d39d6..00000000 --- a/lib/whop_sdk/models/referrals/business_leaderboard_params.rb +++ /dev/null @@ -1,45 +0,0 @@ -# frozen_string_literal: true - -module WhopSDK - module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Businesses#leaderboard - class BusinessLeaderboardParams < WhopSDK::Internal::Type::BaseModel - extend WhopSDK::Internal::Type::RequestParameters::Converter - include WhopSDK::Internal::Type::RequestParameters - - # @!attribute period - # Time window for the rankings. `day`, `month`, and `year` count earnings since - # the start of the current calendar day, month, or year; `last_30_days` counts - # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. - # - # @return [Symbol, WhopSDK::Models::Referrals::BusinessLeaderboardParams::Period, nil] - optional :period, enum: -> { WhopSDK::Referrals::BusinessLeaderboardParams::Period } - - # @!method initialize(period: nil, request_options: {}) - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessLeaderboardParams} for more details. - # - # @param period [Symbol, WhopSDK::Models::Referrals::BusinessLeaderboardParams::Period] Time window for the rankings. `day`, `month`, and `year` count earnings since th - # - # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}] - - # Time window for the rankings. `day`, `month`, and `year` count earnings since - # the start of the current calendar day, month, or year; `last_30_days` counts - # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. - module Period - extend WhopSDK::Internal::Type::Enum - - DAY = :day - MONTH = :month - YEAR = :year - LAST_30_DAYS = :last_30_days - ALL_TIME = :all_time - - # @!method self.values - # @return [Array] - end - end - end - end -end diff --git a/lib/whop_sdk/models/referrals/business_leaderboard_response.rb b/lib/whop_sdk/models/referrals/business_leaderboard_response.rb deleted file mode 100644 index 5188221b..00000000 --- a/lib/whop_sdk/models/referrals/business_leaderboard_response.rb +++ /dev/null @@ -1,284 +0,0 @@ -# frozen_string_literal: true - -module WhopSDK - module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Businesses#leaderboard - class BusinessLeaderboardResponse < WhopSDK::Internal::Type::BaseModel - # @!attribute leaders - # The top referrers by total earnings, best first. - # - # @return [Array] - required :leaders, - -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader] } - - # @!attribute me - # The caller's own standing; null when the caller has no referral earnings. - # - # @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me, nil] - required :me, -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me }, nil?: true - - # @!method initialize(leaders:, me:) - # @param leaders [Array] The top referrers by total earnings, best first. - # - # @param me [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me, nil] The caller's own standing; null when the caller has no referral earnings. - - class Leader < WhopSDK::Internal::Type::BaseModel - # @!attribute first_referral_started_at - # When the referrer's earliest business referral became active. - # - # @return [Time] - required :first_referral_started_at, Time - - # @!attribute rank - # 1-based leaderboard position. - # - # @return [Integer] - required :rank, Integer - - # @!attribute total_earnings_usd - # The referrer's pending + completed earnings across all referred businesses, in - # USD. - # - # @return [String] - required :total_earnings_usd, String - - # @!attribute total_volume_usd - # Credited GMV across all the referrer's referred businesses, in USD. - # - # @return [String] - required :total_volume_usd, String - - # @!attribute user - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - # - # @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User, nil] - required :user, -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User }, nil?: true - - # @!method initialize(first_referral_started_at:, rank:, total_earnings_usd:, total_volume_usd:, user:) - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader} for more - # details. - # - # @param first_referral_started_at [Time] When the referrer's earliest business referral became active. - # - # @param rank [Integer] 1-based leaderboard position. - # - # @param total_earnings_usd [String] The referrer's pending + completed earnings across all referred businesses, in U - # - # @param total_volume_usd [String] Credited GMV across all the referrer's referred businesses, in USD. - # - # @param user [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User, nil] The ranked referrer. Identity fields (id, name, username, profile_picture) are r - - # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader#user - class User < WhopSDK::Internal::Type::BaseModel - # @!attribute city - # The city where the referrer is located, derived from their IP address. Null if - # location sharing is disabled. - # - # @return [String, nil] - required :city, String, nil?: true - - # @!attribute country - # The country where the referrer is located, derived from their IP address. Null - # if location sharing is disabled. - # - # @return [String, nil] - required :country, String, nil?: true - - # @!attribute id - # User ID, prefixed `user_`. Present only on the caller's own entry. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # The user's display name. Present only on the caller's own entry. - # - # @return [String, nil] - optional :name, String, nil?: true - - # @!attribute profile_picture - # The user's profile picture. Present only on the caller's own entry. - # - # @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, nil] - optional :profile_picture, - -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture } - - # @!attribute username - # The user's unique username. Present only on the caller's own entry. - # - # @return [String, nil] - optional :username, String - - # @!method initialize(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil) - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User} for more - # details. - # - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - # - # @param city [String, nil] The city where the referrer is located, derived from their IP address. Null if l - # - # @param country [String, nil] The country where the referrer is located, derived from their IP address. Null i - # - # @param id [String] User ID, prefixed `user_`. Present only on the caller's own entry. - # - # @param name [String, nil] The user's display name. Present only on the caller's own entry. - # - # @param profile_picture [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture] The user's profile picture. Present only on the caller's own entry. - # - # @param username [String] The user's unique username. Present only on the caller's own entry. - - # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User#profile_picture - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - # @!attribute url - # The user's profile picture URL. - # - # @return [String] - required :url, String - - # @!method initialize(url:) - # The user's profile picture. Present only on the caller's own entry. - # - # @param url [String] The user's profile picture URL. - end - end - end - - # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse#me - class Me < WhopSDK::Internal::Type::BaseModel - # @!attribute first_referral_started_at - # When the referrer's earliest business referral became active. - # - # @return [Time] - required :first_referral_started_at, Time - - # @!attribute rank - # 1-based leaderboard position. - # - # @return [Integer] - required :rank, Integer - - # @!attribute total_earnings_usd - # The referrer's pending + completed earnings across all referred businesses, in - # USD. - # - # @return [String] - required :total_earnings_usd, String - - # @!attribute total_volume_usd - # Credited GMV across all the referrer's referred businesses, in USD. - # - # @return [String] - required :total_volume_usd, String - - # @!attribute user - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - # - # @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User, nil] - required :user, -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User }, nil?: true - - # @!method initialize(first_referral_started_at:, rank:, total_earnings_usd:, total_volume_usd:, user:) - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me} for more details. - # - # The caller's own standing; null when the caller has no referral earnings. - # - # @param first_referral_started_at [Time] When the referrer's earliest business referral became active. - # - # @param rank [Integer] 1-based leaderboard position. - # - # @param total_earnings_usd [String] The referrer's pending + completed earnings across all referred businesses, in U - # - # @param total_volume_usd [String] Credited GMV across all the referrer's referred businesses, in USD. - # - # @param user [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User, nil] The ranked referrer. Identity fields (id, name, username, profile_picture) are r - - # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me#user - class User < WhopSDK::Internal::Type::BaseModel - # @!attribute city - # The city where the referrer is located, derived from their IP address. Null if - # location sharing is disabled. - # - # @return [String, nil] - required :city, String, nil?: true - - # @!attribute country - # The country where the referrer is located, derived from their IP address. Null - # if location sharing is disabled. - # - # @return [String, nil] - required :country, String, nil?: true - - # @!attribute id - # User ID, prefixed `user_`. Present only on the caller's own entry. - # - # @return [String, nil] - optional :id, String - - # @!attribute name - # The user's display name. Present only on the caller's own entry. - # - # @return [String, nil] - optional :name, String, nil?: true - - # @!attribute profile_picture - # The user's profile picture. Present only on the caller's own entry. - # - # @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture, nil] - optional :profile_picture, - -> { WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture } - - # @!attribute username - # The user's unique username. Present only on the caller's own entry. - # - # @return [String, nil] - optional :username, String - - # @!method initialize(city:, country:, id: nil, name: nil, profile_picture: nil, username: nil) - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User} for more - # details. - # - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - # - # @param city [String, nil] The city where the referrer is located, derived from their IP address. Null if l - # - # @param country [String, nil] The country where the referrer is located, derived from their IP address. Null i - # - # @param id [String] User ID, prefixed `user_`. Present only on the caller's own entry. - # - # @param name [String, nil] The user's display name. Present only on the caller's own entry. - # - # @param profile_picture [WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture] The user's profile picture. Present only on the caller's own entry. - # - # @param username [String] The user's unique username. Present only on the caller's own entry. - - # @see WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User#profile_picture - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - # @!attribute url - # The user's profile picture URL. - # - # @return [String] - required :url, String - - # @!method initialize(url:) - # The user's profile picture. Present only on the caller's own entry. - # - # @param url [String] The user's profile picture URL. - end - end - end - end - end - end -end diff --git a/lib/whop_sdk/models/referrals/partner_create_params.rb b/lib/whop_sdk/models/referrals/partner_create_params.rb deleted file mode 100644 index aec5e568..00000000 --- a/lib/whop_sdk/models/referrals/partner_create_params.rb +++ /dev/null @@ -1,16 +0,0 @@ -# frozen_string_literal: true - -module WhopSDK - module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Partners#create - class PartnerCreateParams < 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 -end diff --git a/lib/whop_sdk/models/referrals/partner_create_response.rb b/lib/whop_sdk/models/referrals/partner_create_response.rb deleted file mode 100644 index 40b5064c..00000000 --- a/lib/whop_sdk/models/referrals/partner_create_response.rb +++ /dev/null @@ -1,31 +0,0 @@ -# frozen_string_literal: true - -module WhopSDK - module Models - module Referrals - # @see WhopSDK::Resources::Referrals::Partners#create - class PartnerCreateResponse < WhopSDK::Internal::Type::BaseModel - # @!attribute referral_link - # The caller's referral link — businesses that sign up through it are attributed - # to the caller. - # - # @return [String] - required :referral_link, String - - # @!attribute whop_partner_enabled_at - # When the caller became a Whop partner. - # - # @return [Time] - required :whop_partner_enabled_at, Time - - # @!method initialize(referral_link:, whop_partner_enabled_at:) - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::PartnerCreateResponse} for more details. - # - # @param referral_link [String] The caller's referral link — businesses that sign up through it are attributed t - # - # @param whop_partner_enabled_at [Time] When the caller became a Whop partner. - end - end - end -end diff --git a/lib/whop_sdk/models/social_account.rb b/lib/whop_sdk/models/social_account.rb index 05235b9c..9d1f51d5 100644 --- a/lib/whop_sdk/models/social_account.rb +++ b/lib/whop_sdk/models/social_account.rb @@ -10,6 +10,13 @@ class SocialAccount < WhopSDK::Internal::Type::BaseModel # @return [String] required :id, String + # @!attribute error + # Why this social account currently can't be used for advertising — a failed share + # or a Meta-side restriction. Null when the account is healthy. + # + # @return [String, nil] + required :error, String, nil?: true + # @!attribute external_id # The platform-specific ID for this social account. # @@ -59,12 +66,14 @@ class SocialAccount < WhopSDK::Internal::Type::BaseModel # @return [Boolean] required :verified, WhopSDK::Internal::Type::Boolean - # @!method initialize(id:, external_id:, name:, platform:, profile_picture_url:, scopes:, url:, username:, verified:) + # @!method initialize(id:, error:, external_id:, name:, platform:, profile_picture_url:, scopes:, url:, username:, verified:) # Some parameter documentations has been truncated, see # {WhopSDK::Models::SocialAccount} for more details. # # @param id [String] Unique identifier for the social account. # + # @param error [String, nil] Why this social account currently can't be used for advertising — a failed share + # # @param external_id [String, nil] The platform-specific ID for this social account. # # @param name [String, nil] The display name of the social account on the platform. diff --git a/lib/whop_sdk/models/user_recommend_actions_params.rb b/lib/whop_sdk/models/user_recommend_actions_params.rb new file mode 100644 index 00000000..078ef69a --- /dev/null +++ b/lib/whop_sdk/models/user_recommend_actions_params.rb @@ -0,0 +1,20 @@ +# frozen_string_literal: true + +module WhopSDK + module Models + # @see WhopSDK::Resources::Users#recommend_actions + class UserRecommendActionsParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + # @!attribute id + # + # @return [String] + required :id, String + + # @!method initialize(id:, request_options: {}) + # @param id [String] + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}] + end + end +end diff --git a/lib/whop_sdk/models/user_recommend_actions_response.rb b/lib/whop_sdk/models/user_recommend_actions_response.rb new file mode 100644 index 00000000..d2d7c31e --- /dev/null +++ b/lib/whop_sdk/models/user_recommend_actions_response.rb @@ -0,0 +1,161 @@ +# frozen_string_literal: true + +module WhopSDK + module Models + # @see WhopSDK::Resources::Users#recommend_actions + class UserRecommendActionsResponse < WhopSDK::Internal::Type::BaseModel + # @!attribute data + # + # @return [Array] + required :data, + -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::UserRecommendActionsResponse::Data] } + + # @!method initialize(data:) + # @param data [Array] + + class Data < WhopSDK::Internal::Type::BaseModel + # @!attribute account_id + # The account (`biz_`) a business recommendation is for, or `null` for personal + # recommendations + # + # @return [String, nil] + required :account_id, String, nil?: true + + # @!attribute account_name + # The account's display name, or `null` + # + # @return [String, nil] + required :account_name, String, nil?: true + + # @!attribute action + # The recommendation; new values may be added, so handle unknown actions + # gracefully + # + # @return [Symbol, WhopSDK::Models::UserRecommendActionsResponse::Data::Action] + required :action, enum: -> { WhopSDK::Models::UserRecommendActionsResponse::Data::Action } + + # @!attribute blocked_capabilities + # + # @return [Array] + required :blocked_capabilities, WhopSDK::Internal::Type::ArrayOf[String] + + # @!attribute cta + # The URL the call-to-action links to + # + # @return [String] + required :cta, String + + # @!attribute cta_label + # Button label + # + # @return [String] + required :cta_label, String + + # @!attribute description + # Supporting copy, or empty + # + # @return [String] + required :description, String + + # @!attribute icon_url + # Illustration icon URL, or `null` + # + # @return [String, nil] + required :icon_url, String, nil?: true + + # @!attribute impact_score + # Estimated impact from 0-100, or `null` when not ranked + # + # @return [Integer, nil] + required :impact_score, Integer, nil?: true + + # @!attribute reasoning + # Why this action was recommended, or `null` + # + # @return [String, nil] + required :reasoning, String, nil?: true + + # @!attribute status + # Always optional — never blocking + # + # @return [Symbol, WhopSDK::Models::UserRecommendActionsResponse::Data::Status] + required :status, enum: -> { WhopSDK::Models::UserRecommendActionsResponse::Data::Status } + + # @!attribute title + # Headline for the recommendation + # + # @return [String] + required :title, String + + # @!method initialize(account_id:, account_name:, action:, blocked_capabilities:, cta:, cta_label:, description:, icon_url:, impact_score:, reasoning:, status:, title:) + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::UserRecommendActionsResponse::Data} for more details. + # + # @param account_id [String, nil] The account (`biz_`) a business recommendation is for, or `null` for personal re + # + # @param account_name [String, nil] The account's display name, or `null` + # + # @param action [Symbol, WhopSDK::Models::UserRecommendActionsResponse::Data::Action] The recommendation; new values may be added, so handle unknown actions gracefull + # + # @param blocked_capabilities [Array] + # + # @param cta [String] The URL the call-to-action links to + # + # @param cta_label [String] Button label + # + # @param description [String] Supporting copy, or empty + # + # @param icon_url [String, nil] Illustration icon URL, or `null` + # + # @param impact_score [Integer, nil] Estimated impact from 0-100, or `null` when not ranked + # + # @param reasoning [String, nil] Why this action was recommended, or `null` + # + # @param status [Symbol, WhopSDK::Models::UserRecommendActionsResponse::Data::Status] Always optional — never blocking + # + # @param title [String] Headline for the recommendation + + # The recommendation; new values may be added, so handle unknown actions + # gracefully + # + # @see WhopSDK::Models::UserRecommendActionsResponse::Data#action + module Action + extend WhopSDK::Internal::Type::Enum + + CREATE_BUSINESS = :create_business + BECOME_AFFILIATE = :become_affiliate + THEME_BUSINESS = :theme_business + CREATE_PRODUCT = :create_product + CREATE_PLAN = :create_plan + VERIFY_IDENTITY = :verify_identity + CONNECT_AFFILIATE_PROGRAM = :connect_affiliate_program + CREATE_PROMOTION = :create_promotion + SETUP_TRACKING_PIXEL = :setup_tracking_pixel + MIGRATE_FROM_STRIPE = :migrate_from_stripe + ACCEPT_FIRST_PAYMENT = :accept_first_payment + LAUNCH_FIRST_AD = :launch_first_ad + INVITE_TEAM_MEMBER = :invite_team_member + ENABLE_TAX_COLLECTION = :enable_tax_collection + CREATE_CARD = :create_card + JOIN_WHOP_UNIVERSITY = :join_whop_university + APPLY_FOR_FINANCING = :apply_for_financing + + # @!method self.values + # @return [Array] + end + + # Always optional — never blocking + # + # @see WhopSDK::Models::UserRecommendActionsResponse::Data#status + module Status + extend WhopSDK::Internal::Type::Enum + + OPTIONAL = :optional + + # @!method self.values + # @return [Array] + end + end + end + end +end diff --git a/lib/whop_sdk/models/verification_create_params.rb b/lib/whop_sdk/models/verification_create_params.rb index c33b5985..b7f496c5 100644 --- a/lib/whop_sdk/models/verification_create_params.rb +++ b/lib/whop_sdk/models/verification_create_params.rb @@ -78,6 +78,14 @@ class Individual < WhopSDK::Internal::Type::BaseModel # @return [String, nil] optional :business_structure, String + # @!attribute business_tax_identification_number + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + # + # @return [String, nil] + optional :business_tax_identification_number, String + # @!attribute business_website # Business website URL. Whop store pages are not accepted. # @@ -142,12 +150,15 @@ class Individual < WhopSDK::Internal::Type::BaseModel optional :phone, String # @!attribute tax_identification_number - # SSN or ITIN. Tokenized in transit and never stored raw. + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. # # @return [String, nil] optional :tax_identification_number, String - # @!method initialize(address: nil, business_name: nil, business_structure: nil, business_website: nil, country: nil, date_of_birth: nil, document_type: nil, documents: nil, first_name: nil, kind: nil, last_name: nil, phone: nil, tax_identification_number: nil) + # @!method initialize(address: nil, business_name: nil, business_structure: nil, business_tax_identification_number: nil, business_website: nil, country: nil, date_of_birth: nil, document_type: nil, documents: nil, first_name: nil, kind: nil, last_name: nil, phone: nil, tax_identification_number: nil) # Some parameter documentations has been truncated, see # {WhopSDK::Models::VerificationCreateParams::Body::Individual} for more details. # @@ -166,6 +177,8 @@ class Individual < WhopSDK::Internal::Type::BaseModel # # @param business_structure [String] Entity type for sole proprietors, such as `single_member_llc`. Supported values # + # @param business_tax_identification_number [String] The business ID number of the company, as appropriate for the company's country. + # # @param business_website [String] Business website URL. Whop store pages are not accepted. # # @param country [String] Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. @@ -184,7 +197,7 @@ class Individual < WhopSDK::Internal::Type::BaseModel # # @param phone [String] # - # @param tax_identification_number [String] SSN or ITIN. Tokenized in transit and never stored raw. + # @param tax_identification_number [String] The government-issued ID number of the person being verified — the individual fo # @see WhopSDK::Models::VerificationCreateParams::Body::Individual#address class Address < WhopSDK::Internal::Type::BaseModel @@ -288,6 +301,14 @@ class Business < WhopSDK::Internal::Type::BaseModel # @return [String, nil] optional :business_structure, String + # @!attribute business_tax_identification_number + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + # + # @return [String, nil] + optional :business_tax_identification_number, String + # @!attribute business_website # Business website URL. Whop store pages are not accepted. # @@ -313,12 +334,15 @@ class Business < WhopSDK::Internal::Type::BaseModel optional :place_of_incorporation, String # @!attribute tax_identification_number - # EIN. Tokenized in transit and never stored raw. + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. # # @return [String, nil] optional :tax_identification_number, String - # @!method initialize(address: nil, business_name: nil, business_structure: nil, business_website: nil, country: nil, kind: nil, place_of_incorporation: nil, tax_identification_number: nil) + # @!method initialize(address: nil, business_name: nil, business_structure: nil, business_tax_identification_number: nil, business_website: nil, country: nil, kind: nil, place_of_incorporation: nil, tax_identification_number: nil) # Some parameter documentations has been truncated, see # {WhopSDK::Models::VerificationCreateParams::Body::Business} for more details. # @@ -332,6 +356,8 @@ class Business < WhopSDK::Internal::Type::BaseModel # # @param business_structure [String] Legal entity structure of the business, such as `private_corporation` or `sole_p # + # @param business_tax_identification_number [String] The business ID number of the company, as appropriate for the company's country. + # # @param business_website [String] Business website URL. Whop store pages are not accepted. # # @param country [String] Country of incorporation as a two-letter ISO 3166-1 country code. @@ -340,7 +366,7 @@ class Business < WhopSDK::Internal::Type::BaseModel # # @param place_of_incorporation [String] State or region where the business is incorporated. # - # @param tax_identification_number [String] EIN. Tokenized in transit and never stored raw. + # @param tax_identification_number [String] The government-issued ID number of the person being verified — the individual fo # @see WhopSDK::Models::VerificationCreateParams::Body::Business#address class Address < WhopSDK::Internal::Type::BaseModel diff --git a/lib/whop_sdk/models/verification_create_response.rb b/lib/whop_sdk/models/verification_create_response.rb index abbd0a03..d39e58a9 100644 --- a/lib/whop_sdk/models/verification_create_response.rb +++ b/lib/whop_sdk/models/verification_create_response.rb @@ -90,10 +90,11 @@ class VerificationCreateResponse < WhopSDK::Internal::Type::BaseModel # @!attribute status # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @return [Symbol, WhopSDK::Models::VerificationCreateResponse::Status, nil] optional :status, enum: -> { WhopSDK::Models::VerificationCreateResponse::Status } @@ -377,10 +378,11 @@ module Status end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @see WhopSDK::Models::VerificationCreateResponse#status module Status @@ -388,6 +390,7 @@ module Status NOT_STARTED = :not_started PENDING = :pending + PROCESSING = :processing APPROVED = :approved REJECTED = :rejected ACTION_REQUIRED = :action_required diff --git a/lib/whop_sdk/models/verification_list_response.rb b/lib/whop_sdk/models/verification_list_response.rb index 8e51a4cf..fb1c959a 100644 --- a/lib/whop_sdk/models/verification_list_response.rb +++ b/lib/whop_sdk/models/verification_list_response.rb @@ -99,10 +99,11 @@ class Data < WhopSDK::Internal::Type::BaseModel # @!attribute status # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @return [Symbol, WhopSDK::Models::VerificationListResponse::Data::Status, nil] optional :status, enum: -> { WhopSDK::Models::VerificationListResponse::Data::Status } @@ -386,10 +387,11 @@ module Status end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @see WhopSDK::Models::VerificationListResponse::Data#status module Status @@ -397,6 +399,7 @@ module Status NOT_STARTED = :not_started PENDING = :pending + PROCESSING = :processing APPROVED = :approved REJECTED = :rejected ACTION_REQUIRED = :action_required diff --git a/lib/whop_sdk/models/verification_retrieve_response.rb b/lib/whop_sdk/models/verification_retrieve_response.rb index e627df4b..c043b604 100644 --- a/lib/whop_sdk/models/verification_retrieve_response.rb +++ b/lib/whop_sdk/models/verification_retrieve_response.rb @@ -90,10 +90,11 @@ class VerificationRetrieveResponse < WhopSDK::Internal::Type::BaseModel # @!attribute status # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @return [Symbol, WhopSDK::Models::VerificationRetrieveResponse::Status, nil] optional :status, enum: -> { WhopSDK::Models::VerificationRetrieveResponse::Status } @@ -377,10 +378,11 @@ module Status end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @see WhopSDK::Models::VerificationRetrieveResponse#status module Status @@ -388,6 +390,7 @@ module Status NOT_STARTED = :not_started PENDING = :pending + PROCESSING = :processing APPROVED = :approved REJECTED = :rejected ACTION_REQUIRED = :action_required diff --git a/lib/whop_sdk/models/verification_update_params.rb b/lib/whop_sdk/models/verification_update_params.rb index ed165859..d0fc7c6f 100644 --- a/lib/whop_sdk/models/verification_update_params.rb +++ b/lib/whop_sdk/models/verification_update_params.rb @@ -41,6 +41,14 @@ module Body variant -> { WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification } class UpdateIndividualVerification < WhopSDK::Internal::Type::BaseModel + # @!attribute business_tax_identification_number + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + # + # @return [String, nil] + optional :business_tax_identification_number, String + # @!attribute country # Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. # @@ -80,7 +88,16 @@ class UpdateIndividualVerification < WhopSDK::Internal::Type::BaseModel optional :requested_information, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation] } - # @!method initialize(country: nil, date_of_birth: nil, first_name: nil, last_name: nil, personal_address: nil, requested_information: nil) + # @!attribute tax_identification_number + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. + # + # @return [String, nil] + optional :tax_identification_number, String + + # @!method initialize(business_tax_identification_number: nil, country: nil, date_of_birth: nil, first_name: nil, last_name: nil, personal_address: nil, requested_information: nil, tax_identification_number: nil) # Some parameter documentations has been truncated, see # {WhopSDK::Models::VerificationUpdateParams::Body::UpdateIndividualVerification} # for more details. @@ -88,6 +105,8 @@ class UpdateIndividualVerification < WhopSDK::Internal::Type::BaseModel # Fields that can be updated on an individual (KYC) verification. At least one # field is required. # + # @param business_tax_identification_number [String] The business ID number of the company, as appropriate for the company's country. + # # @param country [String] Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. # # @param date_of_birth [String] Formatted as `YYYY-MM-DD`. @@ -99,6 +118,8 @@ class UpdateIndividualVerification < WhopSDK::Internal::Type::BaseModel # @param personal_address [WhopSDK::Models::VerificationUpdateParams::Body::UpdateIndividualVerification::PersonalAddress] Personal address for the individual. # # @param requested_information [Array] Answers to items returned in `requested_information`. Each entry must include th + # + # @param tax_identification_number [String] The government-issued ID number of the person being verified — the individual fo # @see WhopSDK::Models::VerificationUpdateParams::Body::UpdateIndividualVerification#personal_address class PersonalAddress < WhopSDK::Internal::Type::BaseModel @@ -329,6 +350,14 @@ class UpdateBusinessVerification < WhopSDK::Internal::Type::BaseModel # @return [String, nil] optional :business_structure, String + # @!attribute business_tax_identification_number + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + # + # @return [String, nil] + optional :business_tax_identification_number, String + # @!attribute country # Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. # @@ -345,7 +374,16 @@ class UpdateBusinessVerification < WhopSDK::Internal::Type::BaseModel optional :requested_information, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation] } - # @!method initialize(business_address: nil, business_name: nil, business_structure: nil, country: nil, requested_information: nil) + # @!attribute tax_identification_number + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. + # + # @return [String, nil] + optional :tax_identification_number, String + + # @!method initialize(business_address: nil, business_name: nil, business_structure: nil, business_tax_identification_number: nil, country: nil, requested_information: nil, tax_identification_number: nil) # Some parameter documentations has been truncated, see # {WhopSDK::Models::VerificationUpdateParams::Body::UpdateBusinessVerification} # for more details. @@ -359,9 +397,13 @@ class UpdateBusinessVerification < WhopSDK::Internal::Type::BaseModel # # @param business_structure [String] Legal entity structure of the business, such as `private_corporation` or `sole_p # + # @param business_tax_identification_number [String] The business ID number of the company, as appropriate for the company's country. + # # @param country [String] Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. # # @param requested_information [Array] Answers to items returned in `requested_information`. Each entry must include th + # + # @param tax_identification_number [String] The government-issued ID number of the person being verified — the individual fo # @see WhopSDK::Models::VerificationUpdateParams::Body::UpdateBusinessVerification#business_address class BusinessAddress < WhopSDK::Internal::Type::BaseModel diff --git a/lib/whop_sdk/models/verification_update_response.rb b/lib/whop_sdk/models/verification_update_response.rb index e9a65c1d..9920b366 100644 --- a/lib/whop_sdk/models/verification_update_response.rb +++ b/lib/whop_sdk/models/verification_update_response.rb @@ -90,10 +90,11 @@ class VerificationUpdateResponse < WhopSDK::Internal::Type::BaseModel # @!attribute status # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @return [Symbol, WhopSDK::Models::VerificationUpdateResponse::Status, nil] optional :status, enum: -> { WhopSDK::Models::VerificationUpdateResponse::Status } @@ -377,10 +378,11 @@ module Status end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. # # @see WhopSDK::Models::VerificationUpdateResponse#status module Status @@ -388,6 +390,7 @@ module Status NOT_STARTED = :not_started PENDING = :pending + PROCESSING = :processing APPROVED = :approved REJECTED = :rejected ACTION_REQUIRED = :action_required diff --git a/lib/whop_sdk/resources/accounts/preferences.rb b/lib/whop_sdk/resources/accounts/preferences.rb index e037cbc6..5df258ea 100644 --- a/lib/whop_sdk/resources/accounts/preferences.rb +++ b/lib/whop_sdk/resources/accounts/preferences.rb @@ -40,9 +40,9 @@ def retrieve(account_id, params = {}) # always requires a `primary` entry. `backup` is optional when the primary is # `platform_balance` — omitting it removes any configured card — while a `card` # primary requires a `platform_balance` backup. A `platform_balance` entry may - # omit `id` to use the account's default Whop balance. Changing which funding - # sources are configured requires a user token, while account API keys may only - # swap `primary` and `backup`. + # omit `id` to use the account's default Whop balance. Configuring a `card` + # requires a user token; account API keys can set up platform-balance billing, + # remove a configured card, and swap `primary` and `backup`. # # @overload update(account_id, ads_payment_methods: nil, request_options: {}) # diff --git a/lib/whop_sdk/resources/ad_groups.rb b/lib/whop_sdk/resources/ad_groups.rb index 3b969a9a..87faac94 100644 --- a/lib/whop_sdk/resources/ad_groups.rb +++ b/lib/whop_sdk/resources/ad_groups.rb @@ -16,7 +16,7 @@ class AdGroups # # Creates an ad group (ad set) in a campaign. # - # @overload create(ad_campaign_id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, dynamic_creative: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) + # @overload create(ad_campaign_id:, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, detailed_targeting: nil, devices: nil, dynamic_creative: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) # # @param ad_campaign_id [String] The ad campaign to create the ad group in. # @@ -36,6 +36,8 @@ class AdGroups # # @param desired_cost_per_result [Float] Target/cap cost for average_target / maximum_target. # + # @param detailed_targeting [Object] Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], demograp + # # @param devices [Object] Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. # # @param dynamic_creative [Boolean] Run Meta dynamic (Advantage+) creative for this ad set. Set at creation; immutab @@ -54,7 +56,7 @@ class AdGroups # # @param placements [Object] 'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to # - # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/pr + # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups (in # # @param starts_at [String] Schedule start, ISO 8601. # @@ -112,7 +114,7 @@ def retrieve(id, params = {}) # # Updates an ad group's editable fields. Only the keys you send are changed. # - # @overload update(id, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, devices: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) + # @overload update(id, audiences: nil, bid_type: nil, budget_amount: nil, budget_type: nil, conversion_event: nil, conversion_location: nil, demographics: nil, desired_cost_per_result: nil, detailed_targeting: nil, devices: nil, ends_at: nil, frequency_cap: nil, languages: nil, message_apps: nil, minimum_daily_spend: nil, optimization_goal: nil, placements: nil, regions: nil, starts_at: nil, status: nil, title: nil, request_options: {}) # # @param id [String] The ad group ID. # @@ -132,6 +134,8 @@ def retrieve(id, params = {}) # # @param desired_cost_per_result [Float] Target/cap cost for average_target / maximum_target. # + # @param detailed_targeting [Object] Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], demograp + # # @param devices [Object] Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. # # @param ends_at [String] Schedule end, ISO 8601. @@ -148,7 +152,7 @@ def retrieve(id, params = {}) # # @param placements [Object] 'automatic' (Advantage+) or a list of { platform, positions }. Omit positions to # - # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), regions (states/pr + # @param regions [Object] Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups (in # # @param starts_at [String] Schedule start, ISO 8601. # diff --git a/lib/whop_sdk/resources/events.rb b/lib/whop_sdk/resources/events.rb index 160171a7..00e252b4 100644 --- a/lib/whop_sdk/resources/events.rb +++ b/lib/whop_sdk/resources/events.rb @@ -19,7 +19,7 @@ class Events # # @param account_id [String] The account to associate with this event. # - # @param event_name [Symbol, WhopSDK::Models::EventCreateParams::EventName] The type of conversion or engagement event + # @param event_name [String] The type of event. # # @param action_source [Symbol, WhopSDK::Models::EventCreateParams::ActionSource, nil] The channel where an event originated # diff --git a/lib/whop_sdk/resources/partners.rb b/lib/whop_sdk/resources/partners.rb new file mode 100644 index 00000000..ef62a11e --- /dev/null +++ b/lib/whop_sdk/resources/partners.rb @@ -0,0 +1,115 @@ +# frozen_string_literal: true + +module WhopSDK + module Resources + # The Partners API covers your Whop partner activity: the users you referred onto + # Whop, the businesses you referred and the earnings generated from their + # processing volume, and the partner leaderboard. + # + # Use it to enroll as a Whop partner, list the users you referred, list your + # referred businesses and review their earnings, and see the partner leaderboard. + class Partners + # The Partners API covers your Whop partner activity: the users you referred onto + # Whop, the businesses you referred and the earnings generated from their + # processing volume, and the partner leaderboard. + # + # Use it to enroll as a Whop partner, list the users you referred, list your + # referred businesses and review their earnings, and see the partner leaderboard. + # @return [WhopSDK::Resources::Partners::Businesses] + attr_reader :businesses + + # Enrolls the calling user in the Whop partner program, making their partner + # businesses eligible for earnings. Idempotent — enrolling again keeps the + # original enrollment time. + # + # @overload create(request_options: {}) + # + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [WhopSDK::Models::PartnerCreateResponse] + # + # @see WhopSDK::Models::PartnerCreateParams + def create(params = {}) + @client.request( + method: :post, + path: "partners", + model: WhopSDK::Models::PartnerCreateResponse, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerLeaderboardParams} for more details. + # + # Ranks referrers by partner business earnings — all-time by default, or over the + # current day, month, year, or trailing 30 days — and includes the caller's own + # standing. + # + # @overload leaderboard(period: nil, request_options: {}) + # + # @param period [Symbol, WhopSDK::Models::PartnerLeaderboardParams::Period] Time window for the rankings. `day`, `month`, and `year` count earnings since th + # + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [WhopSDK::Models::PartnerLeaderboardResponse] + # + # @see WhopSDK::Models::PartnerLeaderboardParams + def leaderboard(params = {}) + parsed, options = WhopSDK::PartnerLeaderboardParams.dump_request(params) + query = WhopSDK::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "partners/leaderboard", + query: query, + model: WhopSDK::Models::PartnerLeaderboardResponse, + options: options + ) + end + + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::PartnerReferredUsersParams} for more details. + # + # Lists the users the caller referred onto Whop (newest first), each with the + # second-tier earnings the caller has made from that user's businesses. + # + # @overload referred_users(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {}) + # + # @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 first [Integer] Number of referred users to return from the start of the window. + # + # @param has_businesses [Boolean] When true, only referred users who brought at least one business onto Whop. + # + # @param has_earning_businesses [Boolean] When true, only referred users with at least one business that has generated ear + # + # @param last [Integer] Number of referred users to return from the end of the window. + # + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [WhopSDK::Models::PartnerReferredUsersResponse] + # + # @see WhopSDK::Models::PartnerReferredUsersParams + def referred_users(params = {}) + parsed, options = WhopSDK::PartnerReferredUsersParams.dump_request(params) + query = WhopSDK::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "partners/referred_users", + query: query, + model: WhopSDK::Models::PartnerReferredUsersResponse, + options: options + ) + end + + # @api private + # + # @param client [WhopSDK::Client] + def initialize(client:) + @client = client + @businesses = WhopSDK::Resources::Partners::Businesses.new(client: client) + end + end + end +end diff --git a/lib/whop_sdk/resources/partners/businesses.rb b/lib/whop_sdk/resources/partners/businesses.rb new file mode 100644 index 00000000..b65d91da --- /dev/null +++ b/lib/whop_sdk/resources/partners/businesses.rb @@ -0,0 +1,104 @@ +# frozen_string_literal: true + +module WhopSDK + module Resources + class Partners + # The Partners API covers your Whop partner activity: the users you referred onto + # Whop, the businesses you referred and the earnings generated from their + # processing volume, and the partner leaderboard. + # + # Use it to enroll as a Whop partner, list the users you referred, list your + # referred businesses and review their earnings, and see the partner leaderboard. + class Businesses + # The Partners API covers your Whop partner activity: the users you referred onto + # Whop, the businesses you referred and the earnings generated from their + # processing volume, and the partner leaderboard. + # + # Use it to enroll as a Whop partner, list the users you referred, list your + # referred businesses and review their earnings, and see the partner leaderboard. + # @return [WhopSDK::Resources::Partners::Businesses::Earnings] + attr_reader :earnings + + # Retrieves a single referred business and its referral terms. + # + # @overload retrieve(id, request_options: {}) + # + # @param id [String] The partner business ID (a coma\_ identifier). + # + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [WhopSDK::Models::Partners::BusinessRetrieveResponse] + # + # @see WhopSDK::Models::Partners::BusinessRetrieveParams + def retrieve(id, params = {}) + @client.request( + method: :get, + path: ["partners/businesses/%1$s", id], + model: WhopSDK::Models::Partners::BusinessRetrieveResponse, + options: params[:request_options] + ) + end + + # Some parameter documentations has been truncated, see + # {WhopSDK::Models::Partners::BusinessListParams} for more details. + # + # Lists the businesses the authenticated user referred onto Whop, most recent + # first. + # + # @overload list(after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, has_earnings: nil, last: nil, order: nil, referred_user_id: nil, referred_username: nil, status: nil, tier: nil, request_options: {}) + # + # @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 created_after [String] Only return partner businesses created after this timestamp. + # + # @param created_before [String] Only return partner businesses created before this timestamp. + # + # @param direction [Symbol, WhopSDK::Models::Partners::BusinessListParams::Direction] Sort direction. + # + # @param first [Integer] Number of partner businesses to return from the start of the window. + # + # @param has_earnings [Boolean] When true, only businesses with pending or completed earnings paid to the caller + # + # @param last [Integer] Number of partner businesses to return from the end of the window. + # + # @param order [Symbol, WhopSDK::Models::Partners::BusinessListParams::Order] The field to sort partner businesses by. + # + # @param referred_user_id [String] Filter to referrals attributed to this user. For first-tier referrals, this is t + # + # @param referred_username [String] Filter by the referred user's exact username. Ignored when `referred_user_id` is + # + # @param status [Symbol, WhopSDK::Models::Partners::BusinessListParams::Status] Filter by referral status. + # + # @param tier [Symbol, WhopSDK::Models::Partners::BusinessListParams::Tier] Filter to only first-tier referrals or only second-tier referrals. + # + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [WhopSDK::Internal::CursorPage] + # + # @see WhopSDK::Models::Partners::BusinessListParams + def list(params = {}) + parsed, options = WhopSDK::Partners::BusinessListParams.dump_request(params) + query = WhopSDK::Internal::Util.encode_query_params(parsed) + @client.request( + method: :get, + path: "partners/businesses", + query: query, + page: WhopSDK::Internal::CursorPage, + model: WhopSDK::Models::Partners::BusinessListResponse, + options: options + ) + end + + # @api private + # + # @param client [WhopSDK::Client] + def initialize(client:) + @client = client + @earnings = WhopSDK::Resources::Partners::Businesses::Earnings.new(client: client) + end + end + end + end +end diff --git a/lib/whop_sdk/resources/referrals/businesses/earnings.rb b/lib/whop_sdk/resources/partners/businesses/earnings.rb similarity index 68% rename from lib/whop_sdk/resources/referrals/businesses/earnings.rb rename to lib/whop_sdk/resources/partners/businesses/earnings.rb index 53acb759..8edfc7c1 100644 --- a/lib/whop_sdk/resources/referrals/businesses/earnings.rb +++ b/lib/whop_sdk/resources/partners/businesses/earnings.rb @@ -2,9 +2,9 @@ module WhopSDK module Resources - class Referrals + class Partners class Businesses - # The Referrals API covers your Whop partner activity: the users you referred onto + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # @@ -16,7 +16,7 @@ class Earnings # # @overload list(id, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, order: nil, status: nil, request_options: {}) # - # @param id [String] The business referral ID (a coma\_ identifier). + # @param id [String] The partner business ID (a coma\_ identifier). # # @param after [String] # @@ -26,30 +26,30 @@ class Earnings # # @param created_before [String] Only return earnings created before this timestamp. # - # @param direction [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Direction] Sort direction. + # @param direction [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Direction] Sort direction. # # @param first [Integer] # # @param last [Integer] # - # @param order [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Order] The field to sort earnings by. + # @param order [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Order] The field to sort earnings by. # - # @param status [Symbol, WhopSDK::Models::Referrals::Businesses::EarningListParams::Status] Filter by earning status. + # @param status [Symbol, WhopSDK::Models::Partners::Businesses::EarningListParams::Status] Filter by earning status. # # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] # - # @return [WhopSDK::Internal::CursorPage] + # @return [WhopSDK::Internal::CursorPage] # - # @see WhopSDK::Models::Referrals::Businesses::EarningListParams + # @see WhopSDK::Models::Partners::Businesses::EarningListParams def list(id, params = {}) - parsed, options = WhopSDK::Referrals::Businesses::EarningListParams.dump_request(params) + parsed, options = WhopSDK::Partners::Businesses::EarningListParams.dump_request(params) query = WhopSDK::Internal::Util.encode_query_params(parsed) @client.request( method: :get, path: ["partners/businesses/%1$s/earnings", id], query: query, page: WhopSDK::Internal::CursorPage, - model: WhopSDK::Models::Referrals::Businesses::EarningListResponse, + model: WhopSDK::Models::Partners::Businesses::EarningListResponse, options: options ) end diff --git a/lib/whop_sdk/resources/referrals.rb b/lib/whop_sdk/resources/referrals.rb deleted file mode 100644 index 6104b08a..00000000 --- a/lib/whop_sdk/resources/referrals.rb +++ /dev/null @@ -1,77 +0,0 @@ -# frozen_string_literal: true - -module WhopSDK - module Resources - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - class Referrals - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - # @return [WhopSDK::Resources::Referrals::Businesses] - attr_reader :businesses - - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - # @return [WhopSDK::Resources::Referrals::Partners] - attr_reader :partners - - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::ReferralReferredUsersParams} for more details. - # - # Lists the users the caller referred onto Whop (newest first), each with the - # second-tier earnings the caller has made from that user's businesses. - # - # @overload referred_users(after: nil, before: nil, first: nil, has_businesses: nil, has_earning_businesses: nil, last: nil, request_options: {}) - # - # @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 first [Integer] Number of referred users to return from the start of the window. - # - # @param has_businesses [Boolean] When true, only referred users who brought at least one business onto Whop. - # - # @param has_earning_businesses [Boolean] When true, only referred users with at least one business that has generated ear - # - # @param last [Integer] Number of referred users to return from the end of the window. - # - # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [WhopSDK::Models::ReferralReferredUsersResponse] - # - # @see WhopSDK::Models::ReferralReferredUsersParams - def referred_users(params = {}) - parsed, options = WhopSDK::ReferralReferredUsersParams.dump_request(params) - query = WhopSDK::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "partners/referred_users", - query: query, - model: WhopSDK::Models::ReferralReferredUsersResponse, - options: options - ) - end - - # @api private - # - # @param client [WhopSDK::Client] - def initialize(client:) - @client = client - @businesses = WhopSDK::Resources::Referrals::Businesses.new(client: client) - @partners = WhopSDK::Resources::Referrals::Partners.new(client: client) - end - end - end -end diff --git a/lib/whop_sdk/resources/referrals/businesses.rb b/lib/whop_sdk/resources/referrals/businesses.rb deleted file mode 100644 index 5936ad02..00000000 --- a/lib/whop_sdk/resources/referrals/businesses.rb +++ /dev/null @@ -1,132 +0,0 @@ -# frozen_string_literal: true - -module WhopSDK - module Resources - class Referrals - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - class Businesses - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - # @return [WhopSDK::Resources::Referrals::Businesses::Earnings] - attr_reader :earnings - - # Retrieves a single referred business and its referral terms. - # - # @overload retrieve(id, request_options: {}) - # - # @param id [String] The business referral ID (a coma\_ identifier). - # - # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [WhopSDK::Models::Referrals::BusinessRetrieveResponse] - # - # @see WhopSDK::Models::Referrals::BusinessRetrieveParams - def retrieve(id, params = {}) - @client.request( - method: :get, - path: ["partners/businesses/%1$s", id], - model: WhopSDK::Models::Referrals::BusinessRetrieveResponse, - options: params[:request_options] - ) - end - - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessListParams} for more details. - # - # Lists the businesses the authenticated user referred onto Whop, most recent - # first. - # - # @overload list(after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, has_earnings: nil, last: nil, order: nil, referred_user_id: nil, referred_username: nil, status: nil, tier: nil, request_options: {}) - # - # @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 created_after [String] Only return business referrals created after this timestamp. - # - # @param created_before [String] Only return business referrals created before this timestamp. - # - # @param direction [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Direction] Sort direction. - # - # @param first [Integer] Number of business referrals to return from the start of the window. - # - # @param has_earnings [Boolean] When true, only businesses with pending or completed earnings paid to the caller - # - # @param last [Integer] Number of business referrals to return from the end of the window. - # - # @param order [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Order] The field to sort business referrals by. - # - # @param referred_user_id [String] Filter to referrals attributed to this user. For first-tier referrals, this is t - # - # @param referred_username [String] Filter by the referred user's exact username. Ignored when `referred_user_id` is - # - # @param status [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Status] Filter by referral status. - # - # @param tier [Symbol, WhopSDK::Models::Referrals::BusinessListParams::Tier] Filter to only first-tier referrals or only second-tier referrals. - # - # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [WhopSDK::Internal::CursorPage] - # - # @see WhopSDK::Models::Referrals::BusinessListParams - def list(params = {}) - parsed, options = WhopSDK::Referrals::BusinessListParams.dump_request(params) - query = WhopSDK::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "partners/businesses", - query: query, - page: WhopSDK::Internal::CursorPage, - model: WhopSDK::Models::Referrals::BusinessListResponse, - options: options - ) - end - - # Some parameter documentations has been truncated, see - # {WhopSDK::Models::Referrals::BusinessLeaderboardParams} for more details. - # - # Ranks referrers by business referral earnings — all-time by default, or over the - # current day, month, year, or trailing 30 days — and includes the caller's own - # standing. - # - # @overload leaderboard(period: nil, request_options: {}) - # - # @param period [Symbol, WhopSDK::Models::Referrals::BusinessLeaderboardParams::Period] Time window for the rankings. `day`, `month`, and `year` count earnings since th - # - # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [WhopSDK::Models::Referrals::BusinessLeaderboardResponse] - # - # @see WhopSDK::Models::Referrals::BusinessLeaderboardParams - def leaderboard(params = {}) - parsed, options = WhopSDK::Referrals::BusinessLeaderboardParams.dump_request(params) - query = WhopSDK::Internal::Util.encode_query_params(parsed) - @client.request( - method: :get, - path: "partners/leaderboard", - query: query, - model: WhopSDK::Models::Referrals::BusinessLeaderboardResponse, - options: options - ) - end - - # @api private - # - # @param client [WhopSDK::Client] - def initialize(client:) - @client = client - @earnings = WhopSDK::Resources::Referrals::Businesses::Earnings.new(client: client) - end - end - end - end -end diff --git a/lib/whop_sdk/resources/referrals/partners.rb b/lib/whop_sdk/resources/referrals/partners.rb deleted file mode 100644 index 0ceb833c..00000000 --- a/lib/whop_sdk/resources/referrals/partners.rb +++ /dev/null @@ -1,42 +0,0 @@ -# frozen_string_literal: true - -module WhopSDK - module Resources - class Referrals - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - class Partners - # Enrolls the calling user in the Whop partner program, making their business - # referrals eligible for earnings. Idempotent — enrolling again keeps the original - # enrollment time. - # - # @overload create(request_options: {}) - # - # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] - # - # @return [WhopSDK::Models::Referrals::PartnerCreateResponse] - # - # @see WhopSDK::Models::Referrals::PartnerCreateParams - def create(params = {}) - @client.request( - method: :post, - path: "partners", - model: WhopSDK::Models::Referrals::PartnerCreateResponse, - options: params[:request_options] - ) - end - - # @api private - # - # @param client [WhopSDK::Client] - def initialize(client:) - @client = client - end - end - end - end -end diff --git a/lib/whop_sdk/resources/users.rb b/lib/whop_sdk/resources/users.rb index 05a3d805..0c75acb5 100644 --- a/lib/whop_sdk/resources/users.rb +++ b/lib/whop_sdk/resources/users.rb @@ -147,6 +147,30 @@ def check_access(resource_id, params) ) end + # Lists the recommended actions computed for the user: personal suggestions (e.g. + # start a business or become an affiliate) pooled with the highest-impact actions + # across the accounts the user owns. Business actions are tagged with their + # `account_id`/`account_name`; personal actions leave those `null`. Self-only: + # `id` must be `me` or the authenticated user's own tag/username. + # + # @overload recommend_actions(id, request_options: {}) + # + # @param id [String] `me`, or the authenticated user's own `user_` tag or username. + # + # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil] + # + # @return [WhopSDK::Models::UserRecommendActionsResponse] + # + # @see WhopSDK::Models::UserRecommendActionsParams + def recommend_actions(id, params = {}) + @client.request( + method: :get, + path: ["users/%1$s/recommend_actions", id], + model: WhopSDK::Models::UserRecommendActionsResponse, + options: params[:request_options] + ) + end + # Some parameter documentations has been truncated, see # {WhopSDK::Models::UserUpdateMeParams} for more details. # diff --git a/rbi/whop_sdk/client.rbi b/rbi/whop_sdk/client.rbi index c8562a0f..0d570182 100644 --- a/rbi/whop_sdk/client.rbi +++ b/rbi/whop_sdk/client.rbi @@ -271,14 +271,14 @@ module WhopSDK sig { returns(WhopSDK::Resources::Payouts) } attr_reader :payouts - # The Referrals API covers your Whop partner activity: the users you referred onto + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # # Use it to enroll as a Whop partner, list the users you referred, list your # referred businesses and review their earnings, and see the partner leaderboard. - sig { returns(WhopSDK::Resources::Referrals) } - attr_reader :referrals + sig { returns(WhopSDK::Resources::Partners) } + attr_reader :partners # Cards represent Whop-issued virtual payment cards that spend from an account or # user balance. Cards can be assigned to cardholders and configured with spending diff --git a/rbi/whop_sdk/models.rbi b/rbi/whop_sdk/models.rbi index e322a950..65bbd340 100644 --- a/rbi/whop_sdk/models.rbi +++ b/rbi/whop_sdk/models.rbi @@ -589,6 +589,14 @@ module WhopSDK PageInfo = WhopSDK::Models::PageInfo + PartnerCreateParams = WhopSDK::Models::PartnerCreateParams + + PartnerLeaderboardParams = WhopSDK::Models::PartnerLeaderboardParams + + PartnerReferredUsersParams = WhopSDK::Models::PartnerReferredUsersParams + + Partners = WhopSDK::Models::Partners + Payment = WhopSDK::Models::Payment PaymentCreatedWebhookEvent = WhopSDK::Models::PaymentCreatedWebhookEvent @@ -702,10 +710,6 @@ module WhopSDK ReceiptTaxBehavior = WhopSDK::Models::ReceiptTaxBehavior - ReferralReferredUsersParams = WhopSDK::Models::ReferralReferredUsersParams - - Referrals = WhopSDK::Models::Referrals - RefundCreatedWebhookEvent = WhopSDK::Models::RefundCreatedWebhookEvent RefundListParams = WhopSDK::Models::RefundListParams @@ -851,6 +855,8 @@ module WhopSDK UserListParams = WhopSDK::Models::UserListParams + UserRecommendActionsParams = WhopSDK::Models::UserRecommendActionsParams + UserRetrieveParams = WhopSDK::Models::UserRetrieveParams UserUpdateMeParams = WhopSDK::Models::UserUpdateMeParams diff --git a/rbi/whop_sdk/models/account.rbi b/rbi/whop_sdk/models/account.rbi index dcc6ec00..575e78e2 100644 --- a/rbi/whop_sdk/models/account.rbi +++ b/rbi/whop_sdk/models/account.rbi @@ -1086,12 +1086,11 @@ module WhopSDK sig { returns(T.nilable(String)) } attr_accessor :icon_url - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked sig { returns(T.nilable(Integer)) } attr_accessor :impact_score - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` sig { returns(T.nilable(String)) } attr_accessor :reasoning @@ -1136,10 +1135,9 @@ module WhopSDK description:, # Illustration icon URL, or `null` icon_url:, - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked impact_score:, - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` reasoning:, # Always optional — never blocking status:, diff --git a/rbi/whop_sdk/models/account_recommend_actions_response.rbi b/rbi/whop_sdk/models/account_recommend_actions_response.rbi index 92755d7c..e443702c 100644 --- a/rbi/whop_sdk/models/account_recommend_actions_response.rbi +++ b/rbi/whop_sdk/models/account_recommend_actions_response.rbi @@ -77,12 +77,11 @@ module WhopSDK sig { returns(T.nilable(String)) } attr_accessor :icon_url - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked sig { returns(T.nilable(Integer)) } attr_accessor :impact_score - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` sig { returns(T.nilable(String)) } attr_accessor :reasoning @@ -127,10 +126,9 @@ module WhopSDK description:, # Illustration icon URL, or `null` icon_url:, - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked impact_score:, - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` reasoning:, # Always optional — never blocking status:, diff --git a/rbi/whop_sdk/models/ad_group.rbi b/rbi/whop_sdk/models/ad_group.rbi index 529b6fa7..2e168678 100644 --- a/rbi/whop_sdk/models/ad_group.rbi +++ b/rbi/whop_sdk/models/ad_group.rbi @@ -148,6 +148,13 @@ module WhopSDK sig { returns(T.nilable(Float)) } attr_accessor :desired_cost_per_result + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where demographics type is one of + # life_events, industries, income, family_statuses. Incompatible with + # demographics.automatic (Advantage+) and Special Ad Category campaigns. + sig { returns(T.anything) } + attr_accessor :detailed_targeting + # Device targeting: platforms and operating systems. sig { returns(T.anything) } attr_accessor :devices @@ -209,8 +216,10 @@ module WhopSDK sig { returns(Float) } attr_accessor :reach - # Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g. - # US-CA), cities, zips. + # Geo targeting: include/exclude countries, country_groups (include-only Meta + # groups like worldwide — global reach), regions (ISO 3166-2 states, e.g. US-CA), + # cities, zips, and custom_locations (pin + radius: { latitude, longitude, radius, + # distance_unit, name }). sig { returns(T.anything) } attr_accessor :regions @@ -317,6 +326,7 @@ module WhopSDK delivery_status: WhopSDK::AdGroup::DeliveryStatus::OrSymbol, demographics: T.anything, desired_cost_per_result: T.nilable(Float), + detailed_targeting: T.anything, devices: T.anything, dynamic_creative: T::Boolean, ends_at: T.nilable(String), @@ -429,6 +439,11 @@ module WhopSDK demographics:, # Target/cap cost for average_target / maximum_target. desired_cost_per_result:, + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where demographics type is one of + # life_events, industries, income, family_statuses. Incompatible with + # demographics.automatic (Advantage+) and Special Ad Category campaigns. + detailed_targeting:, # Device targeting: platforms and operating systems. devices:, # Whether ads within this ad group have their creatives and copy dynamically AB @@ -458,8 +473,10 @@ module WhopSDK purchases:, # The number of unique people who saw this. reach:, - # Geo targeting: include/exclude countries, regions (ISO 3166-2 states, e.g. - # US-CA), cities, zips. + # Geo targeting: include/exclude countries, country_groups (include-only Meta + # groups like worldwide — global reach), regions (ISO 3166-2 states, e.g. US-CA), + # cities, zips, and custom_locations (pin + radius: { latitude, longitude, radius, + # distance_unit, name }). regions:, # The Whop pixel conversion event whose attributed count represents results — the # optimization goal, or the highest-volume attributed event for campaigns that @@ -536,6 +553,7 @@ module WhopSDK delivery_status: WhopSDK::AdGroup::DeliveryStatus::TaggedSymbol, demographics: T.anything, desired_cost_per_result: T.nilable(Float), + detailed_targeting: T.anything, devices: T.anything, dynamic_creative: T::Boolean, ends_at: T.nilable(String), diff --git a/rbi/whop_sdk/models/ad_group_create_params.rbi b/rbi/whop_sdk/models/ad_group_create_params.rbi index 1ff2d788..d8315e79 100644 --- a/rbi/whop_sdk/models/ad_group_create_params.rbi +++ b/rbi/whop_sdk/models/ad_group_create_params.rbi @@ -100,6 +100,18 @@ module WhopSDK sig { params(desired_cost_per_result: Float).void } attr_writer :desired_cost_per_result + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + sig { returns(T.nilable(T.anything)) } + attr_reader :detailed_targeting + + sig { params(detailed_targeting: T.anything).void } + attr_writer :detailed_targeting + # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. sig { returns(T.nilable(T.anything)) } attr_reader :devices @@ -190,8 +202,12 @@ module WhopSDK sig { params(placements: T.anything).void } attr_writer :placements - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. sig { returns(T.nilable(T.anything)) } attr_reader :regions @@ -239,6 +255,7 @@ module WhopSDK WhopSDK::AdGroupCreateParams::ConversionLocation::OrSymbol, demographics: T.anything, desired_cost_per_result: Float, + detailed_targeting: T.anything, devices: T.anything, dynamic_creative: T::Boolean, ends_at: String, @@ -279,6 +296,13 @@ module WhopSDK demographics: nil, # Target/cap cost for average_target / maximum_target. desired_cost_per_result: nil, + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + detailed_targeting: nil, # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. devices: nil, # Run Meta dynamic (Advantage+) creative for this ad set. Set at creation; @@ -313,8 +337,12 @@ module WhopSDK # - `threads`: `threads_stream` # - `whatsapp`: `status` placements: nil, - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. regions: nil, # Schedule start, ISO 8601. starts_at: nil, @@ -345,6 +373,7 @@ module WhopSDK WhopSDK::AdGroupCreateParams::ConversionLocation::OrSymbol, demographics: T.anything, desired_cost_per_result: Float, + detailed_targeting: T.anything, devices: T.anything, dynamic_creative: T::Boolean, ends_at: String, diff --git a/rbi/whop_sdk/models/ad_group_update_params.rbi b/rbi/whop_sdk/models/ad_group_update_params.rbi index 237a78c9..4920fb2f 100644 --- a/rbi/whop_sdk/models/ad_group_update_params.rbi +++ b/rbi/whop_sdk/models/ad_group_update_params.rbi @@ -99,6 +99,18 @@ module WhopSDK sig { params(desired_cost_per_result: Float).void } attr_writer :desired_cost_per_result + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + sig { returns(T.nilable(T.anything)) } + attr_reader :detailed_targeting + + sig { params(detailed_targeting: T.anything).void } + attr_writer :detailed_targeting + # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. sig { returns(T.nilable(T.anything)) } attr_reader :devices @@ -181,8 +193,12 @@ module WhopSDK sig { params(placements: T.anything).void } attr_writer :placements - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. sig { returns(T.nilable(T.anything)) } attr_reader :regions @@ -230,6 +246,7 @@ module WhopSDK WhopSDK::AdGroupUpdateParams::ConversionLocation::OrSymbol, demographics: T.anything, desired_cost_per_result: Float, + detailed_targeting: T.anything, devices: T.anything, ends_at: String, frequency_cap: T.anything, @@ -268,6 +285,13 @@ module WhopSDK demographics: nil, # Target/cap cost for average_target / maximum_target. desired_cost_per_result: nil, + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + detailed_targeting: nil, # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. devices: nil, # Schedule end, ISO 8601. @@ -299,8 +323,12 @@ module WhopSDK # - `threads`: `threads_stream` # - `whatsapp`: `status` placements: nil, - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. regions: nil, # Schedule start, ISO 8601. starts_at: nil, @@ -331,6 +359,7 @@ module WhopSDK WhopSDK::AdGroupUpdateParams::ConversionLocation::OrSymbol, demographics: T.anything, desired_cost_per_result: Float, + detailed_targeting: T.anything, devices: T.anything, ends_at: String, frequency_cap: T.anything, diff --git a/rbi/whop_sdk/models/event_create_params.rbi b/rbi/whop_sdk/models/event_create_params.rbi index 8972ebe6..f36e2bc9 100644 --- a/rbi/whop_sdk/models/event_create_params.rbi +++ b/rbi/whop_sdk/models/event_create_params.rbi @@ -15,8 +15,12 @@ module WhopSDK sig { returns(String) } attr_accessor :account_id - # The type of conversion or engagement event - sig { returns(WhopSDK::EventCreateParams::EventName::OrSymbol) } + # The type of event. + # + # Use a standard event (lead, submit_application, contact, complete_registration, + # schedule, view_content, add_to_cart) or pass your own name directly for a custom + # event. + sig { returns(String) } attr_accessor :event_name # The channel where an event originated @@ -101,7 +105,7 @@ module WhopSDK sig do params( account_id: String, - event_name: WhopSDK::EventCreateParams::EventName::OrSymbol, + event_name: String, action_source: T.nilable(WhopSDK::EventCreateParams::ActionSource::OrSymbol), context: T.nilable(WhopSDK::EventCreateParams::Context::OrHash), @@ -125,7 +129,11 @@ module WhopSDK def self.new( # The account to associate with this event. account_id:, - # The type of conversion or engagement event + # The type of event. + # + # Use a standard event (lead, submit_application, contact, complete_registration, + # schedule, view_content, add_to_cart) or pass your own name directly for a custom + # event. event_name:, # The channel where an event originated action_source: nil, @@ -168,7 +176,7 @@ module WhopSDK override.returns( { account_id: String, - event_name: WhopSDK::EventCreateParams::EventName::OrSymbol, + event_name: String, action_source: T.nilable(WhopSDK::EventCreateParams::ActionSource::OrSymbol), context: T.nilable(WhopSDK::EventCreateParams::Context), @@ -193,52 +201,6 @@ module WhopSDK def to_hash end - # The type of conversion or engagement event - module EventName - extend WhopSDK::Internal::Type::Enum - - TaggedSymbol = - T.type_alias { T.all(Symbol, WhopSDK::EventCreateParams::EventName) } - OrSymbol = T.type_alias { T.any(Symbol, String) } - - LEAD = T.let(:lead, WhopSDK::EventCreateParams::EventName::TaggedSymbol) - SUBMIT_APPLICATION = - T.let( - :submit_application, - WhopSDK::EventCreateParams::EventName::TaggedSymbol - ) - CONTACT = - T.let(:contact, WhopSDK::EventCreateParams::EventName::TaggedSymbol) - COMPLETE_REGISTRATION = - T.let( - :complete_registration, - WhopSDK::EventCreateParams::EventName::TaggedSymbol - ) - SCHEDULE = - T.let(:schedule, WhopSDK::EventCreateParams::EventName::TaggedSymbol) - VIEW_CONTENT = - T.let( - :view_content, - WhopSDK::EventCreateParams::EventName::TaggedSymbol - ) - ADD_TO_CART = - T.let( - :add_to_cart, - WhopSDK::EventCreateParams::EventName::TaggedSymbol - ) - CUSTOM = - T.let(:custom, WhopSDK::EventCreateParams::EventName::TaggedSymbol) - PAGE = T.let(:page, WhopSDK::EventCreateParams::EventName::TaggedSymbol) - - sig do - override.returns( - T::Array[WhopSDK::EventCreateParams::EventName::TaggedSymbol] - ) - end - def self.values - end - end - # The channel where an event originated module ActionSource extend WhopSDK::Internal::Type::Enum diff --git a/rbi/whop_sdk/models/invoice.rbi b/rbi/whop_sdk/models/invoice.rbi index ad29dff6..760e685f 100644 --- a/rbi/whop_sdk/models/invoice.rbi +++ b/rbi/whop_sdk/models/invoice.rbi @@ -36,6 +36,10 @@ module WhopSDK sig { returns(String) } attr_accessor :fetch_invoice_token + # Optional line items that break down the invoice total into individual charges. + sig { returns(T::Array[WhopSDK::Invoice::LineItem]) } + attr_accessor :line_items + # The sequential invoice number for display purposes. sig { returns(String) } attr_accessor :number @@ -63,6 +67,7 @@ module WhopSDK due_date: T.nilable(Time), email_address: T.nilable(String), fetch_invoice_token: String, + line_items: T::Array[WhopSDK::Invoice::LineItem::OrHash], number: String, status: WhopSDK::InvoiceStatus::OrSymbol, user: T.nilable(WhopSDK::Invoice::User::OrHash) @@ -84,6 +89,8 @@ module WhopSDK # A signed token that allows fetching invoice data publicly without # authentication. fetch_invoice_token:, + # Optional line items that break down the invoice total into individual charges. + line_items:, # The sequential invoice number for display purposes. number:, # The current payment status of the invoice, such as draft, open, paid, or void. @@ -103,6 +110,7 @@ module WhopSDK due_date: T.nilable(Time), email_address: T.nilable(String), fetch_invoice_token: String, + line_items: T::Array[WhopSDK::Invoice::LineItem], number: String, status: WhopSDK::InvoiceStatus::TaggedSymbol, user: T.nilable(WhopSDK::Invoice::User) @@ -163,6 +171,72 @@ module WhopSDK end end + class LineItem < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any(WhopSDK::Invoice::LineItem, WhopSDK::Internal::AnyHash) + end + + # The label or description for this line item. + sig { returns(String) } + attr_accessor :label + + # The display order of this line item within the invoice. + sig { returns(Integer) } + attr_accessor :position + + # The quantity of this line item. + sig { returns(Float) } + attr_accessor :quantity + + # The computed total for this line item (quantity \* unit_price). + sig { returns(Float) } + attr_accessor :total + + # The unit price for this line item. + sig { returns(Float) } + attr_accessor :unit_price + + # A line item on an invoice, representing a single charge with a label, quantity, + # and unit price. + sig do + params( + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + ).returns(T.attached_class) + end + def self.new( + # The label or description for this line item. + label:, + # The display order of this line item within the invoice. + position:, + # The quantity of this line item. + quantity:, + # The computed total for this line item (quantity \* unit_price). + total:, + # The unit price for this line item. + unit_price: + ) + end + + sig do + override.returns( + { + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + } + ) + end + def to_hash + end + end + class User < WhopSDK::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/whop_sdk/models/invoice_list_item.rbi b/rbi/whop_sdk/models/invoice_list_item.rbi index ad4f4bbe..a4f16df3 100644 --- a/rbi/whop_sdk/models/invoice_list_item.rbi +++ b/rbi/whop_sdk/models/invoice_list_item.rbi @@ -40,6 +40,10 @@ module WhopSDK sig { returns(String) } attr_accessor :fetch_invoice_token + # Optional line items that break down the invoice total into individual charges. + sig { returns(T::Array[WhopSDK::InvoiceListItem::LineItem]) } + attr_accessor :line_items + # The sequential invoice number for display purposes. sig { returns(String) } attr_accessor :number @@ -69,6 +73,7 @@ module WhopSDK due_date: T.nilable(Time), email_address: T.nilable(String), fetch_invoice_token: String, + line_items: T::Array[WhopSDK::InvoiceListItem::LineItem::OrHash], number: String, status: WhopSDK::InvoiceStatus::OrSymbol, user: T.nilable(WhopSDK::InvoiceListItem::User::OrHash) @@ -90,6 +95,8 @@ module WhopSDK # A signed token that allows fetching invoice data publicly without # authentication. fetch_invoice_token:, + # Optional line items that break down the invoice total into individual charges. + line_items:, # The sequential invoice number for display purposes. number:, # The current payment status of the invoice, such as draft, open, paid, or void. @@ -109,6 +116,7 @@ module WhopSDK due_date: T.nilable(Time), email_address: T.nilable(String), fetch_invoice_token: String, + line_items: T::Array[WhopSDK::InvoiceListItem::LineItem], number: String, status: WhopSDK::InvoiceStatus::TaggedSymbol, user: T.nilable(WhopSDK::InvoiceListItem::User) @@ -172,6 +180,75 @@ module WhopSDK end end + class LineItem < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::InvoiceListItem::LineItem, + WhopSDK::Internal::AnyHash + ) + end + + # The label or description for this line item. + sig { returns(String) } + attr_accessor :label + + # The display order of this line item within the invoice. + sig { returns(Integer) } + attr_accessor :position + + # The quantity of this line item. + sig { returns(Float) } + attr_accessor :quantity + + # The computed total for this line item (quantity \* unit_price). + sig { returns(Float) } + attr_accessor :total + + # The unit price for this line item. + sig { returns(Float) } + attr_accessor :unit_price + + # A line item on an invoice, representing a single charge with a label, quantity, + # and unit price. + sig do + params( + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + ).returns(T.attached_class) + end + def self.new( + # The label or description for this line item. + label:, + # The display order of this line item within the invoice. + position:, + # The quantity of this line item. + quantity:, + # The computed total for this line item (quantity \* unit_price). + total:, + # The unit price for this line item. + unit_price: + ) + end + + sig do + override.returns( + { + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + } + ) + end + def to_hash + end + end + class User < WhopSDK::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/whop_sdk/models/partner_create_params.rbi b/rbi/whop_sdk/models/partner_create_params.rbi new file mode 100644 index 00000000..b33cafce --- /dev/null +++ b/rbi/whop_sdk/models/partner_create_params.rbi @@ -0,0 +1,27 @@ +# typed: strong + +module WhopSDK + module Models + class PartnerCreateParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(WhopSDK::PartnerCreateParams, WhopSDK::Internal::AnyHash) + end + + sig do + params(request_options: WhopSDK::RequestOptions::OrHash).returns( + T.attached_class + ) + end + def self.new(request_options: {}) + end + + sig { override.returns({ request_options: WhopSDK::RequestOptions }) } + def to_hash + end + end + end +end diff --git a/rbi/whop_sdk/models/partner_create_response.rbi b/rbi/whop_sdk/models/partner_create_response.rbi new file mode 100644 index 00000000..f842fff5 --- /dev/null +++ b/rbi/whop_sdk/models/partner_create_response.rbi @@ -0,0 +1,46 @@ +# typed: strong + +module WhopSDK + module Models + class PartnerCreateResponse < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerCreateResponse, + WhopSDK::Internal::AnyHash + ) + end + + # The caller's referral link — businesses that sign up through it are attributed + # to the caller. + sig { returns(String) } + attr_accessor :referral_link + + # When the caller became a Whop partner. + sig { returns(Time) } + attr_accessor :whop_partner_enabled_at + + sig do + params(referral_link: String, whop_partner_enabled_at: Time).returns( + T.attached_class + ) + end + def self.new( + # The caller's referral link — businesses that sign up through it are attributed + # to the caller. + referral_link:, + # When the caller became a Whop partner. + whop_partner_enabled_at: + ) + end + + sig do + override.returns( + { referral_link: String, whop_partner_enabled_at: Time } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/whop_sdk/models/partner_leaderboard_params.rbi b/rbi/whop_sdk/models/partner_leaderboard_params.rbi new file mode 100644 index 00000000..0571cf8e --- /dev/null +++ b/rbi/whop_sdk/models/partner_leaderboard_params.rbi @@ -0,0 +1,92 @@ +# typed: strong + +module WhopSDK + module Models + class PartnerLeaderboardParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(WhopSDK::PartnerLeaderboardParams, WhopSDK::Internal::AnyHash) + end + + # Time window for the rankings. `day`, `month`, and `year` count earnings since + # the start of the current calendar day, month, or year; `last_30_days` counts + # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. + sig do + returns(T.nilable(WhopSDK::PartnerLeaderboardParams::Period::OrSymbol)) + end + attr_reader :period + + sig do + params(period: WhopSDK::PartnerLeaderboardParams::Period::OrSymbol).void + end + attr_writer :period + + sig do + params( + period: WhopSDK::PartnerLeaderboardParams::Period::OrSymbol, + request_options: WhopSDK::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new( + # Time window for the rankings. `day`, `month`, and `year` count earnings since + # the start of the current calendar day, month, or year; `last_30_days` counts + # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. + period: nil, + request_options: {} + ) + end + + sig do + override.returns( + { + period: WhopSDK::PartnerLeaderboardParams::Period::OrSymbol, + request_options: WhopSDK::RequestOptions + } + ) + end + def to_hash + end + + # Time window for the rankings. `day`, `month`, and `year` count earnings since + # the start of the current calendar day, month, or year; `last_30_days` counts + # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. + module Period + extend WhopSDK::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all(Symbol, WhopSDK::PartnerLeaderboardParams::Period) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + DAY = + T.let(:day, WhopSDK::PartnerLeaderboardParams::Period::TaggedSymbol) + MONTH = + T.let(:month, WhopSDK::PartnerLeaderboardParams::Period::TaggedSymbol) + YEAR = + T.let(:year, WhopSDK::PartnerLeaderboardParams::Period::TaggedSymbol) + LAST_30_DAYS = + T.let( + :last_30_days, + WhopSDK::PartnerLeaderboardParams::Period::TaggedSymbol + ) + ALL_TIME = + T.let( + :all_time, + WhopSDK::PartnerLeaderboardParams::Period::TaggedSymbol + ) + + sig do + override.returns( + T::Array[WhopSDK::PartnerLeaderboardParams::Period::TaggedSymbol] + ) + end + def self.values + end + end + end + end +end diff --git a/rbi/whop_sdk/models/partner_leaderboard_response.rbi b/rbi/whop_sdk/models/partner_leaderboard_response.rbi new file mode 100644 index 00000000..d0ddae0a --- /dev/null +++ b/rbi/whop_sdk/models/partner_leaderboard_response.rbi @@ -0,0 +1,508 @@ +# typed: strong + +module WhopSDK + module Models + class PartnerLeaderboardResponse < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerLeaderboardResponse, + WhopSDK::Internal::AnyHash + ) + end + + # The top referrers by total earnings, best first. + sig do + returns(T::Array[WhopSDK::Models::PartnerLeaderboardResponse::Leader]) + end + attr_accessor :leaders + + # The caller's own standing; null when the caller has no referral earnings. + sig do + returns(T.nilable(WhopSDK::Models::PartnerLeaderboardResponse::Me)) + end + attr_reader :me + + sig do + params( + me: T.nilable(WhopSDK::Models::PartnerLeaderboardResponse::Me::OrHash) + ).void + end + attr_writer :me + + sig do + params( + leaders: + T::Array[ + WhopSDK::Models::PartnerLeaderboardResponse::Leader::OrHash + ], + me: T.nilable(WhopSDK::Models::PartnerLeaderboardResponse::Me::OrHash) + ).returns(T.attached_class) + end + def self.new( + # The top referrers by total earnings, best first. + leaders:, + # The caller's own standing; null when the caller has no referral earnings. + me: + ) + end + + sig do + override.returns( + { + leaders: + T::Array[WhopSDK::Models::PartnerLeaderboardResponse::Leader], + me: T.nilable(WhopSDK::Models::PartnerLeaderboardResponse::Me) + } + ) + end + def to_hash + end + + class Leader < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerLeaderboardResponse::Leader, + WhopSDK::Internal::AnyHash + ) + end + + # When the referrer's earliest partner business became active. + sig { returns(Time) } + attr_accessor :first_referral_started_at + + # 1-based leaderboard position. + sig { returns(Integer) } + attr_accessor :rank + + # The referrer's pending + completed earnings across all referred businesses, in + # USD. + sig { returns(String) } + attr_accessor :total_earnings_usd + + # Credited GMV across all the referrer's referred businesses, in USD. + sig { returns(String) } + attr_accessor :total_volume_usd + + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + sig do + returns( + T.nilable(WhopSDK::Models::PartnerLeaderboardResponse::Leader::User) + ) + end + attr_reader :user + + sig do + params( + user: + T.nilable( + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::OrHash + ) + ).void + end + attr_writer :user + + sig do + params( + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: + T.nilable( + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::OrHash + ) + ).returns(T.attached_class) + end + def self.new( + # When the referrer's earliest partner business became active. + first_referral_started_at:, + # 1-based leaderboard position. + rank:, + # The referrer's pending + completed earnings across all referred businesses, in + # USD. + total_earnings_usd:, + # Credited GMV across all the referrer's referred businesses, in USD. + total_volume_usd:, + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + user: + ) + end + + sig do + override.returns( + { + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: + T.nilable( + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User + ) + } + ) + end + def to_hash + end + + class User < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User, + WhopSDK::Internal::AnyHash + ) + end + + # The city where the referrer is located, derived from their IP address. Null if + # location sharing is disabled. + sig { returns(T.nilable(String)) } + attr_accessor :city + + # The country where the referrer is located, derived from their IP address. Null + # if location sharing is disabled. + sig { returns(T.nilable(String)) } + attr_accessor :country + + # User ID, prefixed `user_`. Present only on the caller's own entry. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # The user's display name. Present only on the caller's own entry. + sig { returns(T.nilable(String)) } + attr_accessor :name + + # The user's profile picture. Present only on the caller's own entry. + sig do + returns( + T.nilable( + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture + ) + ) + end + attr_reader :profile_picture + + sig do + params( + profile_picture: + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture::OrHash + ).void + end + attr_writer :profile_picture + + # The user's unique username. Present only on the caller's own entry. + sig { returns(T.nilable(String)) } + attr_reader :username + + sig { params(username: String).void } + attr_writer :username + + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + sig do + params( + city: T.nilable(String), + country: T.nilable(String), + id: String, + name: T.nilable(String), + profile_picture: + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture::OrHash, + username: String + ).returns(T.attached_class) + end + def self.new( + # The city where the referrer is located, derived from their IP address. Null if + # location sharing is disabled. + city:, + # The country where the referrer is located, derived from their IP address. Null + # if location sharing is disabled. + country:, + # User ID, prefixed `user_`. Present only on the caller's own entry. + id: nil, + # The user's display name. Present only on the caller's own entry. + name: nil, + # The user's profile picture. Present only on the caller's own entry. + profile_picture: nil, + # The user's unique username. Present only on the caller's own entry. + username: nil + ) + end + + sig do + override.returns( + { + city: T.nilable(String), + country: T.nilable(String), + id: String, + name: T.nilable(String), + profile_picture: + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture, + username: String + } + ) + end + def to_hash + end + + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture, + WhopSDK::Internal::AnyHash + ) + end + + # The user's profile picture URL. + sig { returns(String) } + attr_accessor :url + + # The user's profile picture. Present only on the caller's own entry. + sig { params(url: String).returns(T.attached_class) } + def self.new( + # The user's profile picture URL. + url: + ) + end + + sig { override.returns({ url: String }) } + def to_hash + end + end + end + end + + class Me < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerLeaderboardResponse::Me, + WhopSDK::Internal::AnyHash + ) + end + + # When the referrer's earliest partner business became active. + sig { returns(Time) } + attr_accessor :first_referral_started_at + + # 1-based leaderboard position. + sig { returns(Integer) } + attr_accessor :rank + + # The referrer's pending + completed earnings across all referred businesses, in + # USD. + sig { returns(String) } + attr_accessor :total_earnings_usd + + # Credited GMV across all the referrer's referred businesses, in USD. + sig { returns(String) } + attr_accessor :total_volume_usd + + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + sig do + returns( + T.nilable(WhopSDK::Models::PartnerLeaderboardResponse::Me::User) + ) + end + attr_reader :user + + sig do + params( + user: + T.nilable( + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::OrHash + ) + ).void + end + attr_writer :user + + # The caller's own standing; null when the caller has no referral earnings. + sig do + params( + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: + T.nilable( + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::OrHash + ) + ).returns(T.attached_class) + end + def self.new( + # When the referrer's earliest partner business became active. + first_referral_started_at:, + # 1-based leaderboard position. + rank:, + # The referrer's pending + completed earnings across all referred businesses, in + # USD. + total_earnings_usd:, + # Credited GMV across all the referrer's referred businesses, in USD. + total_volume_usd:, + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + user: + ) + end + + sig do + override.returns( + { + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: + T.nilable(WhopSDK::Models::PartnerLeaderboardResponse::Me::User) + } + ) + end + def to_hash + end + + class User < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerLeaderboardResponse::Me::User, + WhopSDK::Internal::AnyHash + ) + end + + # The city where the referrer is located, derived from their IP address. Null if + # location sharing is disabled. + sig { returns(T.nilable(String)) } + attr_accessor :city + + # The country where the referrer is located, derived from their IP address. Null + # if location sharing is disabled. + sig { returns(T.nilable(String)) } + attr_accessor :country + + # User ID, prefixed `user_`. Present only on the caller's own entry. + sig { returns(T.nilable(String)) } + attr_reader :id + + sig { params(id: String).void } + attr_writer :id + + # The user's display name. Present only on the caller's own entry. + sig { returns(T.nilable(String)) } + attr_accessor :name + + # The user's profile picture. Present only on the caller's own entry. + sig do + returns( + T.nilable( + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture + ) + ) + end + attr_reader :profile_picture + + sig do + params( + profile_picture: + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture::OrHash + ).void + end + attr_writer :profile_picture + + # The user's unique username. Present only on the caller's own entry. + sig { returns(T.nilable(String)) } + attr_reader :username + + sig { params(username: String).void } + attr_writer :username + + # The ranked referrer. Identity fields (id, name, username, profile_picture) are + # returned only on the caller's own entry; other referrers expose coarse location + # only. + sig do + params( + city: T.nilable(String), + country: T.nilable(String), + id: String, + name: T.nilable(String), + profile_picture: + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture::OrHash, + username: String + ).returns(T.attached_class) + end + def self.new( + # The city where the referrer is located, derived from their IP address. Null if + # location sharing is disabled. + city:, + # The country where the referrer is located, derived from their IP address. Null + # if location sharing is disabled. + country:, + # User ID, prefixed `user_`. Present only on the caller's own entry. + id: nil, + # The user's display name. Present only on the caller's own entry. + name: nil, + # The user's profile picture. Present only on the caller's own entry. + profile_picture: nil, + # The user's unique username. Present only on the caller's own entry. + username: nil + ) + end + + sig do + override.returns( + { + city: T.nilable(String), + country: T.nilable(String), + id: String, + name: T.nilable(String), + profile_picture: + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture, + username: String + } + ) + end + def to_hash + end + + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture, + WhopSDK::Internal::AnyHash + ) + end + + # The user's profile picture URL. + sig { returns(String) } + attr_accessor :url + + # The user's profile picture. Present only on the caller's own entry. + sig { params(url: String).returns(T.attached_class) } + def self.new( + # The user's profile picture URL. + url: + ) + end + + sig { override.returns({ url: String }) } + def to_hash + end + end + end + end + end + end +end diff --git a/rbi/whop_sdk/models/referral_referred_users_params.rbi b/rbi/whop_sdk/models/partner_referred_users_params.rbi similarity index 93% rename from rbi/whop_sdk/models/referral_referred_users_params.rbi rename to rbi/whop_sdk/models/partner_referred_users_params.rbi index 1658e42b..c60be7c8 100644 --- a/rbi/whop_sdk/models/referral_referred_users_params.rbi +++ b/rbi/whop_sdk/models/partner_referred_users_params.rbi @@ -2,16 +2,13 @@ module WhopSDK module Models - class ReferralReferredUsersParams < WhopSDK::Internal::Type::BaseModel + class PartnerReferredUsersParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters OrHash = T.type_alias do - T.any( - WhopSDK::ReferralReferredUsersParams, - WhopSDK::Internal::AnyHash - ) + T.any(WhopSDK::PartnerReferredUsersParams, WhopSDK::Internal::AnyHash) end # Cursor to fetch the page after (from page_info.end_cursor). diff --git a/rbi/whop_sdk/models/referral_referred_users_response.rbi b/rbi/whop_sdk/models/partner_referred_users_response.rbi similarity index 75% rename from rbi/whop_sdk/models/referral_referred_users_response.rbi rename to rbi/whop_sdk/models/partner_referred_users_response.rbi index 3fadd81b..09e9d0d1 100644 --- a/rbi/whop_sdk/models/referral_referred_users_response.rbi +++ b/rbi/whop_sdk/models/partner_referred_users_response.rbi @@ -2,27 +2,27 @@ module WhopSDK module Models - class ReferralReferredUsersResponse < WhopSDK::Internal::Type::BaseModel + class PartnerReferredUsersResponse < WhopSDK::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - WhopSDK::Models::ReferralReferredUsersResponse, + WhopSDK::Models::PartnerReferredUsersResponse, WhopSDK::Internal::AnyHash ) end sig do - returns(T::Array[WhopSDK::Models::ReferralReferredUsersResponse::Data]) + returns(T::Array[WhopSDK::Models::PartnerReferredUsersResponse::Data]) end attr_accessor :data - sig { returns(WhopSDK::Models::ReferralReferredUsersResponse::PageInfo) } + sig { returns(WhopSDK::Models::PartnerReferredUsersResponse::PageInfo) } attr_reader :page_info sig do params( page_info: - WhopSDK::Models::ReferralReferredUsersResponse::PageInfo::OrHash + WhopSDK::Models::PartnerReferredUsersResponse::PageInfo::OrHash ).void end attr_writer :page_info @@ -31,10 +31,10 @@ module WhopSDK params( data: T::Array[ - WhopSDK::Models::ReferralReferredUsersResponse::Data::OrHash + WhopSDK::Models::PartnerReferredUsersResponse::Data::OrHash ], page_info: - WhopSDK::Models::ReferralReferredUsersResponse::PageInfo::OrHash + WhopSDK::Models::PartnerReferredUsersResponse::PageInfo::OrHash ).returns(T.attached_class) end def self.new(data:, page_info:) @@ -43,9 +43,8 @@ module WhopSDK sig do override.returns( { - data: - T::Array[WhopSDK::Models::ReferralReferredUsersResponse::Data], - page_info: WhopSDK::Models::ReferralReferredUsersResponse::PageInfo + data: T::Array[WhopSDK::Models::PartnerReferredUsersResponse::Data], + page_info: WhopSDK::Models::PartnerReferredUsersResponse::PageInfo } ) end @@ -56,7 +55,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::ReferralReferredUsersResponse::Data, + WhopSDK::Models::PartnerReferredUsersResponse::Data, WhopSDK::Internal::AnyHash ) end @@ -68,14 +67,14 @@ module WhopSDK attr_accessor :total_volume_usd sig do - returns(WhopSDK::Models::ReferralReferredUsersResponse::Data::User) + returns(WhopSDK::Models::PartnerReferredUsersResponse::Data::User) end attr_reader :user sig do params( user: - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::OrHash + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::OrHash ).void end attr_writer :user @@ -85,7 +84,7 @@ module WhopSDK total_earnings_usd: String, total_volume_usd: String, user: - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::OrHash + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::OrHash ).returns(T.attached_class) end def self.new(total_earnings_usd:, total_volume_usd:, user:) @@ -96,7 +95,7 @@ module WhopSDK { total_earnings_usd: String, total_volume_usd: String, - user: WhopSDK::Models::ReferralReferredUsersResponse::Data::User + user: WhopSDK::Models::PartnerReferredUsersResponse::Data::User } ) end @@ -107,7 +106,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::ReferralReferredUsersResponse::Data::User, + WhopSDK::Models::PartnerReferredUsersResponse::Data::User, WhopSDK::Internal::AnyHash ) end @@ -130,7 +129,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture ) ) end @@ -139,7 +138,7 @@ module WhopSDK sig do params( profile_picture: - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture::OrHash + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture::OrHash ).void end attr_writer :profile_picture @@ -152,7 +151,7 @@ module WhopSDK country: T.nilable(String), name: T.nilable(String), profile_picture: - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture::OrHash + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture::OrHash ).returns(T.attached_class) end def self.new( @@ -174,7 +173,7 @@ module WhopSDK country: T.nilable(String), name: T.nilable(String), profile_picture: - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture } ) end @@ -185,7 +184,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture, + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture, WhopSDK::Internal::AnyHash ) end @@ -208,7 +207,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::ReferralReferredUsersResponse::PageInfo, + WhopSDK::Models::PartnerReferredUsersResponse::PageInfo, WhopSDK::Internal::AnyHash ) end diff --git a/rbi/whop_sdk/models/referrals/business_list_params.rbi b/rbi/whop_sdk/models/partners/business_list_params.rbi similarity index 71% rename from rbi/whop_sdk/models/referrals/business_list_params.rbi rename to rbi/whop_sdk/models/partners/business_list_params.rbi index 00cd20ee..97e92d77 100644 --- a/rbi/whop_sdk/models/referrals/business_list_params.rbi +++ b/rbi/whop_sdk/models/partners/business_list_params.rbi @@ -2,7 +2,7 @@ module WhopSDK module Models - module Referrals + module Partners class BusinessListParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters @@ -10,7 +10,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Referrals::BusinessListParams, + WhopSDK::Partners::BusinessListParams, WhopSDK::Internal::AnyHash ) end @@ -29,14 +29,14 @@ module WhopSDK sig { params(before: String).void } attr_writer :before - # Only return business referrals created after this timestamp. + # Only return partner businesses created after this timestamp. sig { returns(T.nilable(String)) } attr_reader :created_after sig { params(created_after: String).void } attr_writer :created_after - # Only return business referrals created before this timestamp. + # Only return partner businesses created before this timestamp. sig { returns(T.nilable(String)) } attr_reader :created_before @@ -47,7 +47,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Referrals::BusinessListParams::Direction::OrSymbol + WhopSDK::Partners::BusinessListParams::Direction::OrSymbol ) ) end @@ -56,12 +56,12 @@ module WhopSDK sig do params( direction: - WhopSDK::Referrals::BusinessListParams::Direction::OrSymbol + WhopSDK::Partners::BusinessListParams::Direction::OrSymbol ).void end attr_writer :direction - # Number of business referrals to return from the start of the window. + # Number of partner businesses to return from the start of the window. sig { returns(T.nilable(Integer)) } attr_reader :first @@ -76,24 +76,24 @@ module WhopSDK sig { params(has_earnings: T::Boolean).void } attr_writer :has_earnings - # Number of business referrals to return from the end of the window. + # Number of partner businesses to return from the end of the window. sig { returns(T.nilable(Integer)) } attr_reader :last sig { params(last: Integer).void } attr_writer :last - # The field to sort business referrals by. + # The field to sort partner businesses by. sig do returns( - T.nilable(WhopSDK::Referrals::BusinessListParams::Order::OrSymbol) + T.nilable(WhopSDK::Partners::BusinessListParams::Order::OrSymbol) ) end attr_reader :order sig do params( - order: WhopSDK::Referrals::BusinessListParams::Order::OrSymbol + order: WhopSDK::Partners::BusinessListParams::Order::OrSymbol ).void end attr_writer :order @@ -118,14 +118,14 @@ module WhopSDK # Filter by referral status. sig do returns( - T.nilable(WhopSDK::Referrals::BusinessListParams::Status::OrSymbol) + T.nilable(WhopSDK::Partners::BusinessListParams::Status::OrSymbol) ) end attr_reader :status sig do params( - status: WhopSDK::Referrals::BusinessListParams::Status::OrSymbol + status: WhopSDK::Partners::BusinessListParams::Status::OrSymbol ).void end attr_writer :status @@ -133,14 +133,14 @@ module WhopSDK # Filter to only first-tier referrals or only second-tier referrals. sig do returns( - T.nilable(WhopSDK::Referrals::BusinessListParams::Tier::OrSymbol) + T.nilable(WhopSDK::Partners::BusinessListParams::Tier::OrSymbol) ) end attr_reader :tier sig do params( - tier: WhopSDK::Referrals::BusinessListParams::Tier::OrSymbol + tier: WhopSDK::Partners::BusinessListParams::Tier::OrSymbol ).void end attr_writer :tier @@ -152,15 +152,15 @@ module WhopSDK created_after: String, created_before: String, direction: - WhopSDK::Referrals::BusinessListParams::Direction::OrSymbol, + WhopSDK::Partners::BusinessListParams::Direction::OrSymbol, first: Integer, has_earnings: T::Boolean, last: Integer, - order: WhopSDK::Referrals::BusinessListParams::Order::OrSymbol, + order: WhopSDK::Partners::BusinessListParams::Order::OrSymbol, referred_user_id: String, referred_username: String, - status: WhopSDK::Referrals::BusinessListParams::Status::OrSymbol, - tier: WhopSDK::Referrals::BusinessListParams::Tier::OrSymbol, + status: WhopSDK::Partners::BusinessListParams::Status::OrSymbol, + tier: WhopSDK::Partners::BusinessListParams::Tier::OrSymbol, request_options: WhopSDK::RequestOptions::OrHash ).returns(T.attached_class) end @@ -169,20 +169,20 @@ module WhopSDK after: nil, # Cursor to fetch the page before (from page_info.start_cursor). before: nil, - # Only return business referrals created after this timestamp. + # Only return partner businesses created after this timestamp. created_after: nil, - # Only return business referrals created before this timestamp. + # Only return partner businesses created before this timestamp. created_before: nil, # Sort direction. direction: nil, - # Number of business referrals to return from the start of the window. + # Number of partner businesses to return from the start of the window. first: nil, # When true, only businesses with pending or completed earnings paid to the # caller. has_earnings: nil, - # Number of business referrals to return from the end of the window. + # Number of partner businesses to return from the end of the window. last: nil, - # The field to sort business referrals by. + # The field to sort partner businesses by. order: nil, # Filter to referrals attributed to this user. For first-tier referrals, this is # the referred account owner; for second-tier referrals, this is the partner you @@ -207,15 +207,15 @@ module WhopSDK created_after: String, created_before: String, direction: - WhopSDK::Referrals::BusinessListParams::Direction::OrSymbol, + WhopSDK::Partners::BusinessListParams::Direction::OrSymbol, first: Integer, has_earnings: T::Boolean, last: Integer, - order: WhopSDK::Referrals::BusinessListParams::Order::OrSymbol, + order: WhopSDK::Partners::BusinessListParams::Order::OrSymbol, referred_user_id: String, referred_username: String, - status: WhopSDK::Referrals::BusinessListParams::Status::OrSymbol, - tier: WhopSDK::Referrals::BusinessListParams::Tier::OrSymbol, + status: WhopSDK::Partners::BusinessListParams::Status::OrSymbol, + tier: WhopSDK::Partners::BusinessListParams::Tier::OrSymbol, request_options: WhopSDK::RequestOptions } ) @@ -229,25 +229,25 @@ module WhopSDK TaggedSymbol = T.type_alias do - T.all(Symbol, WhopSDK::Referrals::BusinessListParams::Direction) + T.all(Symbol, WhopSDK::Partners::BusinessListParams::Direction) end OrSymbol = T.type_alias { T.any(Symbol, String) } ASC = T.let( :asc, - WhopSDK::Referrals::BusinessListParams::Direction::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Direction::TaggedSymbol ) DESC = T.let( :desc, - WhopSDK::Referrals::BusinessListParams::Direction::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Direction::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Referrals::BusinessListParams::Direction::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Direction::TaggedSymbol ] ) end @@ -255,51 +255,51 @@ module WhopSDK end end - # The field to sort business referrals by. + # The field to sort partner businesses by. module Order extend WhopSDK::Internal::Type::Enum TaggedSymbol = T.type_alias do - T.all(Symbol, WhopSDK::Referrals::BusinessListParams::Order) + T.all(Symbol, WhopSDK::Partners::BusinessListParams::Order) end OrSymbol = T.type_alias { T.any(Symbol, String) } CREATED_AT = T.let( :created_at, - WhopSDK::Referrals::BusinessListParams::Order::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Order::TaggedSymbol ) REFERRAL_STARTED_AT = T.let( :referral_started_at, - WhopSDK::Referrals::BusinessListParams::Order::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Order::TaggedSymbol ) REFERRAL_EXPIRES_AT = T.let( :referral_expires_at, - WhopSDK::Referrals::BusinessListParams::Order::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Order::TaggedSymbol ) PAYOUT_PERCENTAGE = T.let( :payout_percentage, - WhopSDK::Referrals::BusinessListParams::Order::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Order::TaggedSymbol ) VOLUME_USD = T.let( :volume_usd, - WhopSDK::Referrals::BusinessListParams::Order::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Order::TaggedSymbol ) EARNINGS_USD = T.let( :earnings_usd, - WhopSDK::Referrals::BusinessListParams::Order::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Order::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Referrals::BusinessListParams::Order::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Order::TaggedSymbol ] ) end @@ -313,25 +313,25 @@ module WhopSDK TaggedSymbol = T.type_alias do - T.all(Symbol, WhopSDK::Referrals::BusinessListParams::Status) + T.all(Symbol, WhopSDK::Partners::BusinessListParams::Status) end OrSymbol = T.type_alias { T.any(Symbol, String) } ACTIVE = T.let( :active, - WhopSDK::Referrals::BusinessListParams::Status::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Status::TaggedSymbol ) REMOVED = T.let( :removed, - WhopSDK::Referrals::BusinessListParams::Status::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Status::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Referrals::BusinessListParams::Status::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Status::TaggedSymbol ] ) end @@ -345,25 +345,25 @@ module WhopSDK TaggedSymbol = T.type_alias do - T.all(Symbol, WhopSDK::Referrals::BusinessListParams::Tier) + T.all(Symbol, WhopSDK::Partners::BusinessListParams::Tier) end OrSymbol = T.type_alias { T.any(Symbol, String) } FIRST = T.let( :first, - WhopSDK::Referrals::BusinessListParams::Tier::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Tier::TaggedSymbol ) SECOND = T.let( :second, - WhopSDK::Referrals::BusinessListParams::Tier::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Tier::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Referrals::BusinessListParams::Tier::TaggedSymbol + WhopSDK::Partners::BusinessListParams::Tier::TaggedSymbol ] ) end diff --git a/rbi/whop_sdk/models/referrals/business_list_response.rbi b/rbi/whop_sdk/models/partners/business_list_response.rbi similarity index 75% rename from rbi/whop_sdk/models/referrals/business_list_response.rbi rename to rbi/whop_sdk/models/partners/business_list_response.rbi index e7dbb10f..4144e57c 100644 --- a/rbi/whop_sdk/models/referrals/business_list_response.rbi +++ b/rbi/whop_sdk/models/partners/business_list_response.rbi @@ -2,24 +2,24 @@ module WhopSDK module Models - module Referrals + module Partners class BusinessListResponse < WhopSDK::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse, + WhopSDK::Models::Partners::BusinessListResponse, WhopSDK::Internal::AnyHash ) end - # Business referral ID. + # Partner business ID. sig { returns(String) } attr_accessor :id # Referred account. sig do returns( - T.nilable(WhopSDK::Models::Referrals::BusinessListResponse::Account) + T.nilable(WhopSDK::Models::Partners::BusinessListResponse::Account) ) end attr_reader :account @@ -28,25 +28,25 @@ module WhopSDK params( account: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::Account::OrHash + WhopSDK::Models::Partners::BusinessListResponse::Account::OrHash ) ).void end attr_writer :account - # When the business referral was created. + # When the partner business was created. sig { returns(Time) } attr_accessor :created_at sig do - returns(WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd) + returns(WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd) end attr_reader :earnings_usd sig do params( earnings_usd: - WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd::OrHash + WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd::OrHash ).void end attr_writer :earnings_usd @@ -56,7 +56,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner ) ) end @@ -66,7 +66,7 @@ module WhopSDK params( first_tier_partner: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::OrHash + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::OrHash ) ).void end @@ -76,14 +76,14 @@ module WhopSDK # owner) or `second` (they referred the first-tier partner). sig do returns( - WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier::TaggedSymbol ) end attr_accessor :my_partner_tier sig do returns( - WhopSDK::Models::Referrals::BusinessListResponse::Object::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::Object::TaggedSymbol ) end attr_accessor :object @@ -91,7 +91,7 @@ module WhopSDK # The owner of the referred business. sig do returns( - T.nilable(WhopSDK::Models::Referrals::BusinessListResponse::Owner) + T.nilable(WhopSDK::Models::Partners::BusinessListResponse::Owner) ) end attr_reader :owner @@ -100,7 +100,7 @@ module WhopSDK params( owner: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::Owner::OrHash + WhopSDK::Models::Partners::BusinessListResponse::Owner::OrHash ) ).void end @@ -122,20 +122,20 @@ module WhopSDK # Current referral status. sig do returns( - WhopSDK::Models::Referrals::BusinessListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::Status::TaggedSymbol ) end attr_accessor :status sig do - returns(WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd) + returns(WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd) end attr_reader :volume_usd sig do params( volume_usd: - WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd::OrHash + WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd::OrHash ).void end attr_writer :volume_usd @@ -145,38 +145,38 @@ module WhopSDK id: String, account: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::Account::OrHash + WhopSDK::Models::Partners::BusinessListResponse::Account::OrHash ), created_at: Time, earnings_usd: - WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd::OrHash, + WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd::OrHash, first_tier_partner: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::OrHash + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::OrHash ), my_partner_tier: - WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier::OrSymbol, + WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier::OrSymbol, object: - WhopSDK::Models::Referrals::BusinessListResponse::Object::OrSymbol, + WhopSDK::Models::Partners::BusinessListResponse::Object::OrSymbol, owner: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::Owner::OrHash + WhopSDK::Models::Partners::BusinessListResponse::Owner::OrHash ), payout_percentage: Float, referral_expires_at: T.nilable(Time), referral_started_at: T.nilable(Time), status: - WhopSDK::Models::Referrals::BusinessListResponse::Status::OrSymbol, + WhopSDK::Models::Partners::BusinessListResponse::Status::OrSymbol, volume_usd: - WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd::OrHash + WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd::OrHash ).returns(T.attached_class) end def self.new( - # Business referral ID. + # Partner business ID. id:, # Referred account. account:, - # When the business referral was created. + # When the partner business was created. created_at:, earnings_usd:, # The partner who referred the business owner onto Whop (first tier). Null if @@ -207,30 +207,30 @@ module WhopSDK id: String, account: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::Account + WhopSDK::Models::Partners::BusinessListResponse::Account ), created_at: Time, earnings_usd: - WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd, + WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd, first_tier_partner: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner ), my_partner_tier: - WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier::TaggedSymbol, + WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier::TaggedSymbol, object: - WhopSDK::Models::Referrals::BusinessListResponse::Object::TaggedSymbol, + WhopSDK::Models::Partners::BusinessListResponse::Object::TaggedSymbol, owner: T.nilable( - WhopSDK::Models::Referrals::BusinessListResponse::Owner + WhopSDK::Models::Partners::BusinessListResponse::Owner ), payout_percentage: Float, referral_expires_at: T.nilable(Time), referral_started_at: T.nilable(Time), status: - WhopSDK::Models::Referrals::BusinessListResponse::Status::TaggedSymbol, + WhopSDK::Models::Partners::BusinessListResponse::Status::TaggedSymbol, volume_usd: - WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd + WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd } ) end @@ -241,7 +241,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse::Account, + WhopSDK::Models::Partners::BusinessListResponse::Account, WhopSDK::Internal::AnyHash ) end @@ -301,7 +301,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd, + WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd, WhopSDK::Internal::AnyHash ) end @@ -346,7 +346,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner, + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner, WhopSDK::Internal::AnyHash ) end @@ -362,7 +362,7 @@ module WhopSDK # The user's profile picture. sig do returns( - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture ) end attr_reader :profile_picture @@ -370,7 +370,7 @@ module WhopSDK sig do params( profile_picture: - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture::OrHash + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture::OrHash ).void end attr_writer :profile_picture @@ -386,7 +386,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture::OrHash, + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture::OrHash, username: String ).returns(T.attached_class) end @@ -408,7 +408,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture, + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture, username: String } ) @@ -420,7 +420,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture, + WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture, WhopSDK::Internal::AnyHash ) end @@ -452,7 +452,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier + WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -460,18 +460,18 @@ module WhopSDK FIRST = T.let( :first, - WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier::TaggedSymbol ) SECOND = T.let( :second, - WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier::TaggedSymbol ] ) end @@ -486,21 +486,21 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessListResponse::Object + WhopSDK::Models::Partners::BusinessListResponse::Object ) end OrSymbol = T.type_alias { T.any(Symbol, String) } - BUSINESS_REFERRAL = + PARTNER_BUSINESS = T.let( - :business_referral, - WhopSDK::Models::Referrals::BusinessListResponse::Object::TaggedSymbol + :partner_business, + WhopSDK::Models::Partners::BusinessListResponse::Object::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessListResponse::Object::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::Object::TaggedSymbol ] ) end @@ -512,7 +512,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse::Owner, + WhopSDK::Models::Partners::BusinessListResponse::Owner, WhopSDK::Internal::AnyHash ) end @@ -528,7 +528,7 @@ module WhopSDK # The user's profile picture. sig do returns( - WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture + WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture ) end attr_reader :profile_picture @@ -536,7 +536,7 @@ module WhopSDK sig do params( profile_picture: - WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture::OrHash + WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture::OrHash ).void end attr_writer :profile_picture @@ -551,7 +551,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture::OrHash, + WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture::OrHash, username: String ).returns(T.attached_class) end @@ -573,7 +573,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture, + WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture, username: String } ) @@ -585,7 +585,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture, + WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture, WhopSDK::Internal::AnyHash ) end @@ -616,7 +616,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessListResponse::Status + WhopSDK::Models::Partners::BusinessListResponse::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -624,18 +624,18 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::Status::TaggedSymbol ) REMOVED = T.let( :removed, - WhopSDK::Models::Referrals::BusinessListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::Status::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessListResponse::Status::TaggedSymbol ] ) end @@ -647,7 +647,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd, + WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd, WhopSDK::Internal::AnyHash ) end diff --git a/rbi/whop_sdk/models/referrals/business_retrieve_params.rbi b/rbi/whop_sdk/models/partners/business_retrieve_params.rbi similarity index 91% rename from rbi/whop_sdk/models/referrals/business_retrieve_params.rbi rename to rbi/whop_sdk/models/partners/business_retrieve_params.rbi index dfedb4b3..1e49d543 100644 --- a/rbi/whop_sdk/models/referrals/business_retrieve_params.rbi +++ b/rbi/whop_sdk/models/partners/business_retrieve_params.rbi @@ -2,7 +2,7 @@ module WhopSDK module Models - module Referrals + module Partners class BusinessRetrieveParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters @@ -10,7 +10,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Referrals::BusinessRetrieveParams, + WhopSDK::Partners::BusinessRetrieveParams, WhopSDK::Internal::AnyHash ) end diff --git a/rbi/whop_sdk/models/referrals/business_retrieve_response.rbi b/rbi/whop_sdk/models/partners/business_retrieve_response.rbi similarity index 65% rename from rbi/whop_sdk/models/referrals/business_retrieve_response.rbi rename to rbi/whop_sdk/models/partners/business_retrieve_response.rbi index 8b3f14a2..dfcea6e3 100644 --- a/rbi/whop_sdk/models/referrals/business_retrieve_response.rbi +++ b/rbi/whop_sdk/models/partners/business_retrieve_response.rbi @@ -2,17 +2,17 @@ module WhopSDK module Models - module Referrals + module Partners class BusinessRetrieveResponse < WhopSDK::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse, + WhopSDK::Models::Partners::BusinessRetrieveResponse, WhopSDK::Internal::AnyHash ) end - # Business referral ID. + # Partner business ID. sig { returns(String) } attr_accessor :id @@ -20,7 +20,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account ) ) end @@ -30,19 +30,19 @@ module WhopSDK params( account: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::OrHash ) ).void end attr_writer :account - # When the business referral was created. + # When the partner business was created. sig { returns(Time) } attr_accessor :created_at sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd + WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd ) end attr_reader :earnings_usd @@ -50,7 +50,7 @@ module WhopSDK sig do params( earnings_usd: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd::OrHash ).void end attr_writer :earnings_usd @@ -60,7 +60,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner ) ) end @@ -70,7 +70,7 @@ module WhopSDK params( first_tier_partner: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::OrHash ) ).void end @@ -80,14 +80,14 @@ module WhopSDK # owner) or `second` (they referred the first-tier partner). sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol ) end attr_accessor :my_partner_tier sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Object::TaggedSymbol ) end attr_accessor :object @@ -96,7 +96,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner ) ) end @@ -106,7 +106,7 @@ module WhopSDK params( owner: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::OrHash ) ).void end @@ -128,14 +128,14 @@ module WhopSDK # Current referral status. sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Status::TaggedSymbol ) end attr_accessor :status sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd + WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd ) end attr_reader :volume_usd @@ -143,7 +143,7 @@ module WhopSDK sig do params( volume_usd: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd::OrHash ).void end attr_writer :volume_usd @@ -153,38 +153,38 @@ module WhopSDK id: String, account: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::OrHash ), created_at: Time, earnings_usd: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd::OrHash, + WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd::OrHash, first_tier_partner: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::OrHash ), my_partner_tier: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier::OrSymbol, object: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Object::OrSymbol, owner: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::OrHash ), payout_percentage: Float, referral_expires_at: T.nilable(Time), referral_started_at: T.nilable(Time), status: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Status::OrSymbol, volume_usd: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd::OrHash ).returns(T.attached_class) end def self.new( - # Business referral ID. + # Partner business ID. id:, # Referred account. account:, - # When the business referral was created. + # When the partner business was created. created_at:, earnings_usd:, # The partner who referred the business owner onto Whop (first tier). Null if @@ -215,30 +215,30 @@ module WhopSDK id: String, account: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account ), created_at: Time, earnings_usd: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd, + WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd, first_tier_partner: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner ), my_partner_tier: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol, object: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Object::TaggedSymbol, owner: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner ), payout_percentage: Float, referral_expires_at: T.nilable(Time), referral_started_at: T.nilable(Time), status: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Status::TaggedSymbol, volume_usd: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd + WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd } ) end @@ -249,7 +249,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account, WhopSDK::Internal::AnyHash ) end @@ -261,7 +261,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities ) ) end @@ -271,7 +271,7 @@ module WhopSDK params( capabilities: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::OrHash ) ).void end @@ -286,7 +286,7 @@ module WhopSDK returns( T.nilable( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction ] ) ) @@ -298,7 +298,7 @@ module WhopSDK returns( T.nilable( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction ] ) ) @@ -319,19 +319,19 @@ module WhopSDK id: String, capabilities: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::OrHash ), logo_url: T.nilable(String), recommended_actions: T.nilable( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::OrHash ] ), required_actions: T.nilable( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::OrHash ] ), route: String, @@ -361,19 +361,19 @@ module WhopSDK id: String, capabilities: T.nilable( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities ), logo_url: T.nilable(String), recommended_actions: T.nilable( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction ] ), required_actions: T.nilable( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction ] ), route: String, @@ -388,7 +388,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities, WhopSDK::Internal::AnyHash ) end @@ -396,7 +396,7 @@ module WhopSDK # Bank payins: debits, transfers, and local bank rails sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol ) end attr_accessor :accept_bank_payments @@ -404,7 +404,7 @@ module WhopSDK # Buy-now-pay-later payins; requires approval sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol ) end attr_accessor :accept_bnpl_payments @@ -412,7 +412,7 @@ module WhopSDK # Card payins, including Apple Pay and Google Pay sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol ) end attr_accessor :accept_card_payments @@ -420,7 +420,7 @@ module WhopSDK # Deposits by bank wire or ACH to the account's virtual bank account sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol ) end attr_accessor :bank_deposit @@ -428,7 +428,7 @@ module WhopSDK # Balance top-ups by charging a stored payment method sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol ) end attr_accessor :card_deposit @@ -436,7 +436,7 @@ module WhopSDK # Issuing Whop cards; requires card application approval sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol ) end attr_accessor :card_issuing @@ -444,7 +444,7 @@ module WhopSDK # On-chain deposits to the account's crypto wallet sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol ) end attr_accessor :crypto_deposit @@ -452,7 +452,7 @@ module WhopSDK # On-chain payouts to a crypto wallet sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol ) end attr_accessor :crypto_payout @@ -460,7 +460,7 @@ module WhopSDK # Instant payouts to an eligible payout destination sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol ) end attr_accessor :instant_payout @@ -468,7 +468,7 @@ module WhopSDK # Standard payouts to an external payout destination sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol ) end attr_accessor :standard_payout @@ -476,7 +476,7 @@ module WhopSDK # Transfers to other accounts sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol ) end attr_accessor :transfer @@ -484,27 +484,27 @@ module WhopSDK sig do params( accept_bank_payments: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::OrSymbol, accept_bnpl_payments: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::OrSymbol, accept_card_payments: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::OrSymbol, bank_deposit: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::OrSymbol, card_deposit: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::OrSymbol, card_issuing: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::OrSymbol, crypto_deposit: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::OrSymbol, crypto_payout: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::OrSymbol, instant_payout: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::OrSymbol, standard_payout: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::OrSymbol, transfer: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer::OrSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer::OrSymbol ).returns(T.attached_class) end def self.new( @@ -537,27 +537,27 @@ module WhopSDK override.returns( { accept_bank_payments: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol, accept_bnpl_payments: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol, accept_card_payments: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol, bank_deposit: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol, card_deposit: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol, card_issuing: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol, crypto_deposit: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol, crypto_payout: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol, instant_payout: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol, standard_payout: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol, transfer: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol } ) end @@ -572,7 +572,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -580,23 +580,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBankPayments::TaggedSymbol ] ) end @@ -612,7 +612,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -620,23 +620,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptBnplPayments::TaggedSymbol ] ) end @@ -652,7 +652,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -660,23 +660,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::AcceptCardPayments::TaggedSymbol ] ) end @@ -692,7 +692,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -700,23 +700,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::BankDeposit::TaggedSymbol ] ) end @@ -732,7 +732,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -740,23 +740,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardDeposit::TaggedSymbol ] ) end @@ -772,7 +772,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -780,23 +780,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CardIssuing::TaggedSymbol ] ) end @@ -812,7 +812,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -820,23 +820,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoDeposit::TaggedSymbol ] ) end @@ -852,7 +852,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -860,23 +860,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::CryptoPayout::TaggedSymbol ] ) end @@ -892,7 +892,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -900,23 +900,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::InstantPayout::TaggedSymbol ] ) end @@ -932,7 +932,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -940,23 +940,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::StandardPayout::TaggedSymbol ] ) end @@ -972,7 +972,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -980,23 +980,23 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol ) INACTIVE = T.let( :inactive, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::Transfer::TaggedSymbol ] ) end @@ -1009,7 +1009,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction, WhopSDK::Internal::AnyHash ) end @@ -1018,7 +1018,7 @@ module WhopSDK # gracefully sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) end attr_accessor :action @@ -1042,19 +1042,18 @@ module WhopSDK sig { returns(T.nilable(String)) } attr_accessor :icon_url - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked sig { returns(T.nilable(Integer)) } attr_accessor :impact_score - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` sig { returns(T.nilable(String)) } attr_accessor :reasoning # Always optional — never blocking sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol ) end attr_accessor :status @@ -1066,7 +1065,7 @@ module WhopSDK sig do params( action: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::OrSymbol, blocked_capabilities: T::Array[String], cta: String, cta_label: String, @@ -1075,7 +1074,7 @@ module WhopSDK impact_score: T.nilable(Integer), reasoning: T.nilable(String), status: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status::OrSymbol, title: String ).returns(T.attached_class) end @@ -1092,10 +1091,9 @@ module WhopSDK description:, # Illustration icon URL, or `null` icon_url:, - # Estimated revenue impact from 0-100, comparable across accounts, or `null` when - # not ranked + # Estimated impact from 0-100, or `null` when not ranked impact_score:, - # Why this action was recommended for this account, or `null` + # Why this action was recommended, or `null` reasoning:, # Always optional — never blocking status:, @@ -1108,7 +1106,7 @@ module WhopSDK override.returns( { action: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol, blocked_capabilities: T::Array[String], cta: String, cta_label: String, @@ -1117,7 +1115,7 @@ module WhopSDK impact_score: T.nilable(Integer), reasoning: T.nilable(String), status: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol, title: String } ) @@ -1134,7 +1132,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1142,83 +1140,83 @@ module WhopSDK THEME_BUSINESS = T.let( :theme_business, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) CREATE_PRODUCT = T.let( :create_product, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) CREATE_PLAN = T.let( :create_plan, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) VERIFY_IDENTITY = T.let( :verify_identity, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) CONNECT_AFFILIATE_PROGRAM = T.let( :connect_affiliate_program, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) CREATE_PROMOTION = T.let( :create_promotion, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) SETUP_TRACKING_PIXEL = T.let( :setup_tracking_pixel, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) MIGRATE_FROM_STRIPE = T.let( :migrate_from_stripe, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) ACCEPT_FIRST_PAYMENT = T.let( :accept_first_payment, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) LAUNCH_FIRST_AD = T.let( :launch_first_ad, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) INVITE_TEAM_MEMBER = T.let( :invite_team_member, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) ENABLE_TAX_COLLECTION = T.let( :enable_tax_collection, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) CREATE_CARD = T.let( :create_card, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) JOIN_WHOP_UNIVERSITY = T.let( :join_whop_university, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) APPLY_FOR_FINANCING = T.let( :apply_for_financing, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Action::TaggedSymbol ] ) end @@ -1234,7 +1232,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1242,13 +1240,13 @@ module WhopSDK OPTIONAL = T.let( :optional, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::Status::TaggedSymbol ] ) end @@ -1261,7 +1259,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction, WhopSDK::Internal::AnyHash ) end @@ -1270,7 +1268,7 @@ module WhopSDK # gracefully sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol ) end attr_accessor :action @@ -1297,7 +1295,7 @@ module WhopSDK # required (act now) or pending (under review) sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol ) end attr_accessor :status @@ -1309,14 +1307,14 @@ module WhopSDK sig do params( action: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::OrSymbol, blocked_capabilities: T::Array[String], cta: T.nilable(String), cta_label: String, description: String, icon_url: T.nilable(String), status: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status::OrSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status::OrSymbol, title: String ).returns(T.attached_class) end @@ -1344,14 +1342,14 @@ module WhopSDK override.returns( { action: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol, blocked_capabilities: T::Array[String], cta: T.nilable(String), cta_label: String, description: String, icon_url: T.nilable(String), status: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol, title: String } ) @@ -1368,7 +1366,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1376,28 +1374,28 @@ module WhopSDK DEPOSIT_FUNDS = T.let( :deposit_funds, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol ) SUBMIT_INFORMATION_REQUEST = T.let( :submit_information_request, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol ) VERIFY_IDENTITY = T.let( :verify_identity, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol ) CONNECT_FULFILLMENT_TRACKER = T.let( :connect_fulfillment_tracker, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Action::TaggedSymbol ] ) end @@ -1413,7 +1411,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1421,18 +1419,18 @@ module WhopSDK REQUIRED = T.let( :required, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::Status::TaggedSymbol ] ) end @@ -1446,7 +1444,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd, + WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd, WhopSDK::Internal::AnyHash ) end @@ -1491,7 +1489,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner, + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner, WhopSDK::Internal::AnyHash ) end @@ -1507,7 +1505,7 @@ module WhopSDK # The user's profile picture. sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture ) end attr_reader :profile_picture @@ -1515,7 +1513,7 @@ module WhopSDK sig do params( profile_picture: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture::OrHash ).void end attr_writer :profile_picture @@ -1531,7 +1529,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture::OrHash, + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture::OrHash, username: String ).returns(T.attached_class) end @@ -1553,7 +1551,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, username: String } ) @@ -1565,7 +1563,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, + WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, WhopSDK::Internal::AnyHash ) end @@ -1597,7 +1595,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier + WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1605,18 +1603,18 @@ module WhopSDK FIRST = T.let( :first, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol ) SECOND = T.let( :second, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier::TaggedSymbol ] ) end @@ -1631,21 +1629,21 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object + WhopSDK::Models::Partners::BusinessRetrieveResponse::Object ) end OrSymbol = T.type_alias { T.any(Symbol, String) } - BUSINESS_REFERRAL = + PARTNER_BUSINESS = T.let( - :business_referral, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object::TaggedSymbol + :partner_business, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Object::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Object::TaggedSymbol ] ) end @@ -1657,7 +1655,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner, WhopSDK::Internal::AnyHash ) end @@ -1673,7 +1671,7 @@ module WhopSDK # The user's profile picture. sig do returns( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture ) end attr_reader :profile_picture @@ -1681,7 +1679,7 @@ module WhopSDK sig do params( profile_picture: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture::OrHash + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture::OrHash ).void end attr_writer :profile_picture @@ -1696,7 +1694,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture::OrHash, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture::OrHash, username: String ).returns(T.attached_class) end @@ -1718,7 +1716,7 @@ module WhopSDK id: String, name: T.nilable(String), profile_picture: - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture, username: String } ) @@ -1730,7 +1728,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture, + WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture, WhopSDK::Internal::AnyHash ) end @@ -1761,7 +1759,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status + WhopSDK::Models::Partners::BusinessRetrieveResponse::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -1769,18 +1767,18 @@ module WhopSDK ACTIVE = T.let( :active, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Status::TaggedSymbol ) REMOVED = T.let( :removed, - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Status::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::BusinessRetrieveResponse::Status::TaggedSymbol ] ) end @@ -1792,7 +1790,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd, + WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd, WhopSDK::Internal::AnyHash ) end diff --git a/rbi/whop_sdk/models/referrals/businesses/earning_list_params.rbi b/rbi/whop_sdk/models/partners/businesses/earning_list_params.rbi similarity index 71% rename from rbi/whop_sdk/models/referrals/businesses/earning_list_params.rbi rename to rbi/whop_sdk/models/partners/businesses/earning_list_params.rbi index a8fe56a2..2fdaf6a3 100644 --- a/rbi/whop_sdk/models/referrals/businesses/earning_list_params.rbi +++ b/rbi/whop_sdk/models/partners/businesses/earning_list_params.rbi @@ -2,7 +2,7 @@ module WhopSDK module Models - module Referrals + module Partners module Businesses class EarningListParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter @@ -11,7 +11,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Referrals::Businesses::EarningListParams, + WhopSDK::Partners::Businesses::EarningListParams, WhopSDK::Internal::AnyHash ) end @@ -49,7 +49,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Referrals::Businesses::EarningListParams::Direction::OrSymbol + WhopSDK::Partners::Businesses::EarningListParams::Direction::OrSymbol ) ) end @@ -58,7 +58,7 @@ module WhopSDK sig do params( direction: - WhopSDK::Referrals::Businesses::EarningListParams::Direction::OrSymbol + WhopSDK::Partners::Businesses::EarningListParams::Direction::OrSymbol ).void end attr_writer :direction @@ -79,7 +79,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Referrals::Businesses::EarningListParams::Order::OrSymbol + WhopSDK::Partners::Businesses::EarningListParams::Order::OrSymbol ) ) end @@ -88,7 +88,7 @@ module WhopSDK sig do params( order: - WhopSDK::Referrals::Businesses::EarningListParams::Order::OrSymbol + WhopSDK::Partners::Businesses::EarningListParams::Order::OrSymbol ).void end attr_writer :order @@ -97,7 +97,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Referrals::Businesses::EarningListParams::Status::OrSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::OrSymbol ) ) end @@ -106,7 +106,7 @@ module WhopSDK sig do params( status: - WhopSDK::Referrals::Businesses::EarningListParams::Status::OrSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::OrSymbol ).void end attr_writer :status @@ -119,13 +119,13 @@ module WhopSDK created_after: String, created_before: String, direction: - WhopSDK::Referrals::Businesses::EarningListParams::Direction::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Direction::OrSymbol, first: Integer, last: Integer, order: - WhopSDK::Referrals::Businesses::EarningListParams::Order::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Order::OrSymbol, status: - WhopSDK::Referrals::Businesses::EarningListParams::Status::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Status::OrSymbol, request_options: WhopSDK::RequestOptions::OrHash ).returns(T.attached_class) end @@ -158,13 +158,13 @@ module WhopSDK created_after: String, created_before: String, direction: - WhopSDK::Referrals::Businesses::EarningListParams::Direction::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Direction::OrSymbol, first: Integer, last: Integer, order: - WhopSDK::Referrals::Businesses::EarningListParams::Order::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Order::OrSymbol, status: - WhopSDK::Referrals::Businesses::EarningListParams::Status::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Status::OrSymbol, request_options: WhopSDK::RequestOptions } ) @@ -180,7 +180,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Referrals::Businesses::EarningListParams::Direction + WhopSDK::Partners::Businesses::EarningListParams::Direction ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -188,18 +188,18 @@ module WhopSDK ASC = T.let( :asc, - WhopSDK::Referrals::Businesses::EarningListParams::Direction::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Direction::TaggedSymbol ) DESC = T.let( :desc, - WhopSDK::Referrals::Businesses::EarningListParams::Direction::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Direction::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Referrals::Businesses::EarningListParams::Direction::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Direction::TaggedSymbol ] ) end @@ -215,7 +215,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Referrals::Businesses::EarningListParams::Order + WhopSDK::Partners::Businesses::EarningListParams::Order ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -223,28 +223,28 @@ module WhopSDK CREATED_AT = T.let( :created_at, - WhopSDK::Referrals::Businesses::EarningListParams::Order::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Order::TaggedSymbol ) COMMISSION_AMOUNT = T.let( :commission_amount, - WhopSDK::Referrals::Businesses::EarningListParams::Order::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Order::TaggedSymbol ) TRANSACTION_AMOUNT = T.let( :transaction_amount, - WhopSDK::Referrals::Businesses::EarningListParams::Order::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Order::TaggedSymbol ) PAYOUT_AT = T.let( :payout_at, - WhopSDK::Referrals::Businesses::EarningListParams::Order::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Order::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Referrals::Businesses::EarningListParams::Order::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Order::TaggedSymbol ] ) end @@ -260,7 +260,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Referrals::Businesses::EarningListParams::Status + WhopSDK::Partners::Businesses::EarningListParams::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -268,33 +268,33 @@ module WhopSDK AWAITING_SETTLEMENT = T.let( :awaiting_settlement, - WhopSDK::Referrals::Businesses::EarningListParams::Status::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Referrals::Businesses::EarningListParams::Status::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::TaggedSymbol ) COMPLETED = T.let( :completed, - WhopSDK::Referrals::Businesses::EarningListParams::Status::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::TaggedSymbol ) CANCELED = T.let( :canceled, - WhopSDK::Referrals::Businesses::EarningListParams::Status::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::TaggedSymbol ) REVERSED = T.let( :reversed, - WhopSDK::Referrals::Businesses::EarningListParams::Status::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Referrals::Businesses::EarningListParams::Status::TaggedSymbol + WhopSDK::Partners::Businesses::EarningListParams::Status::TaggedSymbol ] ) end diff --git a/rbi/whop_sdk/models/referrals/businesses/earning_list_response.rbi b/rbi/whop_sdk/models/partners/businesses/earning_list_response.rbi similarity index 75% rename from rbi/whop_sdk/models/referrals/businesses/earning_list_response.rbi rename to rbi/whop_sdk/models/partners/businesses/earning_list_response.rbi index decf4ec0..f5c176b2 100644 --- a/rbi/whop_sdk/models/referrals/businesses/earning_list_response.rbi +++ b/rbi/whop_sdk/models/partners/businesses/earning_list_response.rbi @@ -2,13 +2,13 @@ module WhopSDK module Models - module Referrals + module Partners module Businesses class EarningListResponse < WhopSDK::Internal::Type::BaseModel OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::Businesses::EarningListResponse, + WhopSDK::Models::Partners::Businesses::EarningListResponse, WhopSDK::Internal::AnyHash ) end @@ -20,7 +20,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account + WhopSDK::Models::Partners::Businesses::EarningListResponse::Account ) ) end @@ -30,7 +30,7 @@ module WhopSDK params( account: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Account::OrHash ) ).void end @@ -53,7 +53,7 @@ module WhopSDK returns( T.nilable( T::Array[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity ] ) ) @@ -62,7 +62,7 @@ module WhopSDK sig do returns( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Object::TaggedSymbol ) end attr_accessor :object @@ -78,7 +78,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product + WhopSDK::Models::Partners::Businesses::EarningListResponse::Product ) ) end @@ -88,7 +88,7 @@ module WhopSDK params( product: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Product::OrHash ) ).void end @@ -98,7 +98,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource ) ) end @@ -108,7 +108,7 @@ module WhopSDK params( resource: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::OrHash ) ).void end @@ -121,7 +121,7 @@ module WhopSDK # Current status of the earning. sig do returns( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol ) end attr_accessor :status @@ -135,7 +135,7 @@ module WhopSDK id: T.nilable(String), account: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Account::OrHash ), cancelation_reason: T.nilable(String), commission_amount_usd: T.nilable(String), @@ -143,24 +143,24 @@ module WhopSDK financial_activity: T.nilable( T::Array[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::OrHash ] ), object: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object::OrSymbol, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Object::OrSymbol, payout_at: T.nilable(Time), payout_percentage: T.nilable(Float), product: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Product::OrHash ), resource: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::OrHash ), second_tier: T::Boolean, status: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::OrSymbol, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::OrSymbol, transaction_amount_usd: String ).returns(T.attached_class) end @@ -199,7 +199,7 @@ module WhopSDK id: T.nilable(String), account: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account + WhopSDK::Models::Partners::Businesses::EarningListResponse::Account ), cancelation_reason: T.nilable(String), commission_amount_usd: T.nilable(String), @@ -207,24 +207,24 @@ module WhopSDK financial_activity: T.nilable( T::Array[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity ] ), object: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object::TaggedSymbol, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Object::TaggedSymbol, payout_at: T.nilable(Time), payout_percentage: T.nilable(Float), product: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product + WhopSDK::Models::Partners::Businesses::EarningListResponse::Product ), resource: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource ), second_tier: T::Boolean, status: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol, transaction_amount_usd: String } ) @@ -236,7 +236,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Account, WhopSDK::Internal::AnyHash ) end @@ -296,7 +296,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity, + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity, WhopSDK::Internal::AnyHash ) end @@ -323,7 +323,7 @@ module WhopSDK # Whether the line is income Whop collected or a cost Whop paid. sig do returns( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol ) end attr_accessor :type @@ -336,7 +336,7 @@ module WhopSDK created_at: T.nilable(Time), currency: String, type: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type::OrSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type::OrSymbol ).returns(T.attached_class) end def self.new( @@ -363,7 +363,7 @@ module WhopSDK created_at: T.nilable(Time), currency: String, type: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol } ) end @@ -378,7 +378,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -386,18 +386,18 @@ module WhopSDK INCOME = T.let( :income, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol ) EXPENSE = T.let( :expense, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::Type::TaggedSymbol ] ) end @@ -413,21 +413,21 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object + WhopSDK::Models::Partners::Businesses::EarningListResponse::Object ) end OrSymbol = T.type_alias { T.any(Symbol, String) } - BUSINESS_REFERRAL_EARNING = + PARTNER_BUSINESS_EARNING = T.let( - :business_referral_earning, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object::TaggedSymbol + :partner_business_earning, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Object::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Object::TaggedSymbol ] ) end @@ -439,7 +439,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Product, WhopSDK::Internal::AnyHash ) end @@ -472,7 +472,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource, WhopSDK::Internal::AnyHash ) end @@ -483,7 +483,7 @@ module WhopSDK sig do returns( T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod ) ) end @@ -493,7 +493,7 @@ module WhopSDK params( alternative_payment_method: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod::OrHash ) ).void end @@ -513,7 +513,7 @@ module WhopSDK sig do returns( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object::TaggedSymbol ) end attr_accessor :object @@ -530,14 +530,14 @@ module WhopSDK id: String, alternative_payment_method: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod::OrHash + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod::OrHash ), brand: T.nilable(String), created_at: Time, currency: String, last4: T.nilable(String), object: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object::OrSymbol, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object::OrSymbol, payment_method_type: T.nilable(String), processor: T.nilable(String) ).returns(T.attached_class) @@ -561,14 +561,14 @@ module WhopSDK id: String, alternative_payment_method: T.nilable( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod ), brand: T.nilable(String), created_at: Time, currency: String, last4: T.nilable(String), object: - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object::TaggedSymbol, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object::TaggedSymbol, payment_method_type: T.nilable(String), processor: T.nilable(String) } @@ -581,7 +581,7 @@ module WhopSDK OrHash = T.type_alias do T.any( - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod, + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod, WhopSDK::Internal::AnyHash ) end @@ -614,7 +614,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -622,13 +622,13 @@ module WhopSDK RECEIPT = T.let( :receipt, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::Object::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::Object::TaggedSymbol ] ) end @@ -645,7 +645,7 @@ module WhopSDK T.type_alias do T.all( Symbol, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status ) end OrSymbol = T.type_alias { T.any(Symbol, String) } @@ -653,33 +653,33 @@ module WhopSDK AWAITING_SETTLEMENT = T.let( :awaiting_settlement, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol ) PENDING = T.let( :pending, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol ) COMPLETED = T.let( :completed, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol ) CANCELED = T.let( :canceled, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol ) REVERSED = T.let( :reversed, - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol ) sig do override.returns( T::Array[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status::TaggedSymbol + WhopSDK::Models::Partners::Businesses::EarningListResponse::Status::TaggedSymbol ] ) end diff --git a/rbi/whop_sdk/models/payout_create_response.rbi b/rbi/whop_sdk/models/payout_create_response.rbi index a62cf134..b739c2f9 100644 --- a/rbi/whop_sdk/models/payout_create_response.rbi +++ b/rbi/whop_sdk/models/payout_create_response.rbi @@ -321,6 +321,11 @@ module WhopSDK :in_transit, WhopSDK::Models::PayoutCreateResponse::Status::TaggedSymbol ) + DENIED = + T.let( + :denied, + WhopSDK::Models::PayoutCreateResponse::Status::TaggedSymbol + ) COMPLETED = T.let( :completed, diff --git a/rbi/whop_sdk/models/product.rbi b/rbi/whop_sdk/models/product.rbi index d47a0087..77b94a38 100644 --- a/rbi/whop_sdk/models/product.rbi +++ b/rbi/whop_sdk/models/product.rbi @@ -313,6 +313,10 @@ module WhopSDK sig { returns(String) } attr_accessor :id + # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + sig { returns(T.nilable(String)) } + attr_accessor :content_type + # A pre-optimized URL for rendering this attachment on the client. This should be # used for displaying attachments in apps. sig { returns(T.nilable(String)) } @@ -320,7 +324,11 @@ module WhopSDK # Represents an image attachment sig do - params(id: String, url: T.nilable(String)).returns(T.attached_class) + params( + id: String, + content_type: T.nilable(String), + url: T.nilable(String) + ).returns(T.attached_class) end def self.new( # Represents a unique identifier that is Base64 obfuscated. It is often used to @@ -329,13 +337,23 @@ module WhopSDK # an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) # input value will be accepted as an ID. id:, + # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + content_type:, # A pre-optimized URL for rendering this attachment on the client. This should be # used for displaying attachments in apps. url: ) end - sig { override.returns({ id: String, url: T.nilable(String) }) } + sig do + override.returns( + { + id: String, + content_type: T.nilable(String), + url: T.nilable(String) + } + ) + end def to_hash end end diff --git a/rbi/whop_sdk/models/product_list_item.rbi b/rbi/whop_sdk/models/product_list_item.rbi index 9c27cd44..b03f4d3e 100644 --- a/rbi/whop_sdk/models/product_list_item.rbi +++ b/rbi/whop_sdk/models/product_list_item.rbi @@ -21,6 +21,10 @@ module WhopSDK sig { returns(T.nilable(String)) } attr_accessor :external_identifier + # The gallery images for this product, ordered by position. + sig { returns(T::Array[WhopSDK::ProductListItem::GalleryImage]) } + attr_accessor :gallery_images + # A short marketing headline displayed prominently on the product's product page. sig { returns(T.nilable(String)) } attr_accessor :headline @@ -70,6 +74,8 @@ module WhopSDK id: String, created_at: Time, external_identifier: T.nilable(String), + gallery_images: + T::Array[WhopSDK::ProductListItem::GalleryImage::OrHash], headline: T.nilable(String), member_count: Integer, metadata: T.nilable(T::Hash[Symbol, T.anything]), @@ -89,6 +95,8 @@ module WhopSDK # External identifier for the product. Providing it on a product creation endpoint # updates the existing product with this identifier instead of creating a new one. external_identifier:, + # The gallery images for this product, ordered by position. + gallery_images:, # A short marketing headline displayed prominently on the product's product page. headline:, # Active memberships for this product. Returns `0` if the account has disabled @@ -122,6 +130,7 @@ module WhopSDK id: String, created_at: Time, external_identifier: T.nilable(String), + gallery_images: T::Array[WhopSDK::ProductListItem::GalleryImage], headline: T.nilable(String), member_count: Integer, metadata: T.nilable(T::Hash[Symbol, T.anything]), @@ -136,6 +145,68 @@ module WhopSDK end def to_hash end + + class GalleryImage < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::ProductListItem::GalleryImage, + WhopSDK::Internal::AnyHash + ) + end + + # Represents a unique identifier that is Base64 obfuscated. It is often used to + # refetch an object or as key for a cache. The ID type appears in a JSON response + # as a String; however, it is not intended to be human-readable. When expected as + # an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) + # input value will be accepted as an ID. + sig { returns(String) } + attr_accessor :id + + # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + sig { returns(T.nilable(String)) } + attr_accessor :content_type + + # A pre-optimized URL for rendering this attachment on the client. This should be + # used for displaying attachments in apps. + sig { returns(T.nilable(String)) } + attr_accessor :url + + # Represents an image attachment + sig do + params( + id: String, + content_type: T.nilable(String), + url: T.nilable(String) + ).returns(T.attached_class) + end + def self.new( + # Represents a unique identifier that is Base64 obfuscated. It is often used to + # refetch an object or as key for a cache. The ID type appears in a JSON response + # as a String; however, it is not intended to be human-readable. When expected as + # an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`) + # input value will be accepted as an ID. + id:, + # Uploaded file MIME type, such as image/jpeg, video/mp4, or audio/mpeg. + content_type:, + # A pre-optimized URL for rendering this attachment on the client. This should be + # used for displaying attachments in apps. + url: + ) + end + + sig do + override.returns( + { + id: String, + content_type: T.nilable(String), + url: T.nilable(String) + } + ) + end + def to_hash + end + end end end end diff --git a/rbi/whop_sdk/models/referrals/business_leaderboard_params.rbi b/rbi/whop_sdk/models/referrals/business_leaderboard_params.rbi deleted file mode 100644 index f52a598a..00000000 --- a/rbi/whop_sdk/models/referrals/business_leaderboard_params.rbi +++ /dev/null @@ -1,120 +0,0 @@ -# typed: strong - -module WhopSDK - module Models - module Referrals - class BusinessLeaderboardParams < WhopSDK::Internal::Type::BaseModel - extend WhopSDK::Internal::Type::RequestParameters::Converter - include WhopSDK::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - WhopSDK::Referrals::BusinessLeaderboardParams, - WhopSDK::Internal::AnyHash - ) - end - - # Time window for the rankings. `day`, `month`, and `year` count earnings since - # the start of the current calendar day, month, or year; `last_30_days` counts - # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. - sig do - returns( - T.nilable( - WhopSDK::Referrals::BusinessLeaderboardParams::Period::OrSymbol - ) - ) - end - attr_reader :period - - sig do - params( - period: - WhopSDK::Referrals::BusinessLeaderboardParams::Period::OrSymbol - ).void - end - attr_writer :period - - sig do - params( - period: - WhopSDK::Referrals::BusinessLeaderboardParams::Period::OrSymbol, - request_options: WhopSDK::RequestOptions::OrHash - ).returns(T.attached_class) - end - def self.new( - # Time window for the rankings. `day`, `month`, and `year` count earnings since - # the start of the current calendar day, month, or year; `last_30_days` counts - # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. - period: nil, - request_options: {} - ) - end - - sig do - override.returns( - { - period: - WhopSDK::Referrals::BusinessLeaderboardParams::Period::OrSymbol, - request_options: WhopSDK::RequestOptions - } - ) - end - def to_hash - end - - # Time window for the rankings. `day`, `month`, and `year` count earnings since - # the start of the current calendar day, month, or year; `last_30_days` counts - # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. - module Period - extend WhopSDK::Internal::Type::Enum - - TaggedSymbol = - T.type_alias do - T.all( - Symbol, - WhopSDK::Referrals::BusinessLeaderboardParams::Period - ) - end - OrSymbol = T.type_alias { T.any(Symbol, String) } - - DAY = - T.let( - :day, - WhopSDK::Referrals::BusinessLeaderboardParams::Period::TaggedSymbol - ) - MONTH = - T.let( - :month, - WhopSDK::Referrals::BusinessLeaderboardParams::Period::TaggedSymbol - ) - YEAR = - T.let( - :year, - WhopSDK::Referrals::BusinessLeaderboardParams::Period::TaggedSymbol - ) - LAST_30_DAYS = - T.let( - :last_30_days, - WhopSDK::Referrals::BusinessLeaderboardParams::Period::TaggedSymbol - ) - ALL_TIME = - T.let( - :all_time, - WhopSDK::Referrals::BusinessLeaderboardParams::Period::TaggedSymbol - ) - - sig do - override.returns( - T::Array[ - WhopSDK::Referrals::BusinessLeaderboardParams::Period::TaggedSymbol - ] - ) - end - def self.values - end - end - end - end - end -end diff --git a/rbi/whop_sdk/models/referrals/business_leaderboard_response.rbi b/rbi/whop_sdk/models/referrals/business_leaderboard_response.rbi deleted file mode 100644 index 538eb1ff..00000000 --- a/rbi/whop_sdk/models/referrals/business_leaderboard_response.rbi +++ /dev/null @@ -1,535 +0,0 @@ -# typed: strong - -module WhopSDK - module Models - module Referrals - class BusinessLeaderboardResponse < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse, - WhopSDK::Internal::AnyHash - ) - end - - # The top referrers by total earnings, best first. - sig do - returns( - T::Array[ - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader - ] - ) - end - attr_accessor :leaders - - # The caller's own standing; null when the caller has no referral earnings. - sig do - returns( - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me - ) - ) - end - attr_reader :me - - sig do - params( - me: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::OrHash - ) - ).void - end - attr_writer :me - - sig do - params( - leaders: - T::Array[ - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::OrHash - ], - me: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::OrHash - ) - ).returns(T.attached_class) - end - def self.new( - # The top referrers by total earnings, best first. - leaders:, - # The caller's own standing; null when the caller has no referral earnings. - me: - ) - end - - sig do - override.returns( - { - leaders: - T::Array[ - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader - ], - me: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me - ) - } - ) - end - def to_hash - end - - class Leader < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader, - WhopSDK::Internal::AnyHash - ) - end - - # When the referrer's earliest business referral became active. - sig { returns(Time) } - attr_accessor :first_referral_started_at - - # 1-based leaderboard position. - sig { returns(Integer) } - attr_accessor :rank - - # The referrer's pending + completed earnings across all referred businesses, in - # USD. - sig { returns(String) } - attr_accessor :total_earnings_usd - - # Credited GMV across all the referrer's referred businesses, in USD. - sig { returns(String) } - attr_accessor :total_volume_usd - - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - sig do - returns( - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User - ) - ) - end - attr_reader :user - - sig do - params( - user: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::OrHash - ) - ).void - end - attr_writer :user - - sig do - params( - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::OrHash - ) - ).returns(T.attached_class) - end - def self.new( - # When the referrer's earliest business referral became active. - first_referral_started_at:, - # 1-based leaderboard position. - rank:, - # The referrer's pending + completed earnings across all referred businesses, in - # USD. - total_earnings_usd:, - # Credited GMV across all the referrer's referred businesses, in USD. - total_volume_usd:, - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - user: - ) - end - - sig do - override.returns( - { - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User - ) - } - ) - end - def to_hash - end - - class User < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User, - WhopSDK::Internal::AnyHash - ) - end - - # The city where the referrer is located, derived from their IP address. Null if - # location sharing is disabled. - sig { returns(T.nilable(String)) } - attr_accessor :city - - # The country where the referrer is located, derived from their IP address. Null - # if location sharing is disabled. - sig { returns(T.nilable(String)) } - attr_accessor :country - - # User ID, prefixed `user_`. Present only on the caller's own entry. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # The user's display name. Present only on the caller's own entry. - sig { returns(T.nilable(String)) } - attr_accessor :name - - # The user's profile picture. Present only on the caller's own entry. - sig do - returns( - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture - ) - ) - end - attr_reader :profile_picture - - sig do - params( - profile_picture: - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture::OrHash - ).void - end - attr_writer :profile_picture - - # The user's unique username. Present only on the caller's own entry. - sig { returns(T.nilable(String)) } - attr_reader :username - - sig { params(username: String).void } - attr_writer :username - - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - sig do - params( - city: T.nilable(String), - country: T.nilable(String), - id: String, - name: T.nilable(String), - profile_picture: - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture::OrHash, - username: String - ).returns(T.attached_class) - end - def self.new( - # The city where the referrer is located, derived from their IP address. Null if - # location sharing is disabled. - city:, - # The country where the referrer is located, derived from their IP address. Null - # if location sharing is disabled. - country:, - # User ID, prefixed `user_`. Present only on the caller's own entry. - id: nil, - # The user's display name. Present only on the caller's own entry. - name: nil, - # The user's profile picture. Present only on the caller's own entry. - profile_picture: nil, - # The user's unique username. Present only on the caller's own entry. - username: nil - ) - end - - sig do - override.returns( - { - city: T.nilable(String), - country: T.nilable(String), - id: String, - name: T.nilable(String), - profile_picture: - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, - username: String - } - ) - end - def to_hash - end - - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, - WhopSDK::Internal::AnyHash - ) - end - - # The user's profile picture URL. - sig { returns(String) } - attr_accessor :url - - # The user's profile picture. Present only on the caller's own entry. - sig { params(url: String).returns(T.attached_class) } - def self.new( - # The user's profile picture URL. - url: - ) - end - - sig { override.returns({ url: String }) } - def to_hash - end - end - end - end - - class Me < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me, - WhopSDK::Internal::AnyHash - ) - end - - # When the referrer's earliest business referral became active. - sig { returns(Time) } - attr_accessor :first_referral_started_at - - # 1-based leaderboard position. - sig { returns(Integer) } - attr_accessor :rank - - # The referrer's pending + completed earnings across all referred businesses, in - # USD. - sig { returns(String) } - attr_accessor :total_earnings_usd - - # Credited GMV across all the referrer's referred businesses, in USD. - sig { returns(String) } - attr_accessor :total_volume_usd - - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - sig do - returns( - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User - ) - ) - end - attr_reader :user - - sig do - params( - user: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::OrHash - ) - ).void - end - attr_writer :user - - # The caller's own standing; null when the caller has no referral earnings. - sig do - params( - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::OrHash - ) - ).returns(T.attached_class) - end - def self.new( - # When the referrer's earliest business referral became active. - first_referral_started_at:, - # 1-based leaderboard position. - rank:, - # The referrer's pending + completed earnings across all referred businesses, in - # USD. - total_earnings_usd:, - # Credited GMV across all the referrer's referred businesses, in USD. - total_volume_usd:, - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - user: - ) - end - - sig do - override.returns( - { - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User - ) - } - ) - end - def to_hash - end - - class User < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User, - WhopSDK::Internal::AnyHash - ) - end - - # The city where the referrer is located, derived from their IP address. Null if - # location sharing is disabled. - sig { returns(T.nilable(String)) } - attr_accessor :city - - # The country where the referrer is located, derived from their IP address. Null - # if location sharing is disabled. - sig { returns(T.nilable(String)) } - attr_accessor :country - - # User ID, prefixed `user_`. Present only on the caller's own entry. - sig { returns(T.nilable(String)) } - attr_reader :id - - sig { params(id: String).void } - attr_writer :id - - # The user's display name. Present only on the caller's own entry. - sig { returns(T.nilable(String)) } - attr_accessor :name - - # The user's profile picture. Present only on the caller's own entry. - sig do - returns( - T.nilable( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture - ) - ) - end - attr_reader :profile_picture - - sig do - params( - profile_picture: - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture::OrHash - ).void - end - attr_writer :profile_picture - - # The user's unique username. Present only on the caller's own entry. - sig { returns(T.nilable(String)) } - attr_reader :username - - sig { params(username: String).void } - attr_writer :username - - # The ranked referrer. Identity fields (id, name, username, profile_picture) are - # returned only on the caller's own entry; other referrers expose coarse location - # only. - sig do - params( - city: T.nilable(String), - country: T.nilable(String), - id: String, - name: T.nilable(String), - profile_picture: - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture::OrHash, - username: String - ).returns(T.attached_class) - end - def self.new( - # The city where the referrer is located, derived from their IP address. Null if - # location sharing is disabled. - city:, - # The country where the referrer is located, derived from their IP address. Null - # if location sharing is disabled. - country:, - # User ID, prefixed `user_`. Present only on the caller's own entry. - id: nil, - # The user's display name. Present only on the caller's own entry. - name: nil, - # The user's profile picture. Present only on the caller's own entry. - profile_picture: nil, - # The user's unique username. Present only on the caller's own entry. - username: nil - ) - end - - sig do - override.returns( - { - city: T.nilable(String), - country: T.nilable(String), - id: String, - name: T.nilable(String), - profile_picture: - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture, - username: String - } - ) - end - def to_hash - end - - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture, - WhopSDK::Internal::AnyHash - ) - end - - # The user's profile picture URL. - sig { returns(String) } - attr_accessor :url - - # The user's profile picture. Present only on the caller's own entry. - sig { params(url: String).returns(T.attached_class) } - def self.new( - # The user's profile picture URL. - url: - ) - end - - sig { override.returns({ url: String }) } - def to_hash - end - end - end - end - end - end - end -end diff --git a/rbi/whop_sdk/models/referrals/partner_create_params.rbi b/rbi/whop_sdk/models/referrals/partner_create_params.rbi deleted file mode 100644 index 00a816cd..00000000 --- a/rbi/whop_sdk/models/referrals/partner_create_params.rbi +++ /dev/null @@ -1,32 +0,0 @@ -# typed: strong - -module WhopSDK - module Models - module Referrals - class PartnerCreateParams < WhopSDK::Internal::Type::BaseModel - extend WhopSDK::Internal::Type::RequestParameters::Converter - include WhopSDK::Internal::Type::RequestParameters - - OrHash = - T.type_alias do - T.any( - WhopSDK::Referrals::PartnerCreateParams, - WhopSDK::Internal::AnyHash - ) - end - - sig do - params(request_options: WhopSDK::RequestOptions::OrHash).returns( - T.attached_class - ) - end - def self.new(request_options: {}) - end - - sig { override.returns({ request_options: WhopSDK::RequestOptions }) } - def to_hash - end - end - end - end -end diff --git a/rbi/whop_sdk/models/referrals/partner_create_response.rbi b/rbi/whop_sdk/models/referrals/partner_create_response.rbi deleted file mode 100644 index d4d75478..00000000 --- a/rbi/whop_sdk/models/referrals/partner_create_response.rbi +++ /dev/null @@ -1,48 +0,0 @@ -# typed: strong - -module WhopSDK - module Models - module Referrals - class PartnerCreateResponse < WhopSDK::Internal::Type::BaseModel - OrHash = - T.type_alias do - T.any( - WhopSDK::Models::Referrals::PartnerCreateResponse, - WhopSDK::Internal::AnyHash - ) - end - - # The caller's referral link — businesses that sign up through it are attributed - # to the caller. - sig { returns(String) } - attr_accessor :referral_link - - # When the caller became a Whop partner. - sig { returns(Time) } - attr_accessor :whop_partner_enabled_at - - sig do - params(referral_link: String, whop_partner_enabled_at: Time).returns( - T.attached_class - ) - end - def self.new( - # The caller's referral link — businesses that sign up through it are attributed - # to the caller. - referral_link:, - # When the caller became a Whop partner. - whop_partner_enabled_at: - ) - end - - sig do - override.returns( - { referral_link: String, whop_partner_enabled_at: Time } - ) - end - def to_hash - end - end - end - end -end diff --git a/rbi/whop_sdk/models/social_account.rbi b/rbi/whop_sdk/models/social_account.rbi index d46f1271..c9fcb228 100644 --- a/rbi/whop_sdk/models/social_account.rbi +++ b/rbi/whop_sdk/models/social_account.rbi @@ -12,6 +12,11 @@ module WhopSDK sig { returns(String) } attr_accessor :id + # Why this social account currently can't be used for advertising — a failed share + # or a Meta-side restriction. Null when the account is healthy. + sig { returns(T.nilable(String)) } + attr_accessor :error + # The platform-specific ID for this social account. sig { returns(T.nilable(String)) } attr_accessor :external_id @@ -48,6 +53,7 @@ module WhopSDK sig do params( id: String, + error: T.nilable(String), external_id: T.nilable(String), name: T.nilable(String), platform: WhopSDK::SocialAccount::Platform::OrSymbol, @@ -61,6 +67,9 @@ module WhopSDK def self.new( # Unique identifier for the social account. id:, + # Why this social account currently can't be used for advertising — a failed share + # or a Meta-side restriction. Null when the account is healthy. + error:, # The platform-specific ID for this social account. external_id:, # The display name of the social account on the platform. @@ -85,6 +94,7 @@ module WhopSDK override.returns( { id: String, + error: T.nilable(String), external_id: T.nilable(String), name: T.nilable(String), platform: WhopSDK::SocialAccount::Platform::TaggedSymbol, diff --git a/rbi/whop_sdk/models/user_recommend_actions_params.rbi b/rbi/whop_sdk/models/user_recommend_actions_params.rbi new file mode 100644 index 00000000..39781777 --- /dev/null +++ b/rbi/whop_sdk/models/user_recommend_actions_params.rbi @@ -0,0 +1,35 @@ +# typed: strong + +module WhopSDK + module Models + class UserRecommendActionsParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + OrHash = + T.type_alias do + T.any(WhopSDK::UserRecommendActionsParams, WhopSDK::Internal::AnyHash) + end + + sig { returns(String) } + attr_accessor :id + + sig do + params( + id: String, + request_options: WhopSDK::RequestOptions::OrHash + ).returns(T.attached_class) + end + def self.new(id:, request_options: {}) + end + + sig do + override.returns( + { id: String, request_options: WhopSDK::RequestOptions } + ) + end + def to_hash + end + end + end +end diff --git a/rbi/whop_sdk/models/user_recommend_actions_response.rbi b/rbi/whop_sdk/models/user_recommend_actions_response.rbi new file mode 100644 index 00000000..6a36e307 --- /dev/null +++ b/rbi/whop_sdk/models/user_recommend_actions_response.rbi @@ -0,0 +1,319 @@ +# typed: strong + +module WhopSDK + module Models + class UserRecommendActionsResponse < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::UserRecommendActionsResponse, + WhopSDK::Internal::AnyHash + ) + end + + sig do + returns(T::Array[WhopSDK::Models::UserRecommendActionsResponse::Data]) + end + attr_accessor :data + + sig do + params( + data: + T::Array[ + WhopSDK::Models::UserRecommendActionsResponse::Data::OrHash + ] + ).returns(T.attached_class) + end + def self.new(data:) + end + + sig do + override.returns( + { + data: T::Array[WhopSDK::Models::UserRecommendActionsResponse::Data] + } + ) + end + def to_hash + end + + class Data < WhopSDK::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + WhopSDK::Models::UserRecommendActionsResponse::Data, + WhopSDK::Internal::AnyHash + ) + end + + # The account (`biz_`) a business recommendation is for, or `null` for personal + # recommendations + sig { returns(T.nilable(String)) } + attr_accessor :account_id + + # The account's display name, or `null` + sig { returns(T.nilable(String)) } + attr_accessor :account_name + + # The recommendation; new values may be added, so handle unknown actions + # gracefully + sig do + returns( + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + end + attr_accessor :action + + sig { returns(T::Array[String]) } + attr_accessor :blocked_capabilities + + # The URL the call-to-action links to + sig { returns(String) } + attr_accessor :cta + + # Button label + sig { returns(String) } + attr_accessor :cta_label + + # Supporting copy, or empty + sig { returns(String) } + attr_accessor :description + + # Illustration icon URL, or `null` + sig { returns(T.nilable(String)) } + attr_accessor :icon_url + + # Estimated impact from 0-100, or `null` when not ranked + sig { returns(T.nilable(Integer)) } + attr_accessor :impact_score + + # Why this action was recommended, or `null` + sig { returns(T.nilable(String)) } + attr_accessor :reasoning + + # Always optional — never blocking + sig do + returns( + WhopSDK::Models::UserRecommendActionsResponse::Data::Status::TaggedSymbol + ) + end + attr_accessor :status + + # Headline for the recommendation + sig { returns(String) } + attr_accessor :title + + sig do + params( + account_id: T.nilable(String), + account_name: T.nilable(String), + action: + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::OrSymbol, + blocked_capabilities: T::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: T.nilable(String), + impact_score: T.nilable(Integer), + reasoning: T.nilable(String), + status: + WhopSDK::Models::UserRecommendActionsResponse::Data::Status::OrSymbol, + title: String + ).returns(T.attached_class) + end + def self.new( + # The account (`biz_`) a business recommendation is for, or `null` for personal + # recommendations + account_id:, + # The account's display name, or `null` + account_name:, + # The recommendation; new values may be added, so handle unknown actions + # gracefully + action:, + blocked_capabilities:, + # The URL the call-to-action links to + cta:, + # Button label + cta_label:, + # Supporting copy, or empty + description:, + # Illustration icon URL, or `null` + icon_url:, + # Estimated impact from 0-100, or `null` when not ranked + impact_score:, + # Why this action was recommended, or `null` + reasoning:, + # Always optional — never blocking + status:, + # Headline for the recommendation + title: + ) + end + + sig do + override.returns( + { + account_id: T.nilable(String), + account_name: T.nilable(String), + action: + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol, + blocked_capabilities: T::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: T.nilable(String), + impact_score: T.nilable(Integer), + reasoning: T.nilable(String), + status: + WhopSDK::Models::UserRecommendActionsResponse::Data::Status::TaggedSymbol, + title: String + } + ) + end + def to_hash + end + + # The recommendation; new values may be added, so handle unknown actions + # gracefully + module Action + extend WhopSDK::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + CREATE_BUSINESS = + T.let( + :create_business, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + BECOME_AFFILIATE = + T.let( + :become_affiliate, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + THEME_BUSINESS = + T.let( + :theme_business, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + CREATE_PRODUCT = + T.let( + :create_product, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + CREATE_PLAN = + T.let( + :create_plan, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + VERIFY_IDENTITY = + T.let( + :verify_identity, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + CONNECT_AFFILIATE_PROGRAM = + T.let( + :connect_affiliate_program, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + CREATE_PROMOTION = + T.let( + :create_promotion, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + SETUP_TRACKING_PIXEL = + T.let( + :setup_tracking_pixel, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + MIGRATE_FROM_STRIPE = + T.let( + :migrate_from_stripe, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + ACCEPT_FIRST_PAYMENT = + T.let( + :accept_first_payment, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + LAUNCH_FIRST_AD = + T.let( + :launch_first_ad, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + INVITE_TEAM_MEMBER = + T.let( + :invite_team_member, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + ENABLE_TAX_COLLECTION = + T.let( + :enable_tax_collection, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + CREATE_CARD = + T.let( + :create_card, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + JOIN_WHOP_UNIVERSITY = + T.let( + :join_whop_university, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + APPLY_FOR_FINANCING = + T.let( + :apply_for_financing, + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + WhopSDK::Models::UserRecommendActionsResponse::Data::Action::TaggedSymbol + ] + ) + end + def self.values + end + end + + # Always optional — never blocking + module Status + extend WhopSDK::Internal::Type::Enum + + TaggedSymbol = + T.type_alias do + T.all( + Symbol, + WhopSDK::Models::UserRecommendActionsResponse::Data::Status + ) + end + OrSymbol = T.type_alias { T.any(Symbol, String) } + + OPTIONAL = + T.let( + :optional, + WhopSDK::Models::UserRecommendActionsResponse::Data::Status::TaggedSymbol + ) + + sig do + override.returns( + T::Array[ + WhopSDK::Models::UserRecommendActionsResponse::Data::Status::TaggedSymbol + ] + ) + end + def self.values + end + end + end + end + end +end diff --git a/rbi/whop_sdk/models/verification_create_params.rbi b/rbi/whop_sdk/models/verification_create_params.rbi index 3e2b8d4d..ccb23a1a 100644 --- a/rbi/whop_sdk/models/verification_create_params.rbi +++ b/rbi/whop_sdk/models/verification_create_params.rbi @@ -139,6 +139,15 @@ module WhopSDK sig { params(business_structure: String).void } attr_writer :business_structure + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + sig { returns(T.nilable(String)) } + attr_reader :business_tax_identification_number + + sig { params(business_tax_identification_number: String).void } + attr_writer :business_tax_identification_number + # Business website URL. Whop store pages are not accepted. sig { returns(T.nilable(String)) } attr_reader :business_website @@ -233,7 +242,10 @@ module WhopSDK sig { params(phone: String).void } attr_writer :phone - # SSN or ITIN. Tokenized in transit and never stored raw. + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. sig { returns(T.nilable(String)) } attr_reader :tax_identification_number @@ -254,6 +266,7 @@ module WhopSDK WhopSDK::VerificationCreateParams::Body::Individual::Address::OrHash, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, date_of_birth: String, @@ -276,6 +289,10 @@ module WhopSDK # vary by country of incorporation — see # [Business structures](/developer/verification/business-structures). business_structure: nil, + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + business_tax_identification_number: nil, # Business website URL. Whop store pages are not accepted. business_website: nil, # Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. @@ -303,7 +320,10 @@ module WhopSDK kind: nil, last_name: nil, phone: nil, - # SSN or ITIN. Tokenized in transit and never stored raw. + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. tax_identification_number: nil ) end @@ -315,6 +335,7 @@ module WhopSDK WhopSDK::VerificationCreateParams::Body::Individual::Address, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, date_of_birth: String, @@ -545,6 +566,15 @@ module WhopSDK sig { params(business_structure: String).void } attr_writer :business_structure + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + sig { returns(T.nilable(String)) } + attr_reader :business_tax_identification_number + + sig { params(business_tax_identification_number: String).void } + attr_writer :business_tax_identification_number + # Business website URL. Whop store pages are not accepted. sig { returns(T.nilable(String)) } attr_reader :business_website @@ -584,7 +614,10 @@ module WhopSDK sig { params(place_of_incorporation: String).void } attr_writer :place_of_incorporation - # EIN. Tokenized in transit and never stored raw. + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. sig { returns(T.nilable(String)) } attr_reader :tax_identification_number @@ -600,6 +633,7 @@ module WhopSDK WhopSDK::VerificationCreateParams::Body::Business::Address::OrHash, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, kind: @@ -616,6 +650,10 @@ module WhopSDK # `sole_proprietorship`. Supported values vary by country of incorporation — see # [Business structures](/developer/verification/business-structures). business_structure: nil, + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + business_tax_identification_number: nil, # Business website URL. Whop store pages are not accepted. business_website: nil, # Country of incorporation as a two-letter ISO 3166-1 country code. @@ -624,7 +662,10 @@ module WhopSDK kind: nil, # State or region where the business is incorporated. place_of_incorporation: nil, - # EIN. Tokenized in transit and never stored raw. + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. tax_identification_number: nil ) end @@ -636,6 +677,7 @@ module WhopSDK WhopSDK::VerificationCreateParams::Body::Business::Address, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, kind: diff --git a/rbi/whop_sdk/models/verification_create_response.rbi b/rbi/whop_sdk/models/verification_create_response.rbi index 4bdb53c8..ac951ddd 100644 --- a/rbi/whop_sdk/models/verification_create_response.rbi +++ b/rbi/whop_sdk/models/verification_create_response.rbi @@ -135,10 +135,11 @@ module WhopSDK attr_accessor :session_url # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. sig do returns( T.nilable( @@ -222,10 +223,11 @@ module WhopSDK # Expires 7 days after creation. session_url: nil, # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. status: nil, # When the verification profile was last updated, as an ISO 8601 timestamp. updated_at: nil @@ -703,10 +705,11 @@ module WhopSDK end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. module Status extend WhopSDK::Internal::Type::Enum @@ -726,6 +729,11 @@ module WhopSDK :pending, WhopSDK::Models::VerificationCreateResponse::Status::TaggedSymbol ) + PROCESSING = + T.let( + :processing, + WhopSDK::Models::VerificationCreateResponse::Status::TaggedSymbol + ) APPROVED = T.let( :approved, diff --git a/rbi/whop_sdk/models/verification_list_response.rbi b/rbi/whop_sdk/models/verification_list_response.rbi index 92ff1758..13dfb13a 100644 --- a/rbi/whop_sdk/models/verification_list_response.rbi +++ b/rbi/whop_sdk/models/verification_list_response.rbi @@ -179,10 +179,11 @@ module WhopSDK attr_accessor :session_url # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. sig do returns( T.nilable( @@ -269,10 +270,11 @@ module WhopSDK # Expires 7 days after creation. session_url: nil, # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. status: nil, # When the verification profile was last updated, as an ISO 8601 timestamp. updated_at: nil @@ -755,10 +757,11 @@ module WhopSDK end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. module Status extend WhopSDK::Internal::Type::Enum @@ -781,6 +784,11 @@ module WhopSDK :pending, WhopSDK::Models::VerificationListResponse::Data::Status::TaggedSymbol ) + PROCESSING = + T.let( + :processing, + WhopSDK::Models::VerificationListResponse::Data::Status::TaggedSymbol + ) APPROVED = T.let( :approved, diff --git a/rbi/whop_sdk/models/verification_retrieve_response.rbi b/rbi/whop_sdk/models/verification_retrieve_response.rbi index 485b5ef3..11baa5ad 100644 --- a/rbi/whop_sdk/models/verification_retrieve_response.rbi +++ b/rbi/whop_sdk/models/verification_retrieve_response.rbi @@ -137,10 +137,11 @@ module WhopSDK attr_accessor :session_url # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. sig do returns( T.nilable( @@ -226,10 +227,11 @@ module WhopSDK # Expires 7 days after creation. session_url: nil, # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. status: nil, # When the verification profile was last updated, as an ISO 8601 timestamp. updated_at: nil @@ -707,10 +709,11 @@ module WhopSDK end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. module Status extend WhopSDK::Internal::Type::Enum @@ -730,6 +733,11 @@ module WhopSDK :pending, WhopSDK::Models::VerificationRetrieveResponse::Status::TaggedSymbol ) + PROCESSING = + T.let( + :processing, + WhopSDK::Models::VerificationRetrieveResponse::Status::TaggedSymbol + ) APPROVED = T.let( :approved, diff --git a/rbi/whop_sdk/models/verification_update_params.rbi b/rbi/whop_sdk/models/verification_update_params.rbi index abd97063..b1dff2aa 100644 --- a/rbi/whop_sdk/models/verification_update_params.rbi +++ b/rbi/whop_sdk/models/verification_update_params.rbi @@ -84,6 +84,15 @@ module WhopSDK ) end + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + sig { returns(T.nilable(String)) } + attr_reader :business_tax_identification_number + + sig { params(business_tax_identification_number: String).void } + attr_writer :business_tax_identification_number + # Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. sig { returns(T.nilable(String)) } attr_reader :country @@ -153,10 +162,21 @@ module WhopSDK end attr_writer :requested_information + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. + sig { returns(T.nilable(String)) } + attr_reader :tax_identification_number + + sig { params(tax_identification_number: String).void } + attr_writer :tax_identification_number + # Fields that can be updated on an individual (KYC) verification. At least one # field is required. sig do params( + business_tax_identification_number: String, country: String, date_of_birth: String, first_name: String, @@ -166,10 +186,15 @@ module WhopSDK requested_information: T::Array[ WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation::OrHash - ] + ], + tax_identification_number: String ).returns(T.attached_class) end def self.new( + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + business_tax_identification_number: nil, # Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. country: nil, # Formatted as `YYYY-MM-DD`. @@ -182,13 +207,19 @@ module WhopSDK # the requested item `id` and exactly one answer payload matching the item's # `type`: `value` for `text`, `date`, or `phone`; `address` for `address`; `files` # for `files`. - requested_information: nil + requested_information: nil, + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. + tax_identification_number: nil ) end sig do override.returns( { + business_tax_identification_number: String, country: String, date_of_birth: String, first_name: String, @@ -198,7 +229,8 @@ module WhopSDK requested_information: T::Array[ WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation - ] + ], + tax_identification_number: String } ) end @@ -669,6 +701,15 @@ module WhopSDK sig { params(business_structure: String).void } attr_writer :business_structure + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + sig { returns(T.nilable(String)) } + attr_reader :business_tax_identification_number + + sig { params(business_tax_identification_number: String).void } + attr_writer :business_tax_identification_number + # Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. sig { returns(T.nilable(String)) } attr_reader :country @@ -701,6 +742,16 @@ module WhopSDK end attr_writer :requested_information + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. + sig { returns(T.nilable(String)) } + attr_reader :tax_identification_number + + sig { params(tax_identification_number: String).void } + attr_writer :tax_identification_number + # Fields that can be updated on a business entity (KYB) verification. At least one # field is required. sig do @@ -709,11 +760,13 @@ module WhopSDK WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::BusinessAddress::OrHash, business_name: String, business_structure: String, + business_tax_identification_number: String, country: String, requested_information: T::Array[ WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation::OrHash - ] + ], + tax_identification_number: String ).returns(T.attached_class) end def self.new( @@ -725,13 +778,22 @@ module WhopSDK # `sole_proprietorship`. Supported values vary by country of incorporation — see # [Business structures](/developer/verification/business-structures). business_structure: nil, + # The business ID number of the company, as appropriate for the company's country. + # Examples are an Employer Identification Number (EIN) in the US, a Business + # Number in Canada, or a Company Number in the UK. + business_tax_identification_number: nil, # Two-letter ISO 3166-1 country code, for example `US`, `DE`, or `GB`. country: nil, # Answers to items returned in `requested_information`. Each entry must include # the requested item `id` and exactly one answer payload matching the item's # `type`: `value` for `text`, `date`, or `phone`; `address` for `address`; `files` # for `files`. - requested_information: nil + requested_information: nil, + # The government-issued ID number of the person being verified — the individual + # for a KYC verification, or the business representative for a KYB verification — + # as appropriate for their country. Examples are a Social Security Number (SSN) in + # the US, or a Social Insurance Number in Canada. + tax_identification_number: nil ) end @@ -742,11 +804,13 @@ module WhopSDK WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::BusinessAddress, business_name: String, business_structure: String, + business_tax_identification_number: String, country: String, requested_information: T::Array[ WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation - ] + ], + tax_identification_number: String } ) end diff --git a/rbi/whop_sdk/models/verification_update_response.rbi b/rbi/whop_sdk/models/verification_update_response.rbi index 2bfd1b49..ae11c5cf 100644 --- a/rbi/whop_sdk/models/verification_update_response.rbi +++ b/rbi/whop_sdk/models/verification_update_response.rbi @@ -135,10 +135,11 @@ module WhopSDK attr_accessor :session_url # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. sig do returns( T.nilable( @@ -222,10 +223,11 @@ module WhopSDK # Expires 7 days after creation. session_url: nil, # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. status: nil, # When the verification profile was last updated, as an ISO 8601 timestamp. updated_at: nil @@ -703,10 +705,11 @@ module WhopSDK end # Current verification state. `not_started` before any session has been created; - # `pending` while a session is in progress; `action_required` when items in - # `requested_information` need answers before review can continue; `approved` once - # verification succeeds; `rejected` if it fails. Call the Create Verification - # endpoint again to start a new session. + # `pending` while a session is in progress and needs the user's input; + # `processing` while the provider reviews submitted documents — nothing to do but + # wait; `action_required` when items in `requested_information` need answers + # before review can continue; `approved` once verification succeeds; `rejected` if + # it fails. Call the Create Verification endpoint again to start a new session. module Status extend WhopSDK::Internal::Type::Enum @@ -726,6 +729,11 @@ module WhopSDK :pending, WhopSDK::Models::VerificationUpdateResponse::Status::TaggedSymbol ) + PROCESSING = + T.let( + :processing, + WhopSDK::Models::VerificationUpdateResponse::Status::TaggedSymbol + ) APPROVED = T.let( :approved, diff --git a/rbi/whop_sdk/resources/accounts/preferences.rbi b/rbi/whop_sdk/resources/accounts/preferences.rbi index 71dd2280..7856dfa8 100644 --- a/rbi/whop_sdk/resources/accounts/preferences.rbi +++ b/rbi/whop_sdk/resources/accounts/preferences.rbi @@ -31,9 +31,9 @@ module WhopSDK # always requires a `primary` entry. `backup` is optional when the primary is # `platform_balance` — omitting it removes any configured card — while a `card` # primary requires a `platform_balance` backup. A `platform_balance` entry may - # omit `id` to use the account's default Whop balance. Changing which funding - # sources are configured requires a user token, while account API keys may only - # swap `primary` and `backup`. + # omit `id` to use the account's default Whop balance. Configuring a `card` + # requires a user token; account API keys can set up platform-balance billing, + # remove a configured card, and swap `primary` and `backup`. sig do params( account_id: String, diff --git a/rbi/whop_sdk/resources/ad_groups.rbi b/rbi/whop_sdk/resources/ad_groups.rbi index a14f5573..d4dffeca 100644 --- a/rbi/whop_sdk/resources/ad_groups.rbi +++ b/rbi/whop_sdk/resources/ad_groups.rbi @@ -30,6 +30,7 @@ module WhopSDK WhopSDK::AdGroupCreateParams::ConversionLocation::OrSymbol, demographics: T.anything, desired_cost_per_result: Float, + detailed_targeting: T.anything, devices: T.anything, dynamic_creative: T::Boolean, ends_at: String, @@ -70,6 +71,13 @@ module WhopSDK demographics: nil, # Target/cap cost for average_target / maximum_target. desired_cost_per_result: nil, + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + detailed_targeting: nil, # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. devices: nil, # Run Meta dynamic (Advantage+) creative for this ad set. Set at creation; @@ -104,8 +112,12 @@ module WhopSDK # - `threads`: `threads_stream` # - `whatsapp`: `status` placements: nil, - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. regions: nil, # Schedule start, ISO 8601. starts_at: nil, @@ -159,6 +171,7 @@ module WhopSDK WhopSDK::AdGroupUpdateParams::ConversionLocation::OrSymbol, demographics: T.anything, desired_cost_per_result: Float, + detailed_targeting: T.anything, devices: T.anything, ends_at: String, frequency_cap: T.anything, @@ -198,6 +211,13 @@ module WhopSDK demographics: nil, # Target/cap cost for average_target / maximum_target. desired_cost_per_result: nil, + # Detailed targeting: { interests: [{id, name}], behaviors: [{id, name}], + # demographics: [{id, name, type}] } where type is one of life_events, industries, + # income, family_statuses. IDs come from Meta's targeting taxonomy. At most 100 + # entries per section. Incompatible with demographics.automatic (Advantage+) and + # Special Ad Category campaigns. Sending the field states complete intent — + # omitted sections clear their stored entries. + detailed_targeting: nil, # Device targeting: { platforms, operating_systems: [{ os, minimum_version }] }. devices: nil, # Schedule end, ISO 8601. @@ -229,8 +249,12 @@ module WhopSDK # - `threads`: `threads_stream` # - `whatsapp`: `status` placements: nil, - # Geo targeting: { include / exclude: { countries (ISO 3166-1), regions - # (states/provinces as ISO 3166-2, e.g. US-CA), cities (keyed), zips } }. + # Geo targeting: { include / exclude: { countries (ISO 3166-1), country_groups + # (include-only, e.g. 'worldwide' for global reach), regions (ISO 3166-2 states, + # e.g. US-CA), cities (keyed), zips, custom_locations } }. custom_locations + # entries are pin + radius: { latitude, longitude, radius, distance_unit ('mile' + # default, or 'kilometer'), name (optional label) }. Radius 1-50 miles or 1-80 km; + # at most 200 custom locations across include and exclude. regions: nil, # Schedule start, ISO 8601. starts_at: nil, diff --git a/rbi/whop_sdk/resources/events.rbi b/rbi/whop_sdk/resources/events.rbi index 6c3d8e0c..c0f18675 100644 --- a/rbi/whop_sdk/resources/events.rbi +++ b/rbi/whop_sdk/resources/events.rbi @@ -14,7 +14,7 @@ module WhopSDK sig do params( account_id: String, - event_name: WhopSDK::EventCreateParams::EventName::OrSymbol, + event_name: String, action_source: T.nilable(WhopSDK::EventCreateParams::ActionSource::OrSymbol), context: T.nilable(WhopSDK::EventCreateParams::Context::OrHash), @@ -38,7 +38,11 @@ module WhopSDK def create( # The account to associate with this event. account_id:, - # The type of conversion or engagement event + # The type of event. + # + # Use a standard event (lead, submit_application, contact, complete_registration, + # schedule, view_content, add_to_cart) or pass your own name directly for a custom + # event. event_name:, # The channel where an event originated action_source: nil, diff --git a/rbi/whop_sdk/resources/referrals.rbi b/rbi/whop_sdk/resources/partners.rbi similarity index 57% rename from rbi/whop_sdk/resources/referrals.rbi rename to rbi/whop_sdk/resources/partners.rbi index 12ddbef6..decca14f 100644 --- a/rbi/whop_sdk/resources/referrals.rbi +++ b/rbi/whop_sdk/resources/partners.rbi @@ -2,30 +2,50 @@ module WhopSDK module Resources - # The Referrals API covers your Whop partner activity: the users you referred onto + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # # Use it to enroll as a Whop partner, list the users you referred, list your # referred businesses and review their earnings, and see the partner leaderboard. - class Referrals - # The Referrals API covers your Whop partner activity: the users you referred onto + class Partners + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # # Use it to enroll as a Whop partner, list the users you referred, list your # referred businesses and review their earnings, and see the partner leaderboard. - sig { returns(WhopSDK::Resources::Referrals::Businesses) } + sig { returns(WhopSDK::Resources::Partners::Businesses) } attr_reader :businesses - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - sig { returns(WhopSDK::Resources::Referrals::Partners) } - attr_reader :partners + # Enrolls the calling user in the Whop partner program, making their partner + # businesses eligible for earnings. Idempotent — enrolling again keeps the + # original enrollment time. + sig do + params(request_options: WhopSDK::RequestOptions::OrHash).returns( + WhopSDK::Models::PartnerCreateResponse + ) + end + def create(request_options: {}) + end + + # Ranks referrers by partner business earnings — all-time by default, or over the + # current day, month, year, or trailing 30 days — and includes the caller's own + # standing. + sig do + params( + period: WhopSDK::PartnerLeaderboardParams::Period::OrSymbol, + request_options: WhopSDK::RequestOptions::OrHash + ).returns(WhopSDK::Models::PartnerLeaderboardResponse) + end + def leaderboard( + # Time window for the rankings. `day`, `month`, and `year` count earnings since + # the start of the current calendar day, month, or year; `last_30_days` counts + # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. + period: nil, + request_options: {} + ) + end # Lists the users the caller referred onto Whop (newest first), each with the # second-tier earnings the caller has made from that user's businesses. @@ -38,7 +58,7 @@ module WhopSDK has_earning_businesses: T::Boolean, last: Integer, request_options: WhopSDK::RequestOptions::OrHash - ).returns(WhopSDK::Models::ReferralReferredUsersResponse) + ).returns(WhopSDK::Models::PartnerReferredUsersResponse) end def referred_users( # Cursor to fetch the page after (from page_info.end_cursor). diff --git a/rbi/whop_sdk/resources/referrals/businesses.rbi b/rbi/whop_sdk/resources/partners/businesses.rbi similarity index 61% rename from rbi/whop_sdk/resources/referrals/businesses.rbi rename to rbi/whop_sdk/resources/partners/businesses.rbi index 68969c91..c8bf6a08 100644 --- a/rbi/whop_sdk/resources/referrals/businesses.rbi +++ b/rbi/whop_sdk/resources/partners/businesses.rbi @@ -2,21 +2,21 @@ module WhopSDK module Resources - class Referrals - # The Referrals API covers your Whop partner activity: the users you referred onto + class Partners + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # # Use it to enroll as a Whop partner, list the users you referred, list your # referred businesses and review their earnings, and see the partner leaderboard. class Businesses - # The Referrals API covers your Whop partner activity: the users you referred onto + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # # Use it to enroll as a Whop partner, list the users you referred, list your # referred businesses and review their earnings, and see the partner leaderboard. - sig { returns(WhopSDK::Resources::Referrals::Businesses::Earnings) } + sig { returns(WhopSDK::Resources::Partners::Businesses::Earnings) } attr_reader :earnings # Retrieves a single referred business and its referral terms. @@ -24,10 +24,10 @@ module WhopSDK params( id: String, request_options: WhopSDK::RequestOptions::OrHash - ).returns(WhopSDK::Models::Referrals::BusinessRetrieveResponse) + ).returns(WhopSDK::Models::Partners::BusinessRetrieveResponse) end def retrieve( - # The business referral ID (a coma\_ identifier). + # The partner business ID (a coma\_ identifier). id, request_options: {} ) @@ -42,19 +42,19 @@ module WhopSDK created_after: String, created_before: String, direction: - WhopSDK::Referrals::BusinessListParams::Direction::OrSymbol, + WhopSDK::Partners::BusinessListParams::Direction::OrSymbol, first: Integer, has_earnings: T::Boolean, last: Integer, - order: WhopSDK::Referrals::BusinessListParams::Order::OrSymbol, + order: WhopSDK::Partners::BusinessListParams::Order::OrSymbol, referred_user_id: String, referred_username: String, - status: WhopSDK::Referrals::BusinessListParams::Status::OrSymbol, - tier: WhopSDK::Referrals::BusinessListParams::Tier::OrSymbol, + status: WhopSDK::Partners::BusinessListParams::Status::OrSymbol, + tier: WhopSDK::Partners::BusinessListParams::Tier::OrSymbol, request_options: WhopSDK::RequestOptions::OrHash ).returns( WhopSDK::Internal::CursorPage[ - WhopSDK::Models::Referrals::BusinessListResponse + WhopSDK::Models::Partners::BusinessListResponse ] ) end @@ -63,20 +63,20 @@ module WhopSDK after: nil, # Cursor to fetch the page before (from page_info.start_cursor). before: nil, - # Only return business referrals created after this timestamp. + # Only return partner businesses created after this timestamp. created_after: nil, - # Only return business referrals created before this timestamp. + # Only return partner businesses created before this timestamp. created_before: nil, # Sort direction. direction: nil, - # Number of business referrals to return from the start of the window. + # Number of partner businesses to return from the start of the window. first: nil, # When true, only businesses with pending or completed earnings paid to the # caller. has_earnings: nil, - # Number of business referrals to return from the end of the window. + # Number of partner businesses to return from the end of the window. last: nil, - # The field to sort business referrals by. + # The field to sort partner businesses by. order: nil, # Filter to referrals attributed to this user. For first-tier referrals, this is # the referred account owner; for second-tier referrals, this is the partner you @@ -93,25 +93,6 @@ module WhopSDK ) end - # Ranks referrers by business referral earnings — all-time by default, or over the - # current day, month, year, or trailing 30 days — and includes the caller's own - # standing. - sig do - params( - period: - WhopSDK::Referrals::BusinessLeaderboardParams::Period::OrSymbol, - request_options: WhopSDK::RequestOptions::OrHash - ).returns(WhopSDK::Models::Referrals::BusinessLeaderboardResponse) - end - def leaderboard( - # Time window for the rankings. `day`, `month`, and `year` count earnings since - # the start of the current calendar day, month, or year; `last_30_days` counts - # earnings over the trailing 30 days; `all_time` ranks lifetime earnings. - period: nil, - request_options: {} - ) - end - # @api private sig { params(client: WhopSDK::Client).returns(T.attached_class) } def self.new(client:) diff --git a/rbi/whop_sdk/resources/referrals/businesses/earnings.rbi b/rbi/whop_sdk/resources/partners/businesses/earnings.rbi similarity index 78% rename from rbi/whop_sdk/resources/referrals/businesses/earnings.rbi rename to rbi/whop_sdk/resources/partners/businesses/earnings.rbi index 4c5dda10..57062bcb 100644 --- a/rbi/whop_sdk/resources/referrals/businesses/earnings.rbi +++ b/rbi/whop_sdk/resources/partners/businesses/earnings.rbi @@ -2,9 +2,9 @@ module WhopSDK module Resources - class Referrals + class Partners class Businesses - # The Referrals API covers your Whop partner activity: the users you referred onto + # The Partners API covers your Whop partner activity: the users you referred onto # Whop, the businesses you referred and the earnings generated from their # processing volume, and the partner leaderboard. # @@ -21,22 +21,22 @@ module WhopSDK created_after: String, created_before: String, direction: - WhopSDK::Referrals::Businesses::EarningListParams::Direction::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Direction::OrSymbol, first: Integer, last: Integer, order: - WhopSDK::Referrals::Businesses::EarningListParams::Order::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Order::OrSymbol, status: - WhopSDK::Referrals::Businesses::EarningListParams::Status::OrSymbol, + WhopSDK::Partners::Businesses::EarningListParams::Status::OrSymbol, request_options: WhopSDK::RequestOptions::OrHash ).returns( WhopSDK::Internal::CursorPage[ - WhopSDK::Models::Referrals::Businesses::EarningListResponse + WhopSDK::Models::Partners::Businesses::EarningListResponse ] ) end def list( - # The business referral ID (a coma\_ identifier). + # The partner business ID (a coma\_ identifier). id, after: nil, before: nil, diff --git a/rbi/whop_sdk/resources/referrals/partners.rbi b/rbi/whop_sdk/resources/referrals/partners.rbi deleted file mode 100644 index 706e46ac..00000000 --- a/rbi/whop_sdk/resources/referrals/partners.rbi +++ /dev/null @@ -1,31 +0,0 @@ -# typed: strong - -module WhopSDK - module Resources - class Referrals - # The Referrals API covers your Whop partner activity: the users you referred onto - # Whop, the businesses you referred and the earnings generated from their - # processing volume, and the partner leaderboard. - # - # Use it to enroll as a Whop partner, list the users you referred, list your - # referred businesses and review their earnings, and see the partner leaderboard. - class Partners - # Enrolls the calling user in the Whop partner program, making their business - # referrals eligible for earnings. Idempotent — enrolling again keeps the original - # enrollment time. - sig do - params(request_options: WhopSDK::RequestOptions::OrHash).returns( - WhopSDK::Models::Referrals::PartnerCreateResponse - ) - end - def create(request_options: {}) - end - - # @api private - sig { params(client: WhopSDK::Client).returns(T.attached_class) } - def self.new(client:) - end - end - end - end -end diff --git a/rbi/whop_sdk/resources/users.rbi b/rbi/whop_sdk/resources/users.rbi index b3847f79..bc3eb1f8 100644 --- a/rbi/whop_sdk/resources/users.rbi +++ b/rbi/whop_sdk/resources/users.rbi @@ -124,6 +124,24 @@ module WhopSDK ) end + # Lists the recommended actions computed for the user: personal suggestions (e.g. + # start a business or become an affiliate) pooled with the highest-impact actions + # across the accounts the user owns. Business actions are tagged with their + # `account_id`/`account_name`; personal actions leave those `null`. Self-only: + # `id` must be `me` or the authenticated user's own tag/username. + sig do + params( + id: String, + request_options: WhopSDK::RequestOptions::OrHash + ).returns(WhopSDK::Models::UserRecommendActionsResponse) + end + def recommend_actions( + # `me`, or the authenticated user's own `user_` tag or username. + id, + request_options: {} + ) + end + # Updates the authenticated user's global profile, or their profile override for # an account when account_id is given. Not available to API keys. sig do diff --git a/sig/whop_sdk/client.rbs b/sig/whop_sdk/client.rbs index a3ef5e41..94fdab79 100644 --- a/sig/whop_sdk/client.rbs +++ b/sig/whop_sdk/client.rbs @@ -108,7 +108,7 @@ module WhopSDK attr_reader payouts: WhopSDK::Resources::Payouts - attr_reader referrals: WhopSDK::Resources::Referrals + attr_reader partners: WhopSDK::Resources::Partners attr_reader cards: WhopSDK::Resources::Cards diff --git a/sig/whop_sdk/models.rbs b/sig/whop_sdk/models.rbs index 758b2865..fbca643f 100644 --- a/sig/whop_sdk/models.rbs +++ b/sig/whop_sdk/models.rbs @@ -559,6 +559,14 @@ module WhopSDK class PageInfo = WhopSDK::Models::PageInfo + class PartnerCreateParams = WhopSDK::Models::PartnerCreateParams + + class PartnerLeaderboardParams = WhopSDK::Models::PartnerLeaderboardParams + + class PartnerReferredUsersParams = WhopSDK::Models::PartnerReferredUsersParams + + module Partners = WhopSDK::Models::Partners + class Payment = WhopSDK::Models::Payment class PaymentCreatedWebhookEvent = WhopSDK::Models::PaymentCreatedWebhookEvent @@ -669,10 +677,6 @@ module WhopSDK module ReceiptTaxBehavior = WhopSDK::Models::ReceiptTaxBehavior - class ReferralReferredUsersParams = WhopSDK::Models::ReferralReferredUsersParams - - module Referrals = WhopSDK::Models::Referrals - class RefundCreatedWebhookEvent = WhopSDK::Models::RefundCreatedWebhookEvent class RefundListParams = WhopSDK::Models::RefundListParams @@ -807,6 +811,8 @@ module WhopSDK class UserListParams = WhopSDK::Models::UserListParams + class UserRecommendActionsParams = WhopSDK::Models::UserRecommendActionsParams + class UserRetrieveParams = WhopSDK::Models::UserRetrieveParams class UserUpdateMeParams = WhopSDK::Models::UserUpdateMeParams diff --git a/sig/whop_sdk/models/ad_group.rbs b/sig/whop_sdk/models/ad_group.rbs index 3f7741e7..86583ea5 100644 --- a/sig/whop_sdk/models/ad_group.rbs +++ b/sig/whop_sdk/models/ad_group.rbs @@ -32,6 +32,7 @@ module WhopSDK delivery_status: WhopSDK::Models::AdGroup::delivery_status, demographics: top, desired_cost_per_result: Float?, + detailed_targeting: top, devices: top, dynamic_creative: bool, ends_at: String?, @@ -127,6 +128,8 @@ module WhopSDK attr_accessor desired_cost_per_result: Float? + attr_accessor detailed_targeting: top + attr_accessor devices: top attr_accessor dynamic_creative: bool @@ -222,6 +225,7 @@ module WhopSDK delivery_status: WhopSDK::Models::AdGroup::delivery_status, demographics: top, desired_cost_per_result: Float?, + detailed_targeting: top, devices: top, dynamic_creative: bool, ends_at: String?, @@ -287,6 +291,7 @@ module WhopSDK delivery_status: WhopSDK::Models::AdGroup::delivery_status, demographics: top, desired_cost_per_result: Float?, + detailed_targeting: top, devices: top, dynamic_creative: bool, ends_at: String?, diff --git a/sig/whop_sdk/models/ad_group_create_params.rbs b/sig/whop_sdk/models/ad_group_create_params.rbs index 743aa521..a1b38c41 100644 --- a/sig/whop_sdk/models/ad_group_create_params.rbs +++ b/sig/whop_sdk/models/ad_group_create_params.rbs @@ -11,6 +11,7 @@ module WhopSDK conversion_location: WhopSDK::Models::AdGroupCreateParams::conversion_location, demographics: top, desired_cost_per_result: Float, + detailed_targeting: top, devices: top, dynamic_creative: bool, ends_at: String, @@ -69,6 +70,10 @@ module WhopSDK def desired_cost_per_result=: (Float) -> Float + attr_reader detailed_targeting: top? + + def detailed_targeting=: (top) -> top + attr_reader devices: top? def devices=: (top) -> top @@ -135,6 +140,7 @@ module WhopSDK ?conversion_location: WhopSDK::Models::AdGroupCreateParams::conversion_location, ?demographics: top, ?desired_cost_per_result: Float, + ?detailed_targeting: top, ?devices: top, ?dynamic_creative: bool, ?ends_at: String, @@ -161,6 +167,7 @@ module WhopSDK conversion_location: WhopSDK::Models::AdGroupCreateParams::conversion_location, demographics: top, desired_cost_per_result: Float, + detailed_targeting: top, devices: top, dynamic_creative: bool, ends_at: String, diff --git a/sig/whop_sdk/models/ad_group_update_params.rbs b/sig/whop_sdk/models/ad_group_update_params.rbs index 3723d9f2..233cc096 100644 --- a/sig/whop_sdk/models/ad_group_update_params.rbs +++ b/sig/whop_sdk/models/ad_group_update_params.rbs @@ -11,6 +11,7 @@ module WhopSDK conversion_location: WhopSDK::Models::AdGroupUpdateParams::conversion_location, demographics: top, desired_cost_per_result: Float, + detailed_targeting: top, devices: top, ends_at: String, frequency_cap: top, @@ -68,6 +69,10 @@ module WhopSDK def desired_cost_per_result=: (Float) -> Float + attr_reader detailed_targeting: top? + + def detailed_targeting=: (top) -> top + attr_reader devices: top? def devices=: (top) -> top @@ -130,6 +135,7 @@ module WhopSDK ?conversion_location: WhopSDK::Models::AdGroupUpdateParams::conversion_location, ?demographics: top, ?desired_cost_per_result: Float, + ?detailed_targeting: top, ?devices: top, ?ends_at: String, ?frequency_cap: top, @@ -155,6 +161,7 @@ module WhopSDK conversion_location: WhopSDK::Models::AdGroupUpdateParams::conversion_location, demographics: top, desired_cost_per_result: Float, + detailed_targeting: top, devices: top, ends_at: String, frequency_cap: top, diff --git a/sig/whop_sdk/models/event_create_params.rbs b/sig/whop_sdk/models/event_create_params.rbs index 809343bf..55e8a4a0 100644 --- a/sig/whop_sdk/models/event_create_params.rbs +++ b/sig/whop_sdk/models/event_create_params.rbs @@ -3,7 +3,7 @@ module WhopSDK type event_create_params = { account_id: String, - event_name: WhopSDK::Models::EventCreateParams::event_name, + event_name: String, action_source: WhopSDK::Models::EventCreateParams::action_source?, context: WhopSDK::EventCreateParams::Context?, currency: WhopSDK::Models::EventCreateParams::currency?, @@ -29,7 +29,7 @@ module WhopSDK attr_accessor account_id: String - attr_accessor event_name: WhopSDK::Models::EventCreateParams::event_name + attr_accessor event_name: String attr_accessor action_source: WhopSDK::Models::EventCreateParams::action_source? @@ -65,7 +65,7 @@ module WhopSDK def initialize: ( account_id: String, - event_name: WhopSDK::Models::EventCreateParams::event_name, + event_name: String, ?action_source: WhopSDK::Models::EventCreateParams::action_source?, ?context: WhopSDK::EventCreateParams::Context?, ?currency: WhopSDK::Models::EventCreateParams::currency?, @@ -87,7 +87,7 @@ module WhopSDK def to_hash: -> { account_id: String, - event_name: WhopSDK::Models::EventCreateParams::event_name, + event_name: String, action_source: WhopSDK::Models::EventCreateParams::action_source?, context: WhopSDK::EventCreateParams::Context?, currency: WhopSDK::Models::EventCreateParams::currency?, @@ -107,33 +107,6 @@ module WhopSDK request_options: WhopSDK::RequestOptions } - type event_name = - :lead - | :submit_application - | :contact - | :complete_registration - | :schedule - | :view_content - | :add_to_cart - | :custom - | :page - - module EventName - extend WhopSDK::Internal::Type::Enum - - LEAD: :lead - SUBMIT_APPLICATION: :submit_application - CONTACT: :contact - COMPLETE_REGISTRATION: :complete_registration - SCHEDULE: :schedule - VIEW_CONTENT: :view_content - ADD_TO_CART: :add_to_cart - CUSTOM: :custom - PAGE: :page - - def self?.values: -> ::Array[WhopSDK::Models::EventCreateParams::event_name] - end - type action_source = :email | :website diff --git a/sig/whop_sdk/models/invoice.rbs b/sig/whop_sdk/models/invoice.rbs index d6548e65..f52ed9cd 100644 --- a/sig/whop_sdk/models/invoice.rbs +++ b/sig/whop_sdk/models/invoice.rbs @@ -8,6 +8,7 @@ module WhopSDK due_date: Time?, email_address: String?, fetch_invoice_token: String, + line_items: ::Array[WhopSDK::Invoice::LineItem], number: String, status: WhopSDK::Models::invoice_status, user: WhopSDK::Invoice::User? @@ -26,6 +27,8 @@ module WhopSDK attr_accessor fetch_invoice_token: String + attr_accessor line_items: ::Array[WhopSDK::Invoice::LineItem] + attr_accessor number: String attr_accessor status: WhopSDK::Models::invoice_status @@ -39,6 +42,7 @@ module WhopSDK due_date: Time?, email_address: String?, fetch_invoice_token: String, + line_items: ::Array[WhopSDK::Invoice::LineItem], number: String, status: WhopSDK::Models::invoice_status, user: WhopSDK::Invoice::User? @@ -51,6 +55,7 @@ module WhopSDK due_date: Time?, email_address: String?, fetch_invoice_token: String, + line_items: ::Array[WhopSDK::Invoice::LineItem], number: String, status: WhopSDK::Models::invoice_status, user: WhopSDK::Invoice::User? @@ -83,6 +88,43 @@ module WhopSDK } end + type line_item = + { + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + } + + class LineItem < WhopSDK::Internal::Type::BaseModel + attr_accessor label: String + + attr_accessor position: Integer + + attr_accessor quantity: Float + + attr_accessor total: Float + + attr_accessor unit_price: Float + + def initialize: ( + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + ) -> void + + def to_hash: -> { + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + } + end + type user = { id: String, name: String?, username: String } class User < WhopSDK::Internal::Type::BaseModel diff --git a/sig/whop_sdk/models/invoice_list_item.rbs b/sig/whop_sdk/models/invoice_list_item.rbs index e5ba76e0..a7405cc5 100644 --- a/sig/whop_sdk/models/invoice_list_item.rbs +++ b/sig/whop_sdk/models/invoice_list_item.rbs @@ -8,6 +8,7 @@ module WhopSDK due_date: Time?, email_address: String?, fetch_invoice_token: String, + line_items: ::Array[WhopSDK::InvoiceListItem::LineItem], number: String, status: WhopSDK::Models::invoice_status, user: WhopSDK::InvoiceListItem::User? @@ -26,6 +27,8 @@ module WhopSDK attr_accessor fetch_invoice_token: String + attr_accessor line_items: ::Array[WhopSDK::InvoiceListItem::LineItem] + attr_accessor number: String attr_accessor status: WhopSDK::Models::invoice_status @@ -39,6 +42,7 @@ module WhopSDK due_date: Time?, email_address: String?, fetch_invoice_token: String, + line_items: ::Array[WhopSDK::InvoiceListItem::LineItem], number: String, status: WhopSDK::Models::invoice_status, user: WhopSDK::InvoiceListItem::User? @@ -51,6 +55,7 @@ module WhopSDK due_date: Time?, email_address: String?, fetch_invoice_token: String, + line_items: ::Array[WhopSDK::InvoiceListItem::LineItem], number: String, status: WhopSDK::Models::invoice_status, user: WhopSDK::InvoiceListItem::User? @@ -83,6 +88,43 @@ module WhopSDK } end + type line_item = + { + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + } + + class LineItem < WhopSDK::Internal::Type::BaseModel + attr_accessor label: String + + attr_accessor position: Integer + + attr_accessor quantity: Float + + attr_accessor total: Float + + attr_accessor unit_price: Float + + def initialize: ( + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + ) -> void + + def to_hash: -> { + label: String, + position: Integer, + quantity: Float, + total: Float, + unit_price: Float + } + end + type user = { id: String, name: String?, username: String } class User < WhopSDK::Internal::Type::BaseModel diff --git a/sig/whop_sdk/models/partner_create_params.rbs b/sig/whop_sdk/models/partner_create_params.rbs new file mode 100644 index 00000000..e9728e98 --- /dev/null +++ b/sig/whop_sdk/models/partner_create_params.rbs @@ -0,0 +1,15 @@ +module WhopSDK + module Models + type partner_create_params = + { } & WhopSDK::Internal::Type::request_parameters + + class PartnerCreateParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + def initialize: (?request_options: WhopSDK::request_opts) -> void + + def to_hash: -> { request_options: WhopSDK::RequestOptions } + end + end +end diff --git a/sig/whop_sdk/models/partner_create_response.rbs b/sig/whop_sdk/models/partner_create_response.rbs new file mode 100644 index 00000000..13501815 --- /dev/null +++ b/sig/whop_sdk/models/partner_create_response.rbs @@ -0,0 +1,19 @@ +module WhopSDK + module Models + type partner_create_response = + { referral_link: String, whop_partner_enabled_at: Time } + + class PartnerCreateResponse < WhopSDK::Internal::Type::BaseModel + attr_accessor referral_link: String + + attr_accessor whop_partner_enabled_at: Time + + def initialize: ( + referral_link: String, + whop_partner_enabled_at: Time + ) -> void + + def to_hash: -> { referral_link: String, whop_partner_enabled_at: Time } + end + end +end diff --git a/sig/whop_sdk/models/partner_leaderboard_params.rbs b/sig/whop_sdk/models/partner_leaderboard_params.rbs new file mode 100644 index 00000000..2db37578 --- /dev/null +++ b/sig/whop_sdk/models/partner_leaderboard_params.rbs @@ -0,0 +1,42 @@ +module WhopSDK + module Models + type partner_leaderboard_params = + { period: WhopSDK::Models::PartnerLeaderboardParams::period } + & WhopSDK::Internal::Type::request_parameters + + class PartnerLeaderboardParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + attr_reader period: WhopSDK::Models::PartnerLeaderboardParams::period? + + def period=: ( + WhopSDK::Models::PartnerLeaderboardParams::period + ) -> WhopSDK::Models::PartnerLeaderboardParams::period + + def initialize: ( + ?period: WhopSDK::Models::PartnerLeaderboardParams::period, + ?request_options: WhopSDK::request_opts + ) -> void + + def to_hash: -> { + period: WhopSDK::Models::PartnerLeaderboardParams::period, + request_options: WhopSDK::RequestOptions + } + + type period = :day | :month | :year | :last_30_days | :all_time + + module Period + extend WhopSDK::Internal::Type::Enum + + DAY: :day + MONTH: :month + YEAR: :year + LAST_30_DAYS: :last_30_days + ALL_TIME: :all_time + + def self?.values: -> ::Array[WhopSDK::Models::PartnerLeaderboardParams::period] + end + end + end +end diff --git a/sig/whop_sdk/models/partner_leaderboard_response.rbs b/sig/whop_sdk/models/partner_leaderboard_response.rbs new file mode 100644 index 00000000..d4335eb6 --- /dev/null +++ b/sig/whop_sdk/models/partner_leaderboard_response.rbs @@ -0,0 +1,219 @@ +module WhopSDK + module Models + type partner_leaderboard_response = + { + leaders: ::Array[WhopSDK::Models::PartnerLeaderboardResponse::Leader], + me: WhopSDK::Models::PartnerLeaderboardResponse::Me? + } + + class PartnerLeaderboardResponse < WhopSDK::Internal::Type::BaseModel + attr_accessor leaders: ::Array[WhopSDK::Models::PartnerLeaderboardResponse::Leader] + + attr_accessor me: WhopSDK::Models::PartnerLeaderboardResponse::Me? + + def initialize: ( + leaders: ::Array[WhopSDK::Models::PartnerLeaderboardResponse::Leader], + me: WhopSDK::Models::PartnerLeaderboardResponse::Me? + ) -> void + + def to_hash: -> { + leaders: ::Array[WhopSDK::Models::PartnerLeaderboardResponse::Leader], + me: WhopSDK::Models::PartnerLeaderboardResponse::Me? + } + + type leader = + { + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User? + } + + class Leader < WhopSDK::Internal::Type::BaseModel + attr_accessor first_referral_started_at: Time + + attr_accessor rank: Integer + + attr_accessor total_earnings_usd: String + + attr_accessor total_volume_usd: String + + attr_accessor user: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User? + + def initialize: ( + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User? + ) -> void + + def to_hash: -> { + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User? + } + + type user = + { + city: String?, + country: String?, + id: String, + name: String?, + profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture, + username: String + } + + class User < WhopSDK::Internal::Type::BaseModel + attr_accessor city: String? + + attr_accessor country: String? + + attr_reader id: String? + + def id=: (String) -> String + + attr_accessor name: String? + + attr_reader profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture? + + def profile_picture=: ( + WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture + ) -> WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture + + attr_reader username: String? + + def username=: (String) -> String + + def initialize: ( + city: String?, + country: String?, + ?id: String, + ?name: String?, + ?profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture, + ?username: String + ) -> void + + def to_hash: -> { + city: String?, + country: String?, + id: String, + name: String?, + profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Leader::User::ProfilePicture, + username: String + } + + type profile_picture = { url: String } + + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + end + end + + type me = + { + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: WhopSDK::Models::PartnerLeaderboardResponse::Me::User? + } + + class Me < WhopSDK::Internal::Type::BaseModel + attr_accessor first_referral_started_at: Time + + attr_accessor rank: Integer + + attr_accessor total_earnings_usd: String + + attr_accessor total_volume_usd: String + + attr_accessor user: WhopSDK::Models::PartnerLeaderboardResponse::Me::User? + + def initialize: ( + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: WhopSDK::Models::PartnerLeaderboardResponse::Me::User? + ) -> void + + def to_hash: -> { + first_referral_started_at: Time, + rank: Integer, + total_earnings_usd: String, + total_volume_usd: String, + user: WhopSDK::Models::PartnerLeaderboardResponse::Me::User? + } + + type user = + { + city: String?, + country: String?, + id: String, + name: String?, + profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture, + username: String + } + + class User < WhopSDK::Internal::Type::BaseModel + attr_accessor city: String? + + attr_accessor country: String? + + attr_reader id: String? + + def id=: (String) -> String + + attr_accessor name: String? + + attr_reader profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture? + + def profile_picture=: ( + WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture + ) -> WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture + + attr_reader username: String? + + def username=: (String) -> String + + def initialize: ( + city: String?, + country: String?, + ?id: String, + ?name: String?, + ?profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture, + ?username: String + ) -> void + + def to_hash: -> { + city: String?, + country: String?, + id: String, + name: String?, + profile_picture: WhopSDK::Models::PartnerLeaderboardResponse::Me::User::ProfilePicture, + username: String + } + + type profile_picture = { url: String } + + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + end + end + end + end +end diff --git a/sig/whop_sdk/models/referral_referred_users_params.rbs b/sig/whop_sdk/models/partner_referred_users_params.rbs similarity index 92% rename from sig/whop_sdk/models/referral_referred_users_params.rbs rename to sig/whop_sdk/models/partner_referred_users_params.rbs index d0da687f..4217be0d 100644 --- a/sig/whop_sdk/models/referral_referred_users_params.rbs +++ b/sig/whop_sdk/models/partner_referred_users_params.rbs @@ -1,6 +1,6 @@ module WhopSDK module Models - type referral_referred_users_params = + type partner_referred_users_params = { after: String, before: String, @@ -11,7 +11,7 @@ module WhopSDK } & WhopSDK::Internal::Type::request_parameters - class ReferralReferredUsersParams < WhopSDK::Internal::Type::BaseModel + class PartnerReferredUsersParams < WhopSDK::Internal::Type::BaseModel extend WhopSDK::Internal::Type::RequestParameters::Converter include WhopSDK::Internal::Type::RequestParameters diff --git a/sig/whop_sdk/models/referral_referred_users_response.rbs b/sig/whop_sdk/models/partner_referred_users_response.rbs similarity index 61% rename from sig/whop_sdk/models/referral_referred_users_response.rbs rename to sig/whop_sdk/models/partner_referred_users_response.rbs index b6fbfb1b..0e40f7d3 100644 --- a/sig/whop_sdk/models/referral_referred_users_response.rbs +++ b/sig/whop_sdk/models/partner_referred_users_response.rbs @@ -1,31 +1,31 @@ module WhopSDK module Models - type referral_referred_users_response = + type partner_referred_users_response = { - data: ::Array[WhopSDK::Models::ReferralReferredUsersResponse::Data], - page_info: WhopSDK::Models::ReferralReferredUsersResponse::PageInfo + data: ::Array[WhopSDK::Models::PartnerReferredUsersResponse::Data], + page_info: WhopSDK::Models::PartnerReferredUsersResponse::PageInfo } - class ReferralReferredUsersResponse < WhopSDK::Internal::Type::BaseModel - attr_accessor data: ::Array[WhopSDK::Models::ReferralReferredUsersResponse::Data] + class PartnerReferredUsersResponse < WhopSDK::Internal::Type::BaseModel + attr_accessor data: ::Array[WhopSDK::Models::PartnerReferredUsersResponse::Data] - attr_accessor page_info: WhopSDK::Models::ReferralReferredUsersResponse::PageInfo + attr_accessor page_info: WhopSDK::Models::PartnerReferredUsersResponse::PageInfo def initialize: ( - data: ::Array[WhopSDK::Models::ReferralReferredUsersResponse::Data], - page_info: WhopSDK::Models::ReferralReferredUsersResponse::PageInfo + data: ::Array[WhopSDK::Models::PartnerReferredUsersResponse::Data], + page_info: WhopSDK::Models::PartnerReferredUsersResponse::PageInfo ) -> void def to_hash: -> { - data: ::Array[WhopSDK::Models::ReferralReferredUsersResponse::Data], - page_info: WhopSDK::Models::ReferralReferredUsersResponse::PageInfo + data: ::Array[WhopSDK::Models::PartnerReferredUsersResponse::Data], + page_info: WhopSDK::Models::PartnerReferredUsersResponse::PageInfo } type data = { total_earnings_usd: String, total_volume_usd: String, - user: WhopSDK::Models::ReferralReferredUsersResponse::Data::User + user: WhopSDK::Models::PartnerReferredUsersResponse::Data::User } class Data < WhopSDK::Internal::Type::BaseModel @@ -33,18 +33,18 @@ module WhopSDK attr_accessor total_volume_usd: String - attr_accessor user: WhopSDK::Models::ReferralReferredUsersResponse::Data::User + attr_accessor user: WhopSDK::Models::PartnerReferredUsersResponse::Data::User def initialize: ( total_earnings_usd: String, total_volume_usd: String, - user: WhopSDK::Models::ReferralReferredUsersResponse::Data::User + user: WhopSDK::Models::PartnerReferredUsersResponse::Data::User ) -> void def to_hash: -> { total_earnings_usd: String, total_volume_usd: String, - user: WhopSDK::Models::ReferralReferredUsersResponse::Data::User + user: WhopSDK::Models::PartnerReferredUsersResponse::Data::User } type user = @@ -54,7 +54,7 @@ module WhopSDK city: String?, country: String?, name: String?, - profile_picture: WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture + profile_picture: WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture } class User < WhopSDK::Internal::Type::BaseModel @@ -68,11 +68,11 @@ module WhopSDK attr_accessor name: String? - attr_reader profile_picture: WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture? + attr_reader profile_picture: WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture? def profile_picture=: ( - WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture - ) -> WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture + WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture + ) -> WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture def initialize: ( id: String, @@ -80,7 +80,7 @@ module WhopSDK ?city: String?, ?country: String?, ?name: String?, - ?profile_picture: WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture + ?profile_picture: WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture ) -> void def to_hash: -> { @@ -89,7 +89,7 @@ module WhopSDK city: String?, country: String?, name: String?, - profile_picture: WhopSDK::Models::ReferralReferredUsersResponse::Data::User::ProfilePicture + profile_picture: WhopSDK::Models::PartnerReferredUsersResponse::Data::User::ProfilePicture } type profile_picture = { url: String? } diff --git a/sig/whop_sdk/models/referrals/business_list_params.rbs b/sig/whop_sdk/models/partners/business_list_params.rbs similarity index 61% rename from sig/whop_sdk/models/referrals/business_list_params.rbs rename to sig/whop_sdk/models/partners/business_list_params.rbs index 9b8d3850..8f39caf3 100644 --- a/sig/whop_sdk/models/referrals/business_list_params.rbs +++ b/sig/whop_sdk/models/partners/business_list_params.rbs @@ -1,21 +1,21 @@ module WhopSDK module Models - module Referrals + module Partners type business_list_params = { after: String, before: String, created_after: String, created_before: String, - direction: WhopSDK::Models::Referrals::BusinessListParams::direction, + direction: WhopSDK::Models::Partners::BusinessListParams::direction, first: Integer, has_earnings: bool, last: Integer, - order: WhopSDK::Models::Referrals::BusinessListParams::order, + order: WhopSDK::Models::Partners::BusinessListParams::order, referred_user_id: String, referred_username: String, - status: WhopSDK::Models::Referrals::BusinessListParams::status, - tier: WhopSDK::Models::Referrals::BusinessListParams::tier + status: WhopSDK::Models::Partners::BusinessListParams::status, + tier: WhopSDK::Models::Partners::BusinessListParams::tier } & WhopSDK::Internal::Type::request_parameters @@ -39,11 +39,11 @@ module WhopSDK def created_before=: (String) -> String - attr_reader direction: WhopSDK::Models::Referrals::BusinessListParams::direction? + attr_reader direction: WhopSDK::Models::Partners::BusinessListParams::direction? def direction=: ( - WhopSDK::Models::Referrals::BusinessListParams::direction - ) -> WhopSDK::Models::Referrals::BusinessListParams::direction + WhopSDK::Models::Partners::BusinessListParams::direction + ) -> WhopSDK::Models::Partners::BusinessListParams::direction attr_reader first: Integer? @@ -57,11 +57,11 @@ module WhopSDK def last=: (Integer) -> Integer - attr_reader order: WhopSDK::Models::Referrals::BusinessListParams::order? + attr_reader order: WhopSDK::Models::Partners::BusinessListParams::order? def order=: ( - WhopSDK::Models::Referrals::BusinessListParams::order - ) -> WhopSDK::Models::Referrals::BusinessListParams::order + WhopSDK::Models::Partners::BusinessListParams::order + ) -> WhopSDK::Models::Partners::BusinessListParams::order attr_reader referred_user_id: String? @@ -71,32 +71,32 @@ module WhopSDK def referred_username=: (String) -> String - attr_reader status: WhopSDK::Models::Referrals::BusinessListParams::status? + attr_reader status: WhopSDK::Models::Partners::BusinessListParams::status? def status=: ( - WhopSDK::Models::Referrals::BusinessListParams::status - ) -> WhopSDK::Models::Referrals::BusinessListParams::status + WhopSDK::Models::Partners::BusinessListParams::status + ) -> WhopSDK::Models::Partners::BusinessListParams::status - attr_reader tier: WhopSDK::Models::Referrals::BusinessListParams::tier? + attr_reader tier: WhopSDK::Models::Partners::BusinessListParams::tier? def tier=: ( - WhopSDK::Models::Referrals::BusinessListParams::tier - ) -> WhopSDK::Models::Referrals::BusinessListParams::tier + WhopSDK::Models::Partners::BusinessListParams::tier + ) -> WhopSDK::Models::Partners::BusinessListParams::tier def initialize: ( ?after: String, ?before: String, ?created_after: String, ?created_before: String, - ?direction: WhopSDK::Models::Referrals::BusinessListParams::direction, + ?direction: WhopSDK::Models::Partners::BusinessListParams::direction, ?first: Integer, ?has_earnings: bool, ?last: Integer, - ?order: WhopSDK::Models::Referrals::BusinessListParams::order, + ?order: WhopSDK::Models::Partners::BusinessListParams::order, ?referred_user_id: String, ?referred_username: String, - ?status: WhopSDK::Models::Referrals::BusinessListParams::status, - ?tier: WhopSDK::Models::Referrals::BusinessListParams::tier, + ?status: WhopSDK::Models::Partners::BusinessListParams::status, + ?tier: WhopSDK::Models::Partners::BusinessListParams::tier, ?request_options: WhopSDK::request_opts ) -> void @@ -105,15 +105,15 @@ module WhopSDK before: String, created_after: String, created_before: String, - direction: WhopSDK::Models::Referrals::BusinessListParams::direction, + direction: WhopSDK::Models::Partners::BusinessListParams::direction, first: Integer, has_earnings: bool, last: Integer, - order: WhopSDK::Models::Referrals::BusinessListParams::order, + order: WhopSDK::Models::Partners::BusinessListParams::order, referred_user_id: String, referred_username: String, - status: WhopSDK::Models::Referrals::BusinessListParams::status, - tier: WhopSDK::Models::Referrals::BusinessListParams::tier, + status: WhopSDK::Models::Partners::BusinessListParams::status, + tier: WhopSDK::Models::Partners::BusinessListParams::tier, request_options: WhopSDK::RequestOptions } @@ -125,7 +125,7 @@ module WhopSDK ASC: :asc DESC: :desc - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessListParams::direction] + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessListParams::direction] end type order = @@ -146,7 +146,7 @@ module WhopSDK VOLUME_USD: :volume_usd EARNINGS_USD: :earnings_usd - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessListParams::order] + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessListParams::order] end type status = :active | :removed @@ -157,7 +157,7 @@ module WhopSDK ACTIVE: :active REMOVED: :removed - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessListParams::status] + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessListParams::status] end type tier = :first | :second @@ -168,7 +168,7 @@ module WhopSDK FIRST: :first SECOND: :second - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessListParams::tier] + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessListParams::tier] end end end diff --git a/sig/whop_sdk/models/referrals/business_list_response.rbs b/sig/whop_sdk/models/partners/business_list_response.rbs similarity index 54% rename from sig/whop_sdk/models/referrals/business_list_response.rbs rename to sig/whop_sdk/models/partners/business_list_response.rbs index 6cbcf9c5..e26191b8 100644 --- a/sig/whop_sdk/models/referrals/business_list_response.rbs +++ b/sig/whop_sdk/models/partners/business_list_response.rbs @@ -1,39 +1,39 @@ module WhopSDK module Models - module Referrals + module Partners type business_list_response = { id: String, - account: WhopSDK::Models::Referrals::BusinessListResponse::Account?, + account: WhopSDK::Models::Partners::BusinessListResponse::Account?, created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner?, - my_partner_tier: WhopSDK::Models::Referrals::BusinessListResponse::my_partner_tier, - object: WhopSDK::Models::Referrals::BusinessListResponse::object, - owner: WhopSDK::Models::Referrals::BusinessListResponse::Owner?, + earnings_usd: WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner?, + my_partner_tier: WhopSDK::Models::Partners::BusinessListResponse::my_partner_tier, + object: WhopSDK::Models::Partners::BusinessListResponse::object, + owner: WhopSDK::Models::Partners::BusinessListResponse::Owner?, payout_percentage: Float, referral_expires_at: Time?, referral_started_at: Time?, - status: WhopSDK::Models::Referrals::BusinessListResponse::status, - volume_usd: WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd + status: WhopSDK::Models::Partners::BusinessListResponse::status, + volume_usd: WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd } class BusinessListResponse < WhopSDK::Internal::Type::BaseModel attr_accessor id: String - attr_accessor account: WhopSDK::Models::Referrals::BusinessListResponse::Account? + attr_accessor account: WhopSDK::Models::Partners::BusinessListResponse::Account? attr_accessor created_at: Time - attr_accessor earnings_usd: WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd + attr_accessor earnings_usd: WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd - attr_accessor first_tier_partner: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner? + attr_accessor first_tier_partner: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner? - attr_accessor my_partner_tier: WhopSDK::Models::Referrals::BusinessListResponse::my_partner_tier + attr_accessor my_partner_tier: WhopSDK::Models::Partners::BusinessListResponse::my_partner_tier - attr_accessor object: WhopSDK::Models::Referrals::BusinessListResponse::object + attr_accessor object: WhopSDK::Models::Partners::BusinessListResponse::object - attr_accessor owner: WhopSDK::Models::Referrals::BusinessListResponse::Owner? + attr_accessor owner: WhopSDK::Models::Partners::BusinessListResponse::Owner? attr_accessor payout_percentage: Float @@ -41,40 +41,40 @@ module WhopSDK attr_accessor referral_started_at: Time? - attr_accessor status: WhopSDK::Models::Referrals::BusinessListResponse::status + attr_accessor status: WhopSDK::Models::Partners::BusinessListResponse::status - attr_accessor volume_usd: WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd + attr_accessor volume_usd: WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd def initialize: ( id: String, - account: WhopSDK::Models::Referrals::BusinessListResponse::Account?, + account: WhopSDK::Models::Partners::BusinessListResponse::Account?, created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner?, - my_partner_tier: WhopSDK::Models::Referrals::BusinessListResponse::my_partner_tier, - object: WhopSDK::Models::Referrals::BusinessListResponse::object, - owner: WhopSDK::Models::Referrals::BusinessListResponse::Owner?, + earnings_usd: WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner?, + my_partner_tier: WhopSDK::Models::Partners::BusinessListResponse::my_partner_tier, + object: WhopSDK::Models::Partners::BusinessListResponse::object, + owner: WhopSDK::Models::Partners::BusinessListResponse::Owner?, payout_percentage: Float, referral_expires_at: Time?, referral_started_at: Time?, - status: WhopSDK::Models::Referrals::BusinessListResponse::status, - volume_usd: WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd + status: WhopSDK::Models::Partners::BusinessListResponse::status, + volume_usd: WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd ) -> void def to_hash: -> { id: String, - account: WhopSDK::Models::Referrals::BusinessListResponse::Account?, + account: WhopSDK::Models::Partners::BusinessListResponse::Account?, created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner?, - my_partner_tier: WhopSDK::Models::Referrals::BusinessListResponse::my_partner_tier, - object: WhopSDK::Models::Referrals::BusinessListResponse::object, - owner: WhopSDK::Models::Referrals::BusinessListResponse::Owner?, + earnings_usd: WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner?, + my_partner_tier: WhopSDK::Models::Partners::BusinessListResponse::my_partner_tier, + object: WhopSDK::Models::Partners::BusinessListResponse::object, + owner: WhopSDK::Models::Partners::BusinessListResponse::Owner?, payout_percentage: Float, referral_expires_at: Time?, referral_started_at: Time?, - status: WhopSDK::Models::Referrals::BusinessListResponse::status, - volume_usd: WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd + status: WhopSDK::Models::Partners::BusinessListResponse::status, + volume_usd: WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd } type account = @@ -127,7 +127,7 @@ module WhopSDK { id: String, name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture, + profile_picture: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture, username: String } @@ -136,21 +136,21 @@ module WhopSDK attr_accessor name: String? - attr_accessor profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture + attr_accessor profile_picture: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture attr_accessor username: String def initialize: ( id: String, name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture, + profile_picture: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture, username: String ) -> void def to_hash: -> { id: String, name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner::ProfilePicture, + profile_picture: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner::ProfilePicture, username: String } @@ -173,24 +173,24 @@ module WhopSDK FIRST: :first SECOND: :second - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessListResponse::my_partner_tier] + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessListResponse::my_partner_tier] end - type object = :business_referral + type object = :partner_business module Object extend WhopSDK::Internal::Type::Enum - BUSINESS_REFERRAL: :business_referral + PARTNER_BUSINESS: :partner_business - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessListResponse::object] + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessListResponse::object] end type owner = { id: String, name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture, + profile_picture: WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture, username: String } @@ -199,21 +199,21 @@ module WhopSDK attr_accessor name: String? - attr_accessor profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture + attr_accessor profile_picture: WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture attr_accessor username: String def initialize: ( id: String, name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture, + profile_picture: WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture, username: String ) -> void def to_hash: -> { id: String, name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessListResponse::Owner::ProfilePicture, + profile_picture: WhopSDK::Models::Partners::BusinessListResponse::Owner::ProfilePicture, username: String } @@ -236,7 +236,7 @@ module WhopSDK ACTIVE: :active REMOVED: :removed - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessListResponse::status] + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessListResponse::status] end type volume_usd = diff --git a/sig/whop_sdk/models/referrals/business_retrieve_params.rbs b/sig/whop_sdk/models/partners/business_retrieve_params.rbs similarity index 96% rename from sig/whop_sdk/models/referrals/business_retrieve_params.rbs rename to sig/whop_sdk/models/partners/business_retrieve_params.rbs index 2e77fe58..b9db1250 100644 --- a/sig/whop_sdk/models/referrals/business_retrieve_params.rbs +++ b/sig/whop_sdk/models/partners/business_retrieve_params.rbs @@ -1,6 +1,6 @@ module WhopSDK module Models - module Referrals + module Partners type business_retrieve_params = { id: String } & WhopSDK::Internal::Type::request_parameters diff --git a/sig/whop_sdk/models/partners/business_retrieve_response.rbs b/sig/whop_sdk/models/partners/business_retrieve_response.rbs new file mode 100644 index 00000000..990d6bac --- /dev/null +++ b/sig/whop_sdk/models/partners/business_retrieve_response.rbs @@ -0,0 +1,677 @@ +module WhopSDK + module Models + module Partners + type business_retrieve_response = + { + id: String, + account: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account?, + created_at: Time, + earnings_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner?, + my_partner_tier: WhopSDK::Models::Partners::BusinessRetrieveResponse::my_partner_tier, + object: WhopSDK::Models::Partners::BusinessRetrieveResponse::object, + owner: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner?, + payout_percentage: Float, + referral_expires_at: Time?, + referral_started_at: Time?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::status, + volume_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd + } + + class BusinessRetrieveResponse < WhopSDK::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor account: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account? + + attr_accessor created_at: Time + + attr_accessor earnings_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd + + attr_accessor first_tier_partner: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner? + + attr_accessor my_partner_tier: WhopSDK::Models::Partners::BusinessRetrieveResponse::my_partner_tier + + attr_accessor object: WhopSDK::Models::Partners::BusinessRetrieveResponse::object + + attr_accessor owner: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner? + + attr_accessor payout_percentage: Float + + attr_accessor referral_expires_at: Time? + + attr_accessor referral_started_at: Time? + + attr_accessor status: WhopSDK::Models::Partners::BusinessRetrieveResponse::status + + attr_accessor volume_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd + + def initialize: ( + id: String, + account: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account?, + created_at: Time, + earnings_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner?, + my_partner_tier: WhopSDK::Models::Partners::BusinessRetrieveResponse::my_partner_tier, + object: WhopSDK::Models::Partners::BusinessRetrieveResponse::object, + owner: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner?, + payout_percentage: Float, + referral_expires_at: Time?, + referral_started_at: Time?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::status, + volume_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd + ) -> void + + def to_hash: -> { + id: String, + account: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account?, + created_at: Time, + earnings_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner?, + my_partner_tier: WhopSDK::Models::Partners::BusinessRetrieveResponse::my_partner_tier, + object: WhopSDK::Models::Partners::BusinessRetrieveResponse::object, + owner: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner?, + payout_percentage: Float, + referral_expires_at: Time?, + referral_started_at: Time?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::status, + volume_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd + } + + type account = + { + id: String, + capabilities: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities?, + logo_url: String?, + recommended_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction]?, + required_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction]?, + route: String, + title: String + } + + class Account < WhopSDK::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor capabilities: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities? + + attr_accessor logo_url: String? + + attr_accessor recommended_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction]? + + attr_accessor required_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction]? + + attr_accessor route: String + + attr_accessor title: String + + def initialize: ( + id: String, + capabilities: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities?, + logo_url: String?, + recommended_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction]?, + required_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction]?, + route: String, + title: String + ) -> void + + def to_hash: -> { + id: String, + capabilities: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities?, + logo_url: String?, + recommended_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction]?, + required_actions: ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction]?, + route: String, + title: String + } + + type capabilities = + { + accept_bank_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments, + accept_bnpl_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments, + accept_card_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments, + bank_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::bank_deposit, + card_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_deposit, + card_issuing: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_issuing, + crypto_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit, + crypto_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_payout, + instant_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::instant_payout, + standard_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::standard_payout, + transfer: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::transfer + } + + class Capabilities < WhopSDK::Internal::Type::BaseModel + attr_accessor accept_bank_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments + + attr_accessor accept_bnpl_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments + + attr_accessor accept_card_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments + + attr_accessor bank_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::bank_deposit + + attr_accessor card_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_deposit + + attr_accessor card_issuing: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_issuing + + attr_accessor crypto_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit + + attr_accessor crypto_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_payout + + attr_accessor instant_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::instant_payout + + attr_accessor standard_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::standard_payout + + attr_accessor transfer: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::transfer + + def initialize: ( + accept_bank_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments, + accept_bnpl_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments, + accept_card_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments, + bank_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::bank_deposit, + card_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_deposit, + card_issuing: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_issuing, + crypto_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit, + crypto_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_payout, + instant_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::instant_payout, + standard_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::standard_payout, + transfer: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::transfer + ) -> void + + def to_hash: -> { + accept_bank_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments, + accept_bnpl_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments, + accept_card_payments: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments, + bank_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::bank_deposit, + card_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_deposit, + card_issuing: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_issuing, + crypto_deposit: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit, + crypto_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_payout, + instant_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::instant_payout, + standard_payout: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::standard_payout, + transfer: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::transfer + } + + type accept_bank_payments = :active | :inactive | :pending + + module AcceptBankPayments + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments] + end + + type accept_bnpl_payments = :active | :inactive | :pending + + module AcceptBnplPayments + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments] + end + + type accept_card_payments = :active | :inactive | :pending + + module AcceptCardPayments + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments] + end + + type bank_deposit = :active | :inactive | :pending + + module BankDeposit + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::bank_deposit] + end + + type card_deposit = :active | :inactive | :pending + + module CardDeposit + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_deposit] + end + + type card_issuing = :active | :inactive | :pending + + module CardIssuing + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::card_issuing] + end + + type crypto_deposit = :active | :inactive | :pending + + module CryptoDeposit + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit] + end + + type crypto_payout = :active | :inactive | :pending + + module CryptoPayout + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::crypto_payout] + end + + type instant_payout = :active | :inactive | :pending + + module InstantPayout + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::instant_payout] + end + + type standard_payout = :active | :inactive | :pending + + module StandardPayout + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::standard_payout] + end + + type transfer = :active | :inactive | :pending + + module Transfer + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + INACTIVE: :inactive + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::Capabilities::transfer] + end + end + + type recommended_action = + { + action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::action, + blocked_capabilities: ::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: String?, + impact_score: Integer?, + reasoning: String?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::status, + title: String + } + + class RecommendedAction < WhopSDK::Internal::Type::BaseModel + attr_accessor action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::action + + attr_accessor blocked_capabilities: ::Array[String] + + attr_accessor cta: String + + attr_accessor cta_label: String + + attr_accessor description: String + + attr_accessor icon_url: String? + + attr_accessor impact_score: Integer? + + attr_accessor reasoning: String? + + attr_accessor status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::status + + attr_accessor title: String + + def initialize: ( + action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::action, + blocked_capabilities: ::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: String?, + impact_score: Integer?, + reasoning: String?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::status, + title: String + ) -> void + + def to_hash: -> { + action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::action, + blocked_capabilities: ::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: String?, + impact_score: Integer?, + reasoning: String?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::status, + title: String + } + + type action = + :theme_business + | :create_product + | :create_plan + | :verify_identity + | :connect_affiliate_program + | :create_promotion + | :setup_tracking_pixel + | :migrate_from_stripe + | :accept_first_payment + | :launch_first_ad + | :invite_team_member + | :enable_tax_collection + | :create_card + | :join_whop_university + | :apply_for_financing + + module Action + extend WhopSDK::Internal::Type::Enum + + THEME_BUSINESS: :theme_business + CREATE_PRODUCT: :create_product + CREATE_PLAN: :create_plan + VERIFY_IDENTITY: :verify_identity + CONNECT_AFFILIATE_PROGRAM: :connect_affiliate_program + CREATE_PROMOTION: :create_promotion + SETUP_TRACKING_PIXEL: :setup_tracking_pixel + MIGRATE_FROM_STRIPE: :migrate_from_stripe + ACCEPT_FIRST_PAYMENT: :accept_first_payment + LAUNCH_FIRST_AD: :launch_first_ad + INVITE_TEAM_MEMBER: :invite_team_member + ENABLE_TAX_COLLECTION: :enable_tax_collection + CREATE_CARD: :create_card + JOIN_WHOP_UNIVERSITY: :join_whop_university + APPLY_FOR_FINANCING: :apply_for_financing + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::action] + end + + type status = :optional + + module Status + extend WhopSDK::Internal::Type::Enum + + OPTIONAL: :optional + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RecommendedAction::status] + end + end + + type required_action = + { + action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::action, + blocked_capabilities: ::Array[String], + cta: String?, + cta_label: String, + description: String, + icon_url: String?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::status, + title: String + } + + class RequiredAction < WhopSDK::Internal::Type::BaseModel + attr_accessor action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::action + + attr_accessor blocked_capabilities: ::Array[String] + + attr_accessor cta: String? + + attr_accessor cta_label: String + + attr_accessor description: String + + attr_accessor icon_url: String? + + attr_accessor status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::status + + attr_accessor title: String + + def initialize: ( + action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::action, + blocked_capabilities: ::Array[String], + cta: String?, + cta_label: String, + description: String, + icon_url: String?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::status, + title: String + ) -> void + + def to_hash: -> { + action: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::action, + blocked_capabilities: ::Array[String], + cta: String?, + cta_label: String, + description: String, + icon_url: String?, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::status, + title: String + } + + type action = + :deposit_funds + | :submit_information_request + | :verify_identity + | :connect_fulfillment_tracker + + module Action + extend WhopSDK::Internal::Type::Enum + + DEPOSIT_FUNDS: :deposit_funds + SUBMIT_INFORMATION_REQUEST: :submit_information_request + VERIFY_IDENTITY: :verify_identity + CONNECT_FULFILLMENT_TRACKER: :connect_fulfillment_tracker + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::action] + end + + type status = :required | :pending + + module Status + extend WhopSDK::Internal::Type::Enum + + REQUIRED: :required + PENDING: :pending + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::Account::RequiredAction::status] + end + end + end + + type earnings_usd = + { completed: String, pending: String, total: String } + + class EarningsUsd < WhopSDK::Internal::Type::BaseModel + attr_accessor completed: String + + attr_accessor pending: String + + attr_accessor total: String + + def initialize: ( + completed: String, + pending: String, + total: String + ) -> void + + def to_hash: -> { completed: String, pending: String, total: String } + end + + type first_tier_partner = + { + id: String, + name: String?, + profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, + username: String + } + + class FirstTierPartner < WhopSDK::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor name: String? + + attr_accessor profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture + + attr_accessor username: String + + def initialize: ( + id: String, + name: String?, + profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, + username: String + ) -> void + + def to_hash: -> { + id: String, + name: String?, + profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, + username: String + } + + type profile_picture = { url: String } + + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + end + + type my_partner_tier = :first | :second + + module MyPartnerTier + extend WhopSDK::Internal::Type::Enum + + FIRST: :first + SECOND: :second + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::my_partner_tier] + end + + type object = :partner_business + + module Object + extend WhopSDK::Internal::Type::Enum + + PARTNER_BUSINESS: :partner_business + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::object] + end + + type owner = + { + id: String, + name: String?, + profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture, + username: String + } + + class Owner < WhopSDK::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor name: String? + + attr_accessor profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture + + attr_accessor username: String + + def initialize: ( + id: String, + name: String?, + profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture, + username: String + ) -> void + + def to_hash: -> { + id: String, + name: String?, + profile_picture: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner::ProfilePicture, + username: String + } + + type profile_picture = { url: String } + + class ProfilePicture < WhopSDK::Internal::Type::BaseModel + attr_accessor url: String + + def initialize: (url: String) -> void + + def to_hash: -> { url: String } + end + end + + type status = :active | :removed + + module Status + extend WhopSDK::Internal::Type::Enum + + ACTIVE: :active + REMOVED: :removed + + def self?.values: -> ::Array[WhopSDK::Models::Partners::BusinessRetrieveResponse::status] + end + + type volume_usd = + { attributed: String, awaiting_settlement: String, settled: String } + + class VolumeUsd < WhopSDK::Internal::Type::BaseModel + attr_accessor attributed: String + + attr_accessor awaiting_settlement: String + + attr_accessor settled: String + + def initialize: ( + attributed: String, + awaiting_settlement: String, + settled: String + ) -> void + + def to_hash: -> { + attributed: String, + awaiting_settlement: String, + settled: String + } + end + end + end + end +end diff --git a/sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs b/sig/whop_sdk/models/partners/businesses/earning_list_params.rbs similarity index 60% rename from sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs rename to sig/whop_sdk/models/partners/businesses/earning_list_params.rbs index f5cd431d..cd701cf7 100644 --- a/sig/whop_sdk/models/referrals/businesses/earning_list_params.rbs +++ b/sig/whop_sdk/models/partners/businesses/earning_list_params.rbs @@ -1,6 +1,6 @@ module WhopSDK module Models - module Referrals + module Partners module Businesses type earning_list_params = { @@ -9,11 +9,11 @@ module WhopSDK before: String, created_after: String, created_before: String, - direction: WhopSDK::Models::Referrals::Businesses::EarningListParams::direction, + direction: WhopSDK::Models::Partners::Businesses::EarningListParams::direction, first: Integer, last: Integer, - order: WhopSDK::Models::Referrals::Businesses::EarningListParams::order, - status: WhopSDK::Models::Referrals::Businesses::EarningListParams::status + order: WhopSDK::Models::Partners::Businesses::EarningListParams::order, + status: WhopSDK::Models::Partners::Businesses::EarningListParams::status } & WhopSDK::Internal::Type::request_parameters @@ -39,11 +39,11 @@ module WhopSDK def created_before=: (String) -> String - attr_reader direction: WhopSDK::Models::Referrals::Businesses::EarningListParams::direction? + attr_reader direction: WhopSDK::Models::Partners::Businesses::EarningListParams::direction? def direction=: ( - WhopSDK::Models::Referrals::Businesses::EarningListParams::direction - ) -> WhopSDK::Models::Referrals::Businesses::EarningListParams::direction + WhopSDK::Models::Partners::Businesses::EarningListParams::direction + ) -> WhopSDK::Models::Partners::Businesses::EarningListParams::direction attr_reader first: Integer? @@ -53,17 +53,17 @@ module WhopSDK def last=: (Integer) -> Integer - attr_reader order: WhopSDK::Models::Referrals::Businesses::EarningListParams::order? + attr_reader order: WhopSDK::Models::Partners::Businesses::EarningListParams::order? def order=: ( - WhopSDK::Models::Referrals::Businesses::EarningListParams::order - ) -> WhopSDK::Models::Referrals::Businesses::EarningListParams::order + WhopSDK::Models::Partners::Businesses::EarningListParams::order + ) -> WhopSDK::Models::Partners::Businesses::EarningListParams::order - attr_reader status: WhopSDK::Models::Referrals::Businesses::EarningListParams::status? + attr_reader status: WhopSDK::Models::Partners::Businesses::EarningListParams::status? def status=: ( - WhopSDK::Models::Referrals::Businesses::EarningListParams::status - ) -> WhopSDK::Models::Referrals::Businesses::EarningListParams::status + WhopSDK::Models::Partners::Businesses::EarningListParams::status + ) -> WhopSDK::Models::Partners::Businesses::EarningListParams::status def initialize: ( id: String, @@ -71,11 +71,11 @@ module WhopSDK ?before: String, ?created_after: String, ?created_before: String, - ?direction: WhopSDK::Models::Referrals::Businesses::EarningListParams::direction, + ?direction: WhopSDK::Models::Partners::Businesses::EarningListParams::direction, ?first: Integer, ?last: Integer, - ?order: WhopSDK::Models::Referrals::Businesses::EarningListParams::order, - ?status: WhopSDK::Models::Referrals::Businesses::EarningListParams::status, + ?order: WhopSDK::Models::Partners::Businesses::EarningListParams::order, + ?status: WhopSDK::Models::Partners::Businesses::EarningListParams::status, ?request_options: WhopSDK::request_opts ) -> void @@ -85,11 +85,11 @@ module WhopSDK before: String, created_after: String, created_before: String, - direction: WhopSDK::Models::Referrals::Businesses::EarningListParams::direction, + direction: WhopSDK::Models::Partners::Businesses::EarningListParams::direction, first: Integer, last: Integer, - order: WhopSDK::Models::Referrals::Businesses::EarningListParams::order, - status: WhopSDK::Models::Referrals::Businesses::EarningListParams::status, + order: WhopSDK::Models::Partners::Businesses::EarningListParams::order, + status: WhopSDK::Models::Partners::Businesses::EarningListParams::status, request_options: WhopSDK::RequestOptions } @@ -101,7 +101,7 @@ module WhopSDK ASC: :asc DESC: :desc - def self?.values: -> ::Array[WhopSDK::Models::Referrals::Businesses::EarningListParams::direction] + def self?.values: -> ::Array[WhopSDK::Models::Partners::Businesses::EarningListParams::direction] end type order = @@ -115,7 +115,7 @@ module WhopSDK TRANSACTION_AMOUNT: :transaction_amount PAYOUT_AT: :payout_at - def self?.values: -> ::Array[WhopSDK::Models::Referrals::Businesses::EarningListParams::order] + def self?.values: -> ::Array[WhopSDK::Models::Partners::Businesses::EarningListParams::order] end type status = @@ -130,7 +130,7 @@ module WhopSDK CANCELED: :canceled REVERSED: :reversed - def self?.values: -> ::Array[WhopSDK::Models::Referrals::Businesses::EarningListParams::status] + def self?.values: -> ::Array[WhopSDK::Models::Partners::Businesses::EarningListParams::status] end end end diff --git a/sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs b/sig/whop_sdk/models/partners/businesses/earning_list_response.rbs similarity index 59% rename from sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs rename to sig/whop_sdk/models/partners/businesses/earning_list_response.rbs index 03985c4e..d111503c 100644 --- a/sig/whop_sdk/models/referrals/businesses/earning_list_response.rbs +++ b/sig/whop_sdk/models/partners/businesses/earning_list_response.rbs @@ -1,29 +1,29 @@ module WhopSDK module Models - module Referrals + module Partners module Businesses type earning_list_response = { id: String?, - account: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account?, + account: WhopSDK::Models::Partners::Businesses::EarningListResponse::Account?, cancelation_reason: String?, commission_amount_usd: String?, created_at: Time, - financial_activity: ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity]?, - object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::object, + financial_activity: ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity]?, + object: WhopSDK::Models::Partners::Businesses::EarningListResponse::object, payout_at: Time?, payout_percentage: Float?, - product: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product?, - resource: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource?, + product: WhopSDK::Models::Partners::Businesses::EarningListResponse::Product?, + resource: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource?, second_tier: bool, - status: WhopSDK::Models::Referrals::Businesses::EarningListResponse::status, + status: WhopSDK::Models::Partners::Businesses::EarningListResponse::status, transaction_amount_usd: String } class EarningListResponse < WhopSDK::Internal::Type::BaseModel attr_accessor id: String? - attr_accessor account: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account? + attr_accessor account: WhopSDK::Models::Partners::Businesses::EarningListResponse::Account? attr_accessor cancelation_reason: String? @@ -31,55 +31,55 @@ module WhopSDK attr_accessor created_at: Time - attr_accessor financial_activity: ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity]? + attr_accessor financial_activity: ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity]? - attr_accessor object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::object + attr_accessor object: WhopSDK::Models::Partners::Businesses::EarningListResponse::object attr_accessor payout_at: Time? attr_accessor payout_percentage: Float? - attr_accessor product: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product? + attr_accessor product: WhopSDK::Models::Partners::Businesses::EarningListResponse::Product? - attr_accessor resource: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource? + attr_accessor resource: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource? attr_accessor second_tier: bool - attr_accessor status: WhopSDK::Models::Referrals::Businesses::EarningListResponse::status + attr_accessor status: WhopSDK::Models::Partners::Businesses::EarningListResponse::status attr_accessor transaction_amount_usd: String def initialize: ( id: String?, - account: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account?, + account: WhopSDK::Models::Partners::Businesses::EarningListResponse::Account?, cancelation_reason: String?, commission_amount_usd: String?, created_at: Time, - financial_activity: ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity]?, - object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::object, + financial_activity: ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity]?, + object: WhopSDK::Models::Partners::Businesses::EarningListResponse::object, payout_at: Time?, payout_percentage: Float?, - product: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product?, - resource: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource?, + product: WhopSDK::Models::Partners::Businesses::EarningListResponse::Product?, + resource: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource?, second_tier: bool, - status: WhopSDK::Models::Referrals::Businesses::EarningListResponse::status, + status: WhopSDK::Models::Partners::Businesses::EarningListResponse::status, transaction_amount_usd: String ) -> void def to_hash: -> { id: String?, - account: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account?, + account: WhopSDK::Models::Partners::Businesses::EarningListResponse::Account?, cancelation_reason: String?, commission_amount_usd: String?, created_at: Time, - financial_activity: ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity]?, - object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::object, + financial_activity: ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity]?, + object: WhopSDK::Models::Partners::Businesses::EarningListResponse::object, payout_at: Time?, payout_percentage: Float?, - product: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product?, - resource: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource?, + product: WhopSDK::Models::Partners::Businesses::EarningListResponse::Product?, + resource: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource?, second_tier: bool, - status: WhopSDK::Models::Referrals::Businesses::EarningListResponse::status, + status: WhopSDK::Models::Partners::Businesses::EarningListResponse::status, transaction_amount_usd: String } @@ -117,7 +117,7 @@ module WhopSDK category: String?, created_at: Time?, currency: String, - type: WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::type_ + type: WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::type_ } class FinancialActivity < WhopSDK::Internal::Type::BaseModel @@ -131,7 +131,7 @@ module WhopSDK attr_accessor currency: String - attr_accessor type: WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::type_ + attr_accessor type: WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::type_ def initialize: ( amount: String, @@ -139,7 +139,7 @@ module WhopSDK category: String?, created_at: Time?, currency: String, - type: WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::type_ + type: WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::type_ ) -> void def to_hash: -> { @@ -148,7 +148,7 @@ module WhopSDK category: String?, created_at: Time?, currency: String, - type: WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::type_ + type: WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::type_ } type type_ = :income | :expense @@ -159,18 +159,18 @@ module WhopSDK INCOME: :income EXPENSE: :expense - def self?.values: -> ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity::type_] + def self?.values: -> ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity::type_] end end - type object = :business_referral_earning + type object = :partner_business_earning module Object extend WhopSDK::Internal::Type::Enum - BUSINESS_REFERRAL_EARNING: :business_referral_earning + PARTNER_BUSINESS_EARNING: :partner_business_earning - def self?.values: -> ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::object] + def self?.values: -> ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::object] end type product = { id: String, route: String, title: String } @@ -190,12 +190,12 @@ module WhopSDK type resource = { id: String, - alternative_payment_method: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod?, + alternative_payment_method: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod?, brand: String?, created_at: Time, currency: String, :last4 => String?, - object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::object, + object: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::object, payment_method_type: String?, processor: String? } @@ -203,7 +203,7 @@ module WhopSDK class Resource < WhopSDK::Internal::Type::BaseModel attr_accessor id: String - attr_accessor alternative_payment_method: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod? + attr_accessor alternative_payment_method: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod? attr_accessor brand: String? @@ -213,7 +213,7 @@ module WhopSDK attr_accessor last4: String? - attr_accessor object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::object + attr_accessor object: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::object attr_accessor payment_method_type: String? @@ -221,24 +221,24 @@ module WhopSDK def initialize: ( id: String, - alternative_payment_method: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod?, + alternative_payment_method: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod?, brand: String?, created_at: Time, currency: String, last4: String?, - object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::object, + object: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::object, payment_method_type: String?, processor: String? ) -> void def to_hash: -> { id: String, - alternative_payment_method: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::AlternativePaymentMethod?, + alternative_payment_method: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::AlternativePaymentMethod?, brand: String?, created_at: Time, currency: String, :last4 => String?, - object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::object, + object: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::object, payment_method_type: String?, processor: String? } @@ -263,7 +263,7 @@ module WhopSDK RECEIPT: :receipt - def self?.values: -> ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource::object] + def self?.values: -> ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource::object] end end @@ -279,7 +279,7 @@ module WhopSDK CANCELED: :canceled REVERSED: :reversed - def self?.values: -> ::Array[WhopSDK::Models::Referrals::Businesses::EarningListResponse::status] + def self?.values: -> ::Array[WhopSDK::Models::Partners::Businesses::EarningListResponse::status] end end end diff --git a/sig/whop_sdk/models/payout_create_response.rbs b/sig/whop_sdk/models/payout_create_response.rbs index 35b11fb4..b0c1640d 100644 --- a/sig/whop_sdk/models/payout_create_response.rbs +++ b/sig/whop_sdk/models/payout_create_response.rbs @@ -121,13 +121,15 @@ module WhopSDK def self?.values: -> ::Array[WhopSDK::Models::PayoutCreateResponse::speed] end - type status = :requested | :in_transit | :completed | :failed | :canceled + type status = + :requested | :in_transit | :denied | :completed | :failed | :canceled module Status extend WhopSDK::Internal::Type::Enum REQUESTED: :requested IN_TRANSIT: :in_transit + DENIED: :denied COMPLETED: :completed FAILED: :failed CANCELED: :canceled diff --git a/sig/whop_sdk/models/product.rbs b/sig/whop_sdk/models/product.rbs index 2adeb5bc..d8853645 100644 --- a/sig/whop_sdk/models/product.rbs +++ b/sig/whop_sdk/models/product.rbs @@ -145,16 +145,22 @@ module WhopSDK def to_hash: -> { id: String, route: String, title: String } end - type gallery_image = { id: String, url: String? } + type gallery_image = { id: String, content_type: String?, url: String? } class GalleryImage < WhopSDK::Internal::Type::BaseModel attr_accessor id: String + attr_accessor content_type: String? + attr_accessor url: String? - def initialize: (id: String, url: String?) -> void + def initialize: ( + id: String, + content_type: String?, + url: String? + ) -> void - def to_hash: -> { id: String, url: String? } + def to_hash: -> { id: String, content_type: String?, url: String? } end type owner_user = { id: String, name: String?, username: String } diff --git a/sig/whop_sdk/models/product_list_item.rbs b/sig/whop_sdk/models/product_list_item.rbs index bba61a27..1d43d78c 100644 --- a/sig/whop_sdk/models/product_list_item.rbs +++ b/sig/whop_sdk/models/product_list_item.rbs @@ -5,6 +5,7 @@ module WhopSDK id: String, created_at: Time, external_identifier: String?, + gallery_images: ::Array[WhopSDK::ProductListItem::GalleryImage], headline: String?, member_count: Integer, metadata: ::Hash[Symbol, top]?, @@ -23,6 +24,8 @@ module WhopSDK attr_accessor external_identifier: String? + attr_accessor gallery_images: ::Array[WhopSDK::ProductListItem::GalleryImage] + attr_accessor headline: String? attr_accessor member_count: Integer @@ -45,6 +48,7 @@ module WhopSDK id: String, created_at: Time, external_identifier: String?, + gallery_images: ::Array[WhopSDK::ProductListItem::GalleryImage], headline: String?, member_count: Integer, metadata: ::Hash[Symbol, top]?, @@ -60,6 +64,7 @@ module WhopSDK id: String, created_at: Time, external_identifier: String?, + gallery_images: ::Array[WhopSDK::ProductListItem::GalleryImage], headline: String?, member_count: Integer, metadata: ::Hash[Symbol, top]?, @@ -70,6 +75,24 @@ module WhopSDK verified: bool, visibility: WhopSDK::Models::visibility } + + type gallery_image = { id: String, content_type: String?, url: String? } + + class GalleryImage < WhopSDK::Internal::Type::BaseModel + attr_accessor id: String + + attr_accessor content_type: String? + + attr_accessor url: String? + + def initialize: ( + id: String, + content_type: String?, + url: String? + ) -> void + + def to_hash: -> { id: String, content_type: String?, url: String? } + end end end end diff --git a/sig/whop_sdk/models/referrals/business_leaderboard_params.rbs b/sig/whop_sdk/models/referrals/business_leaderboard_params.rbs deleted file mode 100644 index c7089b47..00000000 --- a/sig/whop_sdk/models/referrals/business_leaderboard_params.rbs +++ /dev/null @@ -1,46 +0,0 @@ -module WhopSDK - module Models - module Referrals - type business_leaderboard_params = - { - period: WhopSDK::Models::Referrals::BusinessLeaderboardParams::period - } - & WhopSDK::Internal::Type::request_parameters - - class BusinessLeaderboardParams < WhopSDK::Internal::Type::BaseModel - extend WhopSDK::Internal::Type::RequestParameters::Converter - include WhopSDK::Internal::Type::RequestParameters - - attr_reader period: WhopSDK::Models::Referrals::BusinessLeaderboardParams::period? - - def period=: ( - WhopSDK::Models::Referrals::BusinessLeaderboardParams::period - ) -> WhopSDK::Models::Referrals::BusinessLeaderboardParams::period - - def initialize: ( - ?period: WhopSDK::Models::Referrals::BusinessLeaderboardParams::period, - ?request_options: WhopSDK::request_opts - ) -> void - - def to_hash: -> { - period: WhopSDK::Models::Referrals::BusinessLeaderboardParams::period, - request_options: WhopSDK::RequestOptions - } - - type period = :day | :month | :year | :last_30_days | :all_time - - module Period - extend WhopSDK::Internal::Type::Enum - - DAY: :day - MONTH: :month - YEAR: :year - LAST_30_DAYS: :last_30_days - ALL_TIME: :all_time - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessLeaderboardParams::period] - end - end - end - end -end diff --git a/sig/whop_sdk/models/referrals/business_leaderboard_response.rbs b/sig/whop_sdk/models/referrals/business_leaderboard_response.rbs deleted file mode 100644 index 00ff7df6..00000000 --- a/sig/whop_sdk/models/referrals/business_leaderboard_response.rbs +++ /dev/null @@ -1,221 +0,0 @@ -module WhopSDK - module Models - module Referrals - type business_leaderboard_response = - { - leaders: ::Array[WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader], - me: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me? - } - - class BusinessLeaderboardResponse < WhopSDK::Internal::Type::BaseModel - attr_accessor leaders: ::Array[WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader] - - attr_accessor me: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me? - - def initialize: ( - leaders: ::Array[WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader], - me: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me? - ) -> void - - def to_hash: -> { - leaders: ::Array[WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader], - me: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me? - } - - type leader = - { - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User? - } - - class Leader < WhopSDK::Internal::Type::BaseModel - attr_accessor first_referral_started_at: Time - - attr_accessor rank: Integer - - attr_accessor total_earnings_usd: String - - attr_accessor total_volume_usd: String - - attr_accessor user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User? - - def initialize: ( - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User? - ) -> void - - def to_hash: -> { - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User? - } - - type user = - { - city: String?, - country: String?, - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, - username: String - } - - class User < WhopSDK::Internal::Type::BaseModel - attr_accessor city: String? - - attr_accessor country: String? - - attr_reader id: String? - - def id=: (String) -> String - - attr_accessor name: String? - - attr_reader profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture? - - def profile_picture=: ( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture - ) -> WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture - - attr_reader username: String? - - def username=: (String) -> String - - def initialize: ( - city: String?, - country: String?, - ?id: String, - ?name: String?, - ?profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, - ?username: String - ) -> void - - def to_hash: -> { - city: String?, - country: String?, - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader::User::ProfilePicture, - username: String - } - - type profile_picture = { url: String } - - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - attr_accessor url: String - - def initialize: (url: String) -> void - - def to_hash: -> { url: String } - end - end - end - - type me = - { - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User? - } - - class Me < WhopSDK::Internal::Type::BaseModel - attr_accessor first_referral_started_at: Time - - attr_accessor rank: Integer - - attr_accessor total_earnings_usd: String - - attr_accessor total_volume_usd: String - - attr_accessor user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User? - - def initialize: ( - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User? - ) -> void - - def to_hash: -> { - first_referral_started_at: Time, - rank: Integer, - total_earnings_usd: String, - total_volume_usd: String, - user: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User? - } - - type user = - { - city: String?, - country: String?, - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture, - username: String - } - - class User < WhopSDK::Internal::Type::BaseModel - attr_accessor city: String? - - attr_accessor country: String? - - attr_reader id: String? - - def id=: (String) -> String - - attr_accessor name: String? - - attr_reader profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture? - - def profile_picture=: ( - WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture - ) -> WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture - - attr_reader username: String? - - def username=: (String) -> String - - def initialize: ( - city: String?, - country: String?, - ?id: String, - ?name: String?, - ?profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture, - ?username: String - ) -> void - - def to_hash: -> { - city: String?, - country: String?, - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me::User::ProfilePicture, - username: String - } - - type profile_picture = { url: String } - - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - attr_accessor url: String - - def initialize: (url: String) -> void - - def to_hash: -> { url: String } - end - end - end - end - end - end -end diff --git a/sig/whop_sdk/models/referrals/business_retrieve_response.rbs b/sig/whop_sdk/models/referrals/business_retrieve_response.rbs deleted file mode 100644 index a0950883..00000000 --- a/sig/whop_sdk/models/referrals/business_retrieve_response.rbs +++ /dev/null @@ -1,677 +0,0 @@ -module WhopSDK - module Models - module Referrals - type business_retrieve_response = - { - id: String, - account: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account?, - created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner?, - my_partner_tier: WhopSDK::Models::Referrals::BusinessRetrieveResponse::my_partner_tier, - object: WhopSDK::Models::Referrals::BusinessRetrieveResponse::object, - owner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner?, - payout_percentage: Float, - referral_expires_at: Time?, - referral_started_at: Time?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::status, - volume_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd - } - - class BusinessRetrieveResponse < WhopSDK::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor account: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account? - - attr_accessor created_at: Time - - attr_accessor earnings_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd - - attr_accessor first_tier_partner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner? - - attr_accessor my_partner_tier: WhopSDK::Models::Referrals::BusinessRetrieveResponse::my_partner_tier - - attr_accessor object: WhopSDK::Models::Referrals::BusinessRetrieveResponse::object - - attr_accessor owner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner? - - attr_accessor payout_percentage: Float - - attr_accessor referral_expires_at: Time? - - attr_accessor referral_started_at: Time? - - attr_accessor status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::status - - attr_accessor volume_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd - - def initialize: ( - id: String, - account: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account?, - created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner?, - my_partner_tier: WhopSDK::Models::Referrals::BusinessRetrieveResponse::my_partner_tier, - object: WhopSDK::Models::Referrals::BusinessRetrieveResponse::object, - owner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner?, - payout_percentage: Float, - referral_expires_at: Time?, - referral_started_at: Time?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::status, - volume_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd - ) -> void - - def to_hash: -> { - id: String, - account: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account?, - created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner?, - my_partner_tier: WhopSDK::Models::Referrals::BusinessRetrieveResponse::my_partner_tier, - object: WhopSDK::Models::Referrals::BusinessRetrieveResponse::object, - owner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner?, - payout_percentage: Float, - referral_expires_at: Time?, - referral_started_at: Time?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::status, - volume_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd - } - - type account = - { - id: String, - capabilities: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities?, - logo_url: String?, - recommended_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction]?, - required_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction]?, - route: String, - title: String - } - - class Account < WhopSDK::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor capabilities: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities? - - attr_accessor logo_url: String? - - attr_accessor recommended_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction]? - - attr_accessor required_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction]? - - attr_accessor route: String - - attr_accessor title: String - - def initialize: ( - id: String, - capabilities: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities?, - logo_url: String?, - recommended_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction]?, - required_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction]?, - route: String, - title: String - ) -> void - - def to_hash: -> { - id: String, - capabilities: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities?, - logo_url: String?, - recommended_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction]?, - required_actions: ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction]?, - route: String, - title: String - } - - type capabilities = - { - accept_bank_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments, - accept_bnpl_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments, - accept_card_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments, - bank_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::bank_deposit, - card_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_deposit, - card_issuing: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_issuing, - crypto_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit, - crypto_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_payout, - instant_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::instant_payout, - standard_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::standard_payout, - transfer: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::transfer - } - - class Capabilities < WhopSDK::Internal::Type::BaseModel - attr_accessor accept_bank_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments - - attr_accessor accept_bnpl_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments - - attr_accessor accept_card_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments - - attr_accessor bank_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::bank_deposit - - attr_accessor card_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_deposit - - attr_accessor card_issuing: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_issuing - - attr_accessor crypto_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit - - attr_accessor crypto_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_payout - - attr_accessor instant_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::instant_payout - - attr_accessor standard_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::standard_payout - - attr_accessor transfer: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::transfer - - def initialize: ( - accept_bank_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments, - accept_bnpl_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments, - accept_card_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments, - bank_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::bank_deposit, - card_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_deposit, - card_issuing: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_issuing, - crypto_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit, - crypto_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_payout, - instant_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::instant_payout, - standard_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::standard_payout, - transfer: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::transfer - ) -> void - - def to_hash: -> { - accept_bank_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments, - accept_bnpl_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments, - accept_card_payments: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments, - bank_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::bank_deposit, - card_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_deposit, - card_issuing: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_issuing, - crypto_deposit: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit, - crypto_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_payout, - instant_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::instant_payout, - standard_payout: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::standard_payout, - transfer: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::transfer - } - - type accept_bank_payments = :active | :inactive | :pending - - module AcceptBankPayments - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bank_payments] - end - - type accept_bnpl_payments = :active | :inactive | :pending - - module AcceptBnplPayments - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_bnpl_payments] - end - - type accept_card_payments = :active | :inactive | :pending - - module AcceptCardPayments - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::accept_card_payments] - end - - type bank_deposit = :active | :inactive | :pending - - module BankDeposit - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::bank_deposit] - end - - type card_deposit = :active | :inactive | :pending - - module CardDeposit - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_deposit] - end - - type card_issuing = :active | :inactive | :pending - - module CardIssuing - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::card_issuing] - end - - type crypto_deposit = :active | :inactive | :pending - - module CryptoDeposit - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_deposit] - end - - type crypto_payout = :active | :inactive | :pending - - module CryptoPayout - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::crypto_payout] - end - - type instant_payout = :active | :inactive | :pending - - module InstantPayout - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::instant_payout] - end - - type standard_payout = :active | :inactive | :pending - - module StandardPayout - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::standard_payout] - end - - type transfer = :active | :inactive | :pending - - module Transfer - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - INACTIVE: :inactive - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::Capabilities::transfer] - end - end - - type recommended_action = - { - action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::action, - blocked_capabilities: ::Array[String], - cta: String, - cta_label: String, - description: String, - icon_url: String?, - impact_score: Integer?, - reasoning: String?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::status, - title: String - } - - class RecommendedAction < WhopSDK::Internal::Type::BaseModel - attr_accessor action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::action - - attr_accessor blocked_capabilities: ::Array[String] - - attr_accessor cta: String - - attr_accessor cta_label: String - - attr_accessor description: String - - attr_accessor icon_url: String? - - attr_accessor impact_score: Integer? - - attr_accessor reasoning: String? - - attr_accessor status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::status - - attr_accessor title: String - - def initialize: ( - action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::action, - blocked_capabilities: ::Array[String], - cta: String, - cta_label: String, - description: String, - icon_url: String?, - impact_score: Integer?, - reasoning: String?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::status, - title: String - ) -> void - - def to_hash: -> { - action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::action, - blocked_capabilities: ::Array[String], - cta: String, - cta_label: String, - description: String, - icon_url: String?, - impact_score: Integer?, - reasoning: String?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::status, - title: String - } - - type action = - :theme_business - | :create_product - | :create_plan - | :verify_identity - | :connect_affiliate_program - | :create_promotion - | :setup_tracking_pixel - | :migrate_from_stripe - | :accept_first_payment - | :launch_first_ad - | :invite_team_member - | :enable_tax_collection - | :create_card - | :join_whop_university - | :apply_for_financing - - module Action - extend WhopSDK::Internal::Type::Enum - - THEME_BUSINESS: :theme_business - CREATE_PRODUCT: :create_product - CREATE_PLAN: :create_plan - VERIFY_IDENTITY: :verify_identity - CONNECT_AFFILIATE_PROGRAM: :connect_affiliate_program - CREATE_PROMOTION: :create_promotion - SETUP_TRACKING_PIXEL: :setup_tracking_pixel - MIGRATE_FROM_STRIPE: :migrate_from_stripe - ACCEPT_FIRST_PAYMENT: :accept_first_payment - LAUNCH_FIRST_AD: :launch_first_ad - INVITE_TEAM_MEMBER: :invite_team_member - ENABLE_TAX_COLLECTION: :enable_tax_collection - CREATE_CARD: :create_card - JOIN_WHOP_UNIVERSITY: :join_whop_university - APPLY_FOR_FINANCING: :apply_for_financing - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::action] - end - - type status = :optional - - module Status - extend WhopSDK::Internal::Type::Enum - - OPTIONAL: :optional - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RecommendedAction::status] - end - end - - type required_action = - { - action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::action, - blocked_capabilities: ::Array[String], - cta: String?, - cta_label: String, - description: String, - icon_url: String?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::status, - title: String - } - - class RequiredAction < WhopSDK::Internal::Type::BaseModel - attr_accessor action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::action - - attr_accessor blocked_capabilities: ::Array[String] - - attr_accessor cta: String? - - attr_accessor cta_label: String - - attr_accessor description: String - - attr_accessor icon_url: String? - - attr_accessor status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::status - - attr_accessor title: String - - def initialize: ( - action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::action, - blocked_capabilities: ::Array[String], - cta: String?, - cta_label: String, - description: String, - icon_url: String?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::status, - title: String - ) -> void - - def to_hash: -> { - action: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::action, - blocked_capabilities: ::Array[String], - cta: String?, - cta_label: String, - description: String, - icon_url: String?, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::status, - title: String - } - - type action = - :deposit_funds - | :submit_information_request - | :verify_identity - | :connect_fulfillment_tracker - - module Action - extend WhopSDK::Internal::Type::Enum - - DEPOSIT_FUNDS: :deposit_funds - SUBMIT_INFORMATION_REQUEST: :submit_information_request - VERIFY_IDENTITY: :verify_identity - CONNECT_FULFILLMENT_TRACKER: :connect_fulfillment_tracker - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::action] - end - - type status = :required | :pending - - module Status - extend WhopSDK::Internal::Type::Enum - - REQUIRED: :required - PENDING: :pending - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account::RequiredAction::status] - end - end - end - - type earnings_usd = - { completed: String, pending: String, total: String } - - class EarningsUsd < WhopSDK::Internal::Type::BaseModel - attr_accessor completed: String - - attr_accessor pending: String - - attr_accessor total: String - - def initialize: ( - completed: String, - pending: String, - total: String - ) -> void - - def to_hash: -> { completed: String, pending: String, total: String } - end - - type first_tier_partner = - { - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, - username: String - } - - class FirstTierPartner < WhopSDK::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor name: String? - - attr_accessor profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture - - attr_accessor username: String - - def initialize: ( - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, - username: String - ) -> void - - def to_hash: -> { - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner::ProfilePicture, - username: String - } - - type profile_picture = { url: String } - - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - attr_accessor url: String - - def initialize: (url: String) -> void - - def to_hash: -> { url: String } - end - end - - type my_partner_tier = :first | :second - - module MyPartnerTier - extend WhopSDK::Internal::Type::Enum - - FIRST: :first - SECOND: :second - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::my_partner_tier] - end - - type object = :business_referral - - module Object - extend WhopSDK::Internal::Type::Enum - - BUSINESS_REFERRAL: :business_referral - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::object] - end - - type owner = - { - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture, - username: String - } - - class Owner < WhopSDK::Internal::Type::BaseModel - attr_accessor id: String - - attr_accessor name: String? - - attr_accessor profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture - - attr_accessor username: String - - def initialize: ( - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture, - username: String - ) -> void - - def to_hash: -> { - id: String, - name: String?, - profile_picture: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner::ProfilePicture, - username: String - } - - type profile_picture = { url: String } - - class ProfilePicture < WhopSDK::Internal::Type::BaseModel - attr_accessor url: String - - def initialize: (url: String) -> void - - def to_hash: -> { url: String } - end - end - - type status = :active | :removed - - module Status - extend WhopSDK::Internal::Type::Enum - - ACTIVE: :active - REMOVED: :removed - - def self?.values: -> ::Array[WhopSDK::Models::Referrals::BusinessRetrieveResponse::status] - end - - type volume_usd = - { attributed: String, awaiting_settlement: String, settled: String } - - class VolumeUsd < WhopSDK::Internal::Type::BaseModel - attr_accessor attributed: String - - attr_accessor awaiting_settlement: String - - attr_accessor settled: String - - def initialize: ( - attributed: String, - awaiting_settlement: String, - settled: String - ) -> void - - def to_hash: -> { - attributed: String, - awaiting_settlement: String, - settled: String - } - end - end - end - end -end diff --git a/sig/whop_sdk/models/referrals/partner_create_params.rbs b/sig/whop_sdk/models/referrals/partner_create_params.rbs deleted file mode 100644 index 56cf18f0..00000000 --- a/sig/whop_sdk/models/referrals/partner_create_params.rbs +++ /dev/null @@ -1,17 +0,0 @@ -module WhopSDK - module Models - module Referrals - type partner_create_params = - { } & WhopSDK::Internal::Type::request_parameters - - class PartnerCreateParams < WhopSDK::Internal::Type::BaseModel - extend WhopSDK::Internal::Type::RequestParameters::Converter - include WhopSDK::Internal::Type::RequestParameters - - def initialize: (?request_options: WhopSDK::request_opts) -> void - - def to_hash: -> { request_options: WhopSDK::RequestOptions } - end - end - end -end diff --git a/sig/whop_sdk/models/referrals/partner_create_response.rbs b/sig/whop_sdk/models/referrals/partner_create_response.rbs deleted file mode 100644 index 73f93cad..00000000 --- a/sig/whop_sdk/models/referrals/partner_create_response.rbs +++ /dev/null @@ -1,21 +0,0 @@ -module WhopSDK - module Models - module Referrals - type partner_create_response = - { referral_link: String, whop_partner_enabled_at: Time } - - class PartnerCreateResponse < WhopSDK::Internal::Type::BaseModel - attr_accessor referral_link: String - - attr_accessor whop_partner_enabled_at: Time - - def initialize: ( - referral_link: String, - whop_partner_enabled_at: Time - ) -> void - - def to_hash: -> { referral_link: String, whop_partner_enabled_at: Time } - end - end - end -end diff --git a/sig/whop_sdk/models/social_account.rbs b/sig/whop_sdk/models/social_account.rbs index e93c905a..c667d465 100644 --- a/sig/whop_sdk/models/social_account.rbs +++ b/sig/whop_sdk/models/social_account.rbs @@ -3,6 +3,7 @@ module WhopSDK type social_account = { id: String, + error: String?, external_id: String?, name: String?, platform: WhopSDK::Models::SocialAccount::platform, @@ -16,6 +17,8 @@ module WhopSDK class SocialAccount < WhopSDK::Internal::Type::BaseModel attr_accessor id: String + attr_accessor error: String? + attr_accessor external_id: String? attr_accessor name: String? @@ -34,6 +37,7 @@ module WhopSDK def initialize: ( id: String, + error: String?, external_id: String?, name: String?, platform: WhopSDK::Models::SocialAccount::platform, @@ -46,6 +50,7 @@ module WhopSDK def to_hash: -> { id: String, + error: String?, external_id: String?, name: String?, platform: WhopSDK::Models::SocialAccount::platform, diff --git a/sig/whop_sdk/models/user_recommend_actions_params.rbs b/sig/whop_sdk/models/user_recommend_actions_params.rbs new file mode 100644 index 00000000..ab7f9077 --- /dev/null +++ b/sig/whop_sdk/models/user_recommend_actions_params.rbs @@ -0,0 +1,20 @@ +module WhopSDK + module Models + type user_recommend_actions_params = + { id: String } & WhopSDK::Internal::Type::request_parameters + + class UserRecommendActionsParams < WhopSDK::Internal::Type::BaseModel + extend WhopSDK::Internal::Type::RequestParameters::Converter + include WhopSDK::Internal::Type::RequestParameters + + attr_accessor id: String + + def initialize: ( + id: String, + ?request_options: WhopSDK::request_opts + ) -> void + + def to_hash: -> { id: String, request_options: WhopSDK::RequestOptions } + end + end +end diff --git a/sig/whop_sdk/models/user_recommend_actions_response.rbs b/sig/whop_sdk/models/user_recommend_actions_response.rbs new file mode 100644 index 00000000..6705f07b --- /dev/null +++ b/sig/whop_sdk/models/user_recommend_actions_response.rbs @@ -0,0 +1,143 @@ +module WhopSDK + module Models + type user_recommend_actions_response = + { data: ::Array[WhopSDK::Models::UserRecommendActionsResponse::Data] } + + class UserRecommendActionsResponse < WhopSDK::Internal::Type::BaseModel + attr_accessor data: ::Array[WhopSDK::Models::UserRecommendActionsResponse::Data] + + def initialize: ( + data: ::Array[WhopSDK::Models::UserRecommendActionsResponse::Data] + ) -> void + + def to_hash: -> { + data: ::Array[WhopSDK::Models::UserRecommendActionsResponse::Data] + } + + type data = + { + account_id: String?, + account_name: String?, + action: WhopSDK::Models::UserRecommendActionsResponse::Data::action, + blocked_capabilities: ::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: String?, + impact_score: Integer?, + reasoning: String?, + status: WhopSDK::Models::UserRecommendActionsResponse::Data::status, + title: String + } + + class Data < WhopSDK::Internal::Type::BaseModel + attr_accessor account_id: String? + + attr_accessor account_name: String? + + attr_accessor action: WhopSDK::Models::UserRecommendActionsResponse::Data::action + + attr_accessor blocked_capabilities: ::Array[String] + + attr_accessor cta: String + + attr_accessor cta_label: String + + attr_accessor description: String + + attr_accessor icon_url: String? + + attr_accessor impact_score: Integer? + + attr_accessor reasoning: String? + + attr_accessor status: WhopSDK::Models::UserRecommendActionsResponse::Data::status + + attr_accessor title: String + + def initialize: ( + account_id: String?, + account_name: String?, + action: WhopSDK::Models::UserRecommendActionsResponse::Data::action, + blocked_capabilities: ::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: String?, + impact_score: Integer?, + reasoning: String?, + status: WhopSDK::Models::UserRecommendActionsResponse::Data::status, + title: String + ) -> void + + def to_hash: -> { + account_id: String?, + account_name: String?, + action: WhopSDK::Models::UserRecommendActionsResponse::Data::action, + blocked_capabilities: ::Array[String], + cta: String, + cta_label: String, + description: String, + icon_url: String?, + impact_score: Integer?, + reasoning: String?, + status: WhopSDK::Models::UserRecommendActionsResponse::Data::status, + title: String + } + + type action = + :create_business + | :become_affiliate + | :theme_business + | :create_product + | :create_plan + | :verify_identity + | :connect_affiliate_program + | :create_promotion + | :setup_tracking_pixel + | :migrate_from_stripe + | :accept_first_payment + | :launch_first_ad + | :invite_team_member + | :enable_tax_collection + | :create_card + | :join_whop_university + | :apply_for_financing + + module Action + extend WhopSDK::Internal::Type::Enum + + CREATE_BUSINESS: :create_business + BECOME_AFFILIATE: :become_affiliate + THEME_BUSINESS: :theme_business + CREATE_PRODUCT: :create_product + CREATE_PLAN: :create_plan + VERIFY_IDENTITY: :verify_identity + CONNECT_AFFILIATE_PROGRAM: :connect_affiliate_program + CREATE_PROMOTION: :create_promotion + SETUP_TRACKING_PIXEL: :setup_tracking_pixel + MIGRATE_FROM_STRIPE: :migrate_from_stripe + ACCEPT_FIRST_PAYMENT: :accept_first_payment + LAUNCH_FIRST_AD: :launch_first_ad + INVITE_TEAM_MEMBER: :invite_team_member + ENABLE_TAX_COLLECTION: :enable_tax_collection + CREATE_CARD: :create_card + JOIN_WHOP_UNIVERSITY: :join_whop_university + APPLY_FOR_FINANCING: :apply_for_financing + + def self?.values: -> ::Array[WhopSDK::Models::UserRecommendActionsResponse::Data::action] + end + + type status = :optional + + module Status + extend WhopSDK::Internal::Type::Enum + + OPTIONAL: :optional + + def self?.values: -> ::Array[WhopSDK::Models::UserRecommendActionsResponse::Data::status] + end + end + end + end +end diff --git a/sig/whop_sdk/models/verification_create_params.rbs b/sig/whop_sdk/models/verification_create_params.rbs index 7af93cd8..f6bb130c 100644 --- a/sig/whop_sdk/models/verification_create_params.rbs +++ b/sig/whop_sdk/models/verification_create_params.rbs @@ -39,6 +39,7 @@ module WhopSDK address: WhopSDK::VerificationCreateParams::Body::Individual::Address, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, date_of_birth: String, @@ -66,6 +67,10 @@ module WhopSDK def business_structure=: (String) -> String + attr_reader business_tax_identification_number: String? + + def business_tax_identification_number=: (String) -> String + attr_reader business_website: String? def business_website=: (String) -> String @@ -114,6 +119,7 @@ module WhopSDK ?address: WhopSDK::VerificationCreateParams::Body::Individual::Address, ?business_name: String, ?business_structure: String, + ?business_tax_identification_number: String, ?business_website: String, ?country: String, ?date_of_birth: String, @@ -130,6 +136,7 @@ module WhopSDK address: WhopSDK::VerificationCreateParams::Body::Individual::Address, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, date_of_birth: String, @@ -226,6 +233,7 @@ module WhopSDK address: WhopSDK::VerificationCreateParams::Body::Business::Address, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, kind: WhopSDK::Models::VerificationCreateParams::Body::Business::kind, @@ -248,6 +256,10 @@ module WhopSDK def business_structure=: (String) -> String + attr_reader business_tax_identification_number: String? + + def business_tax_identification_number=: (String) -> String + attr_reader business_website: String? def business_website=: (String) -> String @@ -274,6 +286,7 @@ module WhopSDK ?address: WhopSDK::VerificationCreateParams::Body::Business::Address, ?business_name: String, ?business_structure: String, + ?business_tax_identification_number: String, ?business_website: String, ?country: String, ?kind: WhopSDK::Models::VerificationCreateParams::Body::Business::kind, @@ -285,6 +298,7 @@ module WhopSDK address: WhopSDK::VerificationCreateParams::Body::Business::Address, business_name: String, business_structure: String, + business_tax_identification_number: String, business_website: String, country: String, kind: WhopSDK::Models::VerificationCreateParams::Body::Business::kind, diff --git a/sig/whop_sdk/models/verification_create_response.rbs b/sig/whop_sdk/models/verification_create_response.rbs index 17aeeaf7..3b890ddc 100644 --- a/sig/whop_sdk/models/verification_create_response.rbs +++ b/sig/whop_sdk/models/verification_create_response.rbs @@ -315,13 +315,19 @@ module WhopSDK end type status = - :not_started | :pending | :approved | :rejected | :action_required + :not_started + | :pending + | :processing + | :approved + | :rejected + | :action_required module Status extend WhopSDK::Internal::Type::Enum NOT_STARTED: :not_started PENDING: :pending + PROCESSING: :processing APPROVED: :approved REJECTED: :rejected ACTION_REQUIRED: :action_required diff --git a/sig/whop_sdk/models/verification_list_response.rbs b/sig/whop_sdk/models/verification_list_response.rbs index a3eb2f90..caf01217 100644 --- a/sig/whop_sdk/models/verification_list_response.rbs +++ b/sig/whop_sdk/models/verification_list_response.rbs @@ -333,13 +333,19 @@ module WhopSDK end type status = - :not_started | :pending | :approved | :rejected | :action_required + :not_started + | :pending + | :processing + | :approved + | :rejected + | :action_required module Status extend WhopSDK::Internal::Type::Enum NOT_STARTED: :not_started PENDING: :pending + PROCESSING: :processing APPROVED: :approved REJECTED: :rejected ACTION_REQUIRED: :action_required diff --git a/sig/whop_sdk/models/verification_retrieve_response.rbs b/sig/whop_sdk/models/verification_retrieve_response.rbs index c44602fa..79e710ec 100644 --- a/sig/whop_sdk/models/verification_retrieve_response.rbs +++ b/sig/whop_sdk/models/verification_retrieve_response.rbs @@ -315,13 +315,19 @@ module WhopSDK end type status = - :not_started | :pending | :approved | :rejected | :action_required + :not_started + | :pending + | :processing + | :approved + | :rejected + | :action_required module Status extend WhopSDK::Internal::Type::Enum NOT_STARTED: :not_started PENDING: :pending + PROCESSING: :processing APPROVED: :approved REJECTED: :rejected ACTION_REQUIRED: :action_required diff --git a/sig/whop_sdk/models/verification_update_params.rbs b/sig/whop_sdk/models/verification_update_params.rbs index 2a59da70..8239d963 100644 --- a/sig/whop_sdk/models/verification_update_params.rbs +++ b/sig/whop_sdk/models/verification_update_params.rbs @@ -36,15 +36,21 @@ module WhopSDK type update_individual_verification = { + business_tax_identification_number: String, country: String, date_of_birth: String, first_name: String, last_name: String, personal_address: WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::PersonalAddress, - requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation] + requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation], + tax_identification_number: String } class UpdateIndividualVerification < WhopSDK::Internal::Type::BaseModel + attr_reader business_tax_identification_number: String? + + def business_tax_identification_number=: (String) -> String + attr_reader country: String? def country=: (String) -> String @@ -73,22 +79,30 @@ module WhopSDK ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation] ) -> ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation] + attr_reader tax_identification_number: String? + + def tax_identification_number=: (String) -> String + def initialize: ( + ?business_tax_identification_number: String, ?country: String, ?date_of_birth: String, ?first_name: String, ?last_name: String, ?personal_address: WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::PersonalAddress, - ?requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation] + ?requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation], + ?tax_identification_number: String ) -> void def to_hash: -> { + business_tax_identification_number: String, country: String, date_of_birth: String, first_name: String, last_name: String, personal_address: WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::PersonalAddress, - requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation] + requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateIndividualVerification::RequestedInformation], + tax_identification_number: String } type personal_address = @@ -307,8 +321,10 @@ module WhopSDK business_address: WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::BusinessAddress, business_name: String, business_structure: String, + business_tax_identification_number: String, country: String, - requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation] + requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation], + tax_identification_number: String } class UpdateBusinessVerification < WhopSDK::Internal::Type::BaseModel @@ -326,6 +342,10 @@ module WhopSDK def business_structure=: (String) -> String + attr_reader business_tax_identification_number: String? + + def business_tax_identification_number=: (String) -> String + attr_reader country: String? def country=: (String) -> String @@ -336,20 +356,28 @@ module WhopSDK ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation] ) -> ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation] + attr_reader tax_identification_number: String? + + def tax_identification_number=: (String) -> String + def initialize: ( ?business_address: WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::BusinessAddress, ?business_name: String, ?business_structure: String, + ?business_tax_identification_number: String, ?country: String, - ?requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation] + ?requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation], + ?tax_identification_number: String ) -> void def to_hash: -> { business_address: WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::BusinessAddress, business_name: String, business_structure: String, + business_tax_identification_number: String, country: String, - requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation] + requested_information: ::Array[WhopSDK::VerificationUpdateParams::Body::UpdateBusinessVerification::RequestedInformation], + tax_identification_number: String } type business_address = diff --git a/sig/whop_sdk/models/verification_update_response.rbs b/sig/whop_sdk/models/verification_update_response.rbs index f0092948..1cc6100b 100644 --- a/sig/whop_sdk/models/verification_update_response.rbs +++ b/sig/whop_sdk/models/verification_update_response.rbs @@ -315,13 +315,19 @@ module WhopSDK end type status = - :not_started | :pending | :approved | :rejected | :action_required + :not_started + | :pending + | :processing + | :approved + | :rejected + | :action_required module Status extend WhopSDK::Internal::Type::Enum NOT_STARTED: :not_started PENDING: :pending + PROCESSING: :processing APPROVED: :approved REJECTED: :rejected ACTION_REQUIRED: :action_required diff --git a/sig/whop_sdk/resources/ad_groups.rbs b/sig/whop_sdk/resources/ad_groups.rbs index 635da56a..c7e5145c 100644 --- a/sig/whop_sdk/resources/ad_groups.rbs +++ b/sig/whop_sdk/resources/ad_groups.rbs @@ -11,6 +11,7 @@ module WhopSDK ?conversion_location: WhopSDK::Models::AdGroupCreateParams::conversion_location, ?demographics: top, ?desired_cost_per_result: Float, + ?detailed_targeting: top, ?devices: top, ?dynamic_creative: bool, ?ends_at: String, @@ -45,6 +46,7 @@ module WhopSDK ?conversion_location: WhopSDK::Models::AdGroupUpdateParams::conversion_location, ?demographics: top, ?desired_cost_per_result: Float, + ?detailed_targeting: top, ?devices: top, ?ends_at: String, ?frequency_cap: top, diff --git a/sig/whop_sdk/resources/events.rbs b/sig/whop_sdk/resources/events.rbs index ff1121a8..807c459e 100644 --- a/sig/whop_sdk/resources/events.rbs +++ b/sig/whop_sdk/resources/events.rbs @@ -3,7 +3,7 @@ module WhopSDK class Events def create: ( account_id: String, - event_name: WhopSDK::Models::EventCreateParams::event_name, + event_name: String, ?action_source: WhopSDK::Models::EventCreateParams::action_source?, ?context: WhopSDK::EventCreateParams::Context?, ?currency: WhopSDK::Models::EventCreateParams::currency?, diff --git a/sig/whop_sdk/resources/partners.rbs b/sig/whop_sdk/resources/partners.rbs new file mode 100644 index 00000000..ba3f30d5 --- /dev/null +++ b/sig/whop_sdk/resources/partners.rbs @@ -0,0 +1,28 @@ +module WhopSDK + module Resources + class Partners + attr_reader businesses: WhopSDK::Resources::Partners::Businesses + + def create: ( + ?request_options: WhopSDK::request_opts + ) -> WhopSDK::Models::PartnerCreateResponse + + def leaderboard: ( + ?period: WhopSDK::Models::PartnerLeaderboardParams::period, + ?request_options: WhopSDK::request_opts + ) -> WhopSDK::Models::PartnerLeaderboardResponse + + def referred_users: ( + ?after: String, + ?before: String, + ?first: Integer, + ?has_businesses: bool, + ?has_earning_businesses: bool, + ?last: Integer, + ?request_options: WhopSDK::request_opts + ) -> WhopSDK::Models::PartnerReferredUsersResponse + + def initialize: (client: WhopSDK::Client) -> void + end + end +end diff --git a/sig/whop_sdk/resources/partners/businesses.rbs b/sig/whop_sdk/resources/partners/businesses.rbs new file mode 100644 index 00000000..4f4ef986 --- /dev/null +++ b/sig/whop_sdk/resources/partners/businesses.rbs @@ -0,0 +1,33 @@ +module WhopSDK + module Resources + class Partners + class Businesses + attr_reader earnings: WhopSDK::Resources::Partners::Businesses::Earnings + + def retrieve: ( + String id, + ?request_options: WhopSDK::request_opts + ) -> WhopSDK::Models::Partners::BusinessRetrieveResponse + + def list: ( + ?after: String, + ?before: String, + ?created_after: String, + ?created_before: String, + ?direction: WhopSDK::Models::Partners::BusinessListParams::direction, + ?first: Integer, + ?has_earnings: bool, + ?last: Integer, + ?order: WhopSDK::Models::Partners::BusinessListParams::order, + ?referred_user_id: String, + ?referred_username: String, + ?status: WhopSDK::Models::Partners::BusinessListParams::status, + ?tier: WhopSDK::Models::Partners::BusinessListParams::tier, + ?request_options: WhopSDK::request_opts + ) -> WhopSDK::Internal::CursorPage[WhopSDK::Models::Partners::BusinessListResponse] + + def initialize: (client: WhopSDK::Client) -> void + end + end + end +end diff --git a/sig/whop_sdk/resources/referrals/businesses/earnings.rbs b/sig/whop_sdk/resources/partners/businesses/earnings.rbs similarity index 54% rename from sig/whop_sdk/resources/referrals/businesses/earnings.rbs rename to sig/whop_sdk/resources/partners/businesses/earnings.rbs index fc424b90..4c0d3fe9 100644 --- a/sig/whop_sdk/resources/referrals/businesses/earnings.rbs +++ b/sig/whop_sdk/resources/partners/businesses/earnings.rbs @@ -1,6 +1,6 @@ module WhopSDK module Resources - class Referrals + class Partners class Businesses class Earnings def list: ( @@ -9,13 +9,13 @@ module WhopSDK ?before: String, ?created_after: String, ?created_before: String, - ?direction: WhopSDK::Models::Referrals::Businesses::EarningListParams::direction, + ?direction: WhopSDK::Models::Partners::Businesses::EarningListParams::direction, ?first: Integer, ?last: Integer, - ?order: WhopSDK::Models::Referrals::Businesses::EarningListParams::order, - ?status: WhopSDK::Models::Referrals::Businesses::EarningListParams::status, + ?order: WhopSDK::Models::Partners::Businesses::EarningListParams::order, + ?status: WhopSDK::Models::Partners::Businesses::EarningListParams::status, ?request_options: WhopSDK::request_opts - ) -> WhopSDK::Internal::CursorPage[WhopSDK::Models::Referrals::Businesses::EarningListResponse] + ) -> WhopSDK::Internal::CursorPage[WhopSDK::Models::Partners::Businesses::EarningListResponse] def initialize: (client: WhopSDK::Client) -> void end diff --git a/sig/whop_sdk/resources/referrals.rbs b/sig/whop_sdk/resources/referrals.rbs deleted file mode 100644 index 87b39701..00000000 --- a/sig/whop_sdk/resources/referrals.rbs +++ /dev/null @@ -1,21 +0,0 @@ -module WhopSDK - module Resources - class Referrals - attr_reader businesses: WhopSDK::Resources::Referrals::Businesses - - attr_reader partners: WhopSDK::Resources::Referrals::Partners - - def referred_users: ( - ?after: String, - ?before: String, - ?first: Integer, - ?has_businesses: bool, - ?has_earning_businesses: bool, - ?last: Integer, - ?request_options: WhopSDK::request_opts - ) -> WhopSDK::Models::ReferralReferredUsersResponse - - def initialize: (client: WhopSDK::Client) -> void - end - end -end diff --git a/sig/whop_sdk/resources/referrals/businesses.rbs b/sig/whop_sdk/resources/referrals/businesses.rbs deleted file mode 100644 index c0d96321..00000000 --- a/sig/whop_sdk/resources/referrals/businesses.rbs +++ /dev/null @@ -1,38 +0,0 @@ -module WhopSDK - module Resources - class Referrals - class Businesses - attr_reader earnings: WhopSDK::Resources::Referrals::Businesses::Earnings - - def retrieve: ( - String id, - ?request_options: WhopSDK::request_opts - ) -> WhopSDK::Models::Referrals::BusinessRetrieveResponse - - def list: ( - ?after: String, - ?before: String, - ?created_after: String, - ?created_before: String, - ?direction: WhopSDK::Models::Referrals::BusinessListParams::direction, - ?first: Integer, - ?has_earnings: bool, - ?last: Integer, - ?order: WhopSDK::Models::Referrals::BusinessListParams::order, - ?referred_user_id: String, - ?referred_username: String, - ?status: WhopSDK::Models::Referrals::BusinessListParams::status, - ?tier: WhopSDK::Models::Referrals::BusinessListParams::tier, - ?request_options: WhopSDK::request_opts - ) -> WhopSDK::Internal::CursorPage[WhopSDK::Models::Referrals::BusinessListResponse] - - def leaderboard: ( - ?period: WhopSDK::Models::Referrals::BusinessLeaderboardParams::period, - ?request_options: WhopSDK::request_opts - ) -> WhopSDK::Models::Referrals::BusinessLeaderboardResponse - - def initialize: (client: WhopSDK::Client) -> void - end - end - end -end diff --git a/sig/whop_sdk/resources/referrals/partners.rbs b/sig/whop_sdk/resources/referrals/partners.rbs deleted file mode 100644 index d4da1e94..00000000 --- a/sig/whop_sdk/resources/referrals/partners.rbs +++ /dev/null @@ -1,13 +0,0 @@ -module WhopSDK - module Resources - class Referrals - class Partners - def create: ( - ?request_options: WhopSDK::request_opts - ) -> WhopSDK::Models::Referrals::PartnerCreateResponse - - def initialize: (client: WhopSDK::Client) -> void - end - end - end -end diff --git a/sig/whop_sdk/resources/users.rbs b/sig/whop_sdk/resources/users.rbs index 3520bc76..de1315f7 100644 --- a/sig/whop_sdk/resources/users.rbs +++ b/sig/whop_sdk/resources/users.rbs @@ -37,6 +37,11 @@ module WhopSDK ?request_options: WhopSDK::request_opts ) -> WhopSDK::Models::UserCheckAccessResponse + def recommend_actions: ( + String id, + ?request_options: WhopSDK::request_opts + ) -> WhopSDK::Models::UserRecommendActionsResponse + def update_me: ( ?account_id: String, ?bio: String, diff --git a/test/whop_sdk/resource_namespaces.rb b/test/whop_sdk/resource_namespaces.rb index d746d3ad..6a733833 100644 --- a/test/whop_sdk/resource_namespaces.rb +++ b/test/whop_sdk/resource_namespaces.rb @@ -12,14 +12,14 @@ module Affiliates module Businesses end - module Payouts - end - - module Referrals + module Partners module Businesses end end + module Payouts + end + module Workforce end end diff --git a/test/whop_sdk/resources/ad_groups_test.rb b/test/whop_sdk/resources/ad_groups_test.rb index 794e3dda..9826412f 100644 --- a/test/whop_sdk/resources/ad_groups_test.rb +++ b/test/whop_sdk/resources/ad_groups_test.rb @@ -44,6 +44,7 @@ def test_create_required_params delivery_status: WhopSDK::AdGroup::DeliveryStatus, demographics: WhopSDK::Internal::Type::Unknown, desired_cost_per_result: Float | nil, + detailed_targeting: WhopSDK::Internal::Type::Unknown, devices: WhopSDK::Internal::Type::Unknown, dynamic_creative: WhopSDK::Internal::Type::Boolean, ends_at: String | nil, @@ -121,6 +122,7 @@ def test_retrieve delivery_status: WhopSDK::AdGroup::DeliveryStatus, demographics: WhopSDK::Internal::Type::Unknown, desired_cost_per_result: Float | nil, + detailed_targeting: WhopSDK::Internal::Type::Unknown, devices: WhopSDK::Internal::Type::Unknown, dynamic_creative: WhopSDK::Internal::Type::Boolean, ends_at: String | nil, @@ -198,6 +200,7 @@ def test_update delivery_status: WhopSDK::AdGroup::DeliveryStatus, demographics: WhopSDK::Internal::Type::Unknown, desired_cost_per_result: Float | nil, + detailed_targeting: WhopSDK::Internal::Type::Unknown, devices: WhopSDK::Internal::Type::Unknown, dynamic_creative: WhopSDK::Internal::Type::Boolean, ends_at: String | nil, @@ -282,6 +285,7 @@ def test_list delivery_status: WhopSDK::AdGroup::DeliveryStatus, demographics: WhopSDK::Internal::Type::Unknown, desired_cost_per_result: Float | nil, + detailed_targeting: WhopSDK::Internal::Type::Unknown, devices: WhopSDK::Internal::Type::Unknown, dynamic_creative: WhopSDK::Internal::Type::Boolean, ends_at: String | nil, @@ -369,6 +373,7 @@ def test_pause delivery_status: WhopSDK::AdGroup::DeliveryStatus, demographics: WhopSDK::Internal::Type::Unknown, desired_cost_per_result: Float | nil, + detailed_targeting: WhopSDK::Internal::Type::Unknown, devices: WhopSDK::Internal::Type::Unknown, dynamic_creative: WhopSDK::Internal::Type::Boolean, ends_at: String | nil, @@ -446,6 +451,7 @@ def test_unpause delivery_status: WhopSDK::AdGroup::DeliveryStatus, demographics: WhopSDK::Internal::Type::Unknown, desired_cost_per_result: Float | nil, + detailed_targeting: WhopSDK::Internal::Type::Unknown, devices: WhopSDK::Internal::Type::Unknown, dynamic_creative: WhopSDK::Internal::Type::Boolean, ends_at: String | nil, diff --git a/test/whop_sdk/resources/events_test.rb b/test/whop_sdk/resources/events_test.rb index 1f8ad67e..1a685321 100644 --- a/test/whop_sdk/resources/events_test.rb +++ b/test/whop_sdk/resources/events_test.rb @@ -6,7 +6,7 @@ class WhopSDK::Test::Resources::EventsTest < WhopSDK::Test::ResourceTest def test_create_required_params skip("Mock server tests are disabled") - response = @whop.events.create(account_id: "account_id", event_name: :lead) + response = @whop.events.create(account_id: "account_id", event_name: "course_completed") assert_pattern do response => WhopSDK::Models::EventCreateResponse diff --git a/test/whop_sdk/resources/invoices_test.rb b/test/whop_sdk/resources/invoices_test.rb index 2c0c4f92..93383442 100644 --- a/test/whop_sdk/resources/invoices_test.rb +++ b/test/whop_sdk/resources/invoices_test.rb @@ -28,6 +28,7 @@ def test_create_required_params due_date: Time | nil, email_address: String | nil, fetch_invoice_token: String, + line_items: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Invoice::LineItem]), number: String, status: WhopSDK::InvoiceStatus, user: WhopSDK::Invoice::User | nil @@ -52,6 +53,7 @@ def test_retrieve due_date: Time | nil, email_address: String | nil, fetch_invoice_token: String, + line_items: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Invoice::LineItem]), number: String, status: WhopSDK::InvoiceStatus, user: WhopSDK::Invoice::User | nil @@ -76,6 +78,7 @@ def test_update due_date: Time | nil, email_address: String | nil, fetch_invoice_token: String, + line_items: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Invoice::LineItem]), number: String, status: WhopSDK::InvoiceStatus, user: WhopSDK::Invoice::User | nil @@ -107,6 +110,7 @@ def test_list due_date: Time | nil, email_address: String | nil, fetch_invoice_token: String, + line_items: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::InvoiceListItem::LineItem]), number: String, status: WhopSDK::InvoiceStatus, user: WhopSDK::InvoiceListItem::User | nil diff --git a/test/whop_sdk/resources/partners/businesses/earnings_test.rb b/test/whop_sdk/resources/partners/businesses/earnings_test.rb new file mode 100644 index 00000000..0a40ce13 --- /dev/null +++ b/test/whop_sdk/resources/partners/businesses/earnings_test.rb @@ -0,0 +1,41 @@ +# frozen_string_literal: true + +require_relative "../../../test_helper" + +class WhopSDK::Test::Resources::Partners::Businesses::EarningsTest < WhopSDK::Test::ResourceTest + def test_list + skip("Mock server tests are disabled") + + response = @whop.partners.businesses.earnings.list("id") + + assert_pattern do + response => WhopSDK::Internal::CursorPage + end + + row = response.to_enum.first + return if row.nil? + + assert_pattern do + row => WhopSDK::Models::Partners::Businesses::EarningListResponse + end + + assert_pattern do + row => { + id: String | nil, + account: WhopSDK::Models::Partners::Businesses::EarningListResponse::Account | nil, + cancelation_reason: String | nil, + commission_amount_usd: String | nil, + created_at: Time, + financial_activity: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Partners::Businesses::EarningListResponse::FinancialActivity]) | nil, + object: WhopSDK::Models::Partners::Businesses::EarningListResponse::Object, + payout_at: Time | nil, + payout_percentage: Float | nil, + product: WhopSDK::Models::Partners::Businesses::EarningListResponse::Product | nil, + resource: WhopSDK::Models::Partners::Businesses::EarningListResponse::Resource | nil, + second_tier: WhopSDK::Internal::Type::Boolean, + status: WhopSDK::Models::Partners::Businesses::EarningListResponse::Status, + transaction_amount_usd: String + } + end + end +end diff --git a/test/whop_sdk/resources/partners/businesses_test.rb b/test/whop_sdk/resources/partners/businesses_test.rb new file mode 100644 index 00000000..18bcadbf --- /dev/null +++ b/test/whop_sdk/resources/partners/businesses_test.rb @@ -0,0 +1,68 @@ +# frozen_string_literal: true + +require_relative "../../test_helper" + +class WhopSDK::Test::Resources::Partners::BusinessesTest < WhopSDK::Test::ResourceTest + def test_retrieve + skip("Mock server tests are disabled") + + response = @whop.partners.businesses.retrieve("id") + + assert_pattern do + response => WhopSDK::Models::Partners::BusinessRetrieveResponse + end + + assert_pattern do + response => { + id: String, + account: WhopSDK::Models::Partners::BusinessRetrieveResponse::Account | nil, + created_at: Time, + earnings_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessRetrieveResponse::FirstTierPartner | nil, + my_partner_tier: WhopSDK::Models::Partners::BusinessRetrieveResponse::MyPartnerTier, + object: WhopSDK::Models::Partners::BusinessRetrieveResponse::Object, + owner: WhopSDK::Models::Partners::BusinessRetrieveResponse::Owner | nil, + payout_percentage: Float, + referral_expires_at: Time | nil, + referral_started_at: Time | nil, + status: WhopSDK::Models::Partners::BusinessRetrieveResponse::Status, + volume_usd: WhopSDK::Models::Partners::BusinessRetrieveResponse::VolumeUsd + } + end + end + + def test_list + skip("Mock server tests are disabled") + + response = @whop.partners.businesses.list + + assert_pattern do + response => WhopSDK::Internal::CursorPage + end + + row = response.to_enum.first + return if row.nil? + + assert_pattern do + row => WhopSDK::Models::Partners::BusinessListResponse + end + + assert_pattern do + row => { + id: String, + account: WhopSDK::Models::Partners::BusinessListResponse::Account | nil, + created_at: Time, + earnings_usd: WhopSDK::Models::Partners::BusinessListResponse::EarningsUsd, + first_tier_partner: WhopSDK::Models::Partners::BusinessListResponse::FirstTierPartner | nil, + my_partner_tier: WhopSDK::Models::Partners::BusinessListResponse::MyPartnerTier, + object: WhopSDK::Models::Partners::BusinessListResponse::Object, + owner: WhopSDK::Models::Partners::BusinessListResponse::Owner | nil, + payout_percentage: Float, + referral_expires_at: Time | nil, + referral_started_at: Time | nil, + status: WhopSDK::Models::Partners::BusinessListResponse::Status, + volume_usd: WhopSDK::Models::Partners::BusinessListResponse::VolumeUsd + } + end + end +end diff --git a/test/whop_sdk/resources/partners_test.rb b/test/whop_sdk/resources/partners_test.rb new file mode 100644 index 00000000..43e5887e --- /dev/null +++ b/test/whop_sdk/resources/partners_test.rb @@ -0,0 +1,56 @@ +# frozen_string_literal: true + +require_relative "../test_helper" + +class WhopSDK::Test::Resources::PartnersTest < WhopSDK::Test::ResourceTest + def test_create + skip("Mock server tests are disabled") + + response = @whop.partners.create + + assert_pattern do + response => WhopSDK::Models::PartnerCreateResponse + end + + assert_pattern do + response => { + referral_link: String, + whop_partner_enabled_at: Time + } + end + end + + def test_leaderboard + skip("Mock server tests are disabled") + + response = @whop.partners.leaderboard + + assert_pattern do + response => WhopSDK::Models::PartnerLeaderboardResponse + end + + assert_pattern do + response => { + leaders: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PartnerLeaderboardResponse::Leader]), + me: WhopSDK::Models::PartnerLeaderboardResponse::Me | nil + } + end + end + + def test_referred_users + skip("Mock server tests are disabled") + + response = @whop.partners.referred_users + + assert_pattern do + response => WhopSDK::Models::PartnerReferredUsersResponse + end + + assert_pattern do + response => { + data: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::PartnerReferredUsersResponse::Data]), + page_info: WhopSDK::Models::PartnerReferredUsersResponse::PageInfo + } + end + end +end diff --git a/test/whop_sdk/resources/products_test.rb b/test/whop_sdk/resources/products_test.rb index c5c2a153..a1c6827d 100644 --- a/test/whop_sdk/resources/products_test.rb +++ b/test/whop_sdk/resources/products_test.rb @@ -141,6 +141,7 @@ def test_list_required_params id: String, created_at: Time, external_identifier: String | nil, + gallery_images: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::ProductListItem::GalleryImage]), headline: String | nil, member_count: Integer, metadata: ^(WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown]) | nil, diff --git a/test/whop_sdk/resources/referrals/businesses/earnings_test.rb b/test/whop_sdk/resources/referrals/businesses/earnings_test.rb deleted file mode 100644 index 4d0122f2..00000000 --- a/test/whop_sdk/resources/referrals/businesses/earnings_test.rb +++ /dev/null @@ -1,41 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../../test_helper" - -class WhopSDK::Test::Resources::Referrals::Businesses::EarningsTest < WhopSDK::Test::ResourceTest - def test_list - skip("Mock server tests are disabled") - - response = @whop.referrals.businesses.earnings.list("id") - - assert_pattern do - response => WhopSDK::Internal::CursorPage - end - - row = response.to_enum.first - return if row.nil? - - assert_pattern do - row => WhopSDK::Models::Referrals::Businesses::EarningListResponse - end - - assert_pattern do - row => { - id: String | nil, - account: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Account | nil, - cancelation_reason: String | nil, - commission_amount_usd: String | nil, - created_at: Time, - financial_activity: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::Businesses::EarningListResponse::FinancialActivity]) | nil, - object: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Object, - payout_at: Time | nil, - payout_percentage: Float | nil, - product: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Product | nil, - resource: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Resource | nil, - second_tier: WhopSDK::Internal::Type::Boolean, - status: WhopSDK::Models::Referrals::Businesses::EarningListResponse::Status, - transaction_amount_usd: String - } - end - end -end diff --git a/test/whop_sdk/resources/referrals/businesses_test.rb b/test/whop_sdk/resources/referrals/businesses_test.rb deleted file mode 100644 index 377200ab..00000000 --- a/test/whop_sdk/resources/referrals/businesses_test.rb +++ /dev/null @@ -1,85 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../test_helper" - -class WhopSDK::Test::Resources::Referrals::BusinessesTest < WhopSDK::Test::ResourceTest - def test_retrieve - skip("Mock server tests are disabled") - - response = @whop.referrals.businesses.retrieve("id") - - assert_pattern do - response => WhopSDK::Models::Referrals::BusinessRetrieveResponse - end - - assert_pattern do - response => { - id: String, - account: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Account | nil, - created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::FirstTierPartner | nil, - my_partner_tier: WhopSDK::Models::Referrals::BusinessRetrieveResponse::MyPartnerTier, - object: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Object, - owner: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Owner | nil, - payout_percentage: Float, - referral_expires_at: Time | nil, - referral_started_at: Time | nil, - status: WhopSDK::Models::Referrals::BusinessRetrieveResponse::Status, - volume_usd: WhopSDK::Models::Referrals::BusinessRetrieveResponse::VolumeUsd - } - end - end - - def test_list - skip("Mock server tests are disabled") - - response = @whop.referrals.businesses.list - - assert_pattern do - response => WhopSDK::Internal::CursorPage - end - - row = response.to_enum.first - return if row.nil? - - assert_pattern do - row => WhopSDK::Models::Referrals::BusinessListResponse - end - - assert_pattern do - row => { - id: String, - account: WhopSDK::Models::Referrals::BusinessListResponse::Account | nil, - created_at: Time, - earnings_usd: WhopSDK::Models::Referrals::BusinessListResponse::EarningsUsd, - first_tier_partner: WhopSDK::Models::Referrals::BusinessListResponse::FirstTierPartner | nil, - my_partner_tier: WhopSDK::Models::Referrals::BusinessListResponse::MyPartnerTier, - object: WhopSDK::Models::Referrals::BusinessListResponse::Object, - owner: WhopSDK::Models::Referrals::BusinessListResponse::Owner | nil, - payout_percentage: Float, - referral_expires_at: Time | nil, - referral_started_at: Time | nil, - status: WhopSDK::Models::Referrals::BusinessListResponse::Status, - volume_usd: WhopSDK::Models::Referrals::BusinessListResponse::VolumeUsd - } - end - end - - def test_leaderboard - skip("Mock server tests are disabled") - - response = @whop.referrals.businesses.leaderboard - - assert_pattern do - response => WhopSDK::Models::Referrals::BusinessLeaderboardResponse - end - - assert_pattern do - response => { - leaders: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Leader]), - me: WhopSDK::Models::Referrals::BusinessLeaderboardResponse::Me | nil - } - end - end -end diff --git a/test/whop_sdk/resources/referrals/partners_test.rb b/test/whop_sdk/resources/referrals/partners_test.rb deleted file mode 100644 index c6bb02db..00000000 --- a/test/whop_sdk/resources/referrals/partners_test.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -require_relative "../../test_helper" - -class WhopSDK::Test::Resources::Referrals::PartnersTest < WhopSDK::Test::ResourceTest - def test_create - skip("Mock server tests are disabled") - - response = @whop.referrals.partners.create - - assert_pattern do - response => WhopSDK::Models::Referrals::PartnerCreateResponse - end - - assert_pattern do - response => { - referral_link: String, - whop_partner_enabled_at: Time - } - end - end -end diff --git a/test/whop_sdk/resources/referrals_test.rb b/test/whop_sdk/resources/referrals_test.rb deleted file mode 100644 index d5c4cd7e..00000000 --- a/test/whop_sdk/resources/referrals_test.rb +++ /dev/null @@ -1,22 +0,0 @@ -# frozen_string_literal: true - -require_relative "../test_helper" - -class WhopSDK::Test::Resources::ReferralsTest < WhopSDK::Test::ResourceTest - def test_referred_users - skip("Mock server tests are disabled") - - response = @whop.referrals.referred_users - - assert_pattern do - response => WhopSDK::Models::ReferralReferredUsersResponse - end - - assert_pattern do - response => { - data: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::ReferralReferredUsersResponse::Data]), - page_info: WhopSDK::Models::ReferralReferredUsersResponse::PageInfo - } - end - end -end diff --git a/test/whop_sdk/resources/social_accounts_test.rb b/test/whop_sdk/resources/social_accounts_test.rb index d9ae4d53..5a4e75a2 100644 --- a/test/whop_sdk/resources/social_accounts_test.rb +++ b/test/whop_sdk/resources/social_accounts_test.rb @@ -15,6 +15,7 @@ def test_create_required_params assert_pattern do response => { id: String, + error: String | nil, external_id: String | nil, name: String | nil, platform: WhopSDK::SocialAccount::Platform, @@ -46,6 +47,7 @@ def test_list assert_pattern do row => { id: String, + error: String | nil, external_id: String | nil, name: String | nil, platform: WhopSDK::SocialAccount::Platform, diff --git a/test/whop_sdk/resources/users_test.rb b/test/whop_sdk/resources/users_test.rb index 88c338ae..ca247c70 100644 --- a/test/whop_sdk/resources/users_test.rb +++ b/test/whop_sdk/resources/users_test.rb @@ -105,6 +105,22 @@ def test_check_access_required_params end end + def test_recommend_actions + skip("Mock server tests are disabled") + + response = @whop.users.recommend_actions("id") + + assert_pattern do + response => WhopSDK::Models::UserRecommendActionsResponse + end + + assert_pattern do + response => { + data: ^(WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::UserRecommendActionsResponse::Data]) + } + end + end + def test_update_me skip("Mock server tests are disabled")