whop_sdk 0.0.2

data/lib/whop_sdk/models/payment_list_params.rb

@@ -0,0 +1,173 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payments#list
+    class PaymentListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list payments for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute billing_reasons
+      #   The billing reason for the payment
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::PaymentListParams::BillingReason>, nil]
+      optional :billing_reasons,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentListParams::BillingReason] },
+               nil?: true
+
+      # @!attribute created_after
+      #   The minimum creation date to filter by
+      #
+      #   @return [Time, nil]
+      optional :created_after, Time, nil?: true
+
+      # @!attribute created_before
+      #   The maximum creation date to filter by
+      #
+      #   @return [Time, nil]
+      optional :created_before, Time, nil?: true
+
+      # @!attribute currencies
+      #   The currency of the payment.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::Currency>, nil]
+      optional :currencies, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::Currency] }, nil?: true
+
+      # @!attribute direction
+      #   The direction of the sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute include_free
+      #   Whether to include free payments.
+      #
+      #   @return [Boolean, nil]
+      optional :include_free, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute order
+      #   The order to sort the results by.
+      #
+      #   @return [Symbol, WhopSDK::Models::PaymentListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::PaymentListParams::Order }, nil?: true
+
+      # @!attribute plan_ids
+      #   A specific plan.
+      #
+      #   @return [Array<String>, nil]
+      optional :plan_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute product_ids
+      #   A specific product.
+      #
+      #   @return [Array<String>, nil]
+      optional :product_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute statuses
+      #   The status of the payment.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::ReceiptStatus>, nil]
+      optional :statuses, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::ReceiptStatus] }, nil?: true
+
+      # @!attribute substatuses
+      #   The substatus of the payment.
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::FriendlyReceiptStatus>, nil]
+      optional :substatuses,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::FriendlyReceiptStatus] },
+               nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, billing_reasons: nil, created_after: nil, created_before: nil, currencies: nil, direction: nil, first: nil, include_free: nil, last: nil, order: nil, plan_ids: nil, product_ids: nil, statuses: nil, substatuses: nil, request_options: {})
+      #   @param company_id [String] The ID of the company to list payments 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 billing_reasons [Array<Symbol, WhopSDK::Models::PaymentListParams::BillingReason>, nil] The billing reason for the payment
+      #
+      #   @param created_after [Time, nil] The minimum creation date to filter by
+      #
+      #   @param created_before [Time, nil] The maximum creation date to filter by
+      #
+      #   @param currencies [Array<Symbol, WhopSDK::Models::Currency>, nil] The currency of the payment.
+      #
+      #   @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 include_free [Boolean, nil] Whether to include free payments.
+      #
+      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      #   @param order [Symbol, WhopSDK::Models::PaymentListParams::Order, nil] The order to sort the results by.
+      #
+      #   @param plan_ids [Array<String>, nil] A specific plan.
+      #
+      #   @param product_ids [Array<String>, nil] A specific product.
+      #
+      #   @param statuses [Array<Symbol, WhopSDK::Models::ReceiptStatus>, nil] The status of the payment.
+      #
+      #   @param substatuses [Array<Symbol, WhopSDK::Models::FriendlyReceiptStatus>, nil] The substatus of the payment.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The reason why a specific payment was billed
+      module BillingReason
+        extend WhopSDK::Internal::Type::Enum
+
+        SUBSCRIPTION_CREATE = :subscription_create
+        SUBSCRIPTION_CYCLE = :subscription_cycle
+        SUBSCRIPTION_UPDATE = :subscription_update
+        ONE_TIME = :one_time
+        MANUAL = :manual
+        SUBSCRIPTION = :subscription
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The order to sort the results by.
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        FINAL_AMOUNT = :final_amount
+        CREATED_AT = :created_at
+        PAID_AT = :paid_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/payment_list_response.rb

