whop_sdk 2.3.0 → 2.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.fern/metadata.json +3 -3
- data/.fern/replay.lock +91 -1
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload.rb +25 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_api_version.rb +13 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data.rb +77 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_bid_type.rb +15 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_budget_type.rb +14 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_conversion_location.rb +21 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_delivery_status.rb +27 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_message_apps_item.rb +15 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_optimization_goal.rb +30 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_platform.rb +15 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_data_status.rb +16 -0
- data/lib/whop_sdk/ad_groups/types/post_ad_group_updated_payload_type.rb +13 -0
- data/lib/whop_sdk/ad_pixels/client.rb +241 -0
- data/lib/whop_sdk/ad_pixels/types/create_ad_pixels_request.rb +17 -0
- data/lib/whop_sdk/ad_pixels/types/create_ad_pixels_request_platform.rb +13 -0
- data/lib/whop_sdk/ad_pixels/types/delete_ad_pixels_request.rb +11 -0
- data/lib/whop_sdk/ad_pixels/types/delete_ad_pixels_response.rb +13 -0
- data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_request.rb +23 -0
- data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_request_direction.rb +14 -0
- data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_request_order.rb +13 -0
- data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_response.rb +13 -0
- data/lib/whop_sdk/ad_pixels/types/list_ad_pixels_response_page_info.rb +17 -0
- data/lib/whop_sdk/ad_pixels/types/retrieve_ad_pixels_request.rb +11 -0
- data/lib/whop_sdk/ad_pixels/types/update_ad_pixels_request.rb +13 -0
- data/lib/whop_sdk/api_keys/types/create_api_keys_request_api_version_date.rb +3 -0
- data/lib/whop_sdk/api_keys/types/update_api_keys_request_api_version_date.rb +3 -0
- data/lib/whop_sdk/apps/types/create_apps_request.rb +2 -0
- data/lib/whop_sdk/apps/types/list_apps_request_order.rb +1 -0
- data/lib/whop_sdk/card_transactions/client.rb +8 -4
- data/lib/whop_sdk/card_transactions/types/list_card_transactions_request.rb +2 -0
- data/lib/whop_sdk/card_transactions/types/retrieve_card_transactions_request.rb +2 -0
- data/lib/whop_sdk/client.rb +6 -1
- data/lib/whop_sdk/domains/client.rb +5 -3
- data/lib/whop_sdk/domains/types/list_domains_request.rb +5 -3
- data/lib/whop_sdk/domains/types/list_domains_request_platform.rb +17 -0
- data/lib/whop_sdk/domains/types/list_domains_request_registration.rb +17 -0
- data/lib/whop_sdk/domains/types/list_domains_request_verification.rb +17 -0
- data/lib/whop_sdk/domains/types/list_domains_request_website.rb +17 -0
- data/lib/whop_sdk/economic_intelligence/client.rb +3 -1
- data/lib/whop_sdk/experiments/client.rb +11 -16
- data/lib/whop_sdk/feedback_submissions/client.rb +3 -3
- data/lib/whop_sdk/internal/http/raw_client.rb +1 -1
- data/lib/whop_sdk/notifications/topics/client.rb +1 -1
- data/lib/whop_sdk/partner_referral_requests/types/create_partner_referral_requests_request_body_code.rb +1 -2
- data/lib/whop_sdk/payment_quotes/types/create_payment_quotes_request.rb +2 -0
- data/lib/whop_sdk/payment_quotes/types/create_payment_quotes_request_address.rb +1 -1
- data/lib/whop_sdk/payments/client.rb +38 -0
- data/lib/whop_sdk/payments/types/generate_pdf_payments_request.rb +11 -0
- data/lib/whop_sdk/promo_codes/client.rb +1 -1
- data/lib/whop_sdk/transfers/client.rb +4 -7
- data/lib/whop_sdk/transfers/types/create_transfers_request_body.rb +17 -0
- data/lib/whop_sdk/transfers/types/{create_transfers_request.rb → create_transfers_request_body_balance.rb} +6 -10
- data/lib/whop_sdk/transfers/types/{create_transfers_request_feed_type.rb → create_transfers_request_body_balance_feed_type.rb} +1 -1
- data/lib/whop_sdk/transfers/types/create_transfers_request_body_claim_link.rb +18 -0
- data/lib/whop_sdk/transfers/types/create_transfers_response.rb +0 -2
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer.rb +15 -17
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_destination.rb +5 -5
- data/lib/whop_sdk/transfers/types/{create_transfers_request_type.rb → create_transfers_response_transfer_destination_object.rb} +3 -4
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_origin.rb +5 -5
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_origin_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/list_transfers_response_data_item.rb +16 -14
- data/lib/whop_sdk/transfers/types/list_transfers_response_data_item_destination.rb +18 -0
- data/lib/whop_sdk/transfers/types/list_transfers_response_data_item_destination_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/list_transfers_response_data_item_origin.rb +18 -0
- data/lib/whop_sdk/transfers/types/list_transfers_response_data_item_origin_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data.rb +16 -18
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_destination.rb +5 -5
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_destination_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_origin.rb +5 -5
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_origin_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data.rb +16 -18
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_destination.rb +5 -5
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_destination_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_origin.rb +5 -5
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_origin_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data.rb +16 -18
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_destination.rb +5 -5
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_destination_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_origin.rb +5 -5
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_origin_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response.rb +16 -18
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_destination.rb +5 -5
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_destination_object.rb +14 -0
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_origin.rb +5 -5
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_origin_object.rb +14 -0
- data/lib/whop_sdk/types/ad_pixel.rb +25 -0
- data/lib/whop_sdk/types/ad_pixel_platform.rb +11 -0
- data/lib/whop_sdk/types/ad_pixel_status.rb +13 -0
- data/lib/whop_sdk/types/api_key_api_version_date.rb +3 -0
- data/lib/whop_sdk/types/app.rb +3 -3
- data/lib/whop_sdk/types/app_list_item.rb +3 -3
- data/lib/whop_sdk/types/domain.rb +2 -0
- data/lib/whop_sdk/types/domain_issue_capability.rb +1 -0
- data/lib/whop_sdk/types/domain_list_item.rb +2 -0
- data/lib/whop_sdk/types/domain_platform.rb +9 -0
- data/lib/whop_sdk/types/domain_platform_state.rb +14 -0
- data/lib/whop_sdk/types/payment.rb +0 -2
- data/lib/whop_sdk/types/payment_pdf.rb +11 -0
- data/lib/whop_sdk/types/payment_quote_located_by.rb +1 -0
- data/lib/whop_sdk/types/permission_action.rb +2 -0
- data/lib/whop_sdk/types/user.rb +2 -0
- data/lib/whop_sdk/types/user_preferences.rb +2 -0
- data/lib/whop_sdk/types/webhook_event.rb +1 -0
- data/lib/whop_sdk/types/webhook_events_item.rb +1 -0
- data/lib/whop_sdk/types/webhook_list_item_events_item.rb +1 -0
- data/lib/whop_sdk/types/webhook_testable_events_item.rb +1 -0
- data/lib/whop_sdk/users/client.rb +2 -2
- data/lib/whop_sdk/users/preferences/types/update_preferences_request.rb +2 -0
- data/lib/whop_sdk/variants/client.rb +8 -2
- data/lib/whop_sdk/variants/types/list_variants_request.rb +2 -0
- data/lib/whop_sdk/variants/types/retrieve_variants_request.rb +2 -0
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk/webhooks/types/create_webhooks_request_events_item.rb +1 -0
- data/lib/whop_sdk/webhooks/types/update_webhooks_request_events_item.rb +1 -0
- data/lib/whop_sdk.rb +53 -32
- data/reference.md +565 -143
- metadata +55 -34
- data/lib/whop_sdk/transfers/types/create_transfers_response_send.rb +0 -20
- data/lib/whop_sdk/transfers/types/create_transfers_response_send_destination.rb +0 -13
- data/lib/whop_sdk/transfers/types/create_transfers_response_send_source.rb +0 -13
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_created_by_user.rb +0 -17
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_destination_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_destination_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_origin_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/create_transfers_response_transfer_origin_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/list_transfers_response_data_item_created_by_user.rb +0 -17
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_created_by_user.rb +0 -17
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_destination_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_destination_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_origin_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_completed_payload_data_origin_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_created_by_user.rb +0 -17
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_destination_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_destination_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_origin_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_created_payload_data_origin_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_created_by_user.rb +0 -17
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_destination_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_destination_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_origin_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/post_transfer_failed_payload_data_origin_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_created_by_user.rb +0 -17
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_destination_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_destination_user.rb +0 -15
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_origin_company.rb +0 -15
- data/lib/whop_sdk/transfers/types/retrieve_transfers_response_origin_user.rb +0 -15
data/reference.md
CHANGED
|
@@ -4369,6 +4369,391 @@ client.ad_groups.unpause(id: "id")
|
|
|
4369
4369
|
</dl>
|
|
4370
4370
|
|
|
4371
4371
|
|
|
4372
|
+
</dd>
|
|
4373
|
+
</dl>
|
|
4374
|
+
</details>
|
|
4375
|
+
|
|
4376
|
+
## Ad Pixels
|
|
4377
|
+
<details><summary><code>client.ad_pixels.<a href="/lib/whop_sdk/ad_pixels/client.rb">list</a>() -> Whop_sdk::AdPixels::Types::ListAdPixelsResponse</code></summary>
|
|
4378
|
+
<dl>
|
|
4379
|
+
<dd>
|
|
4380
|
+
|
|
4381
|
+
#### 📝 Description
|
|
4382
|
+
|
|
4383
|
+
<dl>
|
|
4384
|
+
<dd>
|
|
4385
|
+
|
|
4386
|
+
<dl>
|
|
4387
|
+
<dd>
|
|
4388
|
+
|
|
4389
|
+
List the pixels you added for businesses whose campaigns you claimed.
|
|
4390
|
+
</dd>
|
|
4391
|
+
</dl>
|
|
4392
|
+
</dd>
|
|
4393
|
+
</dl>
|
|
4394
|
+
|
|
4395
|
+
#### 🔌 Usage
|
|
4396
|
+
|
|
4397
|
+
<dl>
|
|
4398
|
+
<dd>
|
|
4399
|
+
|
|
4400
|
+
<dl>
|
|
4401
|
+
<dd>
|
|
4402
|
+
|
|
4403
|
+
```ruby
|
|
4404
|
+
client.ad_pixels.list
|
|
4405
|
+
```
|
|
4406
|
+
</dd>
|
|
4407
|
+
</dl>
|
|
4408
|
+
</dd>
|
|
4409
|
+
</dl>
|
|
4410
|
+
|
|
4411
|
+
#### ⚙️ Parameters
|
|
4412
|
+
|
|
4413
|
+
<dl>
|
|
4414
|
+
<dd>
|
|
4415
|
+
|
|
4416
|
+
<dl>
|
|
4417
|
+
<dd>
|
|
4418
|
+
|
|
4419
|
+
**account_id:** `String` — Only return the pixel for this business, prefixed `biz_`.
|
|
4420
|
+
|
|
4421
|
+
</dd>
|
|
4422
|
+
</dl>
|
|
4423
|
+
|
|
4424
|
+
<dl>
|
|
4425
|
+
<dd>
|
|
4426
|
+
|
|
4427
|
+
**first:** `Integer` — Number of results to return from the start of the range.
|
|
4428
|
+
|
|
4429
|
+
</dd>
|
|
4430
|
+
</dl>
|
|
4431
|
+
|
|
4432
|
+
<dl>
|
|
4433
|
+
<dd>
|
|
4434
|
+
|
|
4435
|
+
**after:** `String` — Return results after this cursor. Use `page_info.end_cursor` from the previous response to fetch the next page.
|
|
4436
|
+
|
|
4437
|
+
</dd>
|
|
4438
|
+
</dl>
|
|
4439
|
+
|
|
4440
|
+
<dl>
|
|
4441
|
+
<dd>
|
|
4442
|
+
|
|
4443
|
+
**last:** `Integer` — Number of results to return from the end of the range.
|
|
4444
|
+
|
|
4445
|
+
</dd>
|
|
4446
|
+
</dl>
|
|
4447
|
+
|
|
4448
|
+
<dl>
|
|
4449
|
+
<dd>
|
|
4450
|
+
|
|
4451
|
+
**before:** `String` — Return results before this cursor. Use `page_info.start_cursor` from the previous response to fetch the previous page.
|
|
4452
|
+
|
|
4453
|
+
</dd>
|
|
4454
|
+
</dl>
|
|
4455
|
+
|
|
4456
|
+
<dl>
|
|
4457
|
+
<dd>
|
|
4458
|
+
|
|
4459
|
+
**order:** `Whop_sdk::AdPixels::Types::ListAdPixelsRequestOrder`
|
|
4460
|
+
|
|
4461
|
+
</dd>
|
|
4462
|
+
</dl>
|
|
4463
|
+
|
|
4464
|
+
<dl>
|
|
4465
|
+
<dd>
|
|
4466
|
+
|
|
4467
|
+
**direction:** `Whop_sdk::AdPixels::Types::ListAdPixelsRequestDirection`
|
|
4468
|
+
|
|
4469
|
+
</dd>
|
|
4470
|
+
</dl>
|
|
4471
|
+
|
|
4472
|
+
<dl>
|
|
4473
|
+
<dd>
|
|
4474
|
+
|
|
4475
|
+
**request_options:** `Whop_sdk::AdPixels::RequestOptions`
|
|
4476
|
+
|
|
4477
|
+
</dd>
|
|
4478
|
+
</dl>
|
|
4479
|
+
</dd>
|
|
4480
|
+
</dl>
|
|
4481
|
+
|
|
4482
|
+
|
|
4483
|
+
</dd>
|
|
4484
|
+
</dl>
|
|
4485
|
+
</details>
|
|
4486
|
+
|
|
4487
|
+
<details><summary><code>client.ad_pixels.<a href="/lib/whop_sdk/ad_pixels/client.rb">create</a>(request) -> Whop_sdk::Types::AdPixel</code></summary>
|
|
4488
|
+
<dl>
|
|
4489
|
+
<dd>
|
|
4490
|
+
|
|
4491
|
+
#### 📝 Description
|
|
4492
|
+
|
|
4493
|
+
<dl>
|
|
4494
|
+
<dd>
|
|
4495
|
+
|
|
4496
|
+
<dl>
|
|
4497
|
+
<dd>
|
|
4498
|
+
|
|
4499
|
+
Add your pixel for a business whose campaigns you claimed. Whop checks the access token with the ad platform, then sends the pixel the conversions credited to your claimed campaigns for that business. Each business takes one pixel, and each pixel can serve one business.
|
|
4500
|
+
</dd>
|
|
4501
|
+
</dl>
|
|
4502
|
+
</dd>
|
|
4503
|
+
</dl>
|
|
4504
|
+
|
|
4505
|
+
#### 🔌 Usage
|
|
4506
|
+
|
|
4507
|
+
<dl>
|
|
4508
|
+
<dd>
|
|
4509
|
+
|
|
4510
|
+
<dl>
|
|
4511
|
+
<dd>
|
|
4512
|
+
|
|
4513
|
+
```ruby
|
|
4514
|
+
client.ad_pixels.create(
|
|
4515
|
+
access_token: "new-token",
|
|
4516
|
+
account_id: "biz_xxxxxxxxxxxxxx",
|
|
4517
|
+
external_id: "998877665544",
|
|
4518
|
+
platform: "meta"
|
|
4519
|
+
)
|
|
4520
|
+
```
|
|
4521
|
+
</dd>
|
|
4522
|
+
</dl>
|
|
4523
|
+
</dd>
|
|
4524
|
+
</dl>
|
|
4525
|
+
|
|
4526
|
+
#### ⚙️ Parameters
|
|
4527
|
+
|
|
4528
|
+
<dl>
|
|
4529
|
+
<dd>
|
|
4530
|
+
|
|
4531
|
+
<dl>
|
|
4532
|
+
<dd>
|
|
4533
|
+
|
|
4534
|
+
**access_token:** `String` — An access token that can send events to the pixel on the ad platform. Whop never returns it.
|
|
4535
|
+
|
|
4536
|
+
</dd>
|
|
4537
|
+
</dl>
|
|
4538
|
+
|
|
4539
|
+
<dl>
|
|
4540
|
+
<dd>
|
|
4541
|
+
|
|
4542
|
+
**account_id:** `String` — The business whose claimed campaigns send conversions to this pixel, prefixed `biz_`. You must have claimed at least one of its campaigns.
|
|
4543
|
+
|
|
4544
|
+
</dd>
|
|
4545
|
+
</dl>
|
|
4546
|
+
|
|
4547
|
+
<dl>
|
|
4548
|
+
<dd>
|
|
4549
|
+
|
|
4550
|
+
**external_id:** `String` — The pixel's ID on the ad platform.
|
|
4551
|
+
|
|
4552
|
+
</dd>
|
|
4553
|
+
</dl>
|
|
4554
|
+
|
|
4555
|
+
<dl>
|
|
4556
|
+
<dd>
|
|
4557
|
+
|
|
4558
|
+
**platform:** `Whop_sdk::AdPixels::Types::CreateAdPixelsRequestPlatform` — The ad platform the pixel belongs to.
|
|
4559
|
+
|
|
4560
|
+
</dd>
|
|
4561
|
+
</dl>
|
|
4562
|
+
|
|
4563
|
+
<dl>
|
|
4564
|
+
<dd>
|
|
4565
|
+
|
|
4566
|
+
**request_options:** `Whop_sdk::AdPixels::RequestOptions`
|
|
4567
|
+
|
|
4568
|
+
</dd>
|
|
4569
|
+
</dl>
|
|
4570
|
+
</dd>
|
|
4571
|
+
</dl>
|
|
4572
|
+
|
|
4573
|
+
|
|
4574
|
+
</dd>
|
|
4575
|
+
</dl>
|
|
4576
|
+
</details>
|
|
4577
|
+
|
|
4578
|
+
<details><summary><code>client.ad_pixels.<a href="/lib/whop_sdk/ad_pixels/client.rb">retrieve</a>(id:) -> Whop_sdk::Types::AdPixel</code></summary>
|
|
4579
|
+
<dl>
|
|
4580
|
+
<dd>
|
|
4581
|
+
|
|
4582
|
+
#### 🔌 Usage
|
|
4583
|
+
|
|
4584
|
+
<dl>
|
|
4585
|
+
<dd>
|
|
4586
|
+
|
|
4587
|
+
<dl>
|
|
4588
|
+
<dd>
|
|
4589
|
+
|
|
4590
|
+
```ruby
|
|
4591
|
+
client.ad_pixels.retrieve(id: "id")
|
|
4592
|
+
```
|
|
4593
|
+
</dd>
|
|
4594
|
+
</dl>
|
|
4595
|
+
</dd>
|
|
4596
|
+
</dl>
|
|
4597
|
+
|
|
4598
|
+
#### ⚙️ Parameters
|
|
4599
|
+
|
|
4600
|
+
<dl>
|
|
4601
|
+
<dd>
|
|
4602
|
+
|
|
4603
|
+
<dl>
|
|
4604
|
+
<dd>
|
|
4605
|
+
|
|
4606
|
+
**id:** `String` — Ad pixel ID, prefixed `adpx_`.
|
|
4607
|
+
|
|
4608
|
+
</dd>
|
|
4609
|
+
</dl>
|
|
4610
|
+
|
|
4611
|
+
<dl>
|
|
4612
|
+
<dd>
|
|
4613
|
+
|
|
4614
|
+
**request_options:** `Whop_sdk::AdPixels::RequestOptions`
|
|
4615
|
+
|
|
4616
|
+
</dd>
|
|
4617
|
+
</dl>
|
|
4618
|
+
</dd>
|
|
4619
|
+
</dl>
|
|
4620
|
+
|
|
4621
|
+
|
|
4622
|
+
</dd>
|
|
4623
|
+
</dl>
|
|
4624
|
+
</details>
|
|
4625
|
+
|
|
4626
|
+
<details><summary><code>client.ad_pixels.<a href="/lib/whop_sdk/ad_pixels/client.rb">delete</a>(id:) -> Whop_sdk::AdPixels::Types::DeleteAdPixelsResponse</code></summary>
|
|
4627
|
+
<dl>
|
|
4628
|
+
<dd>
|
|
4629
|
+
|
|
4630
|
+
#### 📝 Description
|
|
4631
|
+
|
|
4632
|
+
<dl>
|
|
4633
|
+
<dd>
|
|
4634
|
+
|
|
4635
|
+
<dl>
|
|
4636
|
+
<dd>
|
|
4637
|
+
|
|
4638
|
+
Remove the pixel and its access token. Whop stops sending it conversions.
|
|
4639
|
+
</dd>
|
|
4640
|
+
</dl>
|
|
4641
|
+
</dd>
|
|
4642
|
+
</dl>
|
|
4643
|
+
|
|
4644
|
+
#### 🔌 Usage
|
|
4645
|
+
|
|
4646
|
+
<dl>
|
|
4647
|
+
<dd>
|
|
4648
|
+
|
|
4649
|
+
<dl>
|
|
4650
|
+
<dd>
|
|
4651
|
+
|
|
4652
|
+
```ruby
|
|
4653
|
+
client.ad_pixels.delete(id: "id")
|
|
4654
|
+
```
|
|
4655
|
+
</dd>
|
|
4656
|
+
</dl>
|
|
4657
|
+
</dd>
|
|
4658
|
+
</dl>
|
|
4659
|
+
|
|
4660
|
+
#### ⚙️ Parameters
|
|
4661
|
+
|
|
4662
|
+
<dl>
|
|
4663
|
+
<dd>
|
|
4664
|
+
|
|
4665
|
+
<dl>
|
|
4666
|
+
<dd>
|
|
4667
|
+
|
|
4668
|
+
**id:** `String` — Ad pixel ID, prefixed `adpx_`.
|
|
4669
|
+
|
|
4670
|
+
</dd>
|
|
4671
|
+
</dl>
|
|
4672
|
+
|
|
4673
|
+
<dl>
|
|
4674
|
+
<dd>
|
|
4675
|
+
|
|
4676
|
+
**request_options:** `Whop_sdk::AdPixels::RequestOptions`
|
|
4677
|
+
|
|
4678
|
+
</dd>
|
|
4679
|
+
</dl>
|
|
4680
|
+
</dd>
|
|
4681
|
+
</dl>
|
|
4682
|
+
|
|
4683
|
+
|
|
4684
|
+
</dd>
|
|
4685
|
+
</dl>
|
|
4686
|
+
</details>
|
|
4687
|
+
|
|
4688
|
+
<details><summary><code>client.ad_pixels.<a href="/lib/whop_sdk/ad_pixels/client.rb">update</a>(id:, request) -> Whop_sdk::Types::AdPixel</code></summary>
|
|
4689
|
+
<dl>
|
|
4690
|
+
<dd>
|
|
4691
|
+
|
|
4692
|
+
#### 📝 Description
|
|
4693
|
+
|
|
4694
|
+
<dl>
|
|
4695
|
+
<dd>
|
|
4696
|
+
|
|
4697
|
+
<dl>
|
|
4698
|
+
<dd>
|
|
4699
|
+
|
|
4700
|
+
Replace the pixel's access token. Whop checks the new token with the ad platform and resumes deliveries to an `errored` pixel.
|
|
4701
|
+
</dd>
|
|
4702
|
+
</dl>
|
|
4703
|
+
</dd>
|
|
4704
|
+
</dl>
|
|
4705
|
+
|
|
4706
|
+
#### 🔌 Usage
|
|
4707
|
+
|
|
4708
|
+
<dl>
|
|
4709
|
+
<dd>
|
|
4710
|
+
|
|
4711
|
+
<dl>
|
|
4712
|
+
<dd>
|
|
4713
|
+
|
|
4714
|
+
```ruby
|
|
4715
|
+
client.ad_pixels.update(
|
|
4716
|
+
id: "id",
|
|
4717
|
+
access_token: "new-token"
|
|
4718
|
+
)
|
|
4719
|
+
```
|
|
4720
|
+
</dd>
|
|
4721
|
+
</dl>
|
|
4722
|
+
</dd>
|
|
4723
|
+
</dl>
|
|
4724
|
+
|
|
4725
|
+
#### ⚙️ Parameters
|
|
4726
|
+
|
|
4727
|
+
<dl>
|
|
4728
|
+
<dd>
|
|
4729
|
+
|
|
4730
|
+
<dl>
|
|
4731
|
+
<dd>
|
|
4732
|
+
|
|
4733
|
+
**id:** `String` — Ad pixel ID, prefixed `adpx_`.
|
|
4734
|
+
|
|
4735
|
+
</dd>
|
|
4736
|
+
</dl>
|
|
4737
|
+
|
|
4738
|
+
<dl>
|
|
4739
|
+
<dd>
|
|
4740
|
+
|
|
4741
|
+
**access_token:** `String` — An access token that can send events to the pixel on the ad platform. Whop never returns it.
|
|
4742
|
+
|
|
4743
|
+
</dd>
|
|
4744
|
+
</dl>
|
|
4745
|
+
|
|
4746
|
+
<dl>
|
|
4747
|
+
<dd>
|
|
4748
|
+
|
|
4749
|
+
**request_options:** `Whop_sdk::AdPixels::RequestOptions`
|
|
4750
|
+
|
|
4751
|
+
</dd>
|
|
4752
|
+
</dl>
|
|
4753
|
+
</dd>
|
|
4754
|
+
</dl>
|
|
4755
|
+
|
|
4756
|
+
|
|
4372
4757
|
</dd>
|
|
4373
4758
|
</dl>
|
|
4374
4759
|
</details>
|
|
@@ -7403,7 +7788,7 @@ client.apps.list
|
|
|
7403
7788
|
<dl>
|
|
7404
7789
|
<dd>
|
|
7405
7790
|
|
|
7406
|
-
**order:** `Whop_sdk::Apps::Types::ListAppsRequestOrder` — The field to sort apps by. Defaults to discoverable_at, showing the most recently published apps first. `template_usage` ranks Whop-verified apps first, then by how many businesses created apps from each app as a template.
|
|
7791
|
+
**order:** `Whop_sdk::Apps::Types::ListAppsRequestOrder` — The field to sort apps by. Defaults to discoverable_at, showing the most recently published apps first. `template_usage` ranks Whop-verified apps first, then by how many businesses created apps from each app as a template. `template_recent_sales` ranks them by how many of those businesses processed a payment in the last 24 hours, recounted hourly, breaking ties by `template_usage`.
|
|
7407
7792
|
|
|
7408
7793
|
</dd>
|
|
7409
7794
|
</dl>
|
|
@@ -7529,6 +7914,14 @@ client.apps.create(name: "Shine Time Booking")
|
|
|
7529
7914
|
<dl>
|
|
7530
7915
|
<dd>
|
|
7531
7916
|
|
|
7917
|
+
**domain_id:** `String` — A domain on the account (`dom_` tag) to serve the app at, such as a whop.site address claimed with `POST /domains`. Required with `template_id`.
|
|
7918
|
+
|
|
7919
|
+
</dd>
|
|
7920
|
+
</dl>
|
|
7921
|
+
|
|
7922
|
+
<dl>
|
|
7923
|
+
<dd>
|
|
7924
|
+
|
|
7532
7925
|
**icon:** `Whop_sdk::Apps::Types::CreateAppsRequestIcon` — The icon image for the app in PNG, JPEG, or GIF format, referencing an uploaded file: `{ id }` for an existing attachment or `{ direct_upload_id }` for a new direct upload.
|
|
7533
7926
|
|
|
7534
7927
|
</dd>
|
|
@@ -7561,7 +7954,7 @@ client.apps.create(name: "Shine Time Booking")
|
|
|
7561
7954
|
<dl>
|
|
7562
7955
|
<dd>
|
|
7563
7956
|
|
|
7564
|
-
**route:** `String` — The subdomain route where the app's hosted web builds are served, such as `myapp` for myapp.whop.site.
|
|
7957
|
+
**route:** `String` — Deprecated: claim an address with `POST /domains` and pass `domain_id`. The subdomain route where the app's hosted web builds are served, such as `myapp` for myapp.whop.site.
|
|
7565
7958
|
|
|
7566
7959
|
</dd>
|
|
7567
7960
|
</dl>
|
|
@@ -10111,7 +10504,7 @@ client.bounty_submissions.submit(id: "id")
|
|
|
10111
10504
|
<dl>
|
|
10112
10505
|
<dd>
|
|
10113
10506
|
|
|
10114
|
-
Lists an account
|
|
10507
|
+
Lists the card transactions of an account or a user, newest first. Defaults to the account the credential belongs to. Covers every card the owner has ever had, including canceled cards and spend that predates a re-application, and team members only see transactions on the cards assigned to them. Pass `transaction_ids` to fetch specific transactions instead of paging for them.
|
|
10115
10508
|
</dd>
|
|
10116
10509
|
</dl>
|
|
10117
10510
|
</dd>
|
|
@@ -10145,7 +10538,15 @@ client.card_transactions.list(
|
|
|
10145
10538
|
<dl>
|
|
10146
10539
|
<dd>
|
|
10147
10540
|
|
|
10148
|
-
**account_id:** `String` — The account whose card transactions to list, prefixed `biz_`. Defaults to the credential's account.
|
|
10541
|
+
**account_id:** `String` — The account whose card transactions to list, prefixed `biz_`. Provide this or `user_id`. Defaults to the credential's account.
|
|
10542
|
+
|
|
10543
|
+
</dd>
|
|
10544
|
+
</dl>
|
|
10545
|
+
|
|
10546
|
+
<dl>
|
|
10547
|
+
<dd>
|
|
10548
|
+
|
|
10549
|
+
**user_id:** `String` — The user whose personal card transactions to list, prefixed `user_`. Provide this or `account_id`. Only that user can read them.
|
|
10149
10550
|
|
|
10150
10551
|
</dd>
|
|
10151
10552
|
</dl>
|
|
@@ -10311,7 +10712,15 @@ client.card_transactions.retrieve(id: "id")
|
|
|
10311
10712
|
<dl>
|
|
10312
10713
|
<dd>
|
|
10313
10714
|
|
|
10314
|
-
**account_id:** `String` — The account that owns the transaction, prefixed `biz_`. Defaults to the credential's account.
|
|
10715
|
+
**account_id:** `String` — The account that owns the transaction, prefixed `biz_`. Provide this or `user_id`. Defaults to the credential's account.
|
|
10716
|
+
|
|
10717
|
+
</dd>
|
|
10718
|
+
</dl>
|
|
10719
|
+
|
|
10720
|
+
<dl>
|
|
10721
|
+
<dd>
|
|
10722
|
+
|
|
10723
|
+
**user_id:** `String` — The user that owns the transaction, prefixed `user_`. Provide this or `account_id`. Only that user can read it.
|
|
10315
10724
|
|
|
10316
10725
|
</dd>
|
|
10317
10726
|
</dl>
|
|
@@ -15985,7 +16394,15 @@ client.domains.list(tlds: ["com"])
|
|
|
15985
16394
|
<dl>
|
|
15986
16395
|
<dd>
|
|
15987
16396
|
|
|
15988
|
-
**verification:** `
|
|
16397
|
+
**verification:** `Whop_sdk::Domains::Types::ListDomainsRequestVerification` — Only domains with verification in this state, such as `ready`, or `any` for every domain that has verification.
|
|
16398
|
+
|
|
16399
|
+
</dd>
|
|
16400
|
+
</dl>
|
|
16401
|
+
|
|
16402
|
+
<dl>
|
|
16403
|
+
<dd>
|
|
16404
|
+
|
|
16405
|
+
**registration:** `Whop_sdk::Domains::Types::ListDomainsRequestRegistration` — Only domains with registration in this state, such as `ready`, or `any` for every domain that has registration.
|
|
15989
16406
|
|
|
15990
16407
|
</dd>
|
|
15991
16408
|
</dl>
|
|
@@ -15993,7 +16410,7 @@ client.domains.list(tlds: ["com"])
|
|
|
15993
16410
|
<dl>
|
|
15994
16411
|
<dd>
|
|
15995
16412
|
|
|
15996
|
-
**
|
|
16413
|
+
**platform:** `Whop_sdk::Domains::Types::ListDomainsRequestPlatform` — Only domains with platform in this state, such as `ready`, or `any` for every domain that has platform.
|
|
15997
16414
|
|
|
15998
16415
|
</dd>
|
|
15999
16416
|
</dl>
|
|
@@ -16001,7 +16418,7 @@ client.domains.list(tlds: ["com"])
|
|
|
16001
16418
|
<dl>
|
|
16002
16419
|
<dd>
|
|
16003
16420
|
|
|
16004
|
-
**website:** `
|
|
16421
|
+
**website:** `Whop_sdk::Domains::Types::ListDomainsRequestWebsite` — Only domains with website in this state, such as `ready`, or `any` for every domain that has website.
|
|
16005
16422
|
|
|
16006
16423
|
</dd>
|
|
16007
16424
|
</dl>
|
|
@@ -16424,7 +16841,7 @@ client.domains.check(id: "id")
|
|
|
16424
16841
|
<dl>
|
|
16425
16842
|
<dd>
|
|
16426
16843
|
|
|
16427
|
-
Lists an account's recommendations and generation requests, newest first by default. Without an account, signed-out visitors receive a business-setup template and eligible users receive their saved setup recommendation. With `has_run` and no account, users receive the recommendations run on every account they can read that has Economic Intelligence. An account's executed recommendations and runs stay listed after Economic Intelligence turns off. New recommendations are offered only while it is on. Visitor countries, page views, ad impressions and clicks, and payment volume for a time range come from `GET /stats/time_series/{metric}`.
|
|
16844
|
+
Lists an account's recommendations and generation requests, newest first by default. For callers with company:update permission, listing queues generation when no recommendations are ready or in progress, with a ten-minute cooldown after an unsuccessful request; unsuccessful requests are not listed. Without an account, signed-out visitors receive a business-setup template and eligible users receive their saved setup recommendation. With `has_run` and no account, users receive the recommendations run on every account they can read that has Economic Intelligence. An account's executed recommendations and runs stay listed after Economic Intelligence turns off. New recommendations are offered only while it is on. Visitor countries, page views, ad impressions and clicks, and payment volume for a time range come from `GET /stats/time_series/{metric}`.
|
|
16428
16845
|
</dd>
|
|
16429
16846
|
</dl>
|
|
16430
16847
|
</dd>
|
|
@@ -17990,7 +18407,7 @@ client.experiences.duplicate(id: "exp_xxxxxxxxxxxxxx")
|
|
|
17990
18407
|
<dl>
|
|
17991
18408
|
<dd>
|
|
17992
18409
|
|
|
17993
|
-
Lists experiments for one account with experiment:read permission.
|
|
18410
|
+
Lists experiments for one account with experiment:read permission.
|
|
17994
18411
|
</dd>
|
|
17995
18412
|
</dl>
|
|
17996
18413
|
</dd>
|
|
@@ -18020,7 +18437,7 @@ client.experiments.list
|
|
|
18020
18437
|
<dl>
|
|
18021
18438
|
<dd>
|
|
18022
18439
|
|
|
18023
|
-
**account_id:** `String` — Owning account ID.
|
|
18440
|
+
**account_id:** `String` — Owning account ID.
|
|
18024
18441
|
|
|
18025
18442
|
</dd>
|
|
18026
18443
|
</dl>
|
|
@@ -18116,7 +18533,7 @@ client.experiments.list
|
|
|
18116
18533
|
<dl>
|
|
18117
18534
|
<dd>
|
|
18118
18535
|
|
|
18119
|
-
Creates a draft experiment for the specified account.
|
|
18536
|
+
Creates a draft experiment for the specified account.
|
|
18120
18537
|
</dd>
|
|
18121
18538
|
</dl>
|
|
18122
18539
|
</dd>
|
|
@@ -18132,7 +18549,7 @@ Creates a draft experiment for the specified account. Use internal for a Whop pl
|
|
|
18132
18549
|
|
|
18133
18550
|
```ruby
|
|
18134
18551
|
client.experiments.create(
|
|
18135
|
-
account_id: "
|
|
18552
|
+
account_id: "biz_xxxxxxxxxxxxxx",
|
|
18136
18553
|
flag_key: "checkout_redesign_v2"
|
|
18137
18554
|
)
|
|
18138
18555
|
```
|
|
@@ -18149,7 +18566,7 @@ client.experiments.create(
|
|
|
18149
18566
|
<dl>
|
|
18150
18567
|
<dd>
|
|
18151
18568
|
|
|
18152
|
-
**account_id:** `String` — Owning account
|
|
18569
|
+
**account_id:** `String` — Owning account ID. Required; ownership cannot change.
|
|
18153
18570
|
|
|
18154
18571
|
</dd>
|
|
18155
18572
|
</dl>
|
|
@@ -18157,7 +18574,7 @@ client.experiments.create(
|
|
|
18157
18574
|
<dl>
|
|
18158
18575
|
<dd>
|
|
18159
18576
|
|
|
18160
|
-
**bucket_by:** `Whop_sdk::Experiments::Types::CreateExperimentsRequestBucketBy` — Randomization unit, and the only identity the assignment is keyed on — evaluation fails rather than falling back to another. `user` (default) uses `subject[user_id]
|
|
18577
|
+
**bucket_by:** `Whop_sdk::Experiments::Types::CreateExperimentsRequestBucketBy` — Randomization unit, and the only identity the assignment is keyed on — evaluation fails rather than falling back to another. `user` (default) uses `subject[user_id]`; `account` uses `subject[account_id]`, so every user of an account gets the same arm; `anonymous` uses the anonymous id and survives sign-in. Fixed after creation.
|
|
18161
18578
|
|
|
18162
18579
|
</dd>
|
|
18163
18580
|
</dl>
|
|
@@ -18205,7 +18622,7 @@ client.experiments.create(
|
|
|
18205
18622
|
<dl>
|
|
18206
18623
|
<dd>
|
|
18207
18624
|
|
|
18208
|
-
**related_resource:** `Whop_sdk::Types::ExperimentResourceReference`
|
|
18625
|
+
**related_resource:** `Whop_sdk::Types::ExperimentResourceReference` — Resource owned by the account that this experiment is bound to, such as an app or product. `null` when unbound. Fixed once the experiment first activates.
|
|
18209
18626
|
|
|
18210
18627
|
</dd>
|
|
18211
18628
|
</dl>
|
|
@@ -18255,9 +18672,9 @@ client.experiments.create(
|
|
|
18255
18672
|
|
|
18256
18673
|
Evaluates and records an exposure without requiring authentication. When credentials resolve, their authentication method, API key ID, and signed-in user ID are recorded on the exposure event. Pass subject for bucketing identity and account_id for experiment ownership.
|
|
18257
18674
|
|
|
18258
|
-
Pass `flag_key` to check a single flag, or omit it to fetch active flags in the account and related resource scope.
|
|
18675
|
+
Pass `flag_key` to check a single flag, or omit it to fetch active flags in the account and related resource scope.
|
|
18259
18676
|
|
|
18260
|
-
Assignments use exactly the configured `bucket_by`: `subject[user_id]`, `subject[account_id]`, or `subject[anonymous_id]`.
|
|
18677
|
+
Assignments use exactly the configured `bucket_by`: `subject[user_id]`, `subject[account_id]`, or `subject[anonymous_id]`. Missing the required identity fails single evaluation and omits the experiment from batch evaluation. Subjects outside all treatment ranges receive control.
|
|
18261
18678
|
|
|
18262
18679
|
Pass `subject[account_id]` to enable account-level targeting rules. Pass `properties` as a JSON object to supply the values that `property` targeting conditions match against.
|
|
18263
18680
|
|
|
@@ -18291,7 +18708,7 @@ client.experiments.exposures
|
|
|
18291
18708
|
<dl>
|
|
18292
18709
|
<dd>
|
|
18293
18710
|
|
|
18294
|
-
**subject:** `Whop_sdk::Types::ExposuresExperimentsRequestSubject` — Bucketing subject
|
|
18711
|
+
**subject:** `Whop_sdk::Types::ExposuresExperimentsRequestSubject` — Bucketing subject: the user, account, or anonymous ID the experiment's `bucket_by` assigns on. Ownership is the top-level account_id.
|
|
18295
18712
|
|
|
18296
18713
|
</dd>
|
|
18297
18714
|
</dl>
|
|
@@ -18315,7 +18732,7 @@ client.experiments.exposures
|
|
|
18315
18732
|
<dl>
|
|
18316
18733
|
<dd>
|
|
18317
18734
|
|
|
18318
|
-
**account_id:** `String` — Owning account ID
|
|
18735
|
+
**account_id:** `String` — Owning account ID. Required when evaluating by flag_key or in a batch; optional for an expt_ ID.
|
|
18319
18736
|
|
|
18320
18737
|
</dd>
|
|
18321
18738
|
</dl>
|
|
@@ -18323,7 +18740,7 @@ client.experiments.exposures
|
|
|
18323
18740
|
<dl>
|
|
18324
18741
|
<dd>
|
|
18325
18742
|
|
|
18326
|
-
**properties:** `String` — JSON-encoded scalar values that property targeting conditions match against. Numeric and boolean strings are coerced. Nested query keys such as properties[variant]=pro remain accepted for existing callers.
|
|
18743
|
+
**properties:** `String` — JSON-encoded scalar values that property targeting conditions match against. Numeric and boolean strings are coerced. Nested query keys such as properties[variant]=pro remain accepted for existing callers.
|
|
18327
18744
|
|
|
18328
18745
|
</dd>
|
|
18329
18746
|
</dl>
|
|
@@ -18363,7 +18780,7 @@ client.experiments.exposures
|
|
|
18363
18780
|
<dl>
|
|
18364
18781
|
<dd>
|
|
18365
18782
|
|
|
18366
|
-
Retrieves a single experiment or feature flag by its `expt_` id or flag_key handle. Requires the corresponding experiment permission on the owning account
|
|
18783
|
+
Retrieves a single experiment or feature flag by its `expt_` id or flag_key handle. Requires the corresponding experiment permission on the owning account.
|
|
18367
18784
|
</dd>
|
|
18368
18785
|
</dl>
|
|
18369
18786
|
</dd>
|
|
@@ -18401,7 +18818,7 @@ client.experiments.retrieve(id: "id")
|
|
|
18401
18818
|
<dl>
|
|
18402
18819
|
<dd>
|
|
18403
18820
|
|
|
18404
|
-
**account_id:** `String` — Owning account
|
|
18821
|
+
**account_id:** `String` — Owning account ID. Required when id is a flag key; optional for an expt_ ID.
|
|
18405
18822
|
|
|
18406
18823
|
</dd>
|
|
18407
18824
|
</dl>
|
|
@@ -18433,7 +18850,7 @@ client.experiments.retrieve(id: "id")
|
|
|
18433
18850
|
<dl>
|
|
18434
18851
|
<dd>
|
|
18435
18852
|
|
|
18436
|
-
Updates the targeting rules, treatment allocation, metrics, or hypothesis of an existing experiment or feature flag. Weights and metrics can only grow, so enrolled users never change arms and an existing metric is never dropped. Lifecycle moves through the transition endpoints (`activate`, `pause`, `end`), never through this update. Requires the corresponding experiment permission on the owning account
|
|
18853
|
+
Updates the targeting rules, treatment allocation, metrics, or hypothesis of an existing experiment or feature flag. Weights and metrics can only grow, so enrolled users never change arms and an existing metric is never dropped. Lifecycle moves through the transition endpoints (`activate`, `pause`, `end`), never through this update. Requires the corresponding experiment permission on the owning account.
|
|
18437
18854
|
</dd>
|
|
18438
18855
|
</dl>
|
|
18439
18856
|
</dd>
|
|
@@ -18471,7 +18888,7 @@ client.experiments.update(id: "id")
|
|
|
18471
18888
|
<dl>
|
|
18472
18889
|
<dd>
|
|
18473
18890
|
|
|
18474
|
-
**account_id:** `String` — Owning account
|
|
18891
|
+
**account_id:** `String` — Owning account ID. Required when id is a flag key; optional for an expt_ ID.
|
|
18475
18892
|
|
|
18476
18893
|
</dd>
|
|
18477
18894
|
</dl>
|
|
@@ -18495,7 +18912,7 @@ client.experiments.update(id: "id")
|
|
|
18495
18912
|
<dl>
|
|
18496
18913
|
<dd>
|
|
18497
18914
|
|
|
18498
|
-
**related_resource:** `Whop_sdk::Types::ExperimentResourceReference`
|
|
18915
|
+
**related_resource:** `Whop_sdk::Types::ExperimentResourceReference` — Resource owned by the account that this experiment is bound to, such as an app or product. `null` when unbound. Fixed once the experiment first activates.
|
|
18499
18916
|
|
|
18500
18917
|
</dd>
|
|
18501
18918
|
</dl>
|
|
@@ -18543,7 +18960,7 @@ client.experiments.update(id: "id")
|
|
|
18543
18960
|
<dl>
|
|
18544
18961
|
<dd>
|
|
18545
18962
|
|
|
18546
|
-
Starts (or resumes) an experiment or feature flag so evaluation begins serving it. Activating a draft stamps `started_at`; resuming a paused experiment keeps the original start. Only drafts and paused experiments can be activated. Requires the corresponding experiment permission on the owning account
|
|
18963
|
+
Starts (or resumes) an experiment or feature flag so evaluation begins serving it. Activating a draft stamps `started_at`; resuming a paused experiment keeps the original start. Only drafts and paused experiments can be activated. Requires the corresponding experiment permission on the owning account.
|
|
18547
18964
|
</dd>
|
|
18548
18965
|
</dl>
|
|
18549
18966
|
</dd>
|
|
@@ -18581,7 +18998,7 @@ client.experiments.activate(id: "id")
|
|
|
18581
18998
|
<dl>
|
|
18582
18999
|
<dd>
|
|
18583
19000
|
|
|
18584
|
-
**account_id:** `String` — Owning account
|
|
19001
|
+
**account_id:** `String` — Owning account ID. Required when id is a flag key; optional for an expt_ ID.
|
|
18585
19002
|
|
|
18586
19003
|
</dd>
|
|
18587
19004
|
</dl>
|
|
@@ -18621,7 +19038,7 @@ client.experiments.activate(id: "id")
|
|
|
18621
19038
|
<dl>
|
|
18622
19039
|
<dd>
|
|
18623
19040
|
|
|
18624
|
-
Concludes the experiment and records required `findings`. Pass `winning_arm` to serve the winning treatment to everyone; omit it when control won. Ended experiments cannot restart, but may be ended again to correct the winner. Requires experiment:manage on the account
|
|
19041
|
+
Concludes the experiment and records required `findings`. Pass `winning_arm` to serve the winning treatment to everyone; omit it when control won. Ended experiments cannot restart, but may be ended again to correct the winner. Requires experiment:manage on the account.
|
|
18625
19042
|
</dd>
|
|
18626
19043
|
</dl>
|
|
18627
19044
|
</dd>
|
|
@@ -18662,7 +19079,7 @@ client.experiments.end_(
|
|
|
18662
19079
|
<dl>
|
|
18663
19080
|
<dd>
|
|
18664
19081
|
|
|
18665
|
-
**account_id:** `String` — Owning account
|
|
19082
|
+
**account_id:** `String` — Owning account ID. Required when id is a flag key; optional for an expt_ ID.
|
|
18666
19083
|
|
|
18667
19084
|
</dd>
|
|
18668
19085
|
</dl>
|
|
@@ -18710,7 +19127,7 @@ client.experiments.end_(
|
|
|
18710
19127
|
<dl>
|
|
18711
19128
|
<dd>
|
|
18712
19129
|
|
|
18713
|
-
Pauses an active experiment or feature flag: evaluation stops serving it and exposures stop flowing. Assignments are keyed on stable identity, so users return to their original arm when the experiment resumes. Requires the corresponding experiment permission on the owning account
|
|
19130
|
+
Pauses an active experiment or feature flag: evaluation stops serving it and exposures stop flowing. Assignments are keyed on stable identity, so users return to their original arm when the experiment resumes. Requires the corresponding experiment permission on the owning account.
|
|
18714
19131
|
</dd>
|
|
18715
19132
|
</dl>
|
|
18716
19133
|
</dd>
|
|
@@ -18748,7 +19165,7 @@ client.experiments.pause(id: "id")
|
|
|
18748
19165
|
<dl>
|
|
18749
19166
|
<dd>
|
|
18750
19167
|
|
|
18751
|
-
**account_id:** `String` — Owning account
|
|
19168
|
+
**account_id:** `String` — Owning account ID. Required when id is a flag key; optional for an expt_ ID.
|
|
18752
19169
|
|
|
18753
19170
|
</dd>
|
|
18754
19171
|
</dl>
|
|
@@ -19781,7 +20198,7 @@ client.fee_markups.delete(id: "id")
|
|
|
19781
20198
|
<dl>
|
|
19782
20199
|
<dd>
|
|
19783
20200
|
|
|
19784
|
-
Submits an issue or an unanswered question to Whop for
|
|
20201
|
+
Submits an issue or an unanswered question to Whop for review, recorded under the authenticated user, account, or app. Returns a receipt once the submission is accepted; processing is asynchronous and no reply is sent. Accepts user, account, and app credentials.
|
|
19785
20202
|
</dd>
|
|
19786
20203
|
</dl>
|
|
19787
20204
|
</dd>
|
|
@@ -26830,7 +27247,7 @@ client.payment_quotes.create(account_id: "biz_xxxxxxxxxxxxxx")
|
|
|
26830
27247
|
<dl>
|
|
26831
27248
|
<dd>
|
|
26832
27249
|
|
|
26833
|
-
**address:** `Whop_sdk::PaymentQuotes::Types::CreatePaymentQuotesRequestAddress` — The buyer's billing address. Where tax is calculated when no shipping address is given, and the address a tax registration belongs to. A seller that collects tax on this purchase needs the buyer located by a `country` here, on `shipping_address`, or an `ip_address`; without one the quote is refused with `quote_location_required`. Only the keys you supply are kept. The payment that consumes the quote must put the buyer in the same place, by country, state and postal code, through its own `shipping_address` or its confirmation token's billing address, or it is refused with `quote_mismatch`.
|
|
27250
|
+
**address:** `Whop_sdk::PaymentQuotes::Types::CreatePaymentQuotesRequestAddress` — The buyer's billing address. Where tax is calculated when no shipping address is given, and the address a tax registration belongs to. A seller that collects tax on this purchase needs the buyer located by a `country` here, on `shipping_address`, a `presentment_country`, or an `ip_address`; without one the quote is refused with `quote_location_required`. Only the keys you supply are kept. The payment that consumes the quote must put the buyer in the same place, by country, state and postal code, through its own `shipping_address` or its confirmation token's billing address, or it is refused with `quote_mismatch`.
|
|
26834
27251
|
|
|
26835
27252
|
</dd>
|
|
26836
27253
|
</dl>
|
|
@@ -26838,7 +27255,7 @@ client.payment_quotes.create(account_id: "biz_xxxxxxxxxxxxxx")
|
|
|
26838
27255
|
<dl>
|
|
26839
27256
|
<dd>
|
|
26840
27257
|
|
|
26841
|
-
**ip_address:** `String` — The buyer's IP address, when your server makes the call on their behalf. Locates the buyer when neither address carries a country. A quote located this way (`located_by` is `ip_address`) is a preview: a payment refuses it with `quote_preview_only`, so quote again with the buyer's address before paying. Also where `presentment_currency` `auto` and `recommended_currencies` find the buyer's local currency.
|
|
27258
|
+
**ip_address:** `String` — The buyer's IP address, when your server makes the call on their behalf. Locates the buyer when neither address carries a country and no `presentment_country` is sent. A quote located this way (`located_by` is `ip_address`) is a preview: a payment refuses it with `quote_preview_only`, so quote again with the buyer's address before paying. Also where `presentment_currency` `auto` and `recommended_currencies` find the buyer's local currency, and where a payment method must be able to collect it.
|
|
26842
27259
|
|
|
26843
27260
|
</dd>
|
|
26844
27261
|
</dl>
|
|
@@ -26846,7 +27263,15 @@ client.payment_quotes.create(account_id: "biz_xxxxxxxxxxxxxx")
|
|
|
26846
27263
|
<dl>
|
|
26847
27264
|
<dd>
|
|
26848
27265
|
|
|
26849
|
-
**
|
|
27266
|
+
**presentment_country:** `String` — The country to price the purchase for, as an ISO 3166-1 alpha-2 code such as `JP`, when the buyer chose one: a store's country picker. Prices in the currency `auto` would pick for a buyer in that country, so send it instead of `presentment_currency`, never with it. Whether a payment method can collect that currency is still judged where the buyer is: by `ip_address`, and by this country only without one. With no address that carries a country, tax is estimated for this country (`located_by` is `presentment_country`) at the country level, and a quote located this way is a preview a payment refuses with `quote_preview_only`. Send it only once the buyer has chosen a country: without it, an `ip_address` estimates more precisely, such as for a US state. For a country Whop has no currency for, the quote is priced as `auto` for the buyer's `ip_address`, and tax is still estimated for the country.
|
|
27267
|
+
|
|
27268
|
+
</dd>
|
|
27269
|
+
</dl>
|
|
27270
|
+
|
|
27271
|
+
<dl>
|
|
27272
|
+
<dd>
|
|
27273
|
+
|
|
27274
|
+
**presentment_currency:** `String` — The currency to price and charge the purchase in. Omit it, or send null, to price in the variants' own currency. `auto` prices in the currency of the country Whop places the buyer's `ip_address` in when the purchase can be converted into it and a payment method can collect it, and in the variants' own currency otherwise, including when no `ip_address` is sent or Whop cannot place it in a country. To choose that country instead, send `presentment_country` in place of this. A three-letter ISO 4217 code, such as `eur`, prices in that currency or is refused: with `presentment_currency_unsupported` when the purchase cannot be converted into it (adaptive pricing is off for the variant, the variant is not a one-time purchase, or `plan` describes a variant that does not exist yet), and with `presentment_currency_not_payable` when no payment method can collect it. A converted quote states every amount in this currency at an `exchange_rate` fixed until `expires_at`, and the payment that consumes it is charged in this currency at that rate.
|
|
26850
27275
|
|
|
26851
27276
|
</dd>
|
|
26852
27277
|
</dl>
|
|
@@ -27924,7 +28349,7 @@ client.payments.create(account_id: "biz_xxxxxxxxxxxxxx")
|
|
|
27924
28349
|
<dl>
|
|
27925
28350
|
<dd>
|
|
27926
28351
|
|
|
27927
|
-
**quote_id:** `String` — A payment quote from `POST /payment_quotes`, prefixed `pq_`. The payment charges exactly the quote: its purchase (its variants and quantities, or the `plan` it priced), which this body may then omit, its promo code, and its tax, the quote's `tax_amount` rather than a figure calculated now. Omit it, or send null, to have tax calculated when the payment is charged. The quote must belong to `account_id`. A purchase field you omit or send as null takes the quote's value; the buyer's email, the addresses and the payment method are this request's own, never the quote's. Whatever you do send must describe the quoted purchase: the same variants, quantities and promo code. A quote that priced `plan` takes only the same `plan` you sent to `POST /payment_quotes` (or omit the purchase to take the quoted one), never `plan_id` or `line_items`, and a quote that priced variants by id never takes `plan`. Unless the quote located no buyer (`located_by` is null), the address the payment carries (its shipping address, else its billing address) must put the buyer where the quote priced tax, by country, state and postal code; otherwise the payment is refused with 400 before the payment method is used. A quote located by IP address (`located_by` is `ip_address`) is a preview and cannot be paid. A quote is consumed by one payment: a declined payment keeps it and can be retried; a new payment needs a new quote. A quote cannot be charged through PayPal; such a payment is refused before the payment method is used. A quote priced in a `presentment_currency` is charged in that currency at the quote's `exchange_rate`. A payment refused over its quote carries an error `code`. `quote_expired`: the quote has expired; quote again. `quote_tax_unavailable`: the quote could not price tax; quote again, or omit `quote_id`. `quote_preview_only`: the quote was located by IP address; quote again with the buyer's address. `quote_in_use` (409): another payment holds the quote. `quote_mismatch`: the purchase or the buyer's address is not the one quoted. `quote_rate_expired`: the exchange rate the quote was priced at has moved too far to charge; quote again. `payment_method_currency_unsupported`: the payment method cannot pay in the quote's currency; use another method, or quote again in another currency. `quote_processor_unsupported`: the payment method cannot pay a quote, as with PayPal; use another method, or omit `quote_id` to have tax calculated when the payment is charged.
|
|
28352
|
+
**quote_id:** `String` — A payment quote from `POST /payment_quotes`, prefixed `pq_`. The payment charges exactly the quote: its purchase (its variants and quantities, or the `plan` it priced), which this body may then omit, its promo code, and its tax, the quote's `tax_amount` rather than a figure calculated now. Omit it, or send null, to have tax calculated when the payment is charged. The quote must belong to `account_id`. A purchase field you omit or send as null takes the quote's value; the buyer's email, the addresses and the payment method are this request's own, never the quote's. Whatever you do send must describe the quoted purchase: the same variants, quantities and promo code. A quote that priced `plan` takes only the same `plan` you sent to `POST /payment_quotes` (or omit the purchase to take the quoted one), never `plan_id` or `line_items`, and a quote that priced variants by id never takes `plan`. Unless the quote located no buyer (`located_by` is null), the address the payment carries (its shipping address, else its billing address) must put the buyer where the quote priced tax, by country, state and postal code; otherwise the payment is refused with 400 before the payment method is used. A quote located by IP address or by the country the buyer chose (`located_by` is `ip_address` or `presentment_country`) is a preview and cannot be paid. A quote is consumed by one payment: a declined payment keeps it and can be retried; a new payment needs a new quote. A quote cannot be charged through PayPal; such a payment is refused before the payment method is used. A quote priced in a `presentment_currency` is charged in that currency at the quote's `exchange_rate`. A payment refused over its quote carries an error `code`. `quote_expired`: the quote has expired; quote again. `quote_tax_unavailable`: the quote could not price tax; quote again, or omit `quote_id`. `quote_preview_only`: the quote was located by IP address or by the country the buyer chose; quote again with the buyer's address. `quote_in_use` (409): another payment holds the quote. `quote_mismatch`: the purchase or the buyer's address is not the one quoted. `quote_rate_expired`: the exchange rate the quote was priced at has moved too far to charge; quote again. `payment_method_currency_unsupported`: the payment method cannot pay in the quote's currency; use another method, or quote again in another currency. `quote_processor_unsupported`: the payment method cannot pay a quote, as with PayPal; use another method, or omit `quote_id` to have tax calculated when the payment is charged.
|
|
27928
28353
|
|
|
27929
28354
|
</dd>
|
|
27930
28355
|
</dl>
|
|
@@ -28228,6 +28653,68 @@ client.payments.list_fees(id: "id")
|
|
|
28228
28653
|
</dl>
|
|
28229
28654
|
|
|
28230
28655
|
|
|
28656
|
+
</dd>
|
|
28657
|
+
</dl>
|
|
28658
|
+
</details>
|
|
28659
|
+
|
|
28660
|
+
<details><summary><code>client.payments.<a href="/lib/whop_sdk/payments/client.rb">generate_pdf</a>(id:) -> Whop_sdk::Types::PaymentPdf</code></summary>
|
|
28661
|
+
<dl>
|
|
28662
|
+
<dd>
|
|
28663
|
+
|
|
28664
|
+
#### 📝 Description
|
|
28665
|
+
|
|
28666
|
+
<dl>
|
|
28667
|
+
<dd>
|
|
28668
|
+
|
|
28669
|
+
<dl>
|
|
28670
|
+
<dd>
|
|
28671
|
+
|
|
28672
|
+
Generates the payment's receipt (invoice) as a PDF and returns a short-lived link to download it. Each call generates a new file and link, so this endpoint does not replay `Idempotency-Key` responses.
|
|
28673
|
+
</dd>
|
|
28674
|
+
</dl>
|
|
28675
|
+
</dd>
|
|
28676
|
+
</dl>
|
|
28677
|
+
|
|
28678
|
+
#### 🔌 Usage
|
|
28679
|
+
|
|
28680
|
+
<dl>
|
|
28681
|
+
<dd>
|
|
28682
|
+
|
|
28683
|
+
<dl>
|
|
28684
|
+
<dd>
|
|
28685
|
+
|
|
28686
|
+
```ruby
|
|
28687
|
+
client.payments.generate_pdf(id: "id")
|
|
28688
|
+
```
|
|
28689
|
+
</dd>
|
|
28690
|
+
</dl>
|
|
28691
|
+
</dd>
|
|
28692
|
+
</dl>
|
|
28693
|
+
|
|
28694
|
+
#### ⚙️ Parameters
|
|
28695
|
+
|
|
28696
|
+
<dl>
|
|
28697
|
+
<dd>
|
|
28698
|
+
|
|
28699
|
+
<dl>
|
|
28700
|
+
<dd>
|
|
28701
|
+
|
|
28702
|
+
**id:** `String` — The payment whose receipt to generate, prefixed `pay_`.
|
|
28703
|
+
|
|
28704
|
+
</dd>
|
|
28705
|
+
</dl>
|
|
28706
|
+
|
|
28707
|
+
<dl>
|
|
28708
|
+
<dd>
|
|
28709
|
+
|
|
28710
|
+
**request_options:** `Whop_sdk::Payments::RequestOptions`
|
|
28711
|
+
|
|
28712
|
+
</dd>
|
|
28713
|
+
</dl>
|
|
28714
|
+
</dd>
|
|
28715
|
+
</dl>
|
|
28716
|
+
|
|
28717
|
+
|
|
28231
28718
|
</dd>
|
|
28232
28719
|
</dl>
|
|
28233
28720
|
</details>
|
|
@@ -32024,7 +32511,7 @@ client.promo_codes.list(
|
|
|
32024
32511
|
<dl>
|
|
32025
32512
|
<dd>
|
|
32026
32513
|
|
|
32027
|
-
Creates a promo code for an account.
|
|
32514
|
+
Creates a promo code for an account.
|
|
32028
32515
|
</dd>
|
|
32029
32516
|
</dl>
|
|
32030
32517
|
</dd>
|
|
@@ -38062,7 +38549,7 @@ client.trades.retrieve(id: "id")
|
|
|
38062
38549
|
<dl>
|
|
38063
38550
|
<dd>
|
|
38064
38551
|
|
|
38065
|
-
Lists
|
|
38552
|
+
Lists transfers visible to the caller. Optional account filters narrow the results.
|
|
38066
38553
|
</dd>
|
|
38067
38554
|
</dl>
|
|
38068
38555
|
</dd>
|
|
@@ -38092,7 +38579,7 @@ client.transfers.list
|
|
|
38092
38579
|
<dl>
|
|
38093
38580
|
<dd>
|
|
38094
38581
|
|
|
38095
|
-
**origin_id:** `String` — Filter to transfers sent from this account.
|
|
38582
|
+
**origin_id:** `String` — Filter to transfers sent from this account.
|
|
38096
38583
|
|
|
38097
38584
|
</dd>
|
|
38098
38585
|
</dl>
|
|
@@ -38100,7 +38587,7 @@ client.transfers.list
|
|
|
38100
38587
|
<dl>
|
|
38101
38588
|
<dd>
|
|
38102
38589
|
|
|
38103
|
-
**destination_id:** `String` — Filter to transfers received by this account.
|
|
38590
|
+
**destination_id:** `String` — Filter to transfers received by this account.
|
|
38104
38591
|
|
|
38105
38592
|
</dd>
|
|
38106
38593
|
</dl>
|
|
@@ -38211,10 +38698,7 @@ Moves money between accounts, or into a claim link anyone with the URL can redee
|
|
|
38211
38698
|
<dd>
|
|
38212
38699
|
|
|
38213
38700
|
```ruby
|
|
38214
|
-
client.transfers.create
|
|
38215
|
-
amount: 25,
|
|
38216
|
-
origin_id: "biz_xxxxxxxxxxxxxx"
|
|
38217
|
-
)
|
|
38701
|
+
client.transfers.create
|
|
38218
38702
|
```
|
|
38219
38703
|
</dd>
|
|
38220
38704
|
</dl>
|
|
@@ -38229,95 +38713,7 @@ client.transfers.create(
|
|
|
38229
38713
|
<dl>
|
|
38230
38714
|
<dd>
|
|
38231
38715
|
|
|
38232
|
-
**
|
|
38233
|
-
|
|
38234
|
-
</dd>
|
|
38235
|
-
</dl>
|
|
38236
|
-
|
|
38237
|
-
<dl>
|
|
38238
|
-
<dd>
|
|
38239
|
-
|
|
38240
|
-
**currency:** `String` — Currency, such as `usd`. Required for ledger transfers.
|
|
38241
|
-
|
|
38242
|
-
</dd>
|
|
38243
|
-
</dl>
|
|
38244
|
-
|
|
38245
|
-
<dl>
|
|
38246
|
-
<dd>
|
|
38247
|
-
|
|
38248
|
-
**destination_id:** `String` — The recipient. Required for ledger and wallet_send (a user_/biz_/ldgr_ ID, or — for sends — an email). Omit for claim_link.
|
|
38249
|
-
|
|
38250
|
-
</dd>
|
|
38251
|
-
</dl>
|
|
38252
|
-
|
|
38253
|
-
<dl>
|
|
38254
|
-
<dd>
|
|
38255
|
-
|
|
38256
|
-
**expires_at:** `String` — claim_link only. Link expiry as an ISO 8601 timestamp. Defaults to 24 hours from creation.
|
|
38257
|
-
|
|
38258
|
-
</dd>
|
|
38259
|
-
</dl>
|
|
38260
|
-
|
|
38261
|
-
<dl>
|
|
38262
|
-
<dd>
|
|
38263
|
-
|
|
38264
|
-
**feed_id:** `String` — Ledger transfers only. The feed the transfer was initiated from. Given with `feed_type`, the payment receipt posts into that feed instead of a direct message.
|
|
38265
|
-
|
|
38266
|
-
</dd>
|
|
38267
|
-
</dl>
|
|
38268
|
-
|
|
38269
|
-
<dl>
|
|
38270
|
-
<dd>
|
|
38271
|
-
|
|
38272
|
-
**feed_type:** `Whop_sdk::Transfers::Types::CreateTransfersRequestFeedType` — Ledger transfers only. The type of the feed named by `feed_id`.
|
|
38273
|
-
|
|
38274
|
-
</dd>
|
|
38275
|
-
</dl>
|
|
38276
|
-
|
|
38277
|
-
<dl>
|
|
38278
|
-
<dd>
|
|
38279
|
-
|
|
38280
|
-
**idempotence_key:** `String` — Ledger transfers and wallet sends. A unique key that makes retries safe. Retrying with the same key returns the original transfer, or attaches to the original wallet send, instead of moving money twice.
|
|
38281
|
-
|
|
38282
|
-
</dd>
|
|
38283
|
-
</dl>
|
|
38284
|
-
|
|
38285
|
-
<dl>
|
|
38286
|
-
<dd>
|
|
38287
|
-
|
|
38288
|
-
**metadata:** `Internal::Types::Hash[String, Object]` — Ledger transfers only. Custom key-value pairs attached to the transfer. Max 50 keys, 100 chars per key, 500 chars per string value.
|
|
38289
|
-
|
|
38290
|
-
</dd>
|
|
38291
|
-
</dl>
|
|
38292
|
-
|
|
38293
|
-
<dl>
|
|
38294
|
-
<dd>
|
|
38295
|
-
|
|
38296
|
-
**notes:** `String` — Ledger transfers only. A short note describing the transfer.
|
|
38297
|
-
|
|
38298
|
-
</dd>
|
|
38299
|
-
</dl>
|
|
38300
|
-
|
|
38301
|
-
<dl>
|
|
38302
|
-
<dd>
|
|
38303
|
-
|
|
38304
|
-
**origin_id:** `String` — The account sending the funds. A user ID (user_xxx), account ID (biz_xxx), or ledger account ID (ldgr_xxx).
|
|
38305
|
-
|
|
38306
|
-
</dd>
|
|
38307
|
-
</dl>
|
|
38308
|
-
|
|
38309
|
-
<dl>
|
|
38310
|
-
<dd>
|
|
38311
|
-
|
|
38312
|
-
**redeemable_count:** `Integer` — claim_link only. How many different users can claim the link. Defaults to 1.
|
|
38313
|
-
|
|
38314
|
-
</dd>
|
|
38315
|
-
</dl>
|
|
38316
|
-
|
|
38317
|
-
<dl>
|
|
38318
|
-
<dd>
|
|
38319
|
-
|
|
38320
|
-
**type:** `Whop_sdk::Transfers::Types::CreateTransfersRequestType` — The kind of money movement, which decides what comes back. Defaults to ledger. `ledger` moves credit between two Whop balances and returns a `transfer`; `wallet_send` sends USDT from the origin account's Ethereum wallet and returns a `send`; `claim_link` funds a shareable link anyone with the URL can redeem and returns a `claim_link`. A `ledger` transfer from a stablecoin-rails account settles on-chain when covered, and still returns a `transfer`.
|
|
38716
|
+
**request:** `Whop_sdk::Transfers::Types::CreateTransfersRequestBody`
|
|
38321
38717
|
|
|
38322
38718
|
</dd>
|
|
38323
38719
|
</dl>
|
|
@@ -38592,7 +38988,7 @@ client.users.list
|
|
|
38592
38988
|
<dl>
|
|
38593
38989
|
<dd>
|
|
38594
38990
|
|
|
38595
|
-
Retrieves the authenticated user — the self view of the user object. Same shape as `GET /users/{id}`, with the self-only fields populated: `email` (email-read scope), `staff` (Whop staff only, staff-read scope), `balance` and `earnings_usd` (balance-read scope), the opt-in `balance_history`, and every linked social account.
|
|
38991
|
+
Retrieves the authenticated user — the self view of the user object. Same shape as `GET /users/{id}`, with the self-only fields populated: `email` (email-read scope), `staff` (Whop staff only, staff-read scope), `balance`, `cards` and `earnings_usd` (balance-read scope), the opt-in `balance_history`, and every linked social account.
|
|
38596
38992
|
</dd>
|
|
38597
38993
|
</dl>
|
|
38598
38994
|
</dd>
|
|
@@ -39205,7 +39601,8 @@ client.variants.list(
|
|
|
39205
39601
|
plan_types: ["renewal"],
|
|
39206
39602
|
product_ids: ["prod_xxxxxxxxxxxxxx"],
|
|
39207
39603
|
presentment_currency: "auto",
|
|
39208
|
-
ip_address: "203.0.113.7"
|
|
39604
|
+
ip_address: "203.0.113.7",
|
|
39605
|
+
presentment_country: "JP"
|
|
39209
39606
|
)
|
|
39210
39607
|
```
|
|
39211
39608
|
</dd>
|
|
@@ -39293,7 +39690,7 @@ client.variants.list(
|
|
|
39293
39690
|
<dl>
|
|
39294
39691
|
<dd>
|
|
39295
39692
|
|
|
39296
|
-
**presentment_currency:** `String` — The currency to state each variant's prices in. Omit it, or send null, for each variant's own currency. `auto` states them in the currency of the country Whop places the buyer in: by `ip_address` when your server sends one, and by the request's own IP address otherwise. A three-letter ISO 4217 code, such as `eur`, states them in that currency. A variant converts only where a payment quote for it would be priced in that currency, and stays in its own currency otherwise: a renewing variant, one with adaptive pricing off, a currency no payment method can collect, or `auto` for a buyer Whop cannot place in a country. Converted prices are an estimate at the current exchange rate. Nothing is held: the payment quote the buyer pays from fixes the rate.
|
|
39693
|
+
**presentment_currency:** `String` — The currency to state each variant's prices in. Omit it, or send null, for each variant's own currency. `auto` states them in the currency of the country Whop places the buyer in: by `ip_address` when your server sends one, and by the request's own IP address otherwise. To choose that country instead, send `presentment_country` in place of this. A three-letter ISO 4217 code, such as `eur`, states them in that currency. A variant converts only where a payment quote for it would be priced in that currency, and stays in its own currency otherwise: a renewing variant, one with adaptive pricing off, a currency no payment method can collect, or `auto` for a buyer Whop cannot place in a country. Converted prices are an estimate at the current exchange rate. Nothing is held: the payment quote the buyer pays from fixes the rate.
|
|
39297
39694
|
|
|
39298
39695
|
</dd>
|
|
39299
39696
|
</dl>
|
|
@@ -39301,7 +39698,15 @@ client.variants.list(
|
|
|
39301
39698
|
<dl>
|
|
39302
39699
|
<dd>
|
|
39303
39700
|
|
|
39304
|
-
**ip_address:** `String` — The buyer's IP address, when your server reads on their behalf. Needs an API key; any other caller is placed by its own request. Where `presentment_currency` `auto` finds the buyer's local currency.
|
|
39701
|
+
**ip_address:** `String` — The buyer's IP address, when your server reads on their behalf. Needs an API key; any other caller is placed by its own request. Where `presentment_currency` `auto` finds the buyer's local currency, and where a payment method must be able to collect it.
|
|
39702
|
+
|
|
39703
|
+
</dd>
|
|
39704
|
+
</dl>
|
|
39705
|
+
|
|
39706
|
+
<dl>
|
|
39707
|
+
<dd>
|
|
39708
|
+
|
|
39709
|
+
**presentment_country:** `String` — The country to state each variant's prices for, as an ISO 3166-1 alpha-2 code such as `JP`, when the buyer chose one: a store's country picker. States them in the currency `auto` would for a buyer in that country, so send it instead of `presentment_currency`, never with it. Whether a payment method can collect that currency is still judged where the buyer is: by `ip_address`, else by the request's own IP address. A country Whop has no currency for is ignored, and the prices are stated as `auto` would state them.
|
|
39305
39710
|
|
|
39306
39711
|
</dd>
|
|
39307
39712
|
</dl>
|
|
@@ -39653,7 +40058,8 @@ Retrieves the details of an existing variant.
|
|
|
39653
40058
|
client.variants.retrieve(
|
|
39654
40059
|
id: "id",
|
|
39655
40060
|
presentment_currency: "auto",
|
|
39656
|
-
ip_address: "203.0.113.7"
|
|
40061
|
+
ip_address: "203.0.113.7",
|
|
40062
|
+
presentment_country: "JP"
|
|
39657
40063
|
)
|
|
39658
40064
|
```
|
|
39659
40065
|
</dd>
|
|
@@ -39677,7 +40083,15 @@ client.variants.retrieve(
|
|
|
39677
40083
|
<dl>
|
|
39678
40084
|
<dd>
|
|
39679
40085
|
|
|
39680
|
-
**presentment_currency:** `String` — The currency to state each variant's prices in. Omit it, or send null, for each variant's own currency. `auto` states them in the currency of the country Whop places the buyer in: by `ip_address` when your server sends one, and by the request's own IP address otherwise. A three-letter ISO 4217 code, such as `eur`, states them in that currency. A variant converts only where a payment quote for it would be priced in that currency, and stays in its own currency otherwise: a renewing variant, one with adaptive pricing off, a currency no payment method can collect, or `auto` for a buyer Whop cannot place in a country. Converted prices are an estimate at the current exchange rate. Nothing is held: the payment quote the buyer pays from fixes the rate.
|
|
40086
|
+
**presentment_currency:** `String` — The currency to state each variant's prices in. Omit it, or send null, for each variant's own currency. `auto` states them in the currency of the country Whop places the buyer in: by `ip_address` when your server sends one, and by the request's own IP address otherwise. To choose that country instead, send `presentment_country` in place of this. A three-letter ISO 4217 code, such as `eur`, states them in that currency. A variant converts only where a payment quote for it would be priced in that currency, and stays in its own currency otherwise: a renewing variant, one with adaptive pricing off, a currency no payment method can collect, or `auto` for a buyer Whop cannot place in a country. Converted prices are an estimate at the current exchange rate. Nothing is held: the payment quote the buyer pays from fixes the rate.
|
|
40087
|
+
|
|
40088
|
+
</dd>
|
|
40089
|
+
</dl>
|
|
40090
|
+
|
|
40091
|
+
<dl>
|
|
40092
|
+
<dd>
|
|
40093
|
+
|
|
40094
|
+
**ip_address:** `String` — The buyer's IP address, when your server reads on their behalf. Needs an API key; any other caller is placed by its own request. Where `presentment_currency` `auto` finds the buyer's local currency, and where a payment method must be able to collect it.
|
|
39681
40095
|
|
|
39682
40096
|
</dd>
|
|
39683
40097
|
</dl>
|
|
@@ -39685,7 +40099,7 @@ client.variants.retrieve(
|
|
|
39685
40099
|
<dl>
|
|
39686
40100
|
<dd>
|
|
39687
40101
|
|
|
39688
|
-
**
|
|
40102
|
+
**presentment_country:** `String` — The country to state each variant's prices for, as an ISO 3166-1 alpha-2 code such as `JP`, when the buyer chose one: a store's country picker. States them in the currency `auto` would for a buyer in that country, so send it instead of `presentment_currency`, never with it. Whether a payment method can collect that currency is still judged where the buyer is: by `ip_address`, else by the request's own IP address. A country Whop has no currency for is ignored, and the prices are stated as `auto` would state them.
|
|
39689
40103
|
|
|
39690
40104
|
</dd>
|
|
39691
40105
|
</dl>
|
|
@@ -44181,7 +44595,7 @@ client.members.logs.list(id: "id")
|
|
|
44181
44595
|
<dl>
|
|
44182
44596
|
<dd>
|
|
44183
44597
|
|
|
44184
|
-
Lists the platform's visible notification topics — the categories users can set notification preferences on. App-created topics are
|
|
44598
|
+
Lists the platform's visible notification topics — the categories users can set notification preferences on. App-created topics are not returned.
|
|
44185
44599
|
</dd>
|
|
44186
44600
|
</dl>
|
|
44187
44601
|
</dd>
|
|
@@ -44747,7 +45161,7 @@ client.payments.direct.create(
|
|
|
44747
45161
|
<dl>
|
|
44748
45162
|
<dd>
|
|
44749
45163
|
|
|
44750
|
-
**quote_id:** `String` — A payment quote from `POST /payment_quotes`, prefixed `pq_`. The payment charges exactly the quote: its purchase (its variants and quantities, or the `plan` it priced), which this body may then omit, its promo code, and its tax, the quote's `tax_amount` rather than a figure calculated now. Omit it, or send null, to have tax calculated when the payment is charged. The quote must belong to `account_id`. A purchase field you omit or send as null takes the quote's value; the buyer's email, the addresses and the payment method are this request's own, never the quote's. Whatever you do send must describe the quoted purchase: the same variants, quantities and promo code. A quote that priced `plan` takes only the same `plan` you sent to `POST /payment_quotes` (or omit the purchase to take the quoted one), never `plan_id` or `line_items`, and a quote that priced variants by id never takes `plan`. Unless the quote located no buyer (`located_by` is null), the address the payment carries (its shipping address, else its billing address) must put the buyer where the quote priced tax, by country, state and postal code; otherwise the payment is refused with 400 before the payment method is used. A quote located by IP address (`located_by` is `ip_address`) is a preview and cannot be paid. A quote is consumed by one payment: a declined payment keeps it and can be retried; a new payment needs a new quote. A quote cannot be charged through PayPal; such a payment is refused before the payment method is used. A quote priced in a `presentment_currency` is charged in that currency at the quote's `exchange_rate`. A payment refused over its quote carries an error `code`. `quote_expired`: the quote has expired; quote again. `quote_tax_unavailable`: the quote could not price tax; quote again, or omit `quote_id`. `quote_preview_only`: the quote was located by IP address; quote again with the buyer's address. `quote_in_use` (409): another payment holds the quote. `quote_mismatch`: the purchase or the buyer's address is not the one quoted. `quote_rate_expired`: the exchange rate the quote was priced at has moved too far to charge; quote again. `payment_method_currency_unsupported`: the payment method cannot pay in the quote's currency; use another method, or quote again in another currency. `quote_processor_unsupported`: the payment method cannot pay a quote, as with PayPal; use another method, or omit `quote_id` to have tax calculated when the payment is charged.
|
|
45164
|
+
**quote_id:** `String` — A payment quote from `POST /payment_quotes`, prefixed `pq_`. The payment charges exactly the quote: its purchase (its variants and quantities, or the `plan` it priced), which this body may then omit, its promo code, and its tax, the quote's `tax_amount` rather than a figure calculated now. Omit it, or send null, to have tax calculated when the payment is charged. The quote must belong to `account_id`. A purchase field you omit or send as null takes the quote's value; the buyer's email, the addresses and the payment method are this request's own, never the quote's. Whatever you do send must describe the quoted purchase: the same variants, quantities and promo code. A quote that priced `plan` takes only the same `plan` you sent to `POST /payment_quotes` (or omit the purchase to take the quoted one), never `plan_id` or `line_items`, and a quote that priced variants by id never takes `plan`. Unless the quote located no buyer (`located_by` is null), the address the payment carries (its shipping address, else its billing address) must put the buyer where the quote priced tax, by country, state and postal code; otherwise the payment is refused with 400 before the payment method is used. A quote located by IP address or by the country the buyer chose (`located_by` is `ip_address` or `presentment_country`) is a preview and cannot be paid. A quote is consumed by one payment: a declined payment keeps it and can be retried; a new payment needs a new quote. A quote cannot be charged through PayPal; such a payment is refused before the payment method is used. A quote priced in a `presentment_currency` is charged in that currency at the quote's `exchange_rate`. A payment refused over its quote carries an error `code`. `quote_expired`: the quote has expired; quote again. `quote_tax_unavailable`: the quote could not price tax; quote again, or omit `quote_id`. `quote_preview_only`: the quote was located by IP address or by the country the buyer chose; quote again with the buyer's address. `quote_in_use` (409): another payment holds the quote. `quote_mismatch`: the purchase or the buyer's address is not the one quoted. `quote_rate_expired`: the exchange rate the quote was priced at has moved too far to charge; quote again. `payment_method_currency_unsupported`: the payment method cannot pay in the quote's currency; use another method, or quote again in another currency. `quote_processor_unsupported`: the payment method cannot pay a quote, as with PayPal; use another method, or omit `quote_id` to have tax calculated when the payment is charged.
|
|
44751
45165
|
|
|
44752
45166
|
</dd>
|
|
44753
45167
|
</dl>
|
|
@@ -47073,6 +47487,14 @@ client.users.preferences.update
|
|
|
47073
47487
|
<dl>
|
|
47074
47488
|
<dd>
|
|
47075
47489
|
|
|
47490
|
+
**cards_auto_top_up:** `Internal::Types::Boolean` — Whether incoming funds, including pending balance, are automatically moved to the user's personal cards balance. Requires a cards balance and the `payout:account:update` permission.
|
|
47491
|
+
|
|
47492
|
+
</dd>
|
|
47493
|
+
</dl>
|
|
47494
|
+
|
|
47495
|
+
<dl>
|
|
47496
|
+
<dd>
|
|
47497
|
+
|
|
47076
47498
|
**investigation_enabled:** `Internal::Types::Boolean` — Whether investigation mode is enabled for the user. Only meaningful for staff users with investigation access.
|
|
47077
47499
|
|
|
47078
47500
|
</dd>
|