whop_sdk 0.0.4 → 0.0.6
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/CHANGELOG.md +40 -0
- data/README.md +4 -7
- data/lib/whop_sdk/client.rb +21 -6
- data/lib/whop_sdk/internal/transport/base_client.rb +7 -1
- data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +6 -2
- data/lib/whop_sdk/models/access_level.rb +1 -1
- data/lib/whop_sdk/models/access_pass_type.rb +2 -1
- data/lib/whop_sdk/models/access_token_create_params.rb +67 -0
- data/lib/whop_sdk/models/access_token_create_response.rb +27 -0
- data/lib/whop_sdk/models/checkout_configuration_create_params.rb +4 -4
- data/lib/whop_sdk/models/company.rb +1 -0
- data/lib/whop_sdk/models/course.rb +18 -1
- data/lib/whop_sdk/models/course_create_params.rb +20 -1
- data/lib/whop_sdk/models/course_lesson_create_params.rb +77 -1
- data/lib/whop_sdk/models/course_lesson_list_response.rb +43 -1
- data/lib/whop_sdk/models/course_lesson_update_params.rb +77 -1
- data/lib/whop_sdk/models/course_list_response.rb +18 -1
- data/lib/whop_sdk/models/course_update_params.rb +19 -1
- data/lib/whop_sdk/models/course_visibilities.rb +17 -0
- data/lib/whop_sdk/models/dispute.rb +672 -0
- data/lib/whop_sdk/models/dispute_created_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/dispute_list_params.rb +62 -0
- data/lib/whop_sdk/models/dispute_list_response.rb +187 -0
- data/lib/whop_sdk/models/dispute_retrieve_params.rb +14 -0
- data/lib/whop_sdk/models/dispute_statuses.rb +23 -0
- data/lib/whop_sdk/models/dispute_submit_evidence_params.rb +14 -0
- data/lib/whop_sdk/models/dispute_update_evidence_params.rb +342 -0
- data/lib/whop_sdk/models/dispute_updated_webhook_event.rb +48 -0
- data/lib/whop_sdk/models/embed_type.rb +16 -0
- data/lib/whop_sdk/models/entry.rb +3 -3
- data/lib/whop_sdk/models/entry_list_response.rb +3 -3
- data/lib/whop_sdk/models/experience.rb +5 -6
- data/lib/whop_sdk/models/forum_post.rb +2 -2
- data/lib/whop_sdk/models/forum_post_list_response.rb +2 -2
- data/lib/whop_sdk/models/global_affiliate_status.rb +1 -1
- data/lib/whop_sdk/models/invoice_create_params.rb +2 -2
- data/lib/whop_sdk/models/invoice_list_params.rb +27 -40
- data/lib/whop_sdk/models/lesson.rb +43 -1
- data/lib/whop_sdk/models/member_list_params.rb +11 -11
- data/lib/whop_sdk/models/member_list_response.rb +3 -3
- data/lib/whop_sdk/models/member_retrieve_response.rb +3 -3
- data/lib/whop_sdk/models/membership_list_params.rb +9 -9
- data/lib/whop_sdk/models/message.rb +2 -2
- data/lib/whop_sdk/models/message_list_response.rb +2 -2
- data/lib/whop_sdk/models/notification_create_params.rb +88 -0
- data/lib/whop_sdk/models/notification_create_response.rb +19 -0
- data/lib/whop_sdk/models/payment.rb +3 -3
- data/lib/whop_sdk/models/payment_list_response.rb +3 -3
- data/lib/whop_sdk/models/plan.rb +6 -4
- data/lib/whop_sdk/models/plan_create_params.rb +2 -2
- data/lib/whop_sdk/models/plan_list_response.rb +6 -4
- data/lib/whop_sdk/models/plan_type.rb +1 -1
- data/lib/whop_sdk/models/product.rb +1 -1
- data/lib/whop_sdk/models/product_create_params.rb +6 -6
- data/lib/whop_sdk/models/product_list_item.rb +1 -1
- data/lib/whop_sdk/models/product_update_params.rb +4 -4
- data/lib/whop_sdk/models/promo_code.rb +3 -3
- data/lib/whop_sdk/models/promo_code_list_response.rb +3 -3
- data/lib/whop_sdk/models/unwrap_webhook_event.rb +5 -1
- data/lib/whop_sdk/models.rb +24 -0
- data/lib/whop_sdk/resources/access_tokens.rb +46 -0
- data/lib/whop_sdk/resources/app_builds.rb +4 -2
- data/lib/whop_sdk/resources/apps.rb +3 -2
- data/lib/whop_sdk/resources/authorized_users.rb +2 -1
- data/lib/whop_sdk/resources/chat_channels.rb +9 -2
- data/lib/whop_sdk/resources/checkout_configurations.rb +2 -1
- data/lib/whop_sdk/resources/companies.rb +2 -1
- data/lib/whop_sdk/resources/course_chapters.rb +5 -3
- data/lib/whop_sdk/resources/course_lesson_interactions.rb +2 -1
- data/lib/whop_sdk/resources/course_lessons.rb +19 -5
- data/lib/whop_sdk/resources/course_students.rb +2 -1
- data/lib/whop_sdk/resources/courses.rb +15 -5
- data/lib/whop_sdk/resources/disputes.rb +182 -0
- data/lib/whop_sdk/resources/entries.rb +6 -3
- data/lib/whop_sdk/resources/experiences.rb +8 -6
- data/lib/whop_sdk/resources/forum_posts.rb +3 -2
- data/lib/whop_sdk/resources/forums.rb +3 -2
- data/lib/whop_sdk/resources/invoices.rb +11 -5
- data/lib/whop_sdk/resources/ledger_accounts.rb +6 -2
- data/lib/whop_sdk/resources/members.rb +6 -5
- data/lib/whop_sdk/resources/memberships.rb +10 -8
- data/lib/whop_sdk/resources/messages.rb +3 -2
- data/lib/whop_sdk/resources/notifications.rb +53 -0
- data/lib/whop_sdk/resources/payments.rb +7 -4
- data/lib/whop_sdk/resources/plans.rb +6 -4
- data/lib/whop_sdk/resources/products.rb +9 -7
- data/lib/whop_sdk/resources/promo_codes.rb +4 -2
- data/lib/whop_sdk/resources/reactions.rb +2 -1
- data/lib/whop_sdk/resources/reviews.rb +2 -1
- data/lib/whop_sdk/resources/shipments.rb +2 -1
- data/lib/whop_sdk/resources/support_channels.rb +2 -1
- data/lib/whop_sdk/resources/transfers.rb +2 -1
- data/lib/whop_sdk/resources/users.rb +9 -3
- data/lib/whop_sdk/resources/webhooks.rb +1 -1
- data/lib/whop_sdk/version.rb +1 -1
- data/lib/whop_sdk.rb +19 -0
- data/manifest.yaml +1 -0
- data/rbi/whop_sdk/client.rbi +14 -2
- data/rbi/whop_sdk/internal/transport/base_client.rbi +5 -0
- data/rbi/whop_sdk/internal/transport/pooled_net_requester.rbi +6 -2
- data/rbi/whop_sdk/internal/type/base_model.rbi +8 -4
- data/rbi/whop_sdk/models/access_level.rbi +1 -1
- data/rbi/whop_sdk/models/access_pass_type.rbi +2 -1
- data/rbi/whop_sdk/models/access_token_create_params.rbi +126 -0
- data/rbi/whop_sdk/models/access_token_create_response.rbi +37 -0
- data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +4 -4
- data/rbi/whop_sdk/models/company.rbi +2 -0
- data/rbi/whop_sdk/models/course.rbi +21 -3
- data/rbi/whop_sdk/models/course_create_params.rbi +22 -0
- data/rbi/whop_sdk/models/course_lesson_create_params.rbi +126 -0
- data/rbi/whop_sdk/models/course_lesson_list_response.rbi +68 -0
- data/rbi/whop_sdk/models/course_lesson_update_params.rbi +126 -0
- data/rbi/whop_sdk/models/course_list_response.rbi +21 -3
- data/rbi/whop_sdk/models/course_update_params.rbi +20 -0
- data/rbi/whop_sdk/models/course_visibilities.rbi +23 -0
- data/rbi/whop_sdk/models/dispute.rbi +938 -0
- data/rbi/whop_sdk/models/dispute_created_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/dispute_list_params.rbi +83 -0
- data/rbi/whop_sdk/models/dispute_list_response.rbi +287 -0
- data/rbi/whop_sdk/models/dispute_retrieve_params.rbi +27 -0
- data/rbi/whop_sdk/models/dispute_statuses.rbi +32 -0
- data/rbi/whop_sdk/models/dispute_submit_evidence_params.rbi +30 -0
- data/rbi/whop_sdk/models/dispute_update_evidence_params.rbi +566 -0
- data/rbi/whop_sdk/models/dispute_updated_webhook_event.rbi +72 -0
- data/rbi/whop_sdk/models/embed_type.rbi +20 -0
- data/rbi/whop_sdk/models/entry.rbi +3 -3
- data/rbi/whop_sdk/models/entry_list_response.rbi +3 -3
- data/rbi/whop_sdk/models/experience.rbi +7 -9
- data/rbi/whop_sdk/models/forum_post.rbi +2 -2
- data/rbi/whop_sdk/models/forum_post_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/global_affiliate_status.rbi +1 -1
- data/rbi/whop_sdk/models/invoice_create_params.rbi +2 -2
- data/rbi/whop_sdk/models/invoice_list_params.rbi +26 -71
- data/rbi/whop_sdk/models/lesson.rbi +54 -0
- data/rbi/whop_sdk/models/member_list_params.rbi +10 -10
- data/rbi/whop_sdk/models/member_list_response.rbi +6 -6
- data/rbi/whop_sdk/models/member_retrieve_response.rbi +6 -6
- data/rbi/whop_sdk/models/membership_list_params.rbi +8 -8
- data/rbi/whop_sdk/models/message.rbi +2 -2
- data/rbi/whop_sdk/models/message_list_response.rbi +2 -2
- data/rbi/whop_sdk/models/notification_create_params.rbi +113 -0
- data/rbi/whop_sdk/models/notification_create_response.rbi +31 -0
- data/rbi/whop_sdk/models/payment.rbi +3 -3
- data/rbi/whop_sdk/models/payment_list_response.rbi +3 -3
- data/rbi/whop_sdk/models/plan.rbi +6 -4
- data/rbi/whop_sdk/models/plan_create_params.rbi +2 -2
- data/rbi/whop_sdk/models/plan_list_response.rbi +6 -4
- data/rbi/whop_sdk/models/plan_type.rbi +1 -1
- data/rbi/whop_sdk/models/product.rbi +1 -1
- data/rbi/whop_sdk/models/product_create_params.rbi +6 -6
- data/rbi/whop_sdk/models/product_list_item.rbi +1 -1
- data/rbi/whop_sdk/models/product_update_params.rbi +4 -4
- data/rbi/whop_sdk/models/promo_code.rbi +3 -3
- data/rbi/whop_sdk/models/promo_code_list_response.rbi +3 -3
- data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +3 -1
- data/rbi/whop_sdk/models.rbi +24 -0
- data/rbi/whop_sdk/resources/access_tokens.rbi +41 -0
- data/rbi/whop_sdk/resources/app_builds.rbi +10 -2
- data/rbi/whop_sdk/resources/apps.rbi +6 -1
- data/rbi/whop_sdk/resources/authorized_users.rbi +5 -1
- data/rbi/whop_sdk/resources/chat_channels.rbi +8 -1
- data/rbi/whop_sdk/resources/checkout_configurations.rbi +5 -1
- data/rbi/whop_sdk/resources/companies.rbi +5 -1
- data/rbi/whop_sdk/resources/course_chapters.rbi +11 -2
- data/rbi/whop_sdk/resources/course_lesson_interactions.rbi +5 -1
- data/rbi/whop_sdk/resources/course_lessons.rbi +41 -2
- data/rbi/whop_sdk/resources/course_students.rbi +5 -1
- data/rbi/whop_sdk/resources/courses.rbi +28 -2
- data/rbi/whop_sdk/resources/disputes.rbi +194 -0
- data/rbi/whop_sdk/resources/entries.rbi +15 -3
- data/rbi/whop_sdk/resources/experiences.rbi +14 -2
- data/rbi/whop_sdk/resources/forum_posts.rbi +6 -1
- data/rbi/whop_sdk/resources/forums.rbi +6 -1
- data/rbi/whop_sdk/resources/invoices.rbi +20 -5
- data/rbi/whop_sdk/resources/ledger_accounts.rbi +7 -2
- data/rbi/whop_sdk/resources/members.rbi +9 -5
- data/rbi/whop_sdk/resources/memberships.rbi +16 -5
- data/rbi/whop_sdk/resources/messages.rbi +6 -1
- data/rbi/whop_sdk/resources/notifications.rbi +54 -0
- data/rbi/whop_sdk/resources/payments.rbi +16 -3
- data/rbi/whop_sdk/resources/plans.rbi +12 -3
- data/rbi/whop_sdk/resources/products.rbi +15 -6
- data/rbi/whop_sdk/resources/promo_codes.rbi +10 -2
- data/rbi/whop_sdk/resources/reactions.rbi +5 -1
- data/rbi/whop_sdk/resources/reviews.rbi +5 -1
- data/rbi/whop_sdk/resources/shipments.rbi +5 -1
- data/rbi/whop_sdk/resources/support_channels.rbi +5 -1
- data/rbi/whop_sdk/resources/transfers.rbi +5 -1
- data/rbi/whop_sdk/resources/users.rbi +13 -2
- data/rbi/whop_sdk/resources/webhooks.rbi +3 -1
- data/sig/whop_sdk/client.rbs +7 -1
- data/sig/whop_sdk/internal/transport/base_client.rbs +2 -0
- data/sig/whop_sdk/internal/transport/pooled_net_requester.rbs +4 -1
- data/sig/whop_sdk/models/access_token_create_params.rbs +56 -0
- data/sig/whop_sdk/models/access_token_create_response.rbs +15 -0
- data/sig/whop_sdk/models/company.rbs +2 -0
- data/sig/whop_sdk/models/course.rbs +13 -3
- data/sig/whop_sdk/models/course_create_params.rbs +11 -1
- data/sig/whop_sdk/models/course_lesson_create_params.rbs +46 -0
- data/sig/whop_sdk/models/course_lesson_list_response.rbs +25 -0
- data/sig/whop_sdk/models/course_lesson_update_params.rbs +46 -0
- data/sig/whop_sdk/models/course_list_response.rbs +13 -3
- data/sig/whop_sdk/models/course_update_params.rbs +11 -1
- data/sig/whop_sdk/models/course_visibilities.rbs +14 -0
- data/sig/whop_sdk/models/dispute.rbs +437 -0
- data/sig/whop_sdk/models/dispute_created_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/dispute_list_params.rbs +51 -0
- data/sig/whop_sdk/models/dispute_list_response.rbs +124 -0
- data/sig/whop_sdk/models/dispute_retrieve_params.rbs +15 -0
- data/sig/whop_sdk/models/dispute_statuses.rbs +30 -0
- data/sig/whop_sdk/models/dispute_submit_evidence_params.rbs +15 -0
- data/sig/whop_sdk/models/dispute_update_evidence_params.rbs +215 -0
- data/sig/whop_sdk/models/dispute_updated_webhook_event.rbs +40 -0
- data/sig/whop_sdk/models/embed_type.rbs +14 -0
- data/sig/whop_sdk/models/invoice_list_params.rbs +16 -33
- data/sig/whop_sdk/models/lesson.rbs +25 -0
- data/sig/whop_sdk/models/member_list_params.rbs +5 -5
- data/sig/whop_sdk/models/membership_list_params.rbs +5 -5
- data/sig/whop_sdk/models/notification_create_params.rbs +61 -0
- data/sig/whop_sdk/models/notification_create_response.rbs +13 -0
- data/sig/whop_sdk/models/unwrap_webhook_event.rbs +2 -0
- data/sig/whop_sdk/models.rbs +24 -0
- data/sig/whop_sdk/resources/access_tokens.rbs +15 -0
- data/sig/whop_sdk/resources/course_lessons.rbs +6 -0
- data/sig/whop_sdk/resources/courses.rbs +4 -0
- data/sig/whop_sdk/resources/disputes.rbs +46 -0
- data/sig/whop_sdk/resources/invoices.rbs +3 -1
- data/sig/whop_sdk/resources/members.rbs +1 -1
- data/sig/whop_sdk/resources/memberships.rbs +1 -1
- data/sig/whop_sdk/resources/notifications.rbs +19 -0
- data/sig/whop_sdk/resources/webhooks.rbs +3 -1
- metadata +56 -2
|
@@ -78,7 +78,7 @@ module WhopSDK
|
|
|
78
78
|
required :one_per_customer, WhopSDK::Internal::Type::Boolean
|
|
79
79
|
|
|
80
80
|
# @!attribute product
|
|
81
|
-
# The
|
|
81
|
+
# The product this promo code applies to
|
|
82
82
|
#
|
|
83
83
|
# @return [WhopSDK::Models::PromoCode::Product, nil]
|
|
84
84
|
required :product, -> { WhopSDK::PromoCode::Product }, nil?: true
|
|
@@ -149,7 +149,7 @@ module WhopSDK
|
|
|
149
149
|
#
|
|
150
150
|
# @param one_per_customer [Boolean] Restricts promo use to only be applied once per customer.
|
|
151
151
|
#
|
|
152
|
-
# @param product [WhopSDK::Models::PromoCode::Product, nil] The
|
|
152
|
+
# @param product [WhopSDK::Models::PromoCode::Product, nil] The product this promo code applies to
|
|
153
153
|
#
|
|
154
154
|
# @param promo_duration_months [Integer, nil] The number of months the promo is applied for.
|
|
155
155
|
#
|
|
@@ -200,7 +200,7 @@ module WhopSDK
|
|
|
200
200
|
required :title, String
|
|
201
201
|
|
|
202
202
|
# @!method initialize(id:, title:)
|
|
203
|
-
# The
|
|
203
|
+
# The product this promo code applies to
|
|
204
204
|
#
|
|
205
205
|
# @param id [String] The internal ID of the public product.
|
|
206
206
|
#
|
|
@@ -72,7 +72,7 @@ module WhopSDK
|
|
|
72
72
|
required :one_per_customer, WhopSDK::Internal::Type::Boolean
|
|
73
73
|
|
|
74
74
|
# @!attribute product
|
|
75
|
-
# The
|
|
75
|
+
# The product this promo code applies to
|
|
76
76
|
#
|
|
77
77
|
# @return [WhopSDK::Models::PromoCodeListResponse::Product, nil]
|
|
78
78
|
required :product, -> { WhopSDK::Models::PromoCodeListResponse::Product }, nil?: true
|
|
@@ -141,7 +141,7 @@ module WhopSDK
|
|
|
141
141
|
#
|
|
142
142
|
# @param one_per_customer [Boolean] Restricts promo use to only be applied once per customer.
|
|
143
143
|
#
|
|
144
|
-
# @param product [WhopSDK::Models::PromoCodeListResponse::Product, nil] The
|
|
144
|
+
# @param product [WhopSDK::Models::PromoCodeListResponse::Product, nil] The product this promo code applies to
|
|
145
145
|
#
|
|
146
146
|
# @param promo_duration_months [Integer, nil] The number of months the promo is applied for.
|
|
147
147
|
#
|
|
@@ -170,7 +170,7 @@ module WhopSDK
|
|
|
170
170
|
required :title, String
|
|
171
171
|
|
|
172
172
|
# @!method initialize(id:, title:)
|
|
173
|
-
# The
|
|
173
|
+
# The product this promo code applies to
|
|
174
174
|
#
|
|
175
175
|
# @param id [String] The internal ID of the public product.
|
|
176
176
|
#
|
|
@@ -33,8 +33,12 @@ module WhopSDK
|
|
|
33
33
|
|
|
34
34
|
variant -> { WhopSDK::PaymentPendingWebhookEvent }
|
|
35
35
|
|
|
36
|
+
variant -> { WhopSDK::DisputeCreatedWebhookEvent }
|
|
37
|
+
|
|
38
|
+
variant -> { WhopSDK::DisputeUpdatedWebhookEvent }
|
|
39
|
+
|
|
36
40
|
# @!method self.variants
|
|
37
|
-
# @return [Array(WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent)]
|
|
41
|
+
# @return [Array(WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent, WhopSDK::Models::DisputeCreatedWebhookEvent, WhopSDK::Models::DisputeUpdatedWebhookEvent)]
|
|
38
42
|
end
|
|
39
43
|
end
|
|
40
44
|
end
|
data/lib/whop_sdk/models.rb
CHANGED
|
@@ -43,6 +43,8 @@ module WhopSDK
|
|
|
43
43
|
|
|
44
44
|
AccessPassType = WhopSDK::Models::AccessPassType
|
|
45
45
|
|
|
46
|
+
AccessTokenCreateParams = WhopSDK::Models::AccessTokenCreateParams
|
|
47
|
+
|
|
46
48
|
App = WhopSDK::Models::App
|
|
47
49
|
|
|
48
50
|
AppBuild = WhopSDK::Models::AppBuild
|
|
@@ -160,16 +162,36 @@ module WhopSDK
|
|
|
160
162
|
|
|
161
163
|
CourseUpdateParams = WhopSDK::Models::CourseUpdateParams
|
|
162
164
|
|
|
165
|
+
CourseVisibilities = WhopSDK::Models::CourseVisibilities
|
|
166
|
+
|
|
163
167
|
Currency = WhopSDK::Models::Currency
|
|
164
168
|
|
|
165
169
|
CustomCta = WhopSDK::Models::CustomCta
|
|
166
170
|
|
|
167
171
|
Direction = WhopSDK::Models::Direction
|
|
168
172
|
|
|
173
|
+
Dispute = WhopSDK::Models::Dispute
|
|
174
|
+
|
|
175
|
+
DisputeCreatedWebhookEvent = WhopSDK::Models::DisputeCreatedWebhookEvent
|
|
176
|
+
|
|
177
|
+
DisputeListParams = WhopSDK::Models::DisputeListParams
|
|
178
|
+
|
|
179
|
+
DisputeRetrieveParams = WhopSDK::Models::DisputeRetrieveParams
|
|
180
|
+
|
|
181
|
+
DisputeStatuses = WhopSDK::Models::DisputeStatuses
|
|
182
|
+
|
|
183
|
+
DisputeSubmitEvidenceParams = WhopSDK::Models::DisputeSubmitEvidenceParams
|
|
184
|
+
|
|
185
|
+
DisputeUpdatedWebhookEvent = WhopSDK::Models::DisputeUpdatedWebhookEvent
|
|
186
|
+
|
|
187
|
+
DisputeUpdateEvidenceParams = WhopSDK::Models::DisputeUpdateEvidenceParams
|
|
188
|
+
|
|
169
189
|
DmsPostTypes = WhopSDK::Models::DmsPostTypes
|
|
170
190
|
|
|
171
191
|
EmailNotificationPreferences = WhopSDK::Models::EmailNotificationPreferences
|
|
172
192
|
|
|
193
|
+
EmbedType = WhopSDK::Models::EmbedType
|
|
194
|
+
|
|
173
195
|
Entry = WhopSDK::Models::Entry
|
|
174
196
|
|
|
175
197
|
EntryApprovedWebhookEvent = WhopSDK::Models::EntryApprovedWebhookEvent
|
|
@@ -302,6 +324,8 @@ module WhopSDK
|
|
|
302
324
|
|
|
303
325
|
MessageUpdateParams = WhopSDK::Models::MessageUpdateParams
|
|
304
326
|
|
|
327
|
+
NotificationCreateParams = WhopSDK::Models::NotificationCreateParams
|
|
328
|
+
|
|
305
329
|
PageInfo = WhopSDK::Models::PageInfo
|
|
306
330
|
|
|
307
331
|
Payment = WhopSDK::Models::Payment
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class AccessTokens
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {WhopSDK::Models::AccessTokenCreateParams} for more details.
|
|
8
|
+
#
|
|
9
|
+
# Creates an access token for a user to access a specific resource. These access
|
|
10
|
+
# tokens are designed to be used with Whop's embedded components.
|
|
11
|
+
#
|
|
12
|
+
# @overload create(scoped_actions:, target_resource_id:, target_resource_type:, expires_at: nil, request_options: {})
|
|
13
|
+
#
|
|
14
|
+
# @param scoped_actions [Array<String>] Array of desired scoped actions for the access token. This list must be a subset
|
|
15
|
+
#
|
|
16
|
+
# @param target_resource_id [String] The ID of the target resource (Company, User, etc.) for which the access token i
|
|
17
|
+
#
|
|
18
|
+
# @param target_resource_type [Symbol, WhopSDK::Models::AccessTokenCreateParams::TargetResourceType] The type of the target resource (company, user, product, experience, etc.).
|
|
19
|
+
#
|
|
20
|
+
# @param expires_at [Time, nil] The expiration timestamp for the access token. If not provided, a default expira
|
|
21
|
+
#
|
|
22
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
23
|
+
#
|
|
24
|
+
# @return [WhopSDK::Models::AccessTokenCreateResponse]
|
|
25
|
+
#
|
|
26
|
+
# @see WhopSDK::Models::AccessTokenCreateParams
|
|
27
|
+
def create(params)
|
|
28
|
+
parsed, options = WhopSDK::AccessTokenCreateParams.dump_request(params)
|
|
29
|
+
@client.request(
|
|
30
|
+
method: :post,
|
|
31
|
+
path: "access_tokens",
|
|
32
|
+
body: parsed,
|
|
33
|
+
model: WhopSDK::Models::AccessTokenCreateResponse,
|
|
34
|
+
options: options
|
|
35
|
+
)
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# @api private
|
|
39
|
+
#
|
|
40
|
+
# @param client [WhopSDK::Client]
|
|
41
|
+
def initialize(client:)
|
|
42
|
+
@client = client
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
end
|
|
46
|
+
end
|
|
@@ -48,7 +48,8 @@ module WhopSDK
|
|
|
48
48
|
#
|
|
49
49
|
# @overload retrieve(id, request_options: {})
|
|
50
50
|
#
|
|
51
|
-
# @param id [String]
|
|
51
|
+
# @param id [String] The ID of the app build
|
|
52
|
+
#
|
|
52
53
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
53
54
|
#
|
|
54
55
|
# @return [WhopSDK::Models::AppBuild]
|
|
@@ -110,7 +111,8 @@ module WhopSDK
|
|
|
110
111
|
#
|
|
111
112
|
# @overload promote(id, request_options: {})
|
|
112
113
|
#
|
|
113
|
-
# @param id [String]
|
|
114
|
+
# @param id [String] The ID of the app build to promote.
|
|
115
|
+
#
|
|
114
116
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
115
117
|
#
|
|
116
118
|
# @return [WhopSDK::Models::AppBuild]
|
|
@@ -36,7 +36,8 @@ module WhopSDK
|
|
|
36
36
|
#
|
|
37
37
|
# @overload retrieve(id, request_options: {})
|
|
38
38
|
#
|
|
39
|
-
# @param id [String]
|
|
39
|
+
# @param id [String] The ID of the app
|
|
40
|
+
#
|
|
40
41
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
41
42
|
#
|
|
42
43
|
# @return [WhopSDK::Models::App]
|
|
@@ -60,7 +61,7 @@ module WhopSDK
|
|
|
60
61
|
#
|
|
61
62
|
# @overload update(id, app_store_description: nil, base_url: nil, dashboard_path: nil, description: nil, discover_path: nil, experience_path: nil, icon: nil, name: nil, required_scopes: nil, status: nil, request_options: {})
|
|
62
63
|
#
|
|
63
|
-
# @param id [String]
|
|
64
|
+
# @param id [String] The ID of the app
|
|
64
65
|
#
|
|
65
66
|
# @param app_store_description [String, nil] The description of the app for the app store in-depth app view.
|
|
66
67
|
#
|
|
@@ -12,7 +12,8 @@ module WhopSDK
|
|
|
12
12
|
#
|
|
13
13
|
# @overload retrieve(id, request_options: {})
|
|
14
14
|
#
|
|
15
|
-
# @param id [String]
|
|
15
|
+
# @param id [String] The ID of the authorized user
|
|
16
|
+
#
|
|
16
17
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
17
18
|
#
|
|
18
19
|
# @return [WhopSDK::Models::AuthorizedUserRetrieveResponse]
|
|
@@ -3,6 +3,9 @@
|
|
|
3
3
|
module WhopSDK
|
|
4
4
|
module Resources
|
|
5
5
|
class ChatChannels
|
|
6
|
+
# Some parameter documentations has been truncated, see
|
|
7
|
+
# {WhopSDK::Models::ChatChannelRetrieveParams} for more details.
|
|
8
|
+
#
|
|
6
9
|
# Retrieves a chat channel
|
|
7
10
|
#
|
|
8
11
|
# Required permissions:
|
|
@@ -11,7 +14,8 @@ module WhopSDK
|
|
|
11
14
|
#
|
|
12
15
|
# @overload retrieve(id, request_options: {})
|
|
13
16
|
#
|
|
14
|
-
# @param id [String]
|
|
17
|
+
# @param id [String] The ID of the chat channel to fetch, it can be an experience ID or a chat channe
|
|
18
|
+
#
|
|
15
19
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
16
20
|
#
|
|
17
21
|
# @return [WhopSDK::Models::ChatChannel]
|
|
@@ -26,6 +30,9 @@ module WhopSDK
|
|
|
26
30
|
)
|
|
27
31
|
end
|
|
28
32
|
|
|
33
|
+
# Some parameter documentations has been truncated, see
|
|
34
|
+
# {WhopSDK::Models::ChatChannelUpdateParams} for more details.
|
|
35
|
+
#
|
|
29
36
|
# Updates a chat channel
|
|
30
37
|
#
|
|
31
38
|
# Required permissions:
|
|
@@ -34,7 +41,7 @@ module WhopSDK
|
|
|
34
41
|
#
|
|
35
42
|
# @overload update(id, ban_media: nil, ban_urls: nil, banned_words: nil, user_posts_cooldown_seconds: nil, who_can_post: nil, who_can_react: nil, request_options: {})
|
|
36
43
|
#
|
|
37
|
-
# @param id [String]
|
|
44
|
+
# @param id [String] The ID of the chat channel to update. Can be an experience ID or a chat feed ext
|
|
38
45
|
#
|
|
39
46
|
# @param ban_media [Boolean, nil] Whether media uploads are banned in this chat
|
|
40
47
|
#
|
|
@@ -48,7 +48,8 @@ module WhopSDK
|
|
|
48
48
|
#
|
|
49
49
|
# @overload retrieve(id, request_options: {})
|
|
50
50
|
#
|
|
51
|
-
# @param id [String]
|
|
51
|
+
# @param id [String] The ID of the checkout configuration
|
|
52
|
+
#
|
|
52
53
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
53
54
|
#
|
|
54
55
|
# @return [WhopSDK::Models::CheckoutConfiguration]
|
|
@@ -44,7 +44,8 @@ module WhopSDK
|
|
|
44
44
|
#
|
|
45
45
|
# @overload retrieve(id, request_options: {})
|
|
46
46
|
#
|
|
47
|
-
# @param id [String]
|
|
47
|
+
# @param id [String] The ID or route of the company
|
|
48
|
+
#
|
|
48
49
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
49
50
|
#
|
|
50
51
|
# @return [WhopSDK::Models::Company]
|
|
@@ -39,7 +39,8 @@ module WhopSDK
|
|
|
39
39
|
#
|
|
40
40
|
# @overload retrieve(id, request_options: {})
|
|
41
41
|
#
|
|
42
|
-
# @param id [String]
|
|
42
|
+
# @param id [String] The ID of the chapter
|
|
43
|
+
#
|
|
43
44
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
44
45
|
#
|
|
45
46
|
# @return [WhopSDK::Models::CourseChapter]
|
|
@@ -62,7 +63,7 @@ module WhopSDK
|
|
|
62
63
|
#
|
|
63
64
|
# @overload update(id, title:, request_options: {})
|
|
64
65
|
#
|
|
65
|
-
# @param id [String]
|
|
66
|
+
# @param id [String] The ID of the chapter to update
|
|
66
67
|
#
|
|
67
68
|
# @param title [String] The title of the chapter
|
|
68
69
|
#
|
|
@@ -125,7 +126,8 @@ module WhopSDK
|
|
|
125
126
|
#
|
|
126
127
|
# @overload delete(id, request_options: {})
|
|
127
128
|
#
|
|
128
|
-
# @param id [String]
|
|
129
|
+
# @param id [String] The ID of the chapter to delete
|
|
130
|
+
#
|
|
129
131
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
130
132
|
#
|
|
131
133
|
# @return [Boolean]
|
|
@@ -12,7 +12,8 @@ module WhopSDK
|
|
|
12
12
|
#
|
|
13
13
|
# @overload retrieve(id, request_options: {})
|
|
14
14
|
#
|
|
15
|
-
# @param id [String]
|
|
15
|
+
# @param id [String] The ID of the course lesson interaction
|
|
16
|
+
#
|
|
16
17
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
17
18
|
#
|
|
18
19
|
# @return [WhopSDK::Models::CourseLessonInteraction]
|
|
@@ -9,7 +9,7 @@ module WhopSDK
|
|
|
9
9
|
#
|
|
10
10
|
# - `courses:update`
|
|
11
11
|
#
|
|
12
|
-
# @overload create(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, title: nil, request_options: {})
|
|
12
|
+
# @overload create(chapter_id:, lesson_type:, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, thumbnail: nil, title: nil, request_options: {})
|
|
13
13
|
#
|
|
14
14
|
# @param chapter_id [String] The ID of the chapter to create the lesson in
|
|
15
15
|
#
|
|
@@ -19,6 +19,12 @@ module WhopSDK
|
|
|
19
19
|
#
|
|
20
20
|
# @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
|
|
21
21
|
#
|
|
22
|
+
# @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
|
|
23
|
+
#
|
|
24
|
+
# @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
|
|
25
|
+
#
|
|
26
|
+
# @param thumbnail [WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonCreateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the lesson in png, jpeg, or gif format
|
|
27
|
+
#
|
|
22
28
|
# @param title [String, nil] The title of the lesson
|
|
23
29
|
#
|
|
24
30
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
@@ -45,7 +51,8 @@ module WhopSDK
|
|
|
45
51
|
#
|
|
46
52
|
# @overload retrieve(id, request_options: {})
|
|
47
53
|
#
|
|
48
|
-
# @param id [String]
|
|
54
|
+
# @param id [String] The ID of the lesson
|
|
55
|
+
#
|
|
49
56
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
50
57
|
#
|
|
51
58
|
# @return [WhopSDK::Models::Lesson]
|
|
@@ -69,9 +76,9 @@ module WhopSDK
|
|
|
69
76
|
#
|
|
70
77
|
# - `courses:update`
|
|
71
78
|
#
|
|
72
|
-
# @overload update(id, assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, title: nil, visibility: nil, request_options: {})
|
|
79
|
+
# @overload update(id, assessment_completion_requirement: nil, assessment_questions: nil, attachments: nil, content: nil, days_from_course_start_until_unlock: nil, embed_id: nil, embed_type: nil, lesson_type: nil, main_pdf: nil, max_attempts: nil, mux_asset_id: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
|
|
73
80
|
#
|
|
74
|
-
# @param id [String]
|
|
81
|
+
# @param id [String] The ID of the lesson to update
|
|
75
82
|
#
|
|
76
83
|
# @param assessment_completion_requirement [WhopSDK::Models::CourseLessonUpdateParams::AssessmentCompletionRequirement, nil] Completion requirements for quiz/knowledge check lessons
|
|
77
84
|
#
|
|
@@ -83,6 +90,10 @@ module WhopSDK
|
|
|
83
90
|
#
|
|
84
91
|
# @param days_from_course_start_until_unlock [Integer, nil] Days from course start until unlock
|
|
85
92
|
#
|
|
93
|
+
# @param embed_id [String, nil] ID for the embed (YouTube video ID or Loom share ID)
|
|
94
|
+
#
|
|
95
|
+
# @param embed_type [Symbol, WhopSDK::Models::EmbedType, nil] The type of embed for a lesson
|
|
96
|
+
#
|
|
86
97
|
# @param lesson_type [Symbol, WhopSDK::Models::LessonTypes, nil] The available types for a lesson
|
|
87
98
|
#
|
|
88
99
|
# @param main_pdf [WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::MainPdf::AttachmentInputWithID, nil] The main PDF file for this lesson
|
|
@@ -91,6 +102,8 @@ module WhopSDK
|
|
|
91
102
|
#
|
|
92
103
|
# @param mux_asset_id [String, nil] The ID of the Mux asset to attach to this lesson for video lessons
|
|
93
104
|
#
|
|
105
|
+
# @param thumbnail [WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseLessonUpdateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the lesson in png, jpeg, or gif format
|
|
106
|
+
#
|
|
94
107
|
# @param title [String, nil] The title of the lesson
|
|
95
108
|
#
|
|
96
109
|
# @param visibility [Symbol, WhopSDK::Models::LessonVisibilities, nil] The available visibilities for a lesson. Determines how / whether a lesson is vi
|
|
@@ -156,7 +169,8 @@ module WhopSDK
|
|
|
156
169
|
#
|
|
157
170
|
# @overload delete(id, request_options: {})
|
|
158
171
|
#
|
|
159
|
-
# @param id [String]
|
|
172
|
+
# @param id [String] The ID of the lesson to delete
|
|
173
|
+
#
|
|
160
174
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
161
175
|
#
|
|
162
176
|
# @return [Boolean]
|
|
@@ -12,7 +12,8 @@ module WhopSDK
|
|
|
12
12
|
#
|
|
13
13
|
# @overload retrieve(id, request_options: {})
|
|
14
14
|
#
|
|
15
|
-
# @param id [String]
|
|
15
|
+
# @param id [String] The ID of the course student interaction
|
|
16
|
+
#
|
|
16
17
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
17
18
|
#
|
|
18
19
|
# @return [WhopSDK::Models::CourseStudentRetrieveResponse]
|
|
@@ -12,7 +12,7 @@ module WhopSDK
|
|
|
12
12
|
#
|
|
13
13
|
# - `courses:update`
|
|
14
14
|
#
|
|
15
|
-
# @overload create(experience_id:, title:, certificate_after_completion_enabled: nil, cover_image: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, request_options: {})
|
|
15
|
+
# @overload create(experience_id:, title:, certificate_after_completion_enabled: nil, cover_image: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, visibility: nil, request_options: {})
|
|
16
16
|
#
|
|
17
17
|
# @param experience_id [String] The ID of the experience to create the course in
|
|
18
18
|
#
|
|
@@ -22,12 +22,16 @@ module WhopSDK
|
|
|
22
22
|
#
|
|
23
23
|
# @param cover_image [String, nil] The cover image URL of the course
|
|
24
24
|
#
|
|
25
|
+
# @param order [String, nil] The decimal order position of the course within its experience. If not provided,
|
|
26
|
+
#
|
|
25
27
|
# @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
|
|
26
28
|
#
|
|
27
29
|
# @param tagline [String, nil] The tagline of the course
|
|
28
30
|
#
|
|
29
31
|
# @param thumbnail [WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithDirectUploadID, WhopSDK::Models::CourseCreateParams::Thumbnail::AttachmentInputWithID, nil] The thumbnail for the course in png, jpeg, or gif format
|
|
30
32
|
#
|
|
33
|
+
# @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
|
|
34
|
+
#
|
|
31
35
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
32
36
|
#
|
|
33
37
|
# @return [WhopSDK::Models::Course]
|
|
@@ -52,7 +56,8 @@ module WhopSDK
|
|
|
52
56
|
#
|
|
53
57
|
# @overload retrieve(id, request_options: {})
|
|
54
58
|
#
|
|
55
|
-
# @param id [String]
|
|
59
|
+
# @param id [String] The ID of the course
|
|
60
|
+
#
|
|
56
61
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
57
62
|
#
|
|
58
63
|
# @return [WhopSDK::Models::Course]
|
|
@@ -76,9 +81,9 @@ module WhopSDK
|
|
|
76
81
|
#
|
|
77
82
|
# - `courses:update`
|
|
78
83
|
#
|
|
79
|
-
# @overload update(id, certificate_after_completion_enabled: nil, chapters: nil, cover_image: nil, description: nil, language: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, request_options: {})
|
|
84
|
+
# @overload update(id, certificate_after_completion_enabled: nil, chapters: nil, cover_image: nil, description: nil, language: nil, order: nil, require_completing_lessons_in_order: nil, tagline: nil, thumbnail: nil, title: nil, visibility: nil, request_options: {})
|
|
80
85
|
#
|
|
81
|
-
# @param id [String]
|
|
86
|
+
# @param id [String] The ID of the course to update
|
|
82
87
|
#
|
|
83
88
|
# @param certificate_after_completion_enabled [Boolean, nil] Whether the course will award its students a PDF certificate after completing al
|
|
84
89
|
#
|
|
@@ -90,6 +95,8 @@ module WhopSDK
|
|
|
90
95
|
#
|
|
91
96
|
# @param language [Symbol, WhopSDK::Models::Languages, nil] The available languages for a course
|
|
92
97
|
#
|
|
98
|
+
# @param order [String, nil] The decimal order position of the course within its experience. Use fractional v
|
|
99
|
+
#
|
|
93
100
|
# @param require_completing_lessons_in_order [Boolean, nil] Whether the course requires students to complete the previous lesson before movi
|
|
94
101
|
#
|
|
95
102
|
# @param tagline [String, nil] A short tagline for the course
|
|
@@ -98,6 +105,8 @@ module WhopSDK
|
|
|
98
105
|
#
|
|
99
106
|
# @param title [String, nil] The title of the course
|
|
100
107
|
#
|
|
108
|
+
# @param visibility [Symbol, WhopSDK::Models::CourseVisibilities, nil] The available visibilities for a course. Determines how / whether a course is vi
|
|
109
|
+
#
|
|
101
110
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
102
111
|
#
|
|
103
112
|
# @return [WhopSDK::Models::Course]
|
|
@@ -159,7 +168,8 @@ module WhopSDK
|
|
|
159
168
|
#
|
|
160
169
|
# @overload delete(id, request_options: {})
|
|
161
170
|
#
|
|
162
|
-
# @param id [String]
|
|
171
|
+
# @param id [String] The ID of the course to delete
|
|
172
|
+
#
|
|
163
173
|
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
164
174
|
#
|
|
165
175
|
# @return [Boolean]
|
|
@@ -0,0 +1,182 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module WhopSDK
|
|
4
|
+
module Resources
|
|
5
|
+
class Disputes
|
|
6
|
+
# Retrieves a Dispute by ID
|
|
7
|
+
#
|
|
8
|
+
# Required permissions:
|
|
9
|
+
#
|
|
10
|
+
# - `payment:dispute:read`
|
|
11
|
+
# - `plan:basic:read`
|
|
12
|
+
# - `access_pass:basic:read`
|
|
13
|
+
# - `company:basic:read`
|
|
14
|
+
# - `payment:basic:read`
|
|
15
|
+
# - `member:email:read`
|
|
16
|
+
# - `member:basic:read`
|
|
17
|
+
# - `member:phone:read`
|
|
18
|
+
#
|
|
19
|
+
# @overload retrieve(id, request_options: {})
|
|
20
|
+
#
|
|
21
|
+
# @param id [String] The ID of the dispute
|
|
22
|
+
#
|
|
23
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
24
|
+
#
|
|
25
|
+
# @return [WhopSDK::Models::Dispute]
|
|
26
|
+
#
|
|
27
|
+
# @see WhopSDK::Models::DisputeRetrieveParams
|
|
28
|
+
def retrieve(id, params = {})
|
|
29
|
+
@client.request(
|
|
30
|
+
method: :get,
|
|
31
|
+
path: ["disputes/%1$s", id],
|
|
32
|
+
model: WhopSDK::Dispute,
|
|
33
|
+
options: params[:request_options]
|
|
34
|
+
)
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# Lists disputes the current actor has access to
|
|
38
|
+
#
|
|
39
|
+
# Required permissions:
|
|
40
|
+
#
|
|
41
|
+
# - `payment:dispute:read`
|
|
42
|
+
# - `plan:basic:read`
|
|
43
|
+
# - `access_pass:basic:read`
|
|
44
|
+
# - `company:basic:read`
|
|
45
|
+
# - `payment:basic:read`
|
|
46
|
+
#
|
|
47
|
+
# @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
|
|
48
|
+
#
|
|
49
|
+
# @param company_id [String] The ID of the company to list disputes for
|
|
50
|
+
#
|
|
51
|
+
# @param after [String, nil] Returns the elements in the list that come after the specified cursor.
|
|
52
|
+
#
|
|
53
|
+
# @param before [String, nil] Returns the elements in the list that come before the specified cursor.
|
|
54
|
+
#
|
|
55
|
+
# @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
|
|
56
|
+
#
|
|
57
|
+
# @param first [Integer, nil] Returns the first _n_ elements from the list.
|
|
58
|
+
#
|
|
59
|
+
# @param last [Integer, nil] Returns the last _n_ elements from the list.
|
|
60
|
+
#
|
|
61
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
62
|
+
#
|
|
63
|
+
# @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::DisputeListResponse>]
|
|
64
|
+
#
|
|
65
|
+
# @see WhopSDK::Models::DisputeListParams
|
|
66
|
+
def list(params)
|
|
67
|
+
parsed, options = WhopSDK::DisputeListParams.dump_request(params)
|
|
68
|
+
@client.request(
|
|
69
|
+
method: :get,
|
|
70
|
+
path: "disputes",
|
|
71
|
+
query: parsed,
|
|
72
|
+
page: WhopSDK::Internal::CursorPage,
|
|
73
|
+
model: WhopSDK::Models::DisputeListResponse,
|
|
74
|
+
options: options
|
|
75
|
+
)
|
|
76
|
+
end
|
|
77
|
+
|
|
78
|
+
# Some parameter documentations has been truncated, see
|
|
79
|
+
# {WhopSDK::Models::DisputeSubmitEvidenceParams} for more details.
|
|
80
|
+
#
|
|
81
|
+
# Submit a payment dispute to the payment processor for review. Once submitted, no
|
|
82
|
+
# further edits can be made.
|
|
83
|
+
#
|
|
84
|
+
# Required permissions:
|
|
85
|
+
#
|
|
86
|
+
# - `payment:dispute`
|
|
87
|
+
# - `plan:basic:read`
|
|
88
|
+
# - `access_pass:basic:read`
|
|
89
|
+
# - `company:basic:read`
|
|
90
|
+
# - `payment:basic:read`
|
|
91
|
+
# - `member:email:read`
|
|
92
|
+
# - `member:basic:read`
|
|
93
|
+
# - `member:phone:read`
|
|
94
|
+
#
|
|
95
|
+
# @overload submit_evidence(id, request_options: {})
|
|
96
|
+
#
|
|
97
|
+
# @param id [String] The ID of the dispute (Ex. dspt_xxxx) you want to finalize evidence submission f
|
|
98
|
+
#
|
|
99
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
100
|
+
#
|
|
101
|
+
# @return [WhopSDK::Models::Dispute]
|
|
102
|
+
#
|
|
103
|
+
# @see WhopSDK::Models::DisputeSubmitEvidenceParams
|
|
104
|
+
def submit_evidence(id, params = {})
|
|
105
|
+
@client.request(
|
|
106
|
+
method: :post,
|
|
107
|
+
path: ["disputes/%1$s/submit_evidence", id],
|
|
108
|
+
model: WhopSDK::Dispute,
|
|
109
|
+
options: params[:request_options]
|
|
110
|
+
)
|
|
111
|
+
end
|
|
112
|
+
|
|
113
|
+
# Update a dispute with evidence data to attempt to win the dispute.
|
|
114
|
+
#
|
|
115
|
+
# Required permissions:
|
|
116
|
+
#
|
|
117
|
+
# - `payment:dispute`
|
|
118
|
+
# - `plan:basic:read`
|
|
119
|
+
# - `access_pass:basic:read`
|
|
120
|
+
# - `company:basic:read`
|
|
121
|
+
# - `payment:basic:read`
|
|
122
|
+
# - `member:email:read`
|
|
123
|
+
# - `member:basic:read`
|
|
124
|
+
# - `member:phone:read`
|
|
125
|
+
#
|
|
126
|
+
# @overload update_evidence(id, access_activity_log: nil, billing_address: nil, cancellation_policy_attachment: nil, cancellation_policy_disclosure: nil, customer_communication_attachment: nil, customer_email_address: nil, customer_name: nil, notes: nil, product_description: nil, refund_policy_attachment: nil, refund_policy_disclosure: nil, refund_refusal_explanation: nil, service_date: nil, uncategorized_attachment: nil, request_options: {})
|
|
127
|
+
#
|
|
128
|
+
# @param id [String] The ID of the dispute you want to update.
|
|
129
|
+
#
|
|
130
|
+
# @param access_activity_log [String, nil] An IP access log for the user from Whop.
|
|
131
|
+
#
|
|
132
|
+
# @param billing_address [String, nil] The billing address of the user from their payment details.
|
|
133
|
+
#
|
|
134
|
+
# @param cancellation_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithID, nil] A file containing the cancellation policy from the company.
|
|
135
|
+
#
|
|
136
|
+
# @param cancellation_policy_disclosure [String, nil] A cancellation policy disclosure from the company.
|
|
137
|
+
#
|
|
138
|
+
# @param customer_communication_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithID, nil] A file containing the customer communication from the company (An image).
|
|
139
|
+
#
|
|
140
|
+
# @param customer_email_address [String, nil] The email of the customer from their payment details.
|
|
141
|
+
#
|
|
142
|
+
# @param customer_name [String, nil] The name of the customer from their payment details.
|
|
143
|
+
#
|
|
144
|
+
# @param notes [String, nil] Additional notes the company chooses to submit regarding the dispute.
|
|
145
|
+
#
|
|
146
|
+
# @param product_description [String, nil] The description of the product from the company.
|
|
147
|
+
#
|
|
148
|
+
# @param refund_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithID, nil] A file containing the refund policy from the company.
|
|
149
|
+
#
|
|
150
|
+
# @param refund_policy_disclosure [String, nil] A refund policy disclosure from the company.
|
|
151
|
+
#
|
|
152
|
+
# @param refund_refusal_explanation [String, nil] A description on why the refund is being refused by the company.
|
|
153
|
+
#
|
|
154
|
+
# @param service_date [String, nil] When the product was delivered by the company.
|
|
155
|
+
#
|
|
156
|
+
# @param uncategorized_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithID, nil] A file that does not fit in the other categories.
|
|
157
|
+
#
|
|
158
|
+
# @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
159
|
+
#
|
|
160
|
+
# @return [WhopSDK::Models::Dispute]
|
|
161
|
+
#
|
|
162
|
+
# @see WhopSDK::Models::DisputeUpdateEvidenceParams
|
|
163
|
+
def update_evidence(id, params = {})
|
|
164
|
+
parsed, options = WhopSDK::DisputeUpdateEvidenceParams.dump_request(params)
|
|
165
|
+
@client.request(
|
|
166
|
+
method: :post,
|
|
167
|
+
path: ["disputes/%1$s/update_evidence", id],
|
|
168
|
+
body: parsed,
|
|
169
|
+
model: WhopSDK::Dispute,
|
|
170
|
+
options: options
|
|
171
|
+
)
|
|
172
|
+
end
|
|
173
|
+
|
|
174
|
+
# @api private
|
|
175
|
+
#
|
|
176
|
+
# @param client [WhopSDK::Client]
|
|
177
|
+
def initialize(client:)
|
|
178
|
+
@client = client
|
|
179
|
+
end
|
|
180
|
+
end
|
|
181
|
+
end
|
|
182
|
+
end
|