whop_sdk 0.0.2

data/lib/whop_sdk/models/plan_create_params.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Plans#create
+    class PlanCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The company the plan should be created for.
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute product_id
+      #   The product the plan is related to.
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!attribute billing_period
+      #   The interval at which the plan charges (renewal plans).
+      #
+      #   @return [Integer, nil]
+      optional :billing_period, Integer, nil?: true
+
+      # @!attribute currency
+      #   The available currencies on the platform
+      #
+      #   @return [Symbol, WhopSDK::Models::Currency, nil]
+      optional :currency, enum: -> { WhopSDK::Currency }, nil?: true
+
+      # @!attribute custom_fields
+      #   An array of custom field objects.
+      #
+      #   @return [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil]
+      optional :custom_fields,
+               -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::PlanCreateParams::CustomField] },
+               nil?: true
+
+      # @!attribute description
+      #   The description of the plan.
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute expiration_days
+      #   The interval at which the plan charges (expiration plans).
+      #
+      #   @return [Integer, nil]
+      optional :expiration_days, Integer, nil?: true
+
+      # @!attribute image
+      #   An image for the plan. This will be visible on the product page to customers.
+      #
+      #   @return [WhopSDK::Models::PlanCreateParams::Image, nil]
+      optional :image, -> { WhopSDK::PlanCreateParams::Image }, nil?: true
+
+      # @!attribute initial_price
+      #   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
+      #
+      #   @return [Float, nil]
+      optional :initial_price, Float, nil?: true
+
+      # @!attribute internal_notes
+      #   A personal description or notes section for the business.
+      #
+      #   @return [String, nil]
+      optional :internal_notes, String, nil?: true
+
+      # @!attribute override_tax_type
+      #   Whether or not the tax is included in a plan's price (or if it hasn't been set
+      #   up)
+      #
+      #   @return [Symbol, WhopSDK::Models::TaxType, nil]
+      optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
+
+      # @!attribute plan_type
+      #   The type of plan that can be attached to an access pass
+      #
+      #   @return [Symbol, WhopSDK::Models::PlanType, nil]
+      optional :plan_type, enum: -> { WhopSDK::PlanType }, nil?: true
+
+      # @!attribute release_method
+      #   The methods of how a plan can be released.
+      #
+      #   @return [Symbol, WhopSDK::Models::ReleaseMethod, nil]
+      optional :release_method, enum: -> { WhopSDK::ReleaseMethod }, nil?: true
+
+      # @!attribute renewal_price
+      #   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
+      #
+      #   @return [Float, nil]
+      optional :renewal_price, Float, nil?: true
+
+      # @!attribute title
+      #   The title of the plan. This will be visible on the product page to customers.
+      #
+      #   @return [String, nil]
+      optional :title, String, nil?: true
+
+      # @!attribute trial_period_days
+      #   The number of free trial days added before a renewal plan.
+      #
+      #   @return [Integer, nil]
+      optional :trial_period_days, Integer, nil?: true
+
+      # @!attribute visibility
+      #   Visibility of a resource
+      #
+      #   @return [Symbol, WhopSDK::Models::Visibility, nil]
+      optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+
+      # @!method initialize(company_id:, product_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::PlanCreateParams} for more details.
+      #
+      #   @param company_id [String] The company the plan should be created for.
+      #
+      #   @param product_id [String] The product the plan is related to.
+      #
+      #   @param billing_period [Integer, nil] The interval at which the plan charges (renewal plans).
+      #
+      #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
+      #
+      #   @param custom_fields [Array<WhopSDK::Models::PlanCreateParams::CustomField>, nil] An array of custom field objects.
+      #
+      #   @param description [String, nil] The description of the plan.
+      #
+      #   @param expiration_days [Integer, nil] The interval at which the plan charges (expiration plans).
+      #
+      #   @param image [WhopSDK::Models::PlanCreateParams::Image, nil] An image for the plan. This will be visible on the product page to customers.
+      #
+      #   @param initial_price [Float, nil] An additional amount charged upon first purchase. Use only if a one time payment
+      #
+      #   @param internal_notes [String, nil] A personal description or notes section for the business.
+      #
+      #   @param override_tax_type [Symbol, WhopSDK::Models::TaxType, nil] Whether or not the tax is included in a plan's price (or if it hasn't been set u
+      #
+      #   @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
+      #
+      #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
+      #
+      #   @param renewal_price [Float, nil] The amount the customer is charged every billing period. Use only if a recurring
+      #
+      #   @param title [String, nil] The title of the plan. This will be visible on the product page to customers.
+      #
+      #   @param trial_period_days [Integer, nil] The number of free trial days added before a renewal plan.
+      #
+      #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      class CustomField < WhopSDK::Internal::Type::BaseModel
+        # @!attribute field_type
+        #   The type of the custom field.
+        #
+        #   @return [Symbol, :text]
+        required :field_type, const: :text
+
+        # @!attribute name
+        #   The name of the custom field.
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute id
+        #   The ID of the custom field (if being updated)
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute order
+        #   The order of the field.
+        #
+        #   @return [Integer, nil]
+        optional :order, Integer, nil?: true
+
+        # @!attribute placeholder
+        #   The placeholder value of the field.
+        #
+        #   @return [String, nil]
+        optional :placeholder, String, nil?: true
+
+        # @!attribute required
+        #   Whether or not the field is required.
+        #
+        #   @return [Boolean, nil]
+        optional :required, WhopSDK::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(name:, id: nil, order: nil, placeholder: nil, required: nil, field_type: :text)
+        #   @param name [String] The name of the custom field.
+        #
+        #   @param id [String, nil] The ID of the custom field (if being updated)
+        #
+        #   @param order [Integer, nil] The order of the field.
+        #
+        #   @param placeholder [String, nil] The placeholder value of the field.
+        #
+        #   @param required [Boolean, nil] Whether or not the field is required.
+        #
+        #   @param field_type [Symbol, :text] The type of the custom field.
+      end
+
+      class Image < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The ID of an existing attachment object. Use this when updating a resource and
+        #   keeping a subset of the attachments. Don't use this unless you know what you're
+        #   doing.
+        #
+        #   @return [String, nil]
+        optional :id, String, nil?: true
+
+        # @!attribute direct_upload_id
+        #   This ID should be used the first time you upload an attachment. It is the ID of
+        #   the direct upload that was created when uploading the file to S3 via the
+        #   mediaDirectUpload mutation.
+        #
+        #   @return [String, nil]
+        optional :direct_upload_id, String, nil?: true
+
+        # @!method initialize(id: nil, direct_upload_id: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::PlanCreateParams::Image} for more details.
+        #
+        #   An image for the plan. This will be visible on the product page to customers.
+        #
+        #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
+        #
+        #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/plan_delete_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Plans#delete
+    class PlanDeleteParams < 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_delete_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @type [WhopSDK::Internal::Type::Converter]
+    PlanDeleteResponse = WhopSDK::Internal::Type::Boolean
+  end
+end

