whop_sdk 0.0.7 → 0.0.8

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 (157) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +19 -0
  3. data/README.md +7 -7
  4. data/lib/whop_sdk/client.rb +8 -0
  5. data/lib/whop_sdk/internal/type/base_model.rb +1 -1
  6. data/lib/whop_sdk/models/app.rb +9 -1
  7. data/lib/whop_sdk/models/app_list_params.rb +9 -1
  8. data/lib/whop_sdk/models/app_list_response.rb +9 -1
  9. data/lib/whop_sdk/models/app_type.rb +18 -0
  10. data/lib/whop_sdk/models/app_update_params.rb +9 -1
  11. data/lib/whop_sdk/models/checkout_configuration.rb +69 -7
  12. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +73 -1
  13. data/lib/whop_sdk/models/checkout_configuration_list_response.rb +69 -7
  14. data/lib/whop_sdk/models/checkout_modes.rb +16 -0
  15. data/lib/whop_sdk/models/course.rb +9 -1
  16. data/lib/whop_sdk/models/course_lesson_list_response.rb +9 -1
  17. data/lib/whop_sdk/models/course_lesson_mark_as_completed_params.rb +14 -0
  18. data/lib/whop_sdk/models/course_lesson_mark_as_completed_response.rb +8 -0
  19. data/lib/whop_sdk/models/course_lesson_start_params.rb +14 -0
  20. data/lib/whop_sdk/models/course_lesson_start_response.rb +8 -0
  21. data/lib/whop_sdk/models/course_lesson_submit_assessment_params.rb +52 -0
  22. data/lib/whop_sdk/models/course_lesson_submit_assessment_response.rb +151 -0
  23. data/lib/whop_sdk/models/course_list_response.rb +9 -1
  24. data/lib/whop_sdk/models/forum_post_create_params.rb +3 -14
  25. data/lib/whop_sdk/models/forum_post_update_params.rb +3 -14
  26. data/lib/whop_sdk/models/forum_post_visibility_type.rb +16 -0
  27. data/lib/whop_sdk/models/lesson.rb +104 -2
  28. data/lib/whop_sdk/models/payment_provider.rb +22 -0
  29. data/lib/whop_sdk/models/refund_created_webhook_event.rb +354 -0
  30. data/lib/whop_sdk/models/refund_list_params.rb +62 -0
  31. data/lib/whop_sdk/models/refund_list_response.rb +113 -0
  32. data/lib/whop_sdk/models/refund_reference_status.rb +17 -0
  33. data/lib/whop_sdk/models/refund_reference_type.rb +17 -0
  34. data/lib/whop_sdk/models/refund_retrieve_params.rb +14 -0
  35. data/lib/whop_sdk/models/refund_retrieve_response.rb +307 -0
  36. data/lib/whop_sdk/models/refund_status.rb +19 -0
  37. data/lib/whop_sdk/models/refund_updated_webhook_event.rb +354 -0
  38. data/lib/whop_sdk/models/unwrap_webhook_event.rb +5 -1
  39. data/lib/whop_sdk/models/withdrawal_fee_types.rb +16 -0
  40. data/lib/whop_sdk/models/withdrawal_list_params.rb +78 -0
  41. data/lib/whop_sdk/models/withdrawal_list_response.rb +87 -0
  42. data/lib/whop_sdk/models/withdrawal_retrieve_params.rb +14 -0
  43. data/lib/whop_sdk/models/withdrawal_retrieve_response.rb +320 -0
  44. data/lib/whop_sdk/models/withdrawal_speeds.rb +16 -0
  45. data/lib/whop_sdk/models/withdrawal_status.rb +21 -0
  46. data/lib/whop_sdk/models/withdrawal_types.rb +16 -0
  47. data/lib/whop_sdk/models.rb +40 -0
  48. data/lib/whop_sdk/resources/apps.rb +6 -2
  49. data/lib/whop_sdk/resources/checkout_configurations.rb +11 -1
  50. data/lib/whop_sdk/resources/course_lessons.rb +64 -0
  51. data/lib/whop_sdk/resources/forum_posts.rb +2 -2
  52. data/lib/whop_sdk/resources/refunds.rb +78 -0
  53. data/lib/whop_sdk/resources/webhooks.rb +1 -1
  54. data/lib/whop_sdk/resources/withdrawals.rb +79 -0
  55. data/lib/whop_sdk/version.rb +1 -1
  56. data/lib/whop_sdk.rb +29 -0
  57. data/rbi/whop_sdk/client.rbi +6 -0
  58. data/rbi/whop_sdk/models/app.rbi +8 -0
  59. data/rbi/whop_sdk/models/app_list_params.rbi +8 -0
  60. data/rbi/whop_sdk/models/app_list_response.rbi +8 -0
  61. data/rbi/whop_sdk/models/app_type.rbi +22 -0
  62. data/rbi/whop_sdk/models/app_update_params.rbi +8 -0
  63. data/rbi/whop_sdk/models/checkout_configuration.rbi +117 -7
  64. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +116 -0
  65. data/rbi/whop_sdk/models/checkout_configuration_list_response.rbi +127 -7
  66. data/rbi/whop_sdk/models/checkout_modes.rbi +20 -0
  67. data/rbi/whop_sdk/models/course.rbi +8 -0
  68. data/rbi/whop_sdk/models/course_lesson_list_response.rbi +8 -0
  69. data/rbi/whop_sdk/models/course_lesson_mark_as_completed_params.rbi +30 -0
  70. data/rbi/whop_sdk/models/course_lesson_mark_as_completed_response.rbi +8 -0
  71. data/rbi/whop_sdk/models/course_lesson_start_params.rbi +27 -0
  72. data/rbi/whop_sdk/models/course_lesson_start_response.rbi +8 -0
  73. data/rbi/whop_sdk/models/course_lesson_submit_assessment_params.rbi +104 -0
  74. data/rbi/whop_sdk/models/course_lesson_submit_assessment_response.rbi +222 -0
  75. data/rbi/whop_sdk/models/course_list_response.rbi +8 -0
  76. data/rbi/whop_sdk/models/forum_post_create_params.rbi +3 -37
  77. data/rbi/whop_sdk/models/forum_post_update_params.rbi +3 -37
  78. data/rbi/whop_sdk/models/forum_post_visibility_type.rbi +27 -0
  79. data/rbi/whop_sdk/models/lesson.rbi +115 -3
  80. data/rbi/whop_sdk/models/payment_provider.rbi +27 -0
  81. data/rbi/whop_sdk/models/refund_created_webhook_event.rbi +561 -0
  82. data/rbi/whop_sdk/models/refund_list_params.rbi +83 -0
  83. data/rbi/whop_sdk/models/refund_list_response.rbi +155 -0
  84. data/rbi/whop_sdk/models/refund_reference_status.rbi +26 -0
  85. data/rbi/whop_sdk/models/refund_reference_type.rbi +36 -0
  86. data/rbi/whop_sdk/models/refund_retrieve_params.rbi +27 -0
  87. data/rbi/whop_sdk/models/refund_retrieve_response.rbi +484 -0
  88. data/rbi/whop_sdk/models/refund_status.rbi +24 -0
  89. data/rbi/whop_sdk/models/refund_updated_webhook_event.rbi +561 -0
  90. data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +3 -1
  91. data/rbi/whop_sdk/models/withdrawal_fee_types.rbi +22 -0
  92. data/rbi/whop_sdk/models/withdrawal_list_params.rbi +99 -0
  93. data/rbi/whop_sdk/models/withdrawal_list_response.rbi +107 -0
  94. data/rbi/whop_sdk/models/withdrawal_retrieve_params.rbi +27 -0
  95. data/rbi/whop_sdk/models/withdrawal_retrieve_response.rbi +713 -0
  96. data/rbi/whop_sdk/models/withdrawal_speeds.rbi +22 -0
  97. data/rbi/whop_sdk/models/withdrawal_status.rbi +28 -0
  98. data/rbi/whop_sdk/models/withdrawal_types.rbi +20 -0
  99. data/rbi/whop_sdk/models.rbi +42 -0
  100. data/rbi/whop_sdk/resources/apps.rbi +6 -0
  101. data/rbi/whop_sdk/resources/checkout_configurations.rbi +15 -0
  102. data/rbi/whop_sdk/resources/course_lessons.rbi +48 -0
  103. data/rbi/whop_sdk/resources/forum_posts.rbi +2 -4
  104. data/rbi/whop_sdk/resources/refunds.rbi +68 -0
  105. data/rbi/whop_sdk/resources/webhooks.rbi +3 -1
  106. data/rbi/whop_sdk/resources/withdrawals.rbi +71 -0
  107. data/sig/whop_sdk/client.rbs +4 -0
  108. data/sig/whop_sdk/models/app.rbs +5 -0
  109. data/sig/whop_sdk/models/app_list_params.rbs +5 -0
  110. data/sig/whop_sdk/models/app_list_response.rbs +5 -0
  111. data/sig/whop_sdk/models/app_type.rbs +16 -0
  112. data/sig/whop_sdk/models/app_update_params.rbs +5 -0
  113. data/sig/whop_sdk/models/checkout_configuration.rbs +45 -8
  114. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +43 -1
  115. data/sig/whop_sdk/models/checkout_configuration_list_response.rbs +45 -8
  116. data/sig/whop_sdk/models/checkout_modes.rbs +14 -0
  117. data/sig/whop_sdk/models/course.rbs +5 -0
  118. data/sig/whop_sdk/models/course_lesson_list_response.rbs +5 -0
  119. data/sig/whop_sdk/models/course_lesson_mark_as_completed_params.rbs +15 -0
  120. data/sig/whop_sdk/models/course_lesson_mark_as_completed_response.rbs +5 -0
  121. data/sig/whop_sdk/models/course_lesson_start_params.rbs +15 -0
  122. data/sig/whop_sdk/models/course_lesson_start_response.rbs +5 -0
  123. data/sig/whop_sdk/models/course_lesson_submit_assessment_params.rbs +51 -0
  124. data/sig/whop_sdk/models/course_lesson_submit_assessment_response.rbs +96 -0
  125. data/sig/whop_sdk/models/course_list_response.rbs +5 -0
  126. data/sig/whop_sdk/models/forum_post_create_params.rbs +4 -15
  127. data/sig/whop_sdk/models/forum_post_update_params.rbs +4 -15
  128. data/sig/whop_sdk/models/forum_post_visibility_type.rbs +14 -0
  129. data/sig/whop_sdk/models/lesson.rbs +79 -3
  130. data/sig/whop_sdk/models/payment_provider.rbs +28 -0
  131. data/sig/whop_sdk/models/refund_created_webhook_event.rbs +252 -0
  132. data/sig/whop_sdk/models/refund_list_params.rbs +51 -0
  133. data/sig/whop_sdk/models/refund_list_response.rbs +80 -0
  134. data/sig/whop_sdk/models/refund_reference_status.rbs +15 -0
  135. data/sig/whop_sdk/models/refund_reference_type.rbs +18 -0
  136. data/sig/whop_sdk/models/refund_retrieve_params.rbs +15 -0
  137. data/sig/whop_sdk/models/refund_retrieve_response.rbs +215 -0
  138. data/sig/whop_sdk/models/refund_status.rbs +18 -0
  139. data/sig/whop_sdk/models/refund_updated_webhook_event.rbs +252 -0
  140. data/sig/whop_sdk/models/unwrap_webhook_event.rbs +2 -0
  141. data/sig/whop_sdk/models/withdrawal_fee_types.rbs +14 -0
  142. data/sig/whop_sdk/models/withdrawal_list_params.rbs +61 -0
  143. data/sig/whop_sdk/models/withdrawal_list_response.rbs +60 -0
  144. data/sig/whop_sdk/models/withdrawal_retrieve_params.rbs +15 -0
  145. data/sig/whop_sdk/models/withdrawal_retrieve_response.rbs +297 -0
  146. data/sig/whop_sdk/models/withdrawal_speeds.rbs +14 -0
  147. data/sig/whop_sdk/models/withdrawal_status.rbs +26 -0
  148. data/sig/whop_sdk/models/withdrawal_types.rbs +14 -0
  149. data/sig/whop_sdk/models.rbs +40 -0
  150. data/sig/whop_sdk/resources/apps.rbs +2 -0
  151. data/sig/whop_sdk/resources/checkout_configurations.rbs +3 -0
  152. data/sig/whop_sdk/resources/course_lessons.rbs +16 -0
  153. data/sig/whop_sdk/resources/forum_posts.rbs +2 -2
  154. data/sig/whop_sdk/resources/refunds.rbs +22 -0
  155. data/sig/whop_sdk/resources/webhooks.rbs +3 -1
  156. data/sig/whop_sdk/resources/withdrawals.rbs +24 -0
  157. metadata +89 -2
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # The different fee types for a withdrawal.
6
+ module WithdrawalFeeTypes
7
+ extend WhopSDK::Internal::Type::Enum
8
+
9
+ EXCLUSIVE = :exclusive
10
+ INCLUSIVE = :inclusive
11
+
12
+ # @!method self.values
13
+ # @return [Array<Symbol>]
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,78 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Withdrawals#list
6
+ class WithdrawalListParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ # @!attribute company_id
11
+ # The ID of the company to list withdrawals for
12
+ #
13
+ # @return [String]
14
+ required :company_id, String
15
+
16
+ # @!attribute after
17
+ # Returns the elements in the list that come after the specified cursor.
18
+ #
19
+ # @return [String, nil]
20
+ optional :after, String, nil?: true
21
+
22
+ # @!attribute before
23
+ # Returns the elements in the list that come before the specified cursor.
24
+ #
25
+ # @return [String, nil]
26
+ optional :before, String, nil?: true
27
+
28
+ # @!attribute created_after
29
+ # The minimum creation date to filter by
30
+ #
31
+ # @return [Time, nil]
32
+ optional :created_after, Time, nil?: true
33
+
34
+ # @!attribute created_before
35
+ # The maximum creation date to filter by
36
+ #
37
+ # @return [Time, nil]
38
+ optional :created_before, Time, nil?: true
39
+
40
+ # @!attribute direction
41
+ # The direction of the sort.
42
+ #
43
+ # @return [Symbol, WhopSDK::Models::Direction, nil]
44
+ optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
45
+
46
+ # @!attribute first
47
+ # Returns the first _n_ elements from the list.
48
+ #
49
+ # @return [Integer, nil]
50
+ optional :first, Integer, nil?: true
51
+
52
+ # @!attribute last
53
+ # Returns the last _n_ elements from the list.
54
+ #
55
+ # @return [Integer, nil]
56
+ optional :last, Integer, nil?: true
57
+
58
+ # @!method initialize(company_id:, after: nil, before: nil, created_after: nil, created_before: nil, direction: nil, first: nil, last: nil, request_options: {})
59
+ # @param company_id [String] The ID of the company to list withdrawals for
60
+ #
61
+ # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
62
+ #
63
+ # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
64
+ #
65
+ # @param created_after [Time, nil] The minimum creation date to filter by
66
+ #
67
+ # @param created_before [Time, nil] The maximum creation date to filter by
68
+ #
69
+ # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
70
+ #
71
+ # @param first [Integer, nil] Returns the first _n_ elements from the list.
72
+ #
73
+ # @param last [Integer, nil] Returns the last _n_ elements from the list.
74
+ #
75
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
76
+ end
77
+ end
78
+ end
@@ -0,0 +1,87 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Withdrawals#list
6
+ class WithdrawalListResponse < 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 fee_amount
32
+ # The fee amount that was charged for the withdrawal. This is in the same currency
33
+ # as the withdrawal amount.
34
+ #
35
+ # @return [Float]
36
+ required :fee_amount, Float
37
+
38
+ # @!attribute fee_type
39
+ # The different fee types for a withdrawal.
40
+ #
41
+ # @return [Symbol, WhopSDK::Models::WithdrawalFeeTypes, nil]
42
+ required :fee_type, enum: -> { WhopSDK::WithdrawalFeeTypes }, nil?: true
43
+
44
+ # @!attribute speed
45
+ # The speed of the withdrawal.
46
+ #
47
+ # @return [Symbol, WhopSDK::Models::WithdrawalSpeeds]
48
+ required :speed, enum: -> { WhopSDK::WithdrawalSpeeds }
49
+
50
+ # @!attribute status
51
+ # Status of the withdrawal.
52
+ #
53
+ # @return [Symbol, WhopSDK::Models::WithdrawalStatus]
54
+ required :status, enum: -> { WhopSDK::WithdrawalStatus }
55
+
56
+ # @!attribute withdrawal_type
57
+ # The type of withdrawal.
58
+ #
59
+ # @return [Symbol, WhopSDK::Models::WithdrawalTypes]
60
+ required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
61
+
62
+ # @!method initialize(id:, amount:, created_at:, currency:, fee_amount:, fee_type:, speed:, status:, withdrawal_type:)
63
+ # Some parameter documentations has been truncated, see
64
+ # {WhopSDK::Models::WithdrawalListResponse} for more details.
65
+ #
66
+ # A withdrawal request.
67
+ #
68
+ # @param id [String] Internal ID of the withdrawal request.
69
+ #
70
+ # @param amount [Float] How much money was attempted to be withdrawn, in a float type.
71
+ #
72
+ # @param created_at [Time] When the withdrawal request was created.
73
+ #
74
+ # @param currency [Symbol, WhopSDK::Models::Currency] The currency of the withdrawal request.
75
+ #
76
+ # @param fee_amount [Float] The fee amount that was charged for the withdrawal. This is in the same currency
77
+ #
78
+ # @param fee_type [Symbol, WhopSDK::Models::WithdrawalFeeTypes, nil] The different fee types for a withdrawal.
79
+ #
80
+ # @param speed [Symbol, WhopSDK::Models::WithdrawalSpeeds] The speed of the withdrawal.
81
+ #
82
+ # @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
83
+ #
84
+ # @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
85
+ end
86
+ end
87
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Withdrawals#retrieve
6
+ class WithdrawalRetrieveParams < WhopSDK::Internal::Type::BaseModel
7
+ extend WhopSDK::Internal::Type::RequestParameters::Converter
8
+ include WhopSDK::Internal::Type::RequestParameters
9
+
10
+ # @!method initialize(request_options: {})
11
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
12
+ end
13
+ end
14
+ end
@@ -0,0 +1,320 @@
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 fee_amount
32
+ # The fee amount that was charged for the withdrawal. This is in the same currency
33
+ # as the withdrawal amount.
34
+ #
35
+ # @return [Float]
36
+ required :fee_amount, Float
37
+
38
+ # @!attribute fee_type
39
+ # The different fee types for a withdrawal.
40
+ #
41
+ # @return [Symbol, WhopSDK::Models::WithdrawalFeeTypes, nil]
42
+ required :fee_type, enum: -> { WhopSDK::WithdrawalFeeTypes }, nil?: true
43
+
44
+ # @!attribute latest_payout
45
+ # The latest payout associated with this withdrawal, if any.
46
+ #
47
+ # @return [WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout, nil]
48
+ required :latest_payout, -> { WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout }, nil?: true
49
+
50
+ # @!attribute payout_token
51
+ # The payout token used for the withdrawal, if applicable.
52
+ #
53
+ # @return [WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken, nil]
54
+ required :payout_token, -> { WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken }, nil?: true
55
+
56
+ # @!attribute speed
57
+ # The speed of the withdrawal.
58
+ #
59
+ # @return [Symbol, WhopSDK::Models::WithdrawalSpeeds]
60
+ required :speed, enum: -> { WhopSDK::WithdrawalSpeeds }
61
+
62
+ # @!attribute status
63
+ # Status of the withdrawal.
64
+ #
65
+ # @return [Symbol, WhopSDK::Models::WithdrawalStatus]
66
+ required :status, enum: -> { WhopSDK::WithdrawalStatus }
67
+
68
+ # @!attribute withdrawal_type
69
+ # The type of withdrawal.
70
+ #
71
+ # @return [Symbol, WhopSDK::Models::WithdrawalTypes]
72
+ required :withdrawal_type, enum: -> { WhopSDK::WithdrawalTypes }
73
+
74
+ # @!method initialize(id:, amount:, created_at:, currency:, fee_amount:, fee_type:, latest_payout:, payout_token:, speed:, status:, withdrawal_type:)
75
+ # Some parameter documentations has been truncated, see
76
+ # {WhopSDK::Models::WithdrawalRetrieveResponse} for more details.
77
+ #
78
+ # A withdrawal request.
79
+ #
80
+ # @param id [String] Internal ID of the withdrawal request.
81
+ #
82
+ # @param amount [Float] How much money was attempted to be withdrawn, in a float type.
83
+ #
84
+ # @param created_at [Time] When the withdrawal request was created.
85
+ #
86
+ # @param currency [Symbol, WhopSDK::Models::Currency] The currency of the withdrawal request.
87
+ #
88
+ # @param fee_amount [Float] The fee amount that was charged for the withdrawal. This is in the same currency
89
+ #
90
+ # @param fee_type [Symbol, WhopSDK::Models::WithdrawalFeeTypes, nil] The different fee types for a withdrawal.
91
+ #
92
+ # @param latest_payout [WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout, nil] The latest payout associated with this withdrawal, if any.
93
+ #
94
+ # @param payout_token [WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken, nil] The payout token used for the withdrawal, if applicable.
95
+ #
96
+ # @param speed [Symbol, WhopSDK::Models::WithdrawalSpeeds] The speed of the withdrawal.
97
+ #
98
+ # @param status [Symbol, WhopSDK::Models::WithdrawalStatus] Status of the withdrawal.
99
+ #
100
+ # @param withdrawal_type [Symbol, WhopSDK::Models::WithdrawalTypes] The type of withdrawal.
101
+
102
+ # @see WhopSDK::Models::WithdrawalRetrieveResponse#latest_payout
103
+ class LatestPayout < WhopSDK::Internal::Type::BaseModel
104
+ # @!attribute id
105
+ # The internal ID of the payout.
106
+ #
107
+ # @return [String]
108
+ required :id, String
109
+
110
+ # @!attribute created_at
111
+ # The date and time the payout was created.
112
+ #
113
+ # @return [Time]
114
+ required :created_at, Time
115
+
116
+ # @!attribute error_code
117
+ # The different error codes a payout can be in.
118
+ #
119
+ # @return [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode, nil]
120
+ required :error_code,
121
+ enum: -> { WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode },
122
+ nil?: true
123
+
124
+ # @!attribute error_message
125
+ # The error message for the payout.
126
+ #
127
+ # @return [String, nil]
128
+ required :error_message, String, nil?: true
129
+
130
+ # @!attribute estimated_availability
131
+ # The estimated availability date of the payout.
132
+ #
133
+ # @return [Time, nil]
134
+ required :estimated_availability, Time, nil?: true
135
+
136
+ # @!attribute payer_name
137
+ # The name of the payer for the payout.
138
+ #
139
+ # @return [String, nil]
140
+ required :payer_name, String, nil?: true
141
+
142
+ # @!attribute status
143
+ # The status of the payout.
144
+ #
145
+ # @return [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status]
146
+ required :status, enum: -> { WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status }
147
+
148
+ # @!attribute trace_code
149
+ # The trace code for the payout, if applicable. Provided on ACH transactions when
150
+ # available.
151
+ #
152
+ # @return [String, nil]
153
+ required :trace_code, String, nil?: true
154
+
155
+ # @!method initialize(id:, created_at:, error_code:, error_message:, estimated_availability:, payer_name:, status:, trace_code:)
156
+ # Some parameter documentations has been truncated, see
157
+ # {WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout} for more details.
158
+ #
159
+ # The latest payout associated with this withdrawal, if any.
160
+ #
161
+ # @param id [String] The internal ID of the payout.
162
+ #
163
+ # @param created_at [Time] The date and time the payout was created.
164
+ #
165
+ # @param error_code [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::ErrorCode, nil] The different error codes a payout can be in.
166
+ #
167
+ # @param error_message [String, nil] The error message for the payout.
168
+ #
169
+ # @param estimated_availability [Time, nil] The estimated availability date of the payout.
170
+ #
171
+ # @param payer_name [String, nil] The name of the payer for the payout.
172
+ #
173
+ # @param status [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout::Status] The status of the payout.
174
+ #
175
+ # @param trace_code [String, nil] The trace code for the payout, if applicable. Provided on ACH transactions when
176
+
177
+ # The different error codes a payout can be in.
178
+ #
179
+ # @see WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout#error_code
180
+ module ErrorCode
181
+ extend WhopSDK::Internal::Type::Enum
182
+
183
+ ACCOUNT_CLOSED = :account_closed
184
+ ACCOUNT_DOES_NOT_EXIST = :account_does_not_exist
185
+ ACCOUNT_INFORMATION_INVALID = :account_information_invalid
186
+ ACCOUNT_NUMBER_INVALID_REGION = :account_number_invalid_region
187
+ ACCOUNT_FROZEN = :account_frozen
188
+ ACCOUNT_LOOKUP_FAILED = :account_lookup_failed
189
+ ACCOUNT_NOT_FOUND = :account_not_found
190
+ AMOUNT_OUT_OF_BOUNDS = :amount_out_of_bounds
191
+ ATTRIBUTES_NOT_VALIDATED = :attributes_not_validated
192
+ B2B_PAYMENTS_PROHIBITED = :b2b_payments_prohibited
193
+ BANK_STATEMENT_REQUIRED = :bank_statement_required
194
+ COMPLIANCE_REVIEW = :compliance_review
195
+ CURRENCY_NOT_SUPPORTED = :currency_not_supported
196
+ DEPOSIT_CANCELED = :deposit_canceled
197
+ DEPOSIT_FAILED = :deposit_failed
198
+ DEPOSIT_REJECTED = :deposit_rejected
199
+ DESTINATION_UNAVAILABLE = :destination_unavailable
200
+ EXCEEDED_ACCOUNT_LIMIT = :exceeded_account_limit
201
+ EXPIRED_QUOTE = :expired_quote
202
+ GENERIC_PAYOUT_ERROR = :generic_payout_error
203
+ TECHNICAL_PROBLEM = :technical_problem
204
+ IDENTIFICATION_NUMBER_INVALID = :identification_number_invalid
205
+ INVALID_ACCOUNT_NUMBER = :invalid_account_number
206
+ INVALID_BANK_CODE = :invalid_bank_code
207
+ INVALID_BENEFICIARY = :invalid_beneficiary
208
+ INVALID_BRANCH_NUMBER = :invalid_branch_number
209
+ INVALID_BRANCH_CODE = :invalid_branch_code
210
+ INVALID_PHONE_NUMBER = :invalid_phone_number
211
+ INVALID_ROUTING_NUMBER = :invalid_routing_number
212
+ INVALID_SWIFT_CODE = :invalid_swift_code
213
+ INVALID_COMPANY_DETAILS = :invalid_company_details
214
+ MANUAL_CANCELATION = :manual_cancelation
215
+ MISC_ERROR = :misc_error
216
+ MISSING_CITY_AND_COUNTRY = :missing_city_and_country
217
+ MISSING_PHONE_NUMBER = :missing_phone_number
218
+ MISSING_REMITTANCE_INFO = :missing_remittance_info
219
+ PAYEE_NAME_INVALID = :payee_name_invalid
220
+ RECEIVING_ACCOUNT_LOCKED = :receiving_account_locked
221
+ REJECTED_BY_COMPLIANCE = :rejected_by_compliance
222
+ RTP_NOT_SUPPORTED = :rtp_not_supported
223
+ NON_TRANSACTION_ACCOUNT = :non_transaction_account
224
+ SOURCE_TOKEN_INSUFFICIENT_FUNDS = :source_token_insufficient_funds
225
+ SSN_INVALID = :ssn_invalid
226
+ WALLET_SCREENSHOT_REQUIRED = :wallet_screenshot_required
227
+ UNSUPPORTED_REGION = :unsupported_region
228
+
229
+ # @!method self.values
230
+ # @return [Array<Symbol>]
231
+ end
232
+
233
+ # The status of the payout.
234
+ #
235
+ # @see WhopSDK::Models::WithdrawalRetrieveResponse::LatestPayout#status
236
+ module Status
237
+ extend WhopSDK::Internal::Type::Enum
238
+
239
+ SCHEDULED = :scheduled
240
+ PENDING = :pending
241
+ PROCESSING = :processing
242
+ COMPLETED = :completed
243
+ CANCELED = :canceled
244
+ READY_FOR_PICKUP = :ready_for_pickup
245
+ HOLD = :hold
246
+ ERROR = :error
247
+ EXPIRED = :expired
248
+
249
+ # @!method self.values
250
+ # @return [Array<Symbol>]
251
+ end
252
+ end
253
+
254
+ # @see WhopSDK::Models::WithdrawalRetrieveResponse#payout_token
255
+ class PayoutToken < WhopSDK::Internal::Type::BaseModel
256
+ # @!attribute id
257
+ # The ID of the payout token
258
+ #
259
+ # @return [String]
260
+ required :id, String
261
+
262
+ # @!attribute created_at
263
+ # The date and time the payout token was created
264
+ #
265
+ # @return [Time]
266
+ required :created_at, Time
267
+
268
+ # @!attribute destination_currency_code
269
+ # The currency code of the payout destination. This is the currency that payouts
270
+ # will be made in for this token.
271
+ #
272
+ # @return [String]
273
+ required :destination_currency_code, String
274
+
275
+ # @!attribute nickname
276
+ # An optional nickname for the payout token to help the user identify it. This is
277
+ # not used by the provider and is only for the user's reference.
278
+ #
279
+ # @return [String, nil]
280
+ required :nickname, String, nil?: true
281
+
282
+ # @!attribute status
283
+ # The status of the payout token.
284
+ #
285
+ # @return [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status]
286
+ required :status, enum: -> { WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status }
287
+
288
+ # @!method initialize(id:, created_at:, destination_currency_code:, nickname:, status:)
289
+ # Some parameter documentations has been truncated, see
290
+ # {WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken} for more details.
291
+ #
292
+ # The payout token used for the withdrawal, if applicable.
293
+ #
294
+ # @param id [String] The ID of the payout token
295
+ #
296
+ # @param created_at [Time] The date and time the payout token was created
297
+ #
298
+ # @param destination_currency_code [String] The currency code of the payout destination. This is the currency that payouts w
299
+ #
300
+ # @param nickname [String, nil] An optional nickname for the payout token to help the user identify it. This is
301
+ #
302
+ # @param status [Symbol, WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken::Status] The status of the payout token.
303
+
304
+ # The status of the payout token.
305
+ #
306
+ # @see WhopSDK::Models::WithdrawalRetrieveResponse::PayoutToken#status
307
+ module Status
308
+ extend WhopSDK::Internal::Type::Enum
309
+
310
+ CREATED = :created
311
+ ACTIVE = :active
312
+ BROKEN = :broken
313
+
314
+ # @!method self.values
315
+ # @return [Array<Symbol>]
316
+ end
317
+ end
318
+ end
319
+ end
320
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # The different speeds of withdrawals
6
+ module WithdrawalSpeeds
7
+ extend WhopSDK::Internal::Type::Enum
8
+
9
+ STANDARD = :standard
10
+ INSTANT = :instant
11
+
12
+ # @!method self.values
13
+ # @return [Array<Symbol>]
14
+ end
15
+ end
16
+ end
@@ -0,0 +1,21 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # The status of a withdrawal request
6
+ module WithdrawalStatus
7
+ extend WhopSDK::Internal::Type::Enum
8
+
9
+ REQUESTED = :requested
10
+ AWAITING_PAYMENT = :awaiting_payment
11
+ IN_TRANSIT = :in_transit
12
+ COMPLETED = :completed
13
+ FAILED = :failed
14
+ CANCELED = :canceled
15
+ DENIED = :denied
16
+
17
+ # @!method self.values
18
+ # @return [Array<Symbol>]
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,16 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # The types of withdrawals
6
+ module WithdrawalTypes
7
+ extend WhopSDK::Internal::Type::Enum
8
+
9
+ REGULAR = :regular
10
+ CLAWBACK = :clawback
11
+
12
+ # @!method self.values
13
+ # @return [Array<Symbol>]
14
+ end
15
+ end
16
+ end
@@ -69,6 +69,8 @@ module WhopSDK
69
69
 
