whop_sdk 0.0.2 → 0.0.3

data/lib/whop_sdk/models/promo_code_list_response.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::PromoCodes#list
+    class PromoCodeListResponse < 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 churned_users_only
+      #   Restricts promo use to only users who have churned from the company before.
+      #
+      #   @return [Boolean]
+      required :churned_users_only, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute code
+      #   The specific code used to apply the promo at checkout.
+      #
+      #   @return [String, nil]
+      required :code, String, nil?: true
+
+      # @!attribute created_at
+      #   The timestamp of when the promo was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute currency
+      #   The monetary currency of the promo code.
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency]
+      required :currency, enum: -> { WhopSDK::Currency }
+
+      # @!attribute duration
+      #   The duration setting for the promo code
+      #
+      #   @return [Symbol, WhopSDK::Models::PromoDuration, nil]
+      required :duration, enum: -> { WhopSDK::PromoDuration }, nil?: true
+
+      # @!attribute existing_memberships_only
+      #   Restricts promo use to only be applied to already purchased memberships.
+      #
+      #   @return [Boolean]
+      required :existing_memberships_only, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute expires_at
+      #   The date/time of when the promo expires.
+      #
+      #   @return [Time, nil]
+      required :expires_at, Time, nil?: true
+
+      # @!attribute new_users_only
+      #   Restricts promo use to only users who have never purchased from the company
+      #   before.
+      #
+      #   @return [Boolean]
+      required :new_users_only, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute one_per_customer
+      #   Restricts promo use to only be applied once per customer.
+      #
+      #   @return [Boolean]
+      required :one_per_customer, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute product
+      #   The access pass associated with the promo code.
+      #
+      #   @return [WhopSDK::Models::PromoCodeListResponse::Product, nil]
+      required :product, -> { WhopSDK::Models::PromoCodeListResponse::Product }, nil?: true
+
+      # @!attribute promo_duration_months
+      #   The number of months the promo is applied for.
+      #
+      #   @return [Integer, nil]
+      required :promo_duration_months, 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 }
+
+      # @!attribute status
+      #   Indicates if the promo code is live or disabled.
+      #
+      #   @return [Symbol, WhopSDK::Models::PromoCodeStatus]
+      required :status, enum: -> { WhopSDK::PromoCodeStatus }
+
+      # @!attribute stock
+      #   The quantity limit on the number of uses.
+      #
+      #   @return [Integer]
+      required :stock, Integer
+
+      # @!attribute unlimited_stock
+      #   Whether or not the promo code has unlimited stock.
+      #
+      #   @return [Boolean]
+      required :unlimited_stock, WhopSDK::Internal::Type::Boolean
+
+      # @!attribute uses
+      #   The amount of times the promo codes has been used.
+      #
+      #   @return [Integer]
+      required :uses, Integer
+
+      # @!method initialize(id:, amount_off:, churned_users_only:, code:, created_at:, currency:, duration:, existing_memberships_only:, expires_at:, new_users_only:, one_per_customer:, product:, promo_duration_months:, promo_type:, status:, stock:, unlimited_stock:, uses:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PromoCodeListResponse} for more details.
+      #
+      #   An object representing a promo code for a plan.
+      #
+      #   @param id [String] The ID of the promo.
+      #
+      #   @param amount_off [Float] The amount off (% or flat amount) for the promo.
+      #
+      #   @param churned_users_only [Boolean] Restricts promo use to only users who have churned from the company before.
+      #
+      #   @param code [String, nil] The specific code used to apply the promo at checkout.
+      #
+      #   @param created_at [Time] The timestamp of when the promo was created.
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency] The monetary currency of the promo code.
+      #
+      #   @param duration [Symbol, WhopSDK::Models::PromoDuration, nil] The duration setting for the promo code
+      #
+      #   @param existing_memberships_only [Boolean] Restricts promo use to only be applied to already purchased memberships.
+      #
+      #   @param expires_at [Time, nil] The date/time of when the promo expires.
+      #
+      #   @param new_users_only [Boolean] Restricts promo use to only users who have never purchased from the company befo
+      #
+      #   @param one_per_customer [Boolean] Restricts promo use to only be applied once per customer.
+      #
+      #   @param product [WhopSDK::Models::PromoCodeListResponse::Product, nil] The access pass associated with the promo code.
+      #
+      #   @param promo_duration_months [Integer, nil] The number of months the promo is applied for.
+      #
+      #   @param promo_type [Symbol, WhopSDK::Models::PromoType] The type (% or flat amount) of the promo.
+      #
+      #   @param status [Symbol, WhopSDK::Models::PromoCodeStatus] Indicates if the promo code is live or disabled.
+      #
+      #   @param stock [Integer] The quantity limit on the number of uses.
+      #
+      #   @param unlimited_stock [Boolean] Whether or not the promo code has unlimited stock.
+      #
+      #   @param uses [Integer] The amount of times the promo codes has been used.
+
+      # @see WhopSDK::Models::PromoCodeListResponse#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 associated with the promo code.
+        #
+        #   @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

