whop_sdk 0.0.25 → 0.0.26

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.
Files changed (228) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +15 -0
  3. data/README.md +1 -1
  4. data/lib/whop_sdk/client.rb +4 -0
  5. data/lib/whop_sdk/internal/transport/pooled_net_requester.rb +1 -1
  6. data/lib/whop_sdk/models/{ai_chat_create_response.rb → ai_chat.rb} +5 -5
  7. data/lib/whop_sdk/models/api_version.rb +17 -0
  8. data/lib/whop_sdk/models/authorized_user_list_params.rb +9 -9
  9. data/lib/whop_sdk/models/authorized_user_list_response.rb +31 -1
  10. data/lib/whop_sdk/models/authorized_user_retrieve_response.rb +31 -1
  11. data/lib/whop_sdk/models/bot_token_transaction_types.rb +17 -0
  12. data/lib/whop_sdk/models/cancel_options.rb +22 -0
  13. data/lib/whop_sdk/models/{company_token_transaction_create_response.rb → company_token_transaction.rb} +16 -31
  14. data/lib/whop_sdk/models/company_token_transaction_list_params.rb +3 -17
  15. data/lib/whop_sdk/models/company_token_transaction_list_response.rb +3 -18
  16. data/lib/whop_sdk/models/dm_channel.rb +43 -0
  17. data/lib/whop_sdk/models/dm_channel_create_params.rb +38 -0
  18. data/lib/whop_sdk/models/dm_channel_delete_params.rb +14 -0
  19. data/lib/whop_sdk/models/dm_channel_delete_response.rb +8 -0
  20. data/lib/whop_sdk/models/dm_channel_list_params.rb +54 -0
  21. data/lib/whop_sdk/models/dm_channel_list_response.rb +43 -0
  22. data/lib/whop_sdk/models/dm_channel_retrieve_params.rb +14 -0
  23. data/lib/whop_sdk/models/dm_channel_update_params.rb +22 -0
  24. data/lib/whop_sdk/models/dm_feed_member_notification_preferences.rb +17 -0
  25. data/lib/whop_sdk/models/dm_feed_member_statuses.rb +19 -0
  26. data/lib/whop_sdk/models/{dm_member_create_response.rb → dm_member.rb} +8 -39
  27. data/lib/whop_sdk/models/dm_member_list_response.rb +3 -19
  28. data/lib/whop_sdk/models/dm_member_update_params.rb +6 -34
  29. data/lib/whop_sdk/models/file_create_response.rb +3 -18
  30. data/lib/whop_sdk/models/file_retrieve_response.rb +3 -18
  31. data/lib/whop_sdk/models/{lead_create_response.rb → lead.rb} +13 -13
  32. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +6 -63
  33. data/lib/whop_sdk/models/member_list_params.rb +9 -9
  34. data/lib/whop_sdk/models/membership.rb +3 -22
  35. data/lib/whop_sdk/models/membership_list_params.rb +3 -20
  36. data/lib/whop_sdk/models/membership_list_response.rb +3 -22
  37. data/lib/whop_sdk/models/payment.rb +63 -1
  38. data/lib/whop_sdk/models/payment_list_response.rb +63 -1
  39. data/lib/whop_sdk/models/payout_destination_category.rb +20 -0
  40. data/lib/whop_sdk/models/payout_method_created_webhook_event.rb +3 -20
  41. data/lib/whop_sdk/models/payout_method_list_response.rb +3 -20
  42. data/lib/whop_sdk/models/payout_method_retrieve_response.rb +3 -20
  43. data/lib/whop_sdk/models/upload_status.rb +18 -0
  44. data/lib/whop_sdk/models/verification_error_code.rb +33 -0
  45. data/lib/whop_sdk/models/verification_retrieve_response.rb +6 -62
  46. data/lib/whop_sdk/models/verification_status.rb +27 -0
  47. data/lib/whop_sdk/models/verification_succeeded_webhook_event.rb +6 -62
  48. data/lib/whop_sdk/models/webhook.rb +88 -0
  49. data/lib/whop_sdk/models/webhook_create_params.rb +6 -56
  50. data/lib/whop_sdk/models/webhook_create_response.rb +9 -97
  51. data/lib/whop_sdk/models/webhook_event.rb +41 -0
  52. data/lib/whop_sdk/models/webhook_list_response.rb +6 -57
  53. data/lib/whop_sdk/models/webhook_update_params.rb +6 -56
  54. data/lib/whop_sdk/models/{withdrawal_create_response.rb → withdrawal.rb} +15 -15
  55. data/lib/whop_sdk/models/withdrawal_created_webhook_event.rb +3 -267
  56. data/lib/whop_sdk/models/withdrawal_updated_webhook_event.rb +3 -267
  57. data/lib/whop_sdk/models.rb +44 -0
  58. data/lib/whop_sdk/resources/ai_chats.rb +6 -6
  59. data/lib/whop_sdk/resources/authorized_users.rb +4 -4
  60. data/lib/whop_sdk/resources/company_token_transactions.rb +5 -5
  61. data/lib/whop_sdk/resources/dm_channels.rb +151 -0
  62. data/lib/whop_sdk/resources/dm_members.rb +8 -8
  63. data/lib/whop_sdk/resources/leads.rb +6 -12
  64. data/lib/whop_sdk/resources/members.rb +4 -4
  65. data/lib/whop_sdk/resources/memberships.rb +1 -1
  66. data/lib/whop_sdk/resources/webhooks.rb +8 -8
  67. data/lib/whop_sdk/resources/withdrawals.rb +4 -4
  68. data/lib/whop_sdk/version.rb +1 -1
  69. data/lib/whop_sdk.rb +25 -15
  70. data/rbi/whop_sdk/client.rbi +3 -0
  71. data/rbi/whop_sdk/models/{ai_chat_update_response.rbi → ai_chat.rbi} +7 -17
  72. data/rbi/whop_sdk/models/api_version.rbi +21 -0
  73. data/rbi/whop_sdk/models/authorized_user_list_params.rbi +8 -8
  74. data/rbi/whop_sdk/models/authorized_user_list_response.rbi +47 -0
  75. data/rbi/whop_sdk/models/authorized_user_retrieve_response.rbi +49 -0
  76. data/rbi/whop_sdk/models/bot_token_transaction_types.rbi +28 -0
  77. data/rbi/whop_sdk/models/cancel_options.rbi +30 -0
  78. data/rbi/whop_sdk/models/{company_token_transaction_create_response.rbi → company_token_transaction.rbi} +20 -91
  79. data/rbi/whop_sdk/models/company_token_transaction_list_params.rbi +3 -53
  80. data/rbi/whop_sdk/models/company_token_transaction_list_response.rbi +3 -49
  81. data/rbi/whop_sdk/models/dm_channel.rbi +60 -0
  82. data/rbi/whop_sdk/models/dm_channel_create_params.rbi +59 -0
  83. data/rbi/whop_sdk/models/dm_channel_delete_params.rbi +27 -0
  84. data/rbi/whop_sdk/models/dm_channel_delete_response.rbi +8 -0
  85. data/rbi/whop_sdk/models/dm_channel_list_params.rbi +75 -0
  86. data/rbi/whop_sdk/models/dm_channel_list_response.rbi +65 -0
  87. data/rbi/whop_sdk/models/dm_channel_retrieve_params.rbi +27 -0
  88. data/rbi/whop_sdk/models/dm_channel_update_params.rbi +43 -0
  89. data/rbi/whop_sdk/models/dm_feed_member_notification_preferences.rbi +34 -0
  90. data/rbi/whop_sdk/models/dm_feed_member_statuses.rbi +26 -0
  91. data/rbi/whop_sdk/models/dm_member.rbi +82 -0
  92. data/rbi/whop_sdk/models/dm_member_list_response.rbi +3 -52
  93. data/rbi/whop_sdk/models/dm_member_update_params.rbi +6 -79
  94. data/rbi/whop_sdk/models/file_create_response.rbi +3 -49
  95. data/rbi/whop_sdk/models/file_retrieve_response.rbi +3 -51
  96. data/rbi/whop_sdk/models/{lead_update_response.rbi → lead.rbi} +17 -42
  97. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +6 -230
  98. data/rbi/whop_sdk/models/member_list_params.rbi +8 -8
  99. data/rbi/whop_sdk/models/membership.rbi +3 -47
  100. data/rbi/whop_sdk/models/membership_list_params.rbi +3 -70
  101. data/rbi/whop_sdk/models/membership_list_response.rbi +3 -73
  102. data/rbi/whop_sdk/models/payment.rbi +88 -0
  103. data/rbi/whop_sdk/models/payment_list_response.rbi +100 -0
  104. data/rbi/whop_sdk/models/payout_destination_category.rbi +33 -0
  105. data/rbi/whop_sdk/models/payout_method_created_webhook_event.rbi +3 -64
  106. data/rbi/whop_sdk/models/payout_method_list_response.rbi +3 -64
  107. data/rbi/whop_sdk/models/payout_method_retrieve_response.rbi +3 -64
  108. data/rbi/whop_sdk/models/upload_status.rbi +22 -0
  109. data/rbi/whop_sdk/models/verification_error_code.rbi +101 -0
  110. data/rbi/whop_sdk/models/verification_retrieve_response.rbi +6 -230
  111. data/rbi/whop_sdk/models/verification_status.rbi +38 -0
  112. data/rbi/whop_sdk/models/verification_succeeded_webhook_event.rbi +6 -232
  113. data/rbi/whop_sdk/models/webhook.rbi +104 -0
  114. data/rbi/whop_sdk/models/webhook_create_params.rbi +6 -194
  115. data/rbi/whop_sdk/models/webhook_create_response.rbi +9 -386
  116. data/rbi/whop_sdk/models/webhook_event.rbi +79 -0
  117. data/rbi/whop_sdk/models/webhook_list_response.rbi +6 -210
  118. data/rbi/whop_sdk/models/webhook_update_params.rbi +6 -194
  119. data/rbi/whop_sdk/models/{withdrawal_create_response.rbi → withdrawal.rbi} +63 -127
  120. data/rbi/whop_sdk/models/withdrawal_created_webhook_event.rbi +4 -571
  121. data/rbi/whop_sdk/models/withdrawal_updated_webhook_event.rbi +4 -571
  122. data/rbi/whop_sdk/models.rbi +45 -0
  123. data/rbi/whop_sdk/resources/ai_chats.rbi +3 -3
  124. data/rbi/whop_sdk/resources/authorized_users.rbi +3 -3
  125. data/rbi/whop_sdk/resources/company_token_transactions.rbi +3 -5
  126. data/rbi/whop_sdk/resources/dm_channels.rbi +121 -0
  127. data/rbi/whop_sdk/resources/dm_members.rbi +5 -7
  128. data/rbi/whop_sdk/resources/leads.rbi +3 -3
  129. data/rbi/whop_sdk/resources/members.rbi +3 -3
  130. data/rbi/whop_sdk/resources/memberships.rbi +1 -4
  131. data/rbi/whop_sdk/resources/webhooks.rbi +6 -10
  132. data/rbi/whop_sdk/resources/withdrawals.rbi +2 -2
  133. data/sig/whop_sdk/client.rbs +2 -0
  134. data/sig/whop_sdk/models/{ai_chat_update_response.rbs → ai_chat.rbs} +6 -6
  135. data/sig/whop_sdk/models/api_version.rbs +15 -0
  136. data/sig/whop_sdk/models/authorized_user_list_params.rbs +5 -5
  137. data/sig/whop_sdk/models/authorized_user_list_response.rbs +17 -0
  138. data/sig/whop_sdk/models/authorized_user_retrieve_response.rbs +17 -0
  139. data/sig/whop_sdk/models/bot_token_transaction_types.rbs +15 -0
  140. data/sig/whop_sdk/models/cancel_options.rbs +26 -0
  141. data/sig/whop_sdk/models/{company_token_transaction_create_response.rbs → company_token_transaction.rbs} +18 -30
  142. data/sig/whop_sdk/models/company_token_transaction_list_params.rbs +4 -16
  143. data/sig/whop_sdk/models/company_token_transaction_list_response.rbs +4 -16
  144. data/sig/whop_sdk/models/dm_channel.rbs +30 -0
  145. data/sig/whop_sdk/models/dm_channel_create_params.rbs +36 -0
  146. data/sig/whop_sdk/models/dm_channel_delete_params.rbs +15 -0
  147. data/sig/whop_sdk/models/dm_channel_delete_response.rbs +5 -0
  148. data/sig/whop_sdk/models/dm_channel_list_params.rbs +46 -0
  149. data/sig/whop_sdk/models/dm_channel_list_response.rbs +30 -0
  150. data/sig/whop_sdk/models/dm_channel_retrieve_params.rbs +15 -0
  151. data/sig/whop_sdk/models/dm_channel_update_params.rbs +23 -0
  152. data/sig/whop_sdk/models/dm_feed_member_notification_preferences.rbs +15 -0
  153. data/sig/whop_sdk/models/dm_feed_member_statuses.rbs +18 -0
  154. data/sig/whop_sdk/models/dm_member.rbs +45 -0
  155. data/sig/whop_sdk/models/dm_member_list_response.rbs +4 -18
  156. data/sig/whop_sdk/models/dm_member_update_params.rbs +8 -34
  157. data/sig/whop_sdk/models/file_create_response.rbs +4 -17
  158. data/sig/whop_sdk/models/file_retrieve_response.rbs +4 -17
  159. data/sig/whop_sdk/models/{lead_update_response.rbs → lead.rbs} +14 -14
  160. data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +8 -90
  161. data/sig/whop_sdk/models/member_list_params.rbs +5 -5
  162. data/sig/whop_sdk/models/membership.rbs +4 -27
  163. data/sig/whop_sdk/models/membership_list_params.rbs +4 -27
  164. data/sig/whop_sdk/models/membership_list_response.rbs +4 -27
  165. data/sig/whop_sdk/models/payment.rbs +47 -0
  166. data/sig/whop_sdk/models/payment_list_response.rbs +47 -0
  167. data/sig/whop_sdk/models/payout_destination_category.rbs +19 -0
  168. data/sig/whop_sdk/models/payout_method_created_webhook_event.rbs +4 -25
  169. data/sig/whop_sdk/models/payout_method_list_response.rbs +4 -25
  170. data/sig/whop_sdk/models/payout_method_retrieve_response.rbs +4 -25
  171. data/sig/whop_sdk/models/upload_status.rbs +16 -0
  172. data/sig/whop_sdk/models/verification_error_code.rbs +50 -0
  173. data/sig/whop_sdk/models/verification_retrieve_response.rbs +8 -90
  174. data/sig/whop_sdk/models/verification_status.rbs +38 -0
  175. data/sig/whop_sdk/models/verification_succeeded_webhook_event.rbs +8 -90
  176. data/sig/whop_sdk/models/webhook.rbs +60 -0
  177. data/sig/whop_sdk/models/webhook_create_params.rbs +8 -83
  178. data/sig/whop_sdk/models/webhook_create_response.rbs +12 -150
  179. data/sig/whop_sdk/models/webhook_event.rbs +66 -0
  180. data/sig/whop_sdk/models/webhook_list_response.rbs +8 -83
  181. data/sig/whop_sdk/models/webhook_update_params.rbs +8 -83
  182. data/sig/whop_sdk/models/{withdrawal_create_response.rbs → withdrawal.rbs} +15 -15
  183. data/sig/whop_sdk/models/withdrawal_created_webhook_event.rbs +4 -241
  184. data/sig/whop_sdk/models/withdrawal_updated_webhook_event.rbs +4 -241
  185. data/sig/whop_sdk/models.rbs +44 -0
  186. data/sig/whop_sdk/resources/ai_chats.rbs +3 -3
  187. data/sig/whop_sdk/resources/authorized_users.rbs +1 -1
  188. data/sig/whop_sdk/resources/company_token_transactions.rbs +3 -3
  189. data/sig/whop_sdk/resources/dm_channels.rbs +36 -0
  190. data/sig/whop_sdk/resources/dm_members.rbs +5 -5
  191. data/sig/whop_sdk/resources/leads.rbs +3 -3
  192. data/sig/whop_sdk/resources/members.rbs +1 -1
  193. data/sig/whop_sdk/resources/memberships.rbs +1 -1
  194. data/sig/whop_sdk/resources/webhooks.rbs +6 -6
  195. data/sig/whop_sdk/resources/withdrawals.rbs +2 -2
  196. metadata +77 -47
  197. data/lib/whop_sdk/models/ai_chat_retrieve_response.rb +0 -89
  198. data/lib/whop_sdk/models/ai_chat_update_response.rb +0 -89
  199. data/lib/whop_sdk/models/company_token_transaction_retrieve_response.rb +0 -180
  200. data/lib/whop_sdk/models/dm_member_retrieve_response.rb +0 -94
  201. data/lib/whop_sdk/models/dm_member_update_response.rb +0 -94
  202. data/lib/whop_sdk/models/lead_retrieve_response.rb +0 -149
  203. data/lib/whop_sdk/models/lead_update_response.rb +0 -149
  204. data/lib/whop_sdk/models/webhook_retrieve_response.rb +0 -176
  205. data/lib/whop_sdk/models/webhook_update_response.rb +0 -176
  206. data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +0 -268
  207. data/rbi/whop_sdk/models/ai_chat_create_response.rbi +0 -128
  208. data/rbi/whop_sdk/models/ai_chat_retrieve_response.rbi +0 -128
  209. data/rbi/whop_sdk/models/company_token_transaction_retrieve_response.rbi +0 -312
  210. data/rbi/whop_sdk/models/dm_member_create_response.rbi +0 -179
  211. data/rbi/whop_sdk/models/dm_member_retrieve_response.rbi +0 -179
  212. data/rbi/whop_sdk/models/dm_member_update_response.rbi +0 -179
  213. data/rbi/whop_sdk/models/lead_create_response.rbi +0 -234
  214. data/rbi/whop_sdk/models/lead_retrieve_response.rbi +0 -238
  215. data/rbi/whop_sdk/models/webhook_retrieve_response.rbi +0 -491
  216. data/rbi/whop_sdk/models/webhook_update_response.rbi +0 -486
  217. data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +0 -568
  218. data/sig/whop_sdk/models/ai_chat_create_response.rbs +0 -65
  219. data/sig/whop_sdk/models/ai_chat_retrieve_response.rbs +0 -65
  220. data/sig/whop_sdk/models/company_token_transaction_retrieve_response.rbs +0 -115
  221. data/sig/whop_sdk/models/dm_member_create_response.rbs +0 -71
  222. data/sig/whop_sdk/models/dm_member_retrieve_response.rbs +0 -71
  223. data/sig/whop_sdk/models/dm_member_update_response.rbs +0 -71
  224. data/sig/whop_sdk/models/lead_create_response.rbs +0 -104
  225. data/sig/whop_sdk/models/lead_retrieve_response.rbs +0 -104
  226. data/sig/whop_sdk/models/webhook_retrieve_response.rbs +0 -198
  227. data/sig/whop_sdk/models/webhook_update_response.rbs +0 -198
  228. data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +0 -240