70
70
  AppStatuses = WhopSDK::Models::AppStatuses
71
71
 
72
+ AppType = WhopSDK::Models::AppType
73
+
72
74
  AppUpdateParams = WhopSDK::Models::AppUpdateParams
73
75
 
74
76
  AppViewType = WhopSDK::Models::AppViewType
@@ -103,6 +105,8 @@ module WhopSDK
103
105
 
104
106
  CheckoutConfigurationRetrieveParams = WhopSDK::Models::CheckoutConfigurationRetrieveParams
105
107
 
108
+ CheckoutModes = WhopSDK::Models::CheckoutModes
109
+
106
110
  CollectionMethod = WhopSDK::Models::CollectionMethod
107
111
 
108
112
  Company = WhopSDK::Models::Company
@@ -148,8 +152,14 @@ module WhopSDK
148
152
 
149
153
  CourseLessonListParams = WhopSDK::Models::CourseLessonListParams
150
154
 
155
+ CourseLessonMarkAsCompletedParams = WhopSDK::Models::CourseLessonMarkAsCompletedParams
156
+
151
157
  CourseLessonRetrieveParams = WhopSDK::Models::CourseLessonRetrieveParams
152
158
 
159
+ CourseLessonStartParams = WhopSDK::Models::CourseLessonStartParams
160
+
161
+ CourseLessonSubmitAssessmentParams = WhopSDK::Models::CourseLessonSubmitAssessmentParams
162
+
153
163
  CourseLessonUpdateParams = WhopSDK::Models::CourseLessonUpdateParams