data/lib/whop_sdk/models/plan_list_params.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Plans#list
+    class PlanListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company
+      #
+      #   @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 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 last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute order
+      #   The ways a relation of Plans can be ordered
+      #
+      #   @return [Symbol, WhopSDK::Models::PlanListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::PlanListParams::Order }, nil?: true
+
+      # @!attribute plan_types
+      #   The plan type to filter the plans by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::PlanType>, nil]
+      optional :plan_types, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PlanType] }, nil?: true
+
+      # @!attribute product_ids
+      #   The product IDs to filter the plans by
+      #
+      #   @return [Array<String>, nil]
+      optional :product_ids, WhopSDK::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute release_methods
+      #   The release method to filter the plans by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::ReleaseMethod>, nil]
+      optional :release_methods,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::ReleaseMethod] },
+               nil?: true
+
+      # @!attribute visibilities
+      #   The visibility to filter the plans by
+      #
+      #   @return [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil]
+      optional :visibilities,
+               -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::VisibilityFilter] },
+               nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, order: nil, plan_types: nil, product_ids: nil, release_methods: nil, visibilities: nil, request_options: {})
+      #   @param company_id [String] The ID of the company
+      #
+      #   @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 order [Symbol, WhopSDK::Models::PlanListParams::Order, nil] The ways a relation of Plans can be ordered
+      #
+      #   @param plan_types [Array<Symbol, WhopSDK::Models::PlanType>, nil] The plan type to filter the plans by
+      #
+      #   @param product_ids [Array<String>, nil] The product IDs to filter the plans by
+      #
+      #   @param release_methods [Array<Symbol, WhopSDK::Models::ReleaseMethod>, nil] The release method to filter the plans by
+      #
+      #   @param visibilities [Array<Symbol, WhopSDK::Models::VisibilityFilter>, nil] The visibility to filter the plans by
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The ways a relation of Plans can be ordered
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        ID = :id
+        ACTIVE_MEMBERS_COUNT = :active_members_count
+        CREATED_AT = :created_at
+        INTERNAL_NOTES = :internal_notes
+        EXPIRES_AT = :expires_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/plan_list_response.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Plans#list
+    class PlanListResponse < 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 company
+      #   The company for the plan.
+      #
+      #   @return [WhopSDK::Models::PlanListResponse::Company, nil]
+      required :company, -> { WhopSDK::Models::PlanListResponse::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 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::PlanListResponse::Invoice, nil]
+      required :invoice, -> { WhopSDK::Models::PlanListResponse::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::PlanListResponse::Product, nil]
+      required :product, -> { WhopSDK::Models::PlanListResponse::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 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:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, 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 company [WhopSDK::Models::PlanListResponse::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 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::PlanListResponse::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::PlanListResponse::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 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::PlanListResponse#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
+
+      # @see WhopSDK::Models::PlanListResponse#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::PlanListResponse#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

data/lib/whop_sdk/models/plan_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Plans#retrieve
+    class PlanRetrieveParams < 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_type.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The type of plan that can be attached to an access pass
+    module PlanType
+      extend WhopSDK::Internal::Type::Enum
+
+      RENEWAL = :renewal
+      ONE_TIME = :one_time
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end