whop_sdk 0.0.5 → 0.0.7

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 (93) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +28 -0
  3. data/README.md +4 -7
  4. data/lib/whop_sdk/client.rb +17 -6
  5. data/lib/whop_sdk/models/access_token_create_params.rb +26 -36
  6. data/lib/whop_sdk/models/card_brands.rb +1 -0
  7. data/lib/whop_sdk/models/checkout_configuration_create_params.rb +9 -9
  8. data/lib/whop_sdk/models/company.rb +1 -0
  9. data/lib/whop_sdk/models/currency.rb +1 -0
  10. data/lib/whop_sdk/models/dispute.rb +672 -0
  11. data/lib/whop_sdk/models/dispute_created_webhook_event.rb +48 -0
  12. data/lib/whop_sdk/models/dispute_list_params.rb +62 -0
  13. data/lib/whop_sdk/models/dispute_list_response.rb +187 -0
  14. data/lib/whop_sdk/models/dispute_retrieve_params.rb +14 -0
  15. data/lib/whop_sdk/models/dispute_statuses.rb +23 -0
  16. data/lib/whop_sdk/models/dispute_submit_evidence_params.rb +14 -0
  17. data/lib/whop_sdk/models/dispute_update_evidence_params.rb +342 -0
  18. data/lib/whop_sdk/models/dispute_updated_webhook_event.rb +48 -0
  19. data/lib/whop_sdk/models/forum_post_create_params.rb +20 -1
  20. data/lib/whop_sdk/models/forum_post_update_params.rb +20 -1
  21. data/lib/whop_sdk/models/ledger_account_retrieve_response.rb +1 -0
  22. data/lib/whop_sdk/models/notification_create_params.rb +88 -0
  23. data/lib/whop_sdk/models/notification_create_response.rb +19 -0
  24. data/lib/whop_sdk/models/shipment.rb +3 -3
  25. data/lib/whop_sdk/models/shipment_list_response.rb +3 -3
  26. data/lib/whop_sdk/models/unwrap_webhook_event.rb +5 -1
  27. data/lib/whop_sdk/models.rb +18 -0
  28. data/lib/whop_sdk/resources/access_tokens.rb +9 -7
  29. data/lib/whop_sdk/resources/disputes.rb +182 -0
  30. data/lib/whop_sdk/resources/forum_posts.rb +6 -2
  31. data/lib/whop_sdk/resources/notifications.rb +53 -0
  32. data/lib/whop_sdk/resources/webhooks.rb +1 -1
  33. data/lib/whop_sdk/version.rb +1 -1
  34. data/lib/whop_sdk.rb +13 -0
  35. data/rbi/whop_sdk/client.rbi +11 -2
  36. data/rbi/whop_sdk/models/access_token_create_params.rbi +34 -77
  37. data/rbi/whop_sdk/models/card_brands.rbi +1 -0
  38. data/rbi/whop_sdk/models/checkout_configuration_create_params.rbi +8 -8
  39. data/rbi/whop_sdk/models/company.rbi +2 -0
  40. data/rbi/whop_sdk/models/currency.rbi +1 -0
  41. data/rbi/whop_sdk/models/dispute.rbi +938 -0
  42. data/rbi/whop_sdk/models/dispute_created_webhook_event.rbi +72 -0
  43. data/rbi/whop_sdk/models/dispute_list_params.rbi +83 -0
  44. data/rbi/whop_sdk/models/dispute_list_response.rbi +287 -0
  45. data/rbi/whop_sdk/models/dispute_retrieve_params.rbi +27 -0
  46. data/rbi/whop_sdk/models/dispute_statuses.rbi +32 -0
  47. data/rbi/whop_sdk/models/dispute_submit_evidence_params.rbi +30 -0
  48. data/rbi/whop_sdk/models/dispute_update_evidence_params.rbi +566 -0
  49. data/rbi/whop_sdk/models/dispute_updated_webhook_event.rbi +72 -0
  50. data/rbi/whop_sdk/models/forum_post_create_params.rbi +42 -0
  51. data/rbi/whop_sdk/models/forum_post_update_params.rbi +42 -0
  52. data/rbi/whop_sdk/models/ledger_account_retrieve_response.rbi +5 -0
  53. data/rbi/whop_sdk/models/notification_create_params.rbi +113 -0
  54. data/rbi/whop_sdk/models/notification_create_response.rbi +31 -0
  55. data/rbi/whop_sdk/models/shipment.rbi +6 -4
  56. data/rbi/whop_sdk/models/shipment_list_response.rbi +6 -4
  57. data/rbi/whop_sdk/models/unwrap_webhook_event.rbi +3 -1
  58. data/rbi/whop_sdk/models.rbi +18 -0
  59. data/rbi/whop_sdk/resources/access_tokens.rbi +19 -14
  60. data/rbi/whop_sdk/resources/disputes.rbi +194 -0
  61. data/rbi/whop_sdk/resources/forum_posts.rbi +8 -0
  62. data/rbi/whop_sdk/resources/notifications.rbi +54 -0
  63. data/rbi/whop_sdk/resources/webhooks.rbi +3 -1
  64. data/sig/whop_sdk/client.rbs +5 -1
  65. data/sig/whop_sdk/models/access_token_create_params.rbs +14 -29
  66. data/sig/whop_sdk/models/card_brands.rbs +2 -0
  67. data/sig/whop_sdk/models/checkout_configuration_create_params.rbs +5 -5
  68. data/sig/whop_sdk/models/company.rbs +2 -0
  69. data/sig/whop_sdk/models/currency.rbs +2 -0
  70. data/sig/whop_sdk/models/dispute.rbs +437 -0
  71. data/sig/whop_sdk/models/dispute_created_webhook_event.rbs +40 -0
  72. data/sig/whop_sdk/models/dispute_list_params.rbs +51 -0
  73. data/sig/whop_sdk/models/dispute_list_response.rbs +124 -0
  74. data/sig/whop_sdk/models/dispute_retrieve_params.rbs +15 -0
  75. data/sig/whop_sdk/models/dispute_statuses.rbs +30 -0
  76. data/sig/whop_sdk/models/dispute_submit_evidence_params.rbs +15 -0
  77. data/sig/whop_sdk/models/dispute_update_evidence_params.rbs +215 -0
  78. data/sig/whop_sdk/models/dispute_updated_webhook_event.rbs +40 -0
  79. data/sig/whop_sdk/models/forum_post_create_params.rbs +17 -1
  80. data/sig/whop_sdk/models/forum_post_update_params.rbs +17 -1
  81. data/sig/whop_sdk/models/ledger_account_retrieve_response.rbs +2 -0
  82. data/sig/whop_sdk/models/notification_create_params.rbs +61 -0
  83. data/sig/whop_sdk/models/notification_create_response.rbs +13 -0
  84. data/sig/whop_sdk/models/shipment.rbs +4 -4
  85. data/sig/whop_sdk/models/shipment_list_response.rbs +4 -4
  86. data/sig/whop_sdk/models/unwrap_webhook_event.rbs +2 -0
  87. data/sig/whop_sdk/models.rbs +18 -0
  88. data/sig/whop_sdk/resources/access_tokens.rbs +3 -3
  89. data/sig/whop_sdk/resources/disputes.rbs +46 -0
  90. data/sig/whop_sdk/resources/forum_posts.rbs +2 -0
  91. data/sig/whop_sdk/resources/notifications.rbs +19 -0
  92. data/sig/whop_sdk/resources/webhooks.rbs +3 -1
  93. metadata +41 -2
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ class DisputeCreatedWebhookEvent < WhopSDK::Internal::Type::BaseModel
6
+ # @!attribute id
7
+ # A unique ID for every single webhook request
8
+ #
9
+ # @return [String]
10
+ required :id, String
11
+
12
+ # @!attribute api_version
13
+ # The API version for this webhook
14
+ #
15
+ # @return [Symbol, :v1]
16
+ required :api_version, const: :v1
17
+
18
+ # @!attribute data
19
+ # An object representing a dispute against a company.
20
+ #
21
+ # @return [WhopSDK::Models::Dispute]
22
+ required :data, -> { WhopSDK::Dispute }
23
+
24
+ # @!attribute timestamp
25
+ # The timestamp in ISO 8601 format that the webhook was sent at on the server
26
+ #
27
+ # @return [Time]
28
+ required :timestamp, Time
29
+
30
+ # @!attribute type
31
+ # The webhook event type
32
+ #
33
+ # @return [Symbol, :"dispute.created"]
34
+ required :type, const: :"dispute.created"
35
+
36
+ # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"dispute.created")
37
+ # @param id [String] A unique ID for every single webhook request
38
+ #
39
+ # @param data [WhopSDK::Models::Dispute] An object representing a dispute against a company.
40
+ #
41
+ # @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
42
+ #
43
+ # @param api_version [Symbol, :v1] The API version for this webhook
44
+ #
45
+ # @param type [Symbol, :"dispute.created"] The webhook event type
46
+ end
47
+ end
48
+ end
@@ -0,0 +1,62 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Disputes#list
6
+ class DisputeListParams < 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 disputes 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 direction
29
+ # The direction of the sort.
30
+ #
31
+ # @return [Symbol, WhopSDK::Models::Direction, nil]
32
+ optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
33
+
34
+ # @!attribute first
35
+ # Returns the first _n_ elements from the list.
36
+ #
37
+ # @return [Integer, nil]
38
+ optional :first, Integer, nil?: true
39
+
40
+ # @!attribute last
41
+ # Returns the last _n_ elements from the list.
42
+ #
43
+ # @return [Integer, nil]
44
+ optional :last, Integer, nil?: true
45
+
46
+ # @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
47
+ # @param company_id [String] The ID of the company to list disputes for
48
+ #
49
+ # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
50
+ #
51
+ # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
52
+ #
53
+ # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
54
+ #
55
+ # @param first [Integer, nil] Returns the first _n_ elements from the list.
56
+ #
57
+ # @param last [Integer, nil] Returns the last _n_ elements from the list.
58
+ #
59
+ # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
60
+ end
61
+ end
62
+ end
@@ -0,0 +1,187 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Disputes#list
6
+ class DisputeListResponse < WhopSDK::Internal::Type::BaseModel
7
+ # @!attribute id
8
+ # The internal ID of the dispute.
9
+ #
10
+ # @return [String]
11
+ required :id, String
12
+
13
+ # @!attribute amount
14
+ # The amount of the dispute (formatted).
15
+ #
16
+ # @return [Float]
17
+ required :amount, Float
18
+
19
+ # @!attribute company
20
+ # The company the dispute is against.
21
+ #
22
+ # @return [WhopSDK::Models::DisputeListResponse::Company, nil]
23
+ required :company, -> { WhopSDK::Models::DisputeListResponse::Company }, nil?: true
24
+
25
+ # @!attribute created_at
26
+ # When it was made.
27
+ #
28
+ # @return [Time, nil]
29
+ required :created_at, Time, nil?: true
30
+
31
+ # @!attribute currency
32
+ # The currency of the dispute.
33
+ #
34
+ # @return [Symbol, WhopSDK::Models::Currency]
35
+ required :currency, enum: -> { WhopSDK::Currency }
36
+
37
+ # @!attribute editable
38
+ # Whether or not the dispute data can be edited.
39
+ #
40
+ # @return [Boolean, nil]
41
+ required :editable, WhopSDK::Internal::Type::Boolean, nil?: true
42
+
43
+ # @!attribute needs_response_by
44
+ # The last date the dispute is allow to be submitted by.
45
+ #
46
+ # @return [Time, nil]
47
+ required :needs_response_by, Time, nil?: true
48
+
49
+ # @!attribute payment
50
+ # The payment that got disputed
51
+ #
52
+ # @return [WhopSDK::Models::DisputeListResponse::Payment, nil]
53
+ required :payment, -> { WhopSDK::Models::DisputeListResponse::Payment }, nil?: true
54
+
55
+ # @!attribute plan
56
+ # The plan that got disputed
57
+ #
58
+ # @return [WhopSDK::Models::DisputeListResponse::Plan, nil]
59
+ required :plan, -> { WhopSDK::Models::DisputeListResponse::Plan }, nil?: true
60
+
61
+ # @!attribute product
62
+ # The product that got disputed
63
+ #
64
+ # @return [WhopSDK::Models::DisputeListResponse::Product, nil]
65
+ required :product, -> { WhopSDK::Models::DisputeListResponse::Product }, nil?: true
66
+
67
+ # @!attribute reason
68
+ # The reason for the dispute
69
+ #
70
+ # @return [String, nil]
71
+ required :reason, String, nil?: true
72
+
73
+ # @!attribute status
74
+ # The status of the dispute (mimics stripe's dispute status).
75
+ #
76
+ # @return [Symbol, WhopSDK::Models::DisputeStatuses]
77
+ required :status, enum: -> { WhopSDK::DisputeStatuses }
78
+
79
+ # @!attribute visa_rdr
80
+ # Whether or not the dispute is a Visa Rapid Dispute Resolution.
81
+ #
82
+ # @return [Boolean]
83
+ required :visa_rdr, WhopSDK::Internal::Type::Boolean
84
+
85
+ # @!method initialize(id:, amount:, company:, created_at:, currency:, editable:, needs_response_by:, payment:, plan:, product:, reason:, status:, visa_rdr:)
86
+ # An object representing a dispute against a company.
87
+ #
88
+ # @param id [String] The internal ID of the dispute.
89
+ #
90
+ # @param amount [Float] The amount of the dispute (formatted).
91
+ #
92
+ # @param company [WhopSDK::Models::DisputeListResponse::Company, nil] The company the dispute is against.
93
+ #
94
+ # @param created_at [Time, nil] When it was made.
95
+ #
96
+ # @param currency [Symbol, WhopSDK::Models::Currency] The currency of the dispute.
97
+ #
98
+ # @param editable [Boolean, nil] Whether or not the dispute data can be edited.
99
+ #
100
+ # @param needs_response_by [Time, nil] The last date the dispute is allow to be submitted by.
101
+ #
102
+ # @param payment [WhopSDK::Models::DisputeListResponse::Payment, nil] The payment that got disputed
103
+ #
104
+ # @param plan [WhopSDK::Models::DisputeListResponse::Plan, nil] The plan that got disputed
105
+ #
106
+ # @param product [WhopSDK::Models::DisputeListResponse::Product, nil] The product that got disputed
107
+ #
108
+ # @param reason [String, nil] The reason for the dispute
109
+ #
110
+ # @param status [Symbol, WhopSDK::Models::DisputeStatuses] The status of the dispute (mimics stripe's dispute status).
111
+ #
112
+ # @param visa_rdr [Boolean] Whether or not the dispute is a Visa Rapid Dispute Resolution.
113
+
114
+ # @see WhopSDK::Models::DisputeListResponse#company
115
+ class Company < WhopSDK::Internal::Type::BaseModel
116
+ # @!attribute id
117
+ # The ID of the company
118
+ #
119
+ # @return [String]
120
+ required :id, String
121
+
122
+ # @!attribute title
123
+ # The written name of the company.
124
+ #
125
+ # @return [String]
126
+ required :title, String
127
+
128
+ # @!method initialize(id:, title:)
129
+ # The company the dispute is against.
130
+ #
131
+ # @param id [String] The ID of the company
132
+ #
133
+ # @param title [String] The written name of the company.
134
+ end
135
+
136
+ # @see WhopSDK::Models::DisputeListResponse#payment
137
+ class Payment < WhopSDK::Internal::Type::BaseModel
138
+ # @!attribute id
139
+ # The payment ID
140
+ #
141
+ # @return [String]
142
+ required :id, String
143
+
144
+ # @!method initialize(id:)
145
+ # The payment that got disputed
146
+ #
147
+ # @param id [String] The payment ID
148
+ end
149
+
150
+ # @see WhopSDK::Models::DisputeListResponse#plan
151
+ class Plan < WhopSDK::Internal::Type::BaseModel
152
+ # @!attribute id
153
+ # The internal ID of the plan.
154
+ #
155
+ # @return [String]
156
+ required :id, String
157
+
158
+ # @!method initialize(id:)
159
+ # The plan that got disputed
160
+ #
161
+ # @param id [String] The internal ID of the plan.
162
+ end
163
+
164
+ # @see WhopSDK::Models::DisputeListResponse#product
165
+ class Product < WhopSDK::Internal::Type::BaseModel
166
+ # @!attribute id
167
+ # The internal ID of the public product.
168
+ #
169
+ # @return [String]
170
+ required :id, String
171
+
172
+ # @!attribute title
173
+ # The title of the product. Use for Whop 4.0.
174
+ #
175
+ # @return [String]
176
+ required :title, String
177
+
178
+ # @!method initialize(id:, title:)
179
+ # The product that got disputed
180
+ #
181
+ # @param id [String] The internal ID of the public product.
182
+ #
183
+ # @param title [String] The title of the product. Use for Whop 4.0.
184
+ end
185
+ end
186
+ end
187
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Disputes#retrieve
6
+ class DisputeRetrieveParams < 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,23 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # The possible statuses of a dispute
6
+ module DisputeStatuses
7
+ extend WhopSDK::Internal::Type::Enum
8
+
9
+ WARNING_NEEDS_RESPONSE = :warning_needs_response
10
+ WARNING_UNDER_REVIEW = :warning_under_review
11
+ WARNING_CLOSED = :warning_closed
12
+ NEEDS_RESPONSE = :needs_response
13
+ UNDER_REVIEW = :under_review
14
+ WON = :won
15
+ LOST = :lost
16
+ CLOSED = :closed
17
+ OTHER = :other
18
+
19
+ # @!method self.values
20
+ # @return [Array<Symbol>]
21
+ end
22
+ end
23
+ end
@@ -0,0 +1,14 @@
1
+ # frozen_string_literal: true
2
+
3
+ module WhopSDK
4
+ module Models
5
+ # @see WhopSDK::Resources::Disputes#submit_evidence
6
+ class DisputeSubmitEvidenceParams < 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