whop_sdk 0.0.5 → 0.0.6

data/lib/whop_sdk/resources/disputes.rb

@@ -0,0 +1,182 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Disputes
+      # Retrieves a Dispute by ID
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      #
+      # @overload retrieve(id, request_options: {})
+      #
+      # @param id [String] The ID of the dispute
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Dispute]
+      #
+      # @see WhopSDK::Models::DisputeRetrieveParams
+      def retrieve(id, params = {})
+        @client.request(
+          method: :get,
+          path: ["disputes/%1$s", id],
+          model: WhopSDK::Dispute,
+          options: params[:request_options]
+        )
+      end
+
+      # Lists disputes the current actor has access to
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      #
+      # @overload list(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
+      #
+      # @param company_id [String] The ID of the company to list disputes for
+      #
+      # @param after [String, nil] Returns the elements in the list that come after the specified cursor.
+      #
+      # @param before [String, nil] Returns the elements in the list that come before the specified cursor.
+      #
+      # @param direction [Symbol, WhopSDK::Models::Direction, nil] The direction of the sort.
+      #
+      # @param first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      # @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Internal::CursorPage<WhopSDK::Models::DisputeListResponse>]
+      #
+      # @see WhopSDK::Models::DisputeListParams
+      def list(params)
+        parsed, options = WhopSDK::DisputeListParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: "disputes",
+          query: parsed,
+          page: WhopSDK::Internal::CursorPage,
+          model: WhopSDK::Models::DisputeListResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::DisputeSubmitEvidenceParams} for more details.
+      #
+      # Submit a payment dispute to the payment processor for review. Once submitted, no
+      # further edits can be made.
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      #
+      # @overload submit_evidence(id, request_options: {})
+      #
+      # @param id [String] The ID of the dispute (Ex. dspt_xxxx) you want to finalize evidence submission f
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Dispute]
+      #
+      # @see WhopSDK::Models::DisputeSubmitEvidenceParams
+      def submit_evidence(id, params = {})
+        @client.request(
+          method: :post,
+          path: ["disputes/%1$s/submit_evidence", id],
+          model: WhopSDK::Dispute,
+          options: params[:request_options]
+        )
+      end
+
+      # Update a dispute with evidence data to attempt to win the dispute.
+      #
+      # Required permissions:
+      #
+      # - `payment:dispute`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `company:basic:read`
+      # - `payment:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      #
+      # @overload update_evidence(id, access_activity_log: nil, billing_address: nil, cancellation_policy_attachment: nil, cancellation_policy_disclosure: nil, customer_communication_attachment: nil, customer_email_address: nil, customer_name: nil, notes: nil, product_description: nil, refund_policy_attachment: nil, refund_policy_disclosure: nil, refund_refusal_explanation: nil, service_date: nil, uncategorized_attachment: nil, request_options: {})
+      #
+      # @param id [String] The ID of the dispute you want to update.
+      #
+      # @param access_activity_log [String, nil] An IP access log for the user from Whop.
+      #
+      # @param billing_address [String, nil] The billing address of the user from their payment details.
+      #
+      # @param cancellation_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::CancellationPolicyAttachment::AttachmentInputWithID, nil] A file containing the cancellation policy from the company.
+      #
+      # @param cancellation_policy_disclosure [String, nil] A cancellation policy disclosure from the company.
+      #
+      # @param customer_communication_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::CustomerCommunicationAttachment::AttachmentInputWithID, nil] A file containing the customer communication from the company (An image).
+      #
+      # @param customer_email_address [String, nil] The email of the customer from their payment details.
+      #
+      # @param customer_name [String, nil] The name of the customer from their payment details.
+      #
+      # @param notes [String, nil] Additional notes the company chooses to submit regarding the dispute.
+      #
+      # @param product_description [String, nil] The description of the product from the company.
+      #
+      # @param refund_policy_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::RefundPolicyAttachment::AttachmentInputWithID, nil] A file containing the refund policy from the company.
+      #
+      # @param refund_policy_disclosure [String, nil] A refund policy disclosure from the company.
+      #
+      # @param refund_refusal_explanation [String, nil] A description on why the refund is being refused by the company.
+      #
+      # @param service_date [String, nil] When the product was delivered by the company.
+      #
+      # @param uncategorized_attachment [WhopSDK::Models::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithDirectUploadID, WhopSDK::Models::DisputeUpdateEvidenceParams::UncategorizedAttachment::AttachmentInputWithID, nil] A file that does not fit in the other categories.
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::Dispute]
+      #
+      # @see WhopSDK::Models::DisputeUpdateEvidenceParams
+      def update_evidence(id, params = {})
+        parsed, options = WhopSDK::DisputeUpdateEvidenceParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: ["disputes/%1$s/update_evidence", id],
+          body: parsed,
+          model: WhopSDK::Dispute,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/notifications.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Resources
+    class Notifications
+      # Some parameter documentations has been truncated, see
+      # {WhopSDK::Models::NotificationCreateParams} for more details.
+      #
+      # Queues a notification to be sent to users in an experience or company team
+      #
+      # @overload create(company_id:, content:, title:, experience_id:, icon_user_id: nil, rest_path: nil, subtitle: nil, user_ids: nil, request_options: {})
+      #
+      # @param company_id [String] The id of the company to target. Only team members of this company will receive
+      #
+      # @param content [String] The content of the notification
+      #
+      # @param title [String] The title of the notification
+      #
+      # @param experience_id [String] The id of the experience to target. All users with access to this experience (cu
+      #
+      # @param icon_user_id [String, nil] Optional: ID of a Whop user whose profile picture will be used as the notificati
+      #
+      # @param rest_path [String, nil] The rest path to append to the generated deep link that opens your app. Use [res
+      #
+      # @param subtitle [String, nil] The subtitle of the notification
+      #
+      # @param user_ids [Array<String>, nil] If provided, this will only send to these users if they are also in the main sco
+      #
+      # @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [WhopSDK::Models::NotificationCreateResponse]
+      #
+      # @see WhopSDK::Models::NotificationCreateParams
+      def create(params)
+        parsed, options = WhopSDK::NotificationCreateParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "notifications",
+          body: parsed,
+          model: WhopSDK::Models::NotificationCreateResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [WhopSDK::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/whop_sdk/resources/webhooks.rb

@@ -5,7 +5,7 @@ module WhopSDK
     class Webhooks
       # @param payload [String] The raw webhook payload as a string
       #
-      # @return [WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent]
+      # @return [WhopSDK::Models::InvoiceCreatedWebhookEvent, WhopSDK::Models::InvoicePaidWebhookEvent, WhopSDK::Models::InvoicePastDueWebhookEvent, WhopSDK::Models::InvoiceVoidedWebhookEvent, WhopSDK::Models::MembershipActivatedWebhookEvent, WhopSDK::Models::MembershipDeactivatedWebhookEvent, WhopSDK::Models::EntryCreatedWebhookEvent, WhopSDK::Models::EntryApprovedWebhookEvent, WhopSDK::Models::EntryDeniedWebhookEvent, WhopSDK::Models::EntryDeletedWebhookEvent, WhopSDK::Models::CourseLessonInteractionCompletedWebhookEvent, WhopSDK::Models::PaymentSucceededWebhookEvent, WhopSDK::Models::PaymentFailedWebhookEvent, WhopSDK::Models::PaymentPendingWebhookEvent, WhopSDK::Models::DisputeCreatedWebhookEvent, WhopSDK::Models::DisputeUpdatedWebhookEvent]
       def unwrap(payload)
         parsed = JSON.parse(payload, symbolize_names: true)
         WhopSDK::Internal::Type::Converter.coerce(WhopSDK::Models::UnwrapWebhookEvent, parsed)

data/lib/whop_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WhopSDK
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

data/lib/whop_sdk.rb

@@ -133,6 +133,15 @@ require_relative "whop_sdk/models/course_visibilities"
 require_relative "whop_sdk/models/currency"
 require_relative "whop_sdk/models/custom_cta"
 require_relative "whop_sdk/models/direction"
+require_relative "whop_sdk/models/dispute"
+require_relative "whop_sdk/models/dispute_created_webhook_event"
+require_relative "whop_sdk/models/dispute_list_params"
+require_relative "whop_sdk/models/dispute_list_response"
+require_relative "whop_sdk/models/dispute_retrieve_params"
+require_relative "whop_sdk/models/dispute_statuses"
+require_relative "whop_sdk/models/dispute_submit_evidence_params"
+require_relative "whop_sdk/models/dispute_updated_webhook_event"
+require_relative "whop_sdk/models/dispute_update_evidence_params"
 require_relative "whop_sdk/models/dms_post_types"
 require_relative "whop_sdk/models/email_notification_preferences"
 require_relative "whop_sdk/models/embed_type"
@@ -214,6 +223,8 @@ require_relative "whop_sdk/models/message_list_params"
 require_relative "whop_sdk/models/message_list_response"
 require_relative "whop_sdk/models/message_retrieve_params"
 require_relative "whop_sdk/models/message_update_params"
+require_relative "whop_sdk/models/notification_create_params"
+require_relative "whop_sdk/models/notification_create_response"
 require_relative "whop_sdk/models/page_info"
 require_relative "whop_sdk/models/payment"
 require_relative "whop_sdk/models/payment_failed_webhook_event"
@@ -309,6 +320,7 @@ require_relative "whop_sdk/resources/course_lesson_interactions"
 require_relative "whop_sdk/resources/course_lessons"
 require_relative "whop_sdk/resources/courses"
 require_relative "whop_sdk/resources/course_students"
+require_relative "whop_sdk/resources/disputes"
 require_relative "whop_sdk/resources/entries"
 require_relative "whop_sdk/resources/experiences"
 require_relative "whop_sdk/resources/forum_posts"
@@ -318,6 +330,7 @@ require_relative "whop_sdk/resources/ledger_accounts"
 require_relative "whop_sdk/resources/members"
 require_relative "whop_sdk/resources/memberships"
 require_relative "whop_sdk/resources/messages"
+require_relative "whop_sdk/resources/notifications"
 require_relative "whop_sdk/resources/payments"
 require_relative "whop_sdk/resources/plans"
 require_relative "whop_sdk/resources/products"

data/rbi/whop_sdk/client.rbi

@@ -14,7 +14,9 @@ module WhopSDK
     sig { returns(String) }
     attr_reader :api_key
 
-    sig { returns(String) }
+    # When using the SDK in app mode pass this parameter to allow verifying user
+    # tokens
+    sig { returns(T.nilable(String)) }
     attr_reader :app_id
 
     sig { returns(WhopSDK::Resources::Apps) }
@@ -113,6 +115,12 @@ module WhopSDK
     sig { returns(WhopSDK::Resources::AccessTokens) }
     attr_reader :access_tokens
 
+    sig { returns(WhopSDK::Resources::Notifications) }
+    attr_reader :notifications
+
+    sig { returns(WhopSDK::Resources::Disputes) }
+    attr_reader :disputes
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers
@@ -134,7 +142,8 @@ module WhopSDK
       # The app API key from an app from the /dashboard/developer page Defaults to
       # `ENV["WHOP_API_KEY"]`
       api_key: ENV["WHOP_API_KEY"],
-      # Defaults to `ENV["WHOP_APP_ID"]`
+      # When using the SDK in app mode pass this parameter to allow verifying user
+      # tokens Defaults to `ENV["WHOP_APP_ID"]`
       app_id: ENV["WHOP_APP_ID"],
       # Override the default base URL for the API, e.g.,
       # `"https://api.example.com/v2/"`. Defaults to `ENV["WHOP_BASE_URL"]`

data/rbi/whop_sdk/models/company.rbi

@@ -302,6 +302,8 @@ module WhopSDK
             T.let(:twitch, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
           WEBSITE =
             T.let(:website, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
+          CUSTOM =
+            T.let(:custom, WhopSDK::Company::SocialLink::Website::TaggedSymbol)
 
           sig do
             override.returns(