154
164
 
155
165
  CourseListParams = WhopSDK::Models::CourseListParams
@@ -244,6 +254,8 @@ module WhopSDK
244
254
 
245
255
  ForumPostUpdateParams = WhopSDK::Models::ForumPostUpdateParams
246
256
 
257
+ ForumPostVisibilityType = WhopSDK::Models::ForumPostVisibilityType
258
+
247
259
  ForumRetrieveParams = WhopSDK::Models::ForumRetrieveParams
248
260
 
249
261
  ForumUpdateParams = WhopSDK::Models::ForumUpdateParams
@@ -338,6 +350,8 @@ module WhopSDK
338
350
 
339
351
  PaymentPendingWebhookEvent = WhopSDK::Models::PaymentPendingWebhookEvent
340
352
 
353
+ PaymentProvider = WhopSDK::Models::PaymentProvider
354
+
341
355
  PaymentRefundParams = WhopSDK::Models::PaymentRefundParams
342
356
 
343
357
  PaymentRetrieveParams = WhopSDK::Models::PaymentRetrieveParams
@@ -402,6 +416,20 @@ module WhopSDK
402
416
 
403
417
  ReceiptStatus = WhopSDK::Models::ReceiptStatus
404
418
 
419
+ RefundCreatedWebhookEvent = WhopSDK::Models::RefundCreatedWebhookEvent
420
+
421
+ RefundListParams = WhopSDK::Models::RefundListParams
422
+
423
+ RefundReferenceStatus = WhopSDK::Models::RefundReferenceStatus
424
+
425
+ RefundReferenceType = WhopSDK::Models::RefundReferenceType
426
+
427
+ RefundRetrieveParams = WhopSDK::Models::RefundRetrieveParams
428
+
429
+ RefundStatus = WhopSDK::Models::RefundStatus
430
+
431
+ RefundUpdatedWebhookEvent = WhopSDK::Models::RefundUpdatedWebhookEvent
432
+
405
433
  ReleaseMethod = WhopSDK::Models::ReleaseMethod
