whop_sdk 0.0.2

data/rbi/whop_sdk/resources/payments.rbi

@@ -0,0 +1,173 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Payments
+      # Retrieves a payment by ID
+      #
+      # Required permissions:
+      #
+      # - `payment:basic:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      # - `promo_code:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Payment)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Lists payments
+      #
+      # Required permissions:
+      #
+      # - `payment:basic:read`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      # - `promo_code:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          billing_reasons:
+            T.nilable(
+              T::Array[WhopSDK::PaymentListParams::BillingReason::OrSymbol]
+            ),
+          created_after: T.nilable(Time),
+          created_before: T.nilable(Time),
+          currencies: T.nilable(T::Array[WhopSDK::Currency::OrSymbol]),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          include_free: T.nilable(T::Boolean),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::PaymentListParams::Order::OrSymbol),
+          plan_ids: T.nilable(T::Array[String]),
+          product_ids: T.nilable(T::Array[String]),
+          statuses: T.nilable(T::Array[WhopSDK::ReceiptStatus::OrSymbol]),
+          substatuses:
+            T.nilable(T::Array[WhopSDK::FriendlyReceiptStatus::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::PaymentListResponse]
+        )
+      end
+      def list(
+        # The ID of the company to list payments for
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The billing reason for the payment
+        billing_reasons: nil,
+        # The minimum creation date to filter by
+        created_after: nil,
+        # The maximum creation date to filter by
+        created_before: nil,
+        # The currency of the payment.
+        currencies: nil,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Whether to include free payments.
+        include_free: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The order to sort the results by.
+        order: nil,
+        # A specific plan.
+        plan_ids: nil,
+        # A specific product.
+        product_ids: nil,
+        # The status of the payment.
+        statuses: nil,
+        # The substatus of the payment.
+        substatuses: nil,
+        request_options: {}
+      )
+      end
+
+      # Refunds a payment
+      #
+      # Required permissions:
+      #
+      # - `payment:manage`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      # - `promo_code:basic:read`
+      sig do
+        params(
+          id: String,
+          partial_amount: T.nilable(Float),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Payment)
+      end
+      def refund(
+        id,
+        # An amount if the refund is supposed to be partial.
+        partial_amount: nil,
+        request_options: {}
+      )
+      end
+
+      # Retries a payment
+      #
+      # Required permissions:
+      #
+      # - `payment:manage`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      # - `promo_code:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Payment)
+      end
+      def retry_(id, request_options: {})
+      end
+
+      # Voids a payment
+      #
+      # Required permissions:
+      #
+      # - `payment:manage`
+      # - `plan:basic:read`
+      # - `access_pass:basic:read`
+      # - `member:email:read`
+      # - `member:basic:read`
+      # - `member:phone:read`
+      # - `promo_code:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Payment)
+      end
+      def void(id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/plans.rbi

@@ -0,0 +1,228 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Plans
+      # Create a new Plan
+      #
+      # Required permissions:
+      #
+      # - `plan:create`
+      # - `access_pass:basic:read`
+      # - `plan:basic:read`
+      sig do
+        params(
+          company_id: String,
+          product_id: String,
+          billing_period: T.nilable(Integer),
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          custom_fields:
+            T.nilable(T::Array[WhopSDK::PlanCreateParams::CustomField::OrHash]),
+          description: T.nilable(String),
+          expiration_days: T.nilable(Integer),
+          image: T.nilable(WhopSDK::PlanCreateParams::Image::OrHash),
+          initial_price: T.nilable(Float),
+          internal_notes: T.nilable(String),
+          override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          plan_type: T.nilable(WhopSDK::PlanType::OrSymbol),
+          release_method: T.nilable(WhopSDK::ReleaseMethod::OrSymbol),
+          renewal_price: T.nilable(Float),
+          title: T.nilable(String),
+          trial_period_days: T.nilable(Integer),
+          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Plan)
+      end
+      def create(
+        # The company the plan should be created for.
+        company_id:,
+        # The product the plan is related to.
+        product_id:,
+        # The interval at which the plan charges (renewal plans).
+        billing_period: nil,
+        # The available currencies on the platform
+        currency: nil,
+        # An array of custom field objects.
+        custom_fields: nil,
+        # The description of the plan.
+        description: nil,
+        # The interval at which the plan charges (expiration plans).
+        expiration_days: nil,
+        # An image for the plan. This will be visible on the product page to customers.
+        image: nil,
+        # An additional amount charged upon first purchase. Use only if a one time payment
+        # OR you want to charge an additional amount on top of the renewal price. Provided
+        # as a number in dollars. Eg: 10.43 for $10.43
+        initial_price: nil,
+        # A personal description or notes section for the business.
+        internal_notes: nil,
+        # Whether or not the tax is included in a plan's price (or if it hasn't been set
+        # up)
+        override_tax_type: nil,
+        # The type of plan that can be attached to an access pass
+        plan_type: nil,
+        # The methods of how a plan can be released.
+        release_method: nil,
+        # The amount the customer is charged every billing period. Use only if a recurring
+        # payment. Provided as a number in dollars. Eg: 10.43 for $10.43
+        renewal_price: nil,
+        # The title of the plan. This will be visible on the product page to customers.
+        title: nil,
+        # The number of free trial days added before a renewal plan.
+        trial_period_days: nil,
+        # Visibility of a resource
+        visibility: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a plan by ID
+      #
+      # Required permissions:
+      #
+      # - `plan:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Plan)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Update an existing Plan
+      #
+      # Required permissions:
+      #
+      # - `plan:update`
+      # - `access_pass:basic:read`
+      # - `plan:basic:read`
+      sig do
+        params(
+          id: String,
+          billing_period: T.nilable(Integer),
+          currency: T.nilable(WhopSDK::Currency::OrSymbol),
+          custom_fields:
+            T.nilable(T::Array[WhopSDK::PlanUpdateParams::CustomField::OrHash]),
+          description: T.nilable(String),
+          expiration_days: T.nilable(Integer),
+          image: T.nilable(WhopSDK::PlanUpdateParams::Image::OrHash),
+          initial_price: T.nilable(Float),
+          internal_notes: T.nilable(String),
+          offer_cancel_discount: T.nilable(T::Boolean),
+          override_tax_type: T.nilable(WhopSDK::TaxType::OrSymbol),
+          renewal_price: T.nilable(Float),
+          title: T.nilable(String),
+          trial_period_days: T.nilable(Integer),
+          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Plan)
+      end
+      def update(
+        id,
+        # The interval at which the plan charges (renewal plans).
+        billing_period: nil,
+        # The available currencies on the platform
+        currency: nil,
+        # An array of custom field objects.
+        custom_fields: nil,
+        # The description of the plan.
+        description: nil,
+        # The interval at which the plan charges (expiration plans).
+        expiration_days: nil,
+        # An image for the plan. This will be visible on the product page to customers.
+        image: nil,
+        # An additional amount charged upon first purchase.
+        initial_price: nil,
+        # A personal description or notes section for the business.
+        internal_notes: nil,
+        # Whether or not to offer a discount to cancel a subscription.
+        offer_cancel_discount: nil,
+        # Whether or not the tax is included in a plan's price (or if it hasn't been set
+        # up)
+        override_tax_type: nil,
+        # The amount the customer is charged every billing period.
+        renewal_price: nil,
+        # The title of the plan. This will be visible on the product page to customers.
+        title: nil,
+        # The number of free trial days added before a renewal plan.
+        trial_period_days: nil,
+        # Visibility of a resource
+        visibility: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists plans for a company
+      #
+      # Required permissions:
+      #
+      # - `plan:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::PlanListParams::Order::OrSymbol),
+          plan_types: T.nilable(T::Array[WhopSDK::PlanType::OrSymbol]),
+          product_ids: T.nilable(T::Array[String]),
+          release_methods:
+            T.nilable(T::Array[WhopSDK::ReleaseMethod::OrSymbol]),
+          visibilities:
+            T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(
+          WhopSDK::Internal::CursorPage[WhopSDK::Models::PlanListResponse]
+        )
+      end
+      def list(
+        # The ID of the company
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ways a relation of Plans can be ordered
+        order: nil,
+        # The plan type to filter the plans by
+        plan_types: nil,
+        # The product IDs to filter the plans by
+        product_ids: nil,
+        # The release method to filter the plans by
+        release_methods: nil,
+        # The visibility to filter the plans by
+        visibilities: nil,
+        request_options: {}
+      )
+      end
+
+      # Delete an existing Plan
+      #
+      # Required permissions:
+      #
+      # - `plan:delete`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/whop_sdk/resources/products.rbi

@@ -0,0 +1,254 @@
+# typed: strong
+
+module WhopSDK
+  module Resources
+    class Products
+      # Creates a new Product
+      #
+      # Required permissions:
+      #
+      # - `access_pass:create`
+      # - `access_pass:basic:read`
+      sig do
+        params(
+          company_id: String,
+          title: String,
+          access_pass_type: T.nilable(WhopSDK::AccessPassType::OrSymbol),
+          banner_image:
+            T.nilable(WhopSDK::ProductCreateParams::BannerImage::OrHash),
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          collect_shipping_address: T.nilable(T::Boolean),
+          custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
+          custom_cta_url: T.nilable(String),
+          custom_statement_descriptor: T.nilable(String),
+          description: T.nilable(String),
+          experience_ids: T.nilable(T::Array[String]),
+          global_affiliate_percentage: T.nilable(Float),
+          global_affiliate_status:
+            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          headline: T.nilable(String),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+          member_affiliate_percentage: T.nilable(Float),
+          member_affiliate_status:
+            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          plan_options:
+            T.nilable(WhopSDK::ProductCreateParams::PlanOptions::OrHash),
+          product_highlights:
+            T.nilable(
+              T::Array[WhopSDK::ProductCreateParams::ProductHighlight::OrHash]
+            ),
+          product_tax_code_id: T.nilable(String),
+          redirect_purchase_url: T.nilable(String),
+          route: T.nilable(String),
+          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Product)
+      end
+      def create(
+        # The ID of the company to create the product for.
+        company_id:,
+        # The title of the product.
+        title:,
+        # The different types an access pass can be.
+        access_pass_type: nil,
+        # A banner image for the product in png, jpeg format
+        banner_image: nil,
+        # The different business types a company can be.
+        business_type: nil,
+        # Whether or not to collect shipping information at checkout from the customer.
+        collect_shipping_address: nil,
+        # The different types of custom CTAs that can be selected.
+        custom_cta: nil,
+        # The custom call to action URL for the product.
+        custom_cta_url: nil,
+        # The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+        # between 5 and 22 characters, contain at least one letter, and not contain any of
+        # the following characters: <, >, \, ', "
+        custom_statement_descriptor: nil,
+        # A written description of the product.
+        description: nil,
+        # An array of experience IDs that this pass has
+        experience_ids: nil,
+        # The percentage of the revenue that goes to the global affiliate program.
+        global_affiliate_percentage: nil,
+        # The different statuses of the global affiliate program for an access pass.
+        global_affiliate_status: nil,
+        # The headline of the product.
+        headline: nil,
+        # The different industry types a company can be in.
+        industry_type: nil,
+        # The percentage of the revenue that goes to the member affiliate program.
+        member_affiliate_percentage: nil,
+        # The different statuses of the global affiliate program for an access pass.
+        member_affiliate_status: nil,
+        # The details to assign an autogenerated plan.
+        plan_options: nil,
+        # The product highlights for the product.
+        product_highlights: nil,
+        # The ID of the product tax code to apply to this product.
+        product_tax_code_id: nil,
+        # The URL to redirect the customer to after a purchase.
+        redirect_purchase_url: nil,
+        # The route of the product.
+        route: nil,
+        # Visibility of a resource
+        visibility: nil,
+        request_options: {}
+      )
+      end
+
+      # Retrieves a product by ID or route
+      #
+      # Required permissions:
+      #
+      # - `access_pass:basic:read`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Product)
+      end
+      def retrieve(id, request_options: {})
+      end
+
+      # Updates an existing Product
+      #
+      # Required permissions:
+      #
+      # - `access_pass:update`
+      # - `access_pass:basic:read`
+      sig do
+        params(
+          id: String,
+          banner_image:
+            T.nilable(WhopSDK::ProductUpdateParams::BannerImage::OrHash),
+          business_type: T.nilable(WhopSDK::BusinessTypes::OrSymbol),
+          collect_shipping_address: T.nilable(T::Boolean),
+          custom_cta: T.nilable(WhopSDK::CustomCta::OrSymbol),
+          custom_cta_url: T.nilable(String),
+          custom_statement_descriptor: T.nilable(String),
+          description: T.nilable(String),
+          global_affiliate_percentage: T.nilable(Float),
+          global_affiliate_status:
+            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          headline: T.nilable(String),
+          industry_type: T.nilable(WhopSDK::IndustryTypes::OrSymbol),
+          member_affiliate_percentage: T.nilable(Float),
+          member_affiliate_status:
+            T.nilable(WhopSDK::GlobalAffiliateStatus::OrSymbol),
+          product_tax_code_id: T.nilable(String),
+          redirect_purchase_url: T.nilable(String),
+          route: T.nilable(String),
+          title: T.nilable(String),
+          visibility: T.nilable(WhopSDK::Visibility::OrSymbol),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Product)
+      end
+      def update(
+        id,
+        # A banner image for the product in png, jpeg format
+        banner_image: nil,
+        # The different business types a company can be.
+        business_type: nil,
+        # Whether or not to collect shipping information at checkout from the customer.
+        collect_shipping_address: nil,
+        # The different types of custom CTAs that can be selected.
+        custom_cta: nil,
+        # The custom call to action URL for the product.
+        custom_cta_url: nil,
+        # The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+        # between 5 and 22 characters, contain at least one letter, and not contain any of
+        # the following characters: <, >, \, ', "
+        custom_statement_descriptor: nil,
+        # A written description of the product.
+        description: nil,
+        # The percentage of the revenue that goes to the global affiliate program.
+        global_affiliate_percentage: nil,
+        # The different statuses of the global affiliate program for an access pass.
+        global_affiliate_status: nil,
+        # The headline of the product.
+        headline: nil,
+        # The different industry types a company can be in.
+        industry_type: nil,
+        # The percentage of the revenue that goes to the member affiliate program.
+        member_affiliate_percentage: nil,
+        # The different statuses of the global affiliate program for an access pass.
+        member_affiliate_status: nil,
+        # The ID of the product tax code to apply to this product.
+        product_tax_code_id: nil,
+        # The URL to redirect the customer to after a purchase.
+        redirect_purchase_url: nil,
+        # The route of the product.
+        route: nil,
+        # The title of the product.
+        title: nil,
+        # Visibility of a resource
+        visibility: nil,
+        request_options: {}
+      )
+      end
+
+      # Lists products for a company
+      #
+      # Required permissions:
+      #
+      # - `access_pass:basic:read`
+      sig do
+        params(
+          company_id: String,
+          after: T.nilable(String),
+          before: T.nilable(String),
+          direction: T.nilable(WhopSDK::Direction::OrSymbol),
+          first: T.nilable(Integer),
+          last: T.nilable(Integer),
+          order: T.nilable(WhopSDK::ProductListParams::Order::OrSymbol),
+          product_types: T.nilable(T::Array[WhopSDK::AccessPassType::OrSymbol]),
+          visibilities:
+            T.nilable(T::Array[WhopSDK::VisibilityFilter::OrSymbol]),
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(WhopSDK::Internal::CursorPage[WhopSDK::ProductListItem])
+      end
+      def list(
+        # The ID of the company to filter products by
+        company_id:,
+        # Returns the elements in the list that come after the specified cursor.
+        after: nil,
+        # Returns the elements in the list that come before the specified cursor.
+        before: nil,
+        # The direction of the sort.
+        direction: nil,
+        # Returns the first _n_ elements from the list.
+        first: nil,
+        # Returns the last _n_ elements from the list.
+        last: nil,
+        # The ways a relation of AccessPasses can be ordered
+        order: nil,
+        # The type of products to filter by
+        product_types: nil,
+        # The visibility of the products to filter by
+        visibilities: nil,
+        request_options: {}
+      )
+      end
+
+      # Deletes an existing Product
+      #
+      # Required permissions:
+      #
+      # - `access_pass:delete`
+      sig do
+        params(
+          id: String,
+          request_options: WhopSDK::RequestOptions::OrHash
+        ).returns(T::Boolean)
+      end
+      def delete(id, request_options: {})
+      end
+
+      # @api private
+      sig { params(client: WhopSDK::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end