@@ -1,176 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module WhopSDK
4
- module Models
5
- # @see WhopSDK::Resources::Webhooks#retrieve
6
- class WebhookRetrieveResponse < WhopSDK::Internal::Type::BaseModel
7
- # @!attribute id
8
- # The ID of the webhook
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!attribute api_version
14
- # The API version for this webhook
15
- #
16
- # @return [Symbol, WhopSDK::Models::WebhookRetrieveResponse::APIVersion]
17
- required :api_version, enum: -> { WhopSDK::Models::WebhookRetrieveResponse::APIVersion }
18
-
19
- # @!attribute child_resource_events
20
- # Whether or not to send events for child resources. For example, if the webhook
21
- # is created for a Company, enabling this will only send events from the Company's
22
- # sub-merchants (child companies).
23
- #
24
- # @return [Boolean]
25
- required :child_resource_events, WhopSDK::Internal::Type::Boolean
26
-
27
- # @!attribute created_at
28
- # The timestamp of when the webhook was created
29
- #
30
- # @return [Time]
31
- required :created_at, Time
32
-
33
- # @!attribute enabled
34
- # Whether or not this webhook is turned on or not
35
- #
36
- # @return [Boolean]
37
- required :enabled, WhopSDK::Internal::Type::Boolean
38
-
39
- # @!attribute events
40
- # The number of events this webhooks is configured to receive
41
- #
42
- # @return [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::Event>]
43
- required :events,
44
- -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookRetrieveResponse::Event] }
45
-
46
- # @!attribute resource_id
47
- # The resource ID
48
- #
49
- # @return [String]
50
- required :resource_id, String
51
-
52
- # @!attribute testable_events
53
- # The list of events that can be tested with this webhook
54
- #
55
- # @return [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::TestableEvent>]
56
- required :testable_events,
57
- -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookRetrieveResponse::TestableEvent] }
58
-
59
- # @!attribute url
60
- # The URL the webhook events will be sent to
61
- #
62
- # @return [String]
63
- required :url, String
64
-
65
- # @!method initialize(id:, api_version:, child_resource_events:, created_at:, enabled:, events:, resource_id:, testable_events:, url:)
66
- # Some parameter documentations has been truncated, see
67
- # {WhopSDK::Models::WebhookRetrieveResponse} for more details.
68
- #
69
- # A webhook object, which can be configured to be sent updates about a company
70
- #
71
- # @param id [String] The ID of the webhook
72
- #
73
- # @param api_version [Symbol, WhopSDK::Models::WebhookRetrieveResponse::APIVersion] The API version for this webhook
74
- #
75
- # @param child_resource_events [Boolean] Whether or not to send events for child resources. For example, if the webhook i
76
- #
77
- # @param created_at [Time] The timestamp of when the webhook was created
78
- #
79
- # @param enabled [Boolean] Whether or not this webhook is turned on or not
80
- #
81
- # @param events [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::Event>] The number of events this webhooks is configured to receive
82
- #
83
- # @param resource_id [String] The resource ID
84
- #
85
- # @param testable_events [Array<Symbol, WhopSDK::Models::WebhookRetrieveResponse::TestableEvent>] The list of events that can be tested with this webhook
86
- #
87
- # @param url [String] The URL the webhook events will be sent to
88
-
89
- # The API version for this webhook
90
- #
91
- # @see WhopSDK::Models::WebhookRetrieveResponse#api_version
92
- module APIVersion
93
- extend WhopSDK::Internal::Type::Enum
94
-
95
- V1 = :v1
96
- V2 = :v2
97
- V5 = :v5
98
-
99
- # @!method self.values
100
- # @return [Array<Symbol>]
101
- end
102
-
103
- # The different event types available
104
- module Event
105
- extend WhopSDK::Internal::Type::Enum
106
-
107
- INVOICE_CREATED = :"invoice.created"
108
- INVOICE_PAID = :"invoice.paid"
109
- INVOICE_PAST_DUE = :"invoice.past_due"
110
- INVOICE_VOIDED = :"invoice.voided"
111
- MEMBERSHIP_ACTIVATED = :"membership.activated"
112
- MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
113
- ENTRY_CREATED = :"entry.created"
114
- ENTRY_APPROVED = :"entry.approved"
115
- ENTRY_DENIED = :"entry.denied"
116
- ENTRY_DELETED = :"entry.deleted"
117
- SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
118
- SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
119
- SETUP_INTENT_CANCELED = :"setup_intent.canceled"
120
- WITHDRAWAL_CREATED = :"withdrawal.created"
121
- WITHDRAWAL_UPDATED = :"withdrawal.updated"
122
- COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
123
- PAYOUT_METHOD_CREATED = :"payout_method.created"
124
- VERIFICATION_SUCCEEDED = :"verification.succeeded"
125
- PAYMENT_CREATED = :"payment.created"
126
- PAYMENT_SUCCEEDED = :"payment.succeeded"
127
- PAYMENT_FAILED = :"payment.failed"
128
- PAYMENT_PENDING = :"payment.pending"
129
- DISPUTE_CREATED = :"dispute.created"
130
- DISPUTE_UPDATED = :"dispute.updated"
131
- REFUND_CREATED = :"refund.created"
132
- REFUND_UPDATED = :"refund.updated"
133
- MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
134
-
135
- # @!method self.values
136
- # @return [Array<Symbol>]
137
- end
138
-
139
- # The different event types available
140
- module TestableEvent
141
- extend WhopSDK::Internal::Type::Enum
142
-
143
- INVOICE_CREATED = :"invoice.created"
144
- INVOICE_PAID = :"invoice.paid"
145
- INVOICE_PAST_DUE = :"invoice.past_due"
146
- INVOICE_VOIDED = :"invoice.voided"
147
- MEMBERSHIP_ACTIVATED = :"membership.activated"
148
- MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
149
- ENTRY_CREATED = :"entry.created"
150
- ENTRY_APPROVED = :"entry.approved"
151
- ENTRY_DENIED = :"entry.denied"
152
- ENTRY_DELETED = :"entry.deleted"
153
- SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
154
- SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
155
- SETUP_INTENT_CANCELED = :"setup_intent.canceled"
156
- WITHDRAWAL_CREATED = :"withdrawal.created"
157
- WITHDRAWAL_UPDATED = :"withdrawal.updated"
158
- COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
159
- PAYOUT_METHOD_CREATED = :"payout_method.created"
160
- VERIFICATION_SUCCEEDED = :"verification.succeeded"
161
- PAYMENT_CREATED = :"payment.created"
162
- PAYMENT_SUCCEEDED = :"payment.succeeded"
163
- PAYMENT_FAILED = :"payment.failed"
164
- PAYMENT_PENDING = :"payment.pending"
165
- DISPUTE_CREATED = :"dispute.created"
166
- DISPUTE_UPDATED = :"dispute.updated"
167
- REFUND_CREATED = :"refund.created"
168
- REFUND_UPDATED = :"refund.updated"
169
- MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
170
-
171
- # @!method self.values
172
- # @return [Array<Symbol>]
173
- end
174
- end
175
- end
176
- end
@@ -1,176 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module WhopSDK
4
- module Models
5
- # @see WhopSDK::Resources::Webhooks#update
6
- class WebhookUpdateResponse < WhopSDK::Internal::Type::BaseModel
7
- # @!attribute id
8
- # The ID of the webhook
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!attribute api_version
14
- # The API version for this webhook
15
- #
16
- # @return [Symbol, WhopSDK::Models::WebhookUpdateResponse::APIVersion]
17
- required :api_version, enum: -> { WhopSDK::Models::WebhookUpdateResponse::APIVersion }
18
-
19
- # @!attribute child_resource_events
20
- # Whether or not to send events for child resources. For example, if the webhook
21
- # is created for a Company, enabling this will only send events from the Company's
22
- # sub-merchants (child companies).
23
- #
24
- # @return [Boolean]
25
- required :child_resource_events, WhopSDK::Internal::Type::Boolean
26
-
27
- # @!attribute created_at
28
- # The timestamp of when the webhook was created
29
- #
30
- # @return [Time]
31
- required :created_at, Time
32
-
33
- # @!attribute enabled
34
- # Whether or not this webhook is turned on or not
35
- #
36
- # @return [Boolean]
37
- required :enabled, WhopSDK::Internal::Type::Boolean
38
-
39
- # @!attribute events
40
- # The number of events this webhooks is configured to receive
41
- #
42
- # @return [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::Event>]
43
- required :events,
44
- -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookUpdateResponse::Event] }
45
-
46
- # @!attribute resource_id
47
- # The resource ID
48
- #
49
- # @return [String]
50
- required :resource_id, String
51
-
52
- # @!attribute testable_events
53
- # The list of events that can be tested with this webhook
54
- #
55
- # @return [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::TestableEvent>]
56
- required :testable_events,
57
- -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Models::WebhookUpdateResponse::TestableEvent] }
58
-
59
- # @!attribute url
60
- # The URL the webhook events will be sent to
61
- #
62
- # @return [String]
63
- required :url, String
64
-
65
- # @!method initialize(id:, api_version:, child_resource_events:, created_at:, enabled:, events:, resource_id:, testable_events:, url:)
66
- # Some parameter documentations has been truncated, see
67
- # {WhopSDK::Models::WebhookUpdateResponse} for more details.
68
- #
69
- # A webhook object, which can be configured to be sent updates about a company
70
- #
71
- # @param id [String] The ID of the webhook
72
- #
73
- # @param api_version [Symbol, WhopSDK::Models::WebhookUpdateResponse::APIVersion] The API version for this webhook
74
- #
75
- # @param child_resource_events [Boolean] Whether or not to send events for child resources. For example, if the webhook i
76
- #
77
- # @param created_at [Time] The timestamp of when the webhook was created
78
- #
79
- # @param enabled [Boolean] Whether or not this webhook is turned on or not
80
- #
81
- # @param events [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::Event>] The number of events this webhooks is configured to receive
82
- #
83
- # @param resource_id [String] The resource ID
84
- #
85
- # @param testable_events [Array<Symbol, WhopSDK::Models::WebhookUpdateResponse::TestableEvent>] The list of events that can be tested with this webhook
86
- #
87
- # @param url [String] The URL the webhook events will be sent to
88
-
89
- # The API version for this webhook
90
- #
91
- # @see WhopSDK::Models::WebhookUpdateResponse#api_version
92
- module APIVersion
93
- extend WhopSDK::Internal::Type::Enum
94
-
95
- V1 = :v1
96
- V2 = :v2
97
- V5 = :v5
98
-
99
- # @!method self.values
100
- # @return [Array<Symbol>]
101
- end
102
-
103
- # The different event types available
104
- module Event
105
- extend WhopSDK::Internal::Type::Enum
106
-
107
- INVOICE_CREATED = :"invoice.created"
108
- INVOICE_PAID = :"invoice.paid"
109
- INVOICE_PAST_DUE = :"invoice.past_due"
110
- INVOICE_VOIDED = :"invoice.voided"
111
- MEMBERSHIP_ACTIVATED = :"membership.activated"
112
- MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
113
- ENTRY_CREATED = :"entry.created"
114
- ENTRY_APPROVED = :"entry.approved"
115
- ENTRY_DENIED = :"entry.denied"
116
- ENTRY_DELETED = :"entry.deleted"
117
- SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
118
- SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
119
- SETUP_INTENT_CANCELED = :"setup_intent.canceled"
120
- WITHDRAWAL_CREATED = :"withdrawal.created"
121
- WITHDRAWAL_UPDATED = :"withdrawal.updated"
122
- COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
123
- PAYOUT_METHOD_CREATED = :"payout_method.created"
124
- VERIFICATION_SUCCEEDED = :"verification.succeeded"
125
- PAYMENT_CREATED = :"payment.created"
126
- PAYMENT_SUCCEEDED = :"payment.succeeded"
127
- PAYMENT_FAILED = :"payment.failed"
128
- PAYMENT_PENDING = :"payment.pending"
129
- DISPUTE_CREATED = :"dispute.created"
130
- DISPUTE_UPDATED = :"dispute.updated"
131
- REFUND_CREATED = :"refund.created"
132
- REFUND_UPDATED = :"refund.updated"
133
- MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
134
-
135
- # @!method self.values
136
- # @return [Array<Symbol>]
137
- end
138
-
139
- # The different event types available
140
- module TestableEvent
141
- extend WhopSDK::Internal::Type::Enum
142
-
143
- INVOICE_CREATED = :"invoice.created"
144
- INVOICE_PAID = :"invoice.paid"
145
- INVOICE_PAST_DUE = :"invoice.past_due"
146
- INVOICE_VOIDED = :"invoice.voided"
147
- MEMBERSHIP_ACTIVATED = :"membership.activated"
148
- MEMBERSHIP_DEACTIVATED = :"membership.deactivated"
149
- ENTRY_CREATED = :"entry.created"
150
- ENTRY_APPROVED = :"entry.approved"
151
- ENTRY_DENIED = :"entry.denied"
152
- ENTRY_DELETED = :"entry.deleted"
153
- SETUP_INTENT_REQUIRES_ACTION = :"setup_intent.requires_action"
154
- SETUP_INTENT_SUCCEEDED = :"setup_intent.succeeded"
155
- SETUP_INTENT_CANCELED = :"setup_intent.canceled"
156
- WITHDRAWAL_CREATED = :"withdrawal.created"
157
- WITHDRAWAL_UPDATED = :"withdrawal.updated"
158
- COURSE_LESSON_INTERACTION_COMPLETED = :"course_lesson_interaction.completed"
159
- PAYOUT_METHOD_CREATED = :"payout_method.created"
160
- VERIFICATION_SUCCEEDED = :"verification.succeeded"
161
- PAYMENT_CREATED = :"payment.created"
162
- PAYMENT_SUCCEEDED = :"payment.succeeded"
163
- PAYMENT_FAILED = :"payment.failed"
164
- PAYMENT_PENDING = :"payment.pending"
165
- DISPUTE_CREATED = :"dispute.created"
166
- DISPUTE_UPDATED = :"dispute.updated"
167
- REFUND_CREATED = :"refund.created"
168
- REFUND_UPDATED = :"refund.updated"
169
- MEMBERSHIP_CANCEL_AT_PERIOD_END_CHANGED = :"membership.cancel_at_period_end_changed"
170
-
171
- # @!method self.values
172
- # @return [Array<Symbol>]
173
- end
174
- end
175
- end
176
- end
@@ -1,268 +0,0 @@
1
- # frozen_string_literal: true
2
-
3
- module WhopSDK
4
- module Models
5
- # @see WhopSDK::Resources::Withdrawals#retrieve
6
- class WithdrawalRetrieveResponse < WhopSDK::Internal::Type::BaseModel
7
- # @!attribute id
8
- # Internal ID of the withdrawal request.
9
- #
10
- # @return [String]
11
- required :id, String
12
-
13
- # @!attribute amount
14
- # How much money was attempted to be withdrawn, in a float type.
15
- #
16
- # @return [Float]
17
- required :amount, Float
18
-
19
- # @!attribute created_at
20
- # When the withdrawal request was created.
21
- #
22
- # @return [Time]
23
- required :created_at, Time
24
-
25
- # @!attribute currency
26
- # The currency of the withdrawal request.
27
- #
28
- # @return [Symbol, WhopSDK::Models::Currency]
29
- required :currency, enum: -> { WhopSDK::Currency }
30
-
31
- # @!attribute error_code
32
- # The different error codes a payout can be in.
33
- #
34
- # @return [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode, nil]
35
- required :error_code, enum: -> { WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode }, nil?: true
36
-
37
- # @!attribute error_message
38
- # The error message for the withdrawal, if any.
39
- #
40
- # @return [String, nil]
41
- required :error_message, String, nil?: true
42
-
43
- # @!attribute estimated_availability
44
- # The estimated availability date for the withdrawal, if any.
45
- #
46
- # @return [Time, nil]
47
- required :estimated_availability, Time, nil?: true
48
-
49
- # @!attribute fee_amount
50
- # The fee amount that was charged for the withdrawal. This is in the same currency
51
- # as the withdrawal amount.
52
- #
53
- # @return [Float]
54
- required :fee_amount, Float
55
-
56
- # @!attribute fee_type
57
- # The different fee types for a withdrawal.
58
- #
59
- # @return [Symbol, WhopSDK::Models::WithdrawalFeeTypes, nil]
60
- required :fee_type, enum: -> { WhopSDK::WithdrawalFeeTypes }, nil?: true
61
-
62
- # @!attribute ledger_account
63
- # The ledger account associated with the withdrawal.
64
- #
65
- # @return [WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount]
66
- required :ledger_account, -> { WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount }
67
-
68
- # @!attribute markup_fee
69
- # The markup fee that was charged for the withdrawal. This is in the same currency
70
- # as the withdrawal amount. This only applies to platform accounts using Whop
71
- # Rails.
72
- #
73
- # @return [Float]
74
- required :markup_fee, Float
75
-
76
- # @!attribute payout_token
77
- # The payout token used for the withdrawal, if applicable.
78
- #
79
- # @return [WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken, nil]
80
- required :payout_token, -> { WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken }, nil?: true
81
-
82
- # @!attribute speed
83
- # The speed of the withdrawal.
84
- #
85
- # @return [Symbol, WhopSDK::Models::WithdrawalSpeeds]
86
- required :speed, enum: -> { WhopSDK::WithdrawalSpeeds }
87
-
88
- # @!attribute status
89
- # Status of the withdrawal.
90
- #
91
- # @return [Symbol, WhopSDK::Models::WithdrawalStatus]
92
- required :status, enum: -> { WhopSDK::WithdrawalStatus }
93
-
94
- # @!attribute trace_code
95
- # The trace code for the payout, if applicable. Provided on ACH transactions when
96
- # available.
97
- #
98
- # @return [String, nil]
99
- required :trace_code, String, nil?: true
100
-
101
- # @!method initialize(id:, amount:, created_at:, currency:, error_code:, error_message:, estimated_availability:, fee_amount:, fee_type:, ledger_account:, markup_fee:, payout_token:, speed:, status:, trace_code:)
102
- # Some parameter documentations has been truncated, see
103
- # {WhopSDK::Models::WithdrawalRetrieveResponse} for more details.
104
- #
105
- # A withdrawal request.
106
- #
107
- # @param id [String] Internal ID of the withdrawal request.
108
- #
109
- # @param amount [Float] How much money was attempted to be withdrawn, in a float type.
110
- #
111
- # @param created_at [Time] When the withdrawal request was created.
112
- #
113
- # @param currency [Symbol, WhopSDK::Models::Currency] The currency of the withdrawal request.
114
- #
115
- # @param error_code [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::ErrorCode, nil] The different error codes a payout can be in.
116
- #
117
- # @param error_message [String, nil] The error message for the withdrawal, if any.
118
- #
119
- # @param estimated_availability [Time, nil] The estimated availability date for the withdrawal, if any.
120
- #
121
- # @param fee_amount [Float] The fee amount that was charged for the withdrawal. This is in the same currency
122
- #
123
- # @param fee_type [Symbol, WhopSDK::Models::WithdrawalFeeTypes, nil] The different fee types for a withdrawal.
124
- #
125
- # @param ledger_account [WhopSDK::Models::WithdrawalRetrieveResponse::LedgerAccount] The ledger account associated with the withdrawal.
126
- #
127
- # @param markup_fee [Float] The markup fee that was charged for the withdrawal. This is in the same currency
128
- #
129
- # @param payout_token [WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken, nil] The payout token used for the withdrawal, if applicable.
130
- #
131
- # @param speed [Symbol, WhopSDK::Models::WithdrawalSpeeds] The speed of the withdrawal.
132
- #
133
- # @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
134
- #
135
- # @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
136
-
137
- # The different error codes a payout can be in.
138
- #
139
- # @see WhopSDK::Models::WithdrawalRetrieveResponse#error_code
140
- module ErrorCode
141
- extend WhopSDK::Internal::Type::Enum
142
-
143
- ACCOUNT_CLOSED = :account_closed
144
- ACCOUNT_DOES_NOT_EXIST = :account_does_not_exist
145
- ACCOUNT_INFORMATION_INVALID = :account_information_invalid
146
- ACCOUNT_NUMBER_INVALID_REGION = :account_number_invalid_region
147
- ACCOUNT_FROZEN = :account_frozen
148
- ACCOUNT_LOOKUP_FAILED = :account_lookup_failed
149
- ACCOUNT_NOT_FOUND = :account_not_found
150
- AMOUNT_OUT_OF_BOUNDS = :amount_out_of_bounds
151
- ATTRIBUTES_NOT_VALIDATED = :attributes_not_validated
152
- B2B_PAYMENTS_PROHIBITED = :b2b_payments_prohibited
153
- BANK_STATEMENT_REQUIRED = :bank_statement_required
154
- COMPLIANCE_REVIEW = :compliance_review
155
- CURRENCY_NOT_SUPPORTED = :currency_not_supported
156
- DEPOSIT_CANCELED = :deposit_canceled
157
- DEPOSIT_FAILED = :deposit_failed
158
- DEPOSIT_REJECTED = :deposit_rejected
159
- DESTINATION_UNAVAILABLE = :destination_unavailable
160
- EXCEEDED_ACCOUNT_LIMIT = :exceeded_account_limit
161
- EXPIRED_QUOTE = :expired_quote
162
- GENERIC_PAYOUT_ERROR = :generic_payout_error
163
- TECHNICAL_PROBLEM = :technical_problem
164
- IDENTIFICATION_NUMBER_INVALID = :identification_number_invalid
165
- INVALID_ACCOUNT_NUMBER = :invalid_account_number
166
- INVALID_BANK_CODE = :invalid_bank_code
167
- INVALID_BENEFICIARY = :invalid_beneficiary
168
- INVALID_MAILING_ADDRESS = :invalid_mailing_address
169
- INVALID_BRANCH_NUMBER = :invalid_branch_number
170
- INVALID_BRANCH_CODE = :invalid_branch_code
171
- INVALID_PHONE_NUMBER = :invalid_phone_number
172
- INVALID_ROUTING_NUMBER = :invalid_routing_number
173
- INVALID_SWIFT_CODE = :invalid_swift_code
174
- INVALID_COMPANY_DETAILS = :invalid_company_details
175
- MANUAL_CANCELATION = :manual_cancelation
176
- MISC_ERROR = :misc_error
177
- MISSING_CITY_AND_COUNTRY = :missing_city_and_country
178
- MISSING_PHONE_NUMBER = :missing_phone_number
179
- MISSING_REMITTANCE_INFO = :missing_remittance_info
180
- PAYEE_NAME_INVALID = :payee_name_invalid
181
- RECEIVING_ACCOUNT_LOCKED = :receiving_account_locked
182
- REJECTED_BY_COMPLIANCE = :rejected_by_compliance
183
- RTP_NOT_SUPPORTED = :rtp_not_supported
184
- NON_TRANSACTION_ACCOUNT = :non_transaction_account
185
- SOURCE_TOKEN_INSUFFICIENT_FUNDS = :source_token_insufficient_funds
186
- SSN_INVALID = :ssn_invalid
187
- WALLET_SCREENSHOT_REQUIRED = :wallet_screenshot_required
188
- UNSUPPORTED_REGION = :unsupported_region
189
-
190
- # @!method self.values
191
- # @return [Array<Symbol>]
192
- end
193
-
194
- # @see WhopSDK::Models::WithdrawalRetrieveResponse#ledger_account
195
- class LedgerAccount < WhopSDK::Internal::Type::BaseModel
196
- # @!attribute id
197
- # The ID of the LedgerAccount.
198
- #
199
- # @return [String]
200
- required :id, String
201
-
202
- # @!attribute company_id
203
- # The ID of the company associated with this ledger account.
204
- #
205
- # @return [String, nil]
206
- required :company_id, String, nil?: true
207
-
208
- # @!method initialize(id:, company_id:)
209
- # The ledger account associated with the withdrawal.
210
- #
211
- # @param id [String] The ID of the LedgerAccount.
212
- #
213
- # @param company_id [String, nil] The ID of the company associated with this ledger account.
214
- end
215
-
216
- # @see WhopSDK::Models::WithdrawalRetrieveResponse#payout_token
217
- class PayoutToken < WhopSDK::Internal::Type::BaseModel
218
- # @!attribute id
219
- # The ID of the payout token
220
- #
221
- # @return [String]
222
- required :id, String
223
-
224
- # @!attribute created_at
225
- # The date and time the payout token was created
226
- #
227
- # @return [Time]
228
- required :created_at, Time
229
-
230
- # @!attribute destination_currency_code
231
- # The currency code of the payout destination. This is the currency that payouts
232
- # will be made in for this token.
233
- #
234
- # @return [String]
235
- required :destination_currency_code, String
236
-
237
- # @!attribute nickname
238
- # An optional nickname for the payout token to help the user identify it. This is
239
- # not used by the provider and is only for the user's reference.
240
- #
241
- # @return [String, nil]
242
- required :nickname, String, nil?: true
243
-
244
- # @!attribute payer_name
245
- # The name of the payer associated with the payout token.
246
- #
247
- # @return [String, nil]
248
- required :payer_name, String, nil?: true
249
-
250
- # @!method initialize(id:, created_at:, destination_currency_code:, nickname:, payer_name:)
251
- # Some parameter documentations has been truncated, see
252
- # {WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken} for more details.
253
- #
254
- # The payout token used for the withdrawal, if applicable.
255
- #
256
- # @param id [String] The ID of the payout token
257
- #
258
- # @param created_at [Time] The date and time the payout token was created
259
- #
260
- # @param destination_currency_code [String] The currency code of the payout destination. This is the currency that payouts w
261
- #
262
- # @param nickname [String, nil] An optional nickname for the payout token to help the user identify it. This is
263
- #
264
- # @param payer_name [String, nil] The name of the payer associated with the payout token.
265
- end
266
- end
267
- end
268
- end