data/lib/whop_sdk/models/promo_code_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::PromoCodes#retrieve
+    class PromoCodeRetrieveParams < 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/promo_code_status.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # Statuses for promo codes
+    module PromoCodeStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      ACTIVE = :active
+      INACTIVE = :inactive
+      ARCHIVED = :archived
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/promo_duration.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The duration setting for the promo code
+    module PromoDuration
+      extend WhopSDK::Internal::Type::Enum
+
+      FOREVER = :forever
+      ONCE = :once
+      REPEATING = :repeating
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/review_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Reviews#list
+    class ReviewListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute product_id
+      #   The ID of the product
+      #
+      #   @return [String]
+      required :product_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 first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute max_stars
+      #   The maximum star rating of the review (inclusive)
+      #
+      #   @return [Integer, nil]
+      optional :max_stars, Integer, nil?: true
+
+      # @!attribute min_stars
+      #   The minimum star rating of the review (inclusive)
+      #
+      #   @return [Integer, nil]
+      optional :min_stars, Integer, nil?: true
+
+      # @!method initialize(product_id:, after: nil, before: nil, first: nil, last: nil, max_stars: nil, min_stars: nil, request_options: {})
+      #   @param product_id [String] The ID of the product
+      #
+      #   @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 first [Integer, nil] Returns the first _n_ elements from the list.
+      #
+      #   @param last [Integer, nil] Returns the last _n_ elements from the list.
+      #
+      #   @param max_stars [Integer, nil] The maximum star rating of the review (inclusive)
+      #
+      #   @param min_stars [Integer, nil] The minimum star rating of the review (inclusive)
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/review_list_response.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Reviews#list
+    class ReviewListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The internal ID of the review.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute attachments
+      #   The attachments attached to the review.
+      #
+      #   @return [Array<WhopSDK::Models::ReviewListResponse::Attachment>]
+      required :attachments,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::ReviewListResponse::Attachment] }
+
+      # @!attribute created_at
+      #   The timestamp of when the review was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute description
+      #   The description of the review.
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute joined_at
+      #   The timestamp of when the user joined the product.
+      #
+      #   @return [Time, nil]
+      required :joined_at, Time, nil?: true
+
+      # @!attribute paid_for_product
+      #   Whether or not the user paid for the product. If null, the payment status is
+      #   unknown.
+      #
+      #   @return [Boolean, nil]
+      required :paid_for_product, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute published_at
+      #   The timestamp of when the review was published.
+      #
+      #   @return [Time, nil]
+      required :published_at, Time, nil?: true
+
+      # @!attribute stars
+      #   The number of stars the user gave the product.
+      #
+      #   @return [Integer]
+      required :stars, Integer
+
+      # @!attribute status
+      #   The status of the review.
+      #
+      #   @return [Symbol, WhopSDK::Models::ReviewStatus]
+      required :status, enum: -> { WhopSDK::ReviewStatus }
+
+      # @!attribute title
+      #   The title of the review.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
+      # @!attribute updated_at
+      #   The timestamp of when the review was last updated.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute user
+      #   The user account that performed the action.
+      #
+      #   @return [WhopSDK::Models::ReviewListResponse::User]
+      required :user, -> { WhopSDK::Models::ReviewListResponse::User }
+
+      # @!method initialize(id:, attachments:, created_at:, description:, joined_at:, paid_for_product:, published_at:, stars:, status:, title:, updated_at:, user:)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::ReviewListResponse} for more details.
+      #
+      #   An object representing a user review of a company.
+      #
+      #   @param id [String] The internal ID of the review.
+      #
+      #   @param attachments [Array<WhopSDK::Models::ReviewListResponse::Attachment>] The attachments attached to the review.
+      #
+      #   @param created_at [Time] The timestamp of when the review was created.
+      #
+      #   @param description [String, nil] The description of the review.
+      #
+      #   @param joined_at [Time, nil] The timestamp of when the user joined the product.
+      #
+      #   @param paid_for_product [Boolean, nil] Whether or not the user paid for the product. If null, the payment status is unk
+      #
+      #   @param published_at [Time, nil] The timestamp of when the review was published.
+      #
+      #   @param stars [Integer] The number of stars the user gave the product.
+      #
+      #   @param status [Symbol, WhopSDK::Models::ReviewStatus] The status of the review.
+      #
+      #   @param title [String, nil] The title of the review.
+      #
+      #   @param updated_at [Time] The timestamp of when the review was last updated.
+      #
+      #   @param user [WhopSDK::Models::ReviewListResponse::User] The user account that performed the action.
+
+      class Attachment < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of the attachment
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute content_type
+        #   The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @return [String, nil]
+        required :content_type, String, nil?: true
+
+        # @!attribute filename
+        #   The name of the file
+        #
+        #   @return [String, nil]
+        required :filename, String, nil?: true
+
+        # @!attribute url
+        #   This is the URL you use to render optimized attachments on the client. This
+        #   should be used for apps.
+        #
+        #   @return [String, nil]
+        required :url, String, nil?: true
+
+        # @!method initialize(id:, content_type:, filename:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::ReviewListResponse::Attachment} for more details.
+        #
+        #   Represents an image attachment
+        #
+        #   @param id [String] The ID of the attachment
+        #
+        #   @param content_type [String, nil] The attachment's content type (e.g., image/jpg, video/mp4)
+        #
+        #   @param filename [String, nil] The name of the file
+        #
+        #   @param url [String, nil] This is the URL you use to render optimized attachments on the client. This shou
+      end
+
+      # @see WhopSDK::Models::ReviewListResponse#user
+      class User < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!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:, name:, username:)
+        #   The user account that performed the action.
+        #
+        #   @param id [String] The internal ID 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

data/lib/whop_sdk/models/review_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Reviews#retrieve
+    class ReviewRetrieveParams < 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