406
434
 
407
435
  ReviewListParams = WhopSDK::Models::ReviewListParams
@@ -461,4 +489,16 @@ module WhopSDK
461
489
  WhoCanPostTypes = WhopSDK::Models::WhoCanPostTypes
462
490
 
463
491
  WhoCanReact = WhopSDK::Models::WhoCanReact
492
+
493
+ WithdrawalFeeTypes = WhopSDK::Models::WithdrawalFeeTypes
494
+
495
+ WithdrawalListParams = WhopSDK::Models::WithdrawalListParams
496
+
497
+ WithdrawalRetrieveParams = WhopSDK::Models::WithdrawalRetrieveParams
498
+
499
+ WithdrawalSpeeds = WhopSDK::Models::WithdrawalSpeeds
500
+
501
+ WithdrawalStatus = WhopSDK::Models::WithdrawalStatus
502
+
503
+ WithdrawalTypes = WhopSDK::Models::WithdrawalTypes
464
504
  end
@@ -59,12 +59,14 @@ module WhopSDK
59
59
  # - `developer:update_app`
60
60
  # - `developer:manage_api_key`
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
+ # @overload update(id, app_store_description: nil, app_type: 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: {})
63
63
  #
64
64
  # @param id [String] The ID of the app
65
65
  #
66
66
  # @param app_store_description [String, nil] The description of the app for the app store in-depth app view.
67
67
  #
68
+ # @param app_type [Symbol, WhopSDK::Models::AppType, nil] The type of end-user an app is built for
69
+ #
68
70
  # @param base_url [String, nil] The base production url of the app
69
71
  #
70
72
  # @param dashboard_path [String, nil] The path for the dashboard view of the app
@@ -104,10 +106,12 @@ module WhopSDK
104
106
  #
105
107
  # Fetches a list of apps
106
108
  #
107
- # @overload list(after: nil, before: nil, company_id: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, verified_apps_only: nil, view_type: nil, request_options: {})
109
+ # @overload list(after: nil, app_type: nil, before: nil, company_id: nil, direction: nil, first: nil, last: nil, order: nil, query: nil, verified_apps_only: nil, view_type: nil, request_options: {})
108
110
  #
109
111
  # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
110
112
  #
113
+ # @param app_type [Symbol, WhopSDK::Models::AppType, nil] The type of end-user an app is built for
114
+ #
111
115
  # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
112
116
  #
113
117
  # @param company_id [String, nil] The ID of the company to filter apps by