whop_sdk 0.0.2

data/lib/whop_sdk/models/payment_pending_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class PaymentPendingWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   An object representing a receipt for a membership.
+      #
+      #   @return [WhopSDK::Models::Payment]
+      required :data, -> { WhopSDK::Payment }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"payment.pending"]
+      required :type, const: :"payment.pending"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"payment.pending")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Payment] An object representing a receipt for a membership.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"payment.pending"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/payment_refund_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payments#refund
+    class PaymentRefundParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute partial_amount
+      #   An amount if the refund is supposed to be partial.
+      #
+      #   @return [Float, nil]
+      optional :partial_amount, Float, nil?: true
+
+      # @!method initialize(partial_amount: nil, request_options: {})
+      #   @param partial_amount [Float, nil] An amount if the refund is supposed to be partial.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/payment_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payments#retrieve
+    class PaymentRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/payment_retry_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payments#retry_
+    class PaymentRetryParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/payment_succeeded_webhook_event.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class PaymentSucceededWebhookEvent < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID for every single webhook request
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute api_version
+      #   The API version for this webhook
+      #
+      #   @return [Symbol, :v1]
+      required :api_version, const: :v1
+
+      # @!attribute data
+      #   An object representing a receipt for a membership.
+      #
+      #   @return [WhopSDK::Models::Payment]
+      required :data, -> { WhopSDK::Payment }
+
+      # @!attribute timestamp
+      #   The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @return [Time]
+      required :timestamp, Time
+
+      # @!attribute type
+      #   The webhook event type
+      #
+      #   @return [Symbol, :"payment.succeeded"]
+      required :type, const: :"payment.succeeded"
+
+      # @!method initialize(id:, data:, timestamp:, api_version: :v1, type: :"payment.succeeded")
+      #   @param id [String] A unique ID for every single webhook request
+      #
+      #   @param data [WhopSDK::Models::Payment] An object representing a receipt for a membership.
+      #
+      #   @param timestamp [Time] The timestamp in ISO 8601 format that the webhook was sent at on the server
+      #
+      #   @param api_version [Symbol, :v1] The API version for this webhook
+      #
+      #   @param type [Symbol, :"payment.succeeded"] The webhook event type
+    end
+  end
+end

data/lib/whop_sdk/models/payment_void_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payments#void
+    class PaymentVoidParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/plan.rb