@@ -0,0 +1,535 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Payments#list
+    class PaymentListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The payment ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute amount_after_fees
+      #   How much the payment is for after fees
+      #
+      #   @return [Float]
+      required :amount_after_fees, Float
+
+      # @!attribute auto_refunded
+      #   Whether this payment was auto refunded or not
+      #
+      #   @return [Boolean]
+      required :auto_refunded, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute billing_address
+      #   The address of the user who made the payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::BillingAddress, nil]
+      required :billing_address, -> { WhopSDK::Models::PaymentListResponse::BillingAddress }, nil?: true
+
+      # @!attribute billing_reason
+      #   The billing reason
+      #
+      #   @return [String, nil]
+      required :billing_reason, String, nil?: true
+
+      # @!attribute card_brand
+      #   The type of card used as the payment method.
+      #
+      #   @return [String, nil]
+      required :card_brand, String, nil?: true
+
+      # @!attribute card_last4
+      #   The last 4 digits of the card used to make the payment.
+      #
+      #   @return [String, nil]
+      required :card_last4, String, nil?: true
+
+      # @!attribute company
+      #   The company for the payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::Company, nil]
+      required :company, -> { WhopSDK::Models::PaymentListResponse::Company }, nil?: true
+
+      # @!attribute created_at
+      #   The datetime the payment was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The available currencies on the platform
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency, nil]
+      required :currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+      # @!attribute dispute_alerted_at
+      #   When an alert came in that this transaction will be disputed
+      #
+      #   @return [Time, nil]
+      required :dispute_alerted_at, Time, nil?: true
+
+      # @!attribute failure_message
+      #   If the payment failed, the reason for the failure.
+      #
+      #   @return [String, nil]
+      required :failure_message, String, nil?: true
+
+      # @!attribute last_payment_attempt
+      #   The time of the last payment attempt.
+      #
+      #   @return [Time, nil]
+      required :last_payment_attempt, Time, nil?: true
+
+      # @!attribute member
+      #   The member attached to this payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::Member, nil]
+      required :member, -> { WhopSDK::Models::PaymentListResponse::Member }, nil?: true
+
+      # @!attribute membership
+      #   The membership attached to this payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::Membership, nil]
+      required :membership, -> { WhopSDK::Models::PaymentListResponse::Membership }, nil?: true
+
+      # @!attribute paid_at
+      #   The datetime the payment was paid
+      #
+      #   @return [Time, nil]
+      required :paid_at, Time, nil?: true
+
+      # @!attribute payment_method_type
+      #   Returns the type of payment method used for the payment, if available. Ex.
+      #   klarna, affirm, card, cashapp
+      #
+      #   @return [String, nil]
+      required :payment_method_type, String, nil?: true
+
+      # @!attribute plan
+      #   The plan attached to this payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::Plan, nil]
+      required :plan, -> { WhopSDK::Models::PaymentListResponse::Plan }, nil?: true
+
+      # @!attribute product
+      #   The access pass attached to this payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::Product, nil]
+      required :product, -> { WhopSDK::Models::PaymentListResponse::Product }, nil?: true
+
+      # @!attribute promo_code
+      #   The promo code used for this payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::PromoCode, nil]
+      required :promo_code, -> { WhopSDK::Models::PaymentListResponse::PromoCode }, nil?: true
+
+      # @!attribute refundable
+      #   Whether the payment can be refunded.
+      #
+      #   @return [Boolean]
+      required :refundable, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute refunded_amount
+      #   The payment refund amount(if applicable).
+      #
+      #   @return [Float, nil]
+      required :refunded_amount, Float, nil?: true
+
+      # @!attribute refunded_at
+      #   When the payment was refunded (if applicable).
+      #
+      #   @return [Time, nil]
+      required :refunded_at, Time, nil?: true
+
+      # @!attribute retryable
+      #   Whether the payment can be retried.
+      #
+      #   @return [Boolean]
+      required :retryable, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute status
+      #   The status of a receipt
+      #
+      #   @return [Symbol, WhopSDK::Models::ReceiptStatus, nil]
+      required :status, enum: -> { WhopSDK::ReceiptStatus }, nil?: true
+
+      # @!attribute substatus
+      #   The friendly status of the payment.
+      #
+      #   @return [Symbol, WhopSDK::Models::FriendlyReceiptStatus]
+      required :substatus, enum: -> { WhopSDK::FriendlyReceiptStatus }
+
+      # @!attribute subtotal
+      #   The subtotal to show to the creator (excluding buyer fees).
+      #
+      #   @return [Float, nil]
+      required :subtotal, Float, nil?: true
+
+      # @!attribute total
+      #   The total to show to the creator (excluding buyer fees).
+      #
+      #   @return [Float, nil]
+      required :total, Float, nil?: true
+
+      # @!attribute usd_total
+      #   The total in USD to show to the creator (excluding buyer fees).
+      #
+      #   @return [Float, nil]
+      required :usd_total, Float, nil?: true
+
+      # @!attribute user
+      #   The user that made this payment.
+      #
+      #   @return [WhopSDK::Models::PaymentListResponse::User, nil]
+      required :user, -> { WhopSDK::Models::PaymentListResponse::User }, nil?: true
+
+      # @!attribute voidable
+      #   Whether the payment can be voided.
+      #
+      #   @return [Boolean]
+      required :voidable, WhopSDK::Internal::Type::Boolean
+
+      # @!method initialize(id:, amount_after_fees:, auto_refunded:, billing_address:, billing_reason:, card_brand:, card_last4:, company:, created_at:, currency:, dispute_alerted_at:, failure_message:, last_payment_attempt:, member:, membership:, paid_at:, payment_method_type:, plan:, product:, promo_code:, refundable:, refunded_amount:, refunded_at:, retryable:, status:, substatus:, subtotal:, total:, usd_total:, user:, voidable:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PaymentListResponse} for more details.
+      #
+      #   An object representing a receipt for a membership.
+      #
+      #   @param id [String] The payment ID
+      #
+      #   @param amount_after_fees [Float] How much the payment is for after fees
+      #
+      #   @param auto_refunded [Boolean] Whether this payment was auto refunded or not
+      #
+      #   @param billing_address [WhopSDK::Models::PaymentListResponse::BillingAddress, nil] The address of the user who made the payment.
+      #
+      #   @param billing_reason [String, nil] The billing reason
+      #
+      #   @param card_brand [String, nil] The type of card used as the payment method.
+      #
+      #   @param card_last4 [String, nil] The last 4 digits of the card used to make the payment.
+      #
+      #   @param company [WhopSDK::Models::PaymentListResponse::Company, nil] The company for the payment.
+      #
+      #   @param created_at [Time] The datetime the payment was created
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #
+      #   @param dispute_alerted_at [Time, nil] When an alert came in that this transaction will be disputed
+      #
+      #   @param failure_message [String, nil] If the payment failed, the reason for the failure.
+      #
+      #   @param last_payment_attempt [Time, nil] The time of the last payment attempt.
+      #
+      #   @param member [WhopSDK::Models::PaymentListResponse::Member, nil] The member attached to this payment.
+      #
+      #   @param membership [WhopSDK::Models::PaymentListResponse::Membership, nil] The membership attached to this payment.
+      #
+      #   @param paid_at [Time, nil] The datetime the payment was paid
+      #
+      #   @param payment_method_type [String, nil] Returns the type of payment method used for the payment, if available. Ex. klarn
+      #
+      #   @param plan [WhopSDK::Models::PaymentListResponse::Plan, nil] The plan attached to this payment.
+      #
+      #   @param product [WhopSDK::Models::PaymentListResponse::Product, nil] The access pass attached to this payment.
+      #
+      #   @param promo_code [WhopSDK::Models::PaymentListResponse::PromoCode, nil] The promo code used for this payment.
+      #
+      #   @param refundable [Boolean] Whether the payment can be refunded.
+      #
+      #   @param refunded_amount [Float, nil] The payment refund amount(if applicable).
+      #
+      #   @param refunded_at [Time, nil] When the payment was refunded (if applicable).
+      #
+      #   @param retryable [Boolean] Whether the payment can be retried.
+      #
+      #   @param status [Symbol, WhopSDK::Models::ReceiptStatus, nil] The status of a receipt
+      #
+      #   @param substatus [Symbol, WhopSDK::Models::FriendlyReceiptStatus] The friendly status of the payment.
+      #
+      #   @param subtotal [Float, nil] The subtotal to show to the creator (excluding buyer fees).
+      #
+      #   @param total [Float, nil] The total to show to the creator (excluding buyer fees).
+      #
+      #   @param usd_total [Float, nil] The total in USD to show to the creator (excluding buyer fees).
+      #
+      #   @param user [WhopSDK::Models::PaymentListResponse::User, nil] The user that made this payment.
+      #
+      #   @param voidable [Boolean] Whether the payment can be voided.
+
+      # @see WhopSDK::Models::PaymentListResponse#billing_address
+      class BillingAddress < WhopSDK::Internal::Type::BaseModel
+        # @!attribute city
+        #   The city of the address.
+        #
+        #   @return [String, nil]
+        required :city, String, nil?: true
+
+        # @!attribute country
+        #   The country of the address.
+        #
+        #   @return [String, nil]
+        required :country, String, nil?: true
+
+        # @!attribute line1
+        #   The line 1 of the address.
+        #
+        #   @return [String, nil]
+        required :line1, String, nil?: true
+
+        # @!attribute line2
+        #   The line 2 of the address.
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute name
+        #   The name of the customer.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute postal_code
+        #   The postal code of the address.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute state
+        #   The state of the address.
+        #
+        #   @return [String, nil]
+        required :state, String, nil?: true
+
+        # @!method initialize(city:, country:, line1:, line2:, name:, postal_code:, state:)
+        #   The address of the user who made the payment.
+        #
+        #   @param city [String, nil] The city of the address.
+        #
+        #   @param country [String, nil] The country of the address.
+        #
+        #   @param line1 [String, nil] The line 1 of the address.
+        #
+        #   @param line2 [String, nil] The line 2 of the address.
+        #
+        #   @param name [String, nil] The name of the customer.
+        #
+        #   @param postal_code [String, nil] The postal code of the address.
+        #
+        #   @param state [String, nil] The state of the address.
+      end
+
+      # @see WhopSDK::Models::PaymentListResponse#company
+      class Company < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the company
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute route
+        #   The slug/route of the company on the Whop site.
+        #
+        #   @return [String]
+        required :route, String
+
+        # @!attribute title
+        #   The written name of the company.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, route:, title:)
+        #   The company for the payment.
+        #
+        #   @param id [String] The ID of the company
+        #
+        #   @param route [String] The slug/route of the company on the Whop site.
+        #
+        #   @param title [String] The written name of the company.
+      end
+
+      # @see WhopSDK::Models::PaymentListResponse#member
+      class Member < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the member
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute phone
+        #   The phone number for the member, if available.
+        #
+        #   @return [String, nil]
+        required :phone, String, nil?: true
+
+        # @!method initialize(id:, phone:)
+        #   The member attached to this payment.
+        #
+        #   @param id [String] The ID of the member
+        #
+        #   @param phone [String, nil] The phone number for the member, if available.
+      end
+
+      # @see WhopSDK::Models::PaymentListResponse#membership
+      class Membership < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the membership.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute status
+        #   The state of the membership.
+        #
+        #   @return [Symbol, WhopSDK::Models::MembershipStatus]
+        required :status, enum: -> { WhopSDK::MembershipStatus }
+
+        # @!method initialize(id:, status:)
+        #   The membership attached to this payment.
+        #
+        #   @param id [String] The internal ID of the membership.
+        #
+        #   @param status [Symbol, WhopSDK::Models::MembershipStatus] The state of the membership.
+      end
+
+      # @see WhopSDK::Models::PaymentListResponse#plan
+      class Plan < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the plan.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The plan attached to this payment.
+        #
+        #   @param id [String] The internal ID of the plan.
+      end
+
+      # @see WhopSDK::Models::PaymentListResponse#product
+      class Product < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the public product.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute route
+        #   The route of the product.
+        #
+        #   @return [String]
+        required :route, String
+
+        # @!attribute title
+        #   The title of the product. Use for Whop 4.0.
+        #
+        #   @return [String]
+        required :title, String
+
+        # @!method initialize(id:, route:, title:)
+        #   The access pass attached to this payment.
+        #
+        #   @param id [String] The internal ID of the public product.
+        #
+        #   @param route [String] The route of the product.
+        #
+        #   @param title [String] The title of the product. Use for Whop 4.0.
+      end
+
+      # @see WhopSDK::Models::PaymentListResponse#promo_code
+      class PromoCode < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the promo.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount_off
+        #   The amount off (% or flat amount) for the promo.
+        #
+        #   @return [Float]
+        required :amount_off, Float
+
+        # @!attribute base_currency
+        #   The monetary currency of the promo code.
+        #
+        #   @return [Symbol, WhopSDK::Models::Currency]
+        required :base_currency, enum: -> { WhopSDK::Currency }
+
+        # @!attribute code
+        #   The specific code used to apply the promo at checkout.
+        #
+        #   @return [String, nil]
+        required :code, String, nil?: true
+
+        # @!attribute number_of_intervals
+        #   The number of billing cycles the promo is applied for.
+        #
+        #   @return [Integer, nil]
+        required :number_of_intervals, Integer, nil?: true
+
+        # @!attribute promo_type
+        #   The type (% or flat amount) of the promo.
+        #
+        #   @return [Symbol, WhopSDK::Models::PromoType]
+        required :promo_type, enum: -> { WhopSDK::PromoType }
+
+        # @!method initialize(id:, amount_off:, base_currency:, code:, number_of_intervals:, promo_type:)
+        #   The promo code used for this payment.
+        #
+        #   @param id [String] The ID of the promo.
+        #
+        #   @param amount_off [Float] The amount off (% or flat amount) for the promo.
+        #
+        #   @param base_currency [Symbol, WhopSDK::Models::Currency] The monetary currency of the promo code.
+        #
+        #   @param code [String, nil] The specific code used to apply the promo at checkout.
+        #
+        #   @param number_of_intervals [Integer, nil] The number of billing cycles the promo is applied for.
+        #
+        #   @param promo_type [Symbol, WhopSDK::Models::PromoType] The type (% or flat amount) of the promo.
+      end
+
+      # @see WhopSDK::Models::PaymentListResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute email
+        #   The email of the user
+        #
+        #   @return [String, nil]
+        required :email, String, nil?: true
+
+        # @!attribute name
+        #   The name of the user from their Whop account.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, email:, name:, username:)
+        #   The user that made this payment.
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param email [String, nil] The email of the user
+        #
+        #   @param name [String, nil] The name of the user from their Whop account.
+        #
+        #   @param username [String] The username of the user from their Whop account.
+      end
+    end
+  end
+end