@@ -0,0 +1,297 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class Plan < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the plan.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute billing_period
+      #   The interval at which the plan charges (renewal plans).
+      #
+      #   @return [Integer, nil]
+      required :billing_period, Integer, nil?: true
+
+      # @!attribute collect_tax
+      #   Whether or not the plan collects tax.
+      #
+      #   @return [Boolean]
+      required :collect_tax, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute company
+      #   The company for the plan.
+      #
+      #   @return [WhopSDK::Models::Plan::Company, nil]
+      required :company, -> { WhopSDK::Plan::Company }, nil?: true
+
+      # @!attribute created_at
+      #   When the plan was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The respective currency identifier for the plan.
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
+
+      # @!attribute custom_fields
+      #   The custom fields for the plan.
+      #
+      #   @return [Array<WhopSDK::Models::Plan::CustomField>]
+      required :custom_fields, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Plan::CustomField] }
+
+      # @!attribute description
+      #   The description of the plan.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute expiration_days
+      #   The interval at which the plan charges (expiration plans).
+      #
+      #   @return [Integer, nil]
+      required :expiration_days, Integer, nil?: true
+
+      # @!attribute initial_price
+      #   The price a person has to pay for a plan on the initial purchase.
+      #
+      #   @return [Float]
+      required :initial_price, Float
+
+      # @!attribute internal_notes
+      #   A personal description or notes section for the business.
+      #
+      #   @return [String, nil]
+      required :internal_notes, String, nil?: true
+
+      # @!attribute invoice
+      #   The invoice associated with this plan.
+      #
+      #   @return [WhopSDK::Models::Plan::Invoice, nil]
+      required :invoice, -> { WhopSDK::Plan::Invoice }, nil?: true
+
+      # @!attribute member_count
+      #   The number of members for the plan.
+      #
+      #   @return [Integer, nil]
+      required :member_count, Integer, nil?: true
+
+      # @!attribute plan_type
+      #   Indicates if the plan is a one time payment or recurring.
+      #
+      #   @return [Symbol, WhopSDK::Models::PlanType]
+      required :plan_type, enum: -> { WhopSDK::PlanType }
+
+      # @!attribute product
+      #   The access pass for the plan.
+      #
+      #   @return [WhopSDK::Models::Plan::Product, nil]
+      required :product, -> { WhopSDK::Plan::Product }, nil?: true
+
+      # @!attribute purchase_url
+      #   The direct link to purchase the product.
+      #
+      #   @return [String]
+      required :purchase_url, String
+
+      # @!attribute release_method
+      #   This is the release method the business uses to sell this plan.
+      #
+      #   @return [Symbol, WhopSDK::Models::ReleaseMethod]
+      required :release_method, enum: -> { WhopSDK::ReleaseMethod }
+
+      # @!attribute renewal_price
+      #   The price a person has to pay for a plan on the renewal purchase.
+      #
+      #   @return [Float]
+      required :renewal_price, Float
+
+      # @!attribute tax_type
+      #   The tax type for the plan.
+      #
+      #   @return [Symbol, WhopSDK::Models::TaxType]
+      required :tax_type, enum: -> { WhopSDK::TaxType }
+
+      # @!attribute trial_period_days
+      #   The number of free trial days added before a renewal plan.
+      #
+      #   @return [Integer, nil]
+      required :trial_period_days, Integer, nil?: true
+
+      # @!attribute updated_at
+      #   When the plan was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute visibility
+      #   Shows or hides the plan from public/business view.
+      #
+      #   @return [Symbol, WhopSDK::Models::Visibility]
+      required :visibility, enum: -> { WhopSDK::Visibility }
+
+      # @!method initialize(id:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, tax_type:, trial_period_days:, updated_at:, visibility:)
+      #   An object representing a (sanitized) plan of an access pass.
+      #
+      #   @param id [String] The internal ID of the plan.
+      #
+      #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
+      #
+      #   @param collect_tax [Boolean] Whether or not the plan collects tax.
+      #
+      #   @param company [WhopSDK::Models::Plan::Company, nil] The company for the plan.
+      #
+      #   @param created_at [Time] When the plan was created.
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The respective currency identifier for the plan.
+      #
+      #   @param custom_fields [Array<WhopSDK::Models::Plan::CustomField>] The custom fields for the plan.
+      #
+      #   @param description [String, nil] The description of the plan.
+      #
+      #   @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
+      #
+      #   @param initial_price [Float] The price a person has to pay for a plan on the initial purchase.
+      #
+      #   @param internal_notes [String, nil] A personal description or notes section for the business.
+      #
+      #   @param invoice [WhopSDK::Models::Plan::Invoice, nil] The invoice associated with this plan.
+      #
+      #   @param member_count [Integer, nil] The number of members for the plan.
+      #
+      #   @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
+      #
+      #   @param product [WhopSDK::Models::Plan::Product, nil] The access pass for the plan.
+      #
+      #   @param purchase_url [String] The direct link to purchase the product.
+      #
+      #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod] This is the release method the business uses to sell this plan.
+      #
+      #   @param renewal_price [Float] The price a person has to pay for a plan on the renewal purchase.
+      #
+      #   @param tax_type [Symbol, WhopSDK::Models::TaxType] The tax type for the plan.
+      #
+      #   @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
+      #
+      #   @param updated_at [Time] When the plan was last updated.
+      #
+      #   @param visibility [Symbol, WhopSDK::Models::Visibility] Shows or hides the plan from public/business view.
+
+      # @see WhopSDK::Models::Plan#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID (tag) of the company.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The company for the plan.
+        #
+        #   @param id [String] The ID (tag) of the company.
+        #
+        #   @param title [String] The title of the company.
+      end
+
+      class CustomField < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the given custom field
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute field_type
+        #   What type of input field to use.
+        #
+        #   @return [Symbol, :text]
+        required :field_type, const: :text
+
+        # @!attribute name
+        #   The title/header of the custom field.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute order
+        #   How the custom field should be ordered when rendered on the checkout page.
+        #
+        #   @return [Integer, nil]
+        required :order, Integer, nil?: true
+
+        # @!attribute placeholder
+        #   An example response displayed in the input field.
+        #
+        #   @return [String, nil]
+        required :placeholder, String, nil?: true
+
+        # @!attribute required
+        #   Whether or not the custom field is required.
+        #
+        #   @return [Boolean]
+        required :required, WhopSDK::Internal::Type::Boolean
+
+        # @!method initialize(id:, name:, order:, placeholder:, required:, field_type: :text)
+        #   An object representing a custom field for a plan.
+        #
+        #   @param id [String] The internal ID of the given custom field
+        #
+        #   @param name [String] The title/header of the custom field.
+        #
+        #   @param order [Integer, nil] How the custom field should be ordered when rendered on the checkout page.
+        #
+        #   @param placeholder [String, nil] An example response displayed in the input field.
+        #
+        #   @param required [Boolean] Whether or not the custom field is required.
+        #
+        #   @param field_type [Symbol, :text] What type of input field to use.
+      end
+
+      # @see WhopSDK::Models::Plan#invoice
+      class Invoice < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the invoice.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The invoice associated with this plan.
+        #
+        #   @param id [String] The ID of the invoice.
+      end
+
+      # @see WhopSDK::Models::Plan#product
+      class Product < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the public product.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute title
+        #   The title of the product. Use for Whop 4.0.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, title:)
+        #   The access pass for the plan.
+        #
+        #   @param id [String] The internal ID of the public product.
+        #
+        #   @param title [String] The title of the product. Use for Whop 4.0.
+      end
+    end
+  end
+end