whop_sdk 0.0.2 → 0.0.4

data/lib/whop_sdk/models/checkout_configuration_create_params.rb

@@ -7,6 +7,12 @@ module WhopSDK
       extend WhopSDK::Internal::Type::RequestParameters::Converter
       include WhopSDK::Internal::Type::RequestParameters
 
+      # @!attribute plan
+      #   Pass this object to create a new plan for this checkout configuration
+      #
+      #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan]
+      required :plan, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan }
+
       # @!attribute affiliate_code
       #   The affiliate code to use for the checkout configuration
       #
@@ -19,33 +25,27 @@ module WhopSDK
       #   @return [Hash{Symbol=>Object}, nil]
       optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
 
-      # @!attribute plan
-      #   Pass this object to create a new plan for this checkout configuration
+      # @!attribute redirect_url
+      #   The URL to redirect the user to after the checkout configuration is created
       #
-      #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil]
-      optional :plan, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan }, nil?: true
+      #   @return [String, nil]
+      optional :redirect_url, String, nil?: true
 
       # @!attribute plan_id
       #   The ID of the plan to use for the checkout configuration
       #
-      #   @return [String, nil]
-      optional :plan_id, String, nil?: true
+      #   @return [String]
+      required :plan_id, String
 
-      # @!attribute redirect_url
-      #   The URL to redirect the user to after the checkout configuration is created
+      # @!method initialize(plan:, plan_id:, affiliate_code: nil, metadata: nil, redirect_url: nil, request_options: {})
+      #   @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan] Pass this object to create a new plan for this checkout configuration
+      #
+      #   @param plan_id [String] The ID of the plan to use for the checkout configuration
       #
-      #   @return [String, nil]
-      optional :redirect_url, String, nil?: true
-
-      # @!method initialize(affiliate_code: nil, metadata: nil, plan: nil, plan_id: nil, redirect_url: nil, request_options: {})
       #   @param affiliate_code [String, nil] The affiliate code to use for the checkout configuration
       #
       #   @param metadata [Hash{Symbol=>Object}, nil] The metadata to use for the checkout configuration
       #
-      #   @param plan [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan, nil] Pass this object to create a new plan for this checkout configuration
-      #
-      #   @param plan_id [String, nil] The ID of the plan to use for the checkout configuration
-      #
       #   @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
@@ -101,8 +101,8 @@ module WhopSDK
         # @!attribute image
         #   An image for the plan. This will be visible on the product page to customers.
         #
-        #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image, nil]
-        optional :image, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image }, nil?: true
+        #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID, nil]
+        optional :image, union: -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image }, nil?: true
 
         # @!attribute initial_price
         #   An additional amount charged upon first purchase.
@@ -123,14 +123,30 @@ module WhopSDK
         #   @return [Symbol, WhopSDK::Models::TaxType, nil]
         optional :override_tax_type, enum: -> { WhopSDK::TaxType }, nil?: true
 
+        # @!attribute payment_method_configuration
+        #   The explicit payment method configuration for the plan. If not provided, the
+        #   platform or company's defaults will apply.
+        #
+        #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration, nil]
+        optional :payment_method_configuration,
+                 -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration },
+                 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 product
+        #   Pass this object to create a new product for this plan. We will use the product
+        #   external identifier to find or create an existing product.
+        #
+        #   @return [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Product, nil]
+        optional :product, -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Product }, nil?: true
+
         # @!attribute product_id
-        #   The product the plan is related to.
+        #   The product the plan is related to. Either this or product is required.
         #
         #   @return [String, nil]
         optional :product_id, String, nil?: true
@@ -165,7 +181,7 @@ module WhopSDK
         #   @return [Symbol, WhopSDK::Models::Visibility, nil]
         optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
 
-        # @!method initialize(company_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, plan_type: nil, product_id: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil)
+        # @!method initialize(company_id:, billing_period: nil, currency: nil, custom_fields: nil, description: nil, expiration_days: nil, force_create_new_plan: nil, image: nil, initial_price: nil, internal_notes: nil, override_tax_type: nil, payment_method_configuration: nil, plan_type: nil, product: nil, product_id: nil, release_method: nil, renewal_price: nil, title: nil, trial_period_days: nil, visibility: nil)
         #   Some parameter documentations has been truncated, see
         #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan} for more details.
         #
@@ -185,7 +201,7 @@ module WhopSDK
         #
         #   @param force_create_new_plan [Boolean, nil] Whether to force the creation of a new plan even if one with the same attributes
         #
-        #   @param image [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image, nil] An image for the plan. This will be visible on the product page to customers.
+        #   @param image [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID, 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.
         #
@@ -193,9 +209,13 @@ module WhopSDK
         #
         #   @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 payment_method_configuration [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan. If not provided, the pla
+        #
         #   @param plan_type [Symbol, WhopSDK::Models::PlanType, nil] The type of plan that can be attached to an access pass
         #
-        #   @param product_id [String, nil] The product the plan is related to.
+        #   @param product [WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Product, nil] Pass this object to create a new product for this plan. We will use the product
+        #
+        #   @param product_id [String, nil] The product the plan is related to. Either this or product is required.
         #
         #   @param release_method [Symbol, WhopSDK::Models::ReleaseMethod, nil] The methods of how a plan can be released.
         #
@@ -258,34 +278,227 @@ module WhopSDK
           #   @param field_type [Symbol, :text] The type of the custom field.
         end
 
+        # An image for the plan. This will be visible on the product page to customers.
+        #
         # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#image
-        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.
+        module Image
+          extend WhopSDK::Internal::Type::Union
+
+          # Input for an attachment
+          variant -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID }
+
+          # Input for an attachment
+          variant -> { WhopSDK::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID }
+
+          class AttachmentInputWithDirectUploadID < WhopSDK::Internal::Type::BaseModel
+            # @!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]
+            required :direct_upload_id, String
+
+            # @!method initialize(direct_upload_id:)
+            #   Some parameter documentations has been truncated, see
+            #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID}
+            #   for more details.
+            #
+            #   Input for an attachment
+            #
+            #   @param direct_upload_id [String] This ID should be used the first time you upload an attachment. It is the ID of
+          end
+
+          class AttachmentInputWithID < 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]
+            required :id, String
+
+            # @!method initialize(id:)
+            #   Some parameter documentations has been truncated, see
+            #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID}
+            #   for more details.
+            #
+            #   Input for an attachment
+            #
+            #   @param id [String] The ID of an existing attachment object. Use this when updating a resource and k
+          end
+
+          # @!method self.variants
+          #   @return [Array(WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image::AttachmentInputWithID)]
+        end
+
+        # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#payment_method_configuration
+        class PaymentMethodConfiguration < WhopSDK::Internal::Type::BaseModel
+          # @!attribute disabled
+          #   An array of payment method identifiers that are explicitly disabled. Only
+          #   applies if the include_platform_defaults is true.
+          #
+          #   @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
+          required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
+
+          # @!attribute enabled
+          #   An array of payment method identifiers that are explicitly enabled. This means
+          #   these payment methods will be shown on checkout. Example use case is to only
+          #   enable a specific payment method like cashapp, or extending the platform
+          #   defaults with additional methods.
+          #
+          #   @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
+          required :enabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
+
+          # @!attribute include_platform_defaults
+          #   Whether Whop's platform default payment method enablement settings are included
+          #   in this configuration. The full list of default payment methods can be found in
+          #   the documentation at docs.whop.com/payments.
+          #
+          #   @return [Boolean]
+          required :include_platform_defaults, WhopSDK::Internal::Type::Boolean
+
+          # @!method initialize(disabled:, enabled:, include_platform_defaults:)
+          #   Some parameter documentations has been truncated, see
+          #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::PaymentMethodConfiguration}
+          #   for more details.
+          #
+          #   The explicit payment method configuration for the plan. If not provided, the
+          #   platform or company's defaults will apply.
+          #
+          #   @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
+          #
+          #   @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
+          #
+          #   @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
+        end
+
+        # @see WhopSDK::Models::CheckoutConfigurationCreateParams::Plan#product
+        class Product < WhopSDK::Internal::Type::BaseModel
+          # @!attribute external_identifier
+          #   A unique ID used to find or create a product. When provided during creation, we
+          #   will look for an existing product with this external identifier — if found, it
+          #   will be updated; otherwise, a new product will be created.
+          #
+          #   @return [String]
+          required :external_identifier, String
+
+          # @!attribute title
+          #   The title of the product.
+          #
+          #   @return [String]
+          required :title, String
+
+          # @!attribute business_type
+          #   The different business types a company can be.
+          #
+          #   @return [Symbol, WhopSDK::Models::BusinessTypes, nil]
+          optional :business_type, enum: -> { WhopSDK::BusinessTypes }, nil?: true
+
+          # @!attribute collect_shipping_address
+          #   Whether or not to collect shipping information at checkout from the customer.
+          #
+          #   @return [Boolean, nil]
+          optional :collect_shipping_address, WhopSDK::Internal::Type::Boolean, nil?: true
+
+          # @!attribute custom_statement_descriptor
+          #   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: <, >, \, ', "
           #
           #   @return [String, nil]
-          optional :id, String, nil?: true
+          optional :custom_statement_descriptor, 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.
+          # @!attribute description
+          #   A written description of the product.
           #
           #   @return [String, nil]
-          optional :direct_upload_id, String, nil?: true
+          optional :description, String, nil?: true
 
-          # @!method initialize(id: nil, direct_upload_id: nil)
+          # @!attribute global_affiliate_percentage
+          #   The percentage of the revenue that goes to the global affiliate program.
+          #
+          #   @return [Float, nil]
+          optional :global_affiliate_percentage, Float, nil?: true
+
+          # @!attribute global_affiliate_status
+          #   The different statuses of the global affiliate program for an access pass.
+          #
+          #   @return [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil]
+          optional :global_affiliate_status, enum: -> { WhopSDK::GlobalAffiliateStatus }, nil?: true
+
+          # @!attribute headline
+          #   The headline of the product.
+          #
+          #   @return [String, nil]
+          optional :headline, String, nil?: true
+
+          # @!attribute industry_type
+          #   The different industry types a company can be in.
+          #
+          #   @return [Symbol, WhopSDK::Models::IndustryTypes, nil]
+          optional :industry_type, enum: -> { WhopSDK::IndustryTypes }, nil?: true
+
+          # @!attribute product_tax_code_id
+          #   The ID of the product tax code to apply to this product.
+          #
+          #   @return [String, nil]
+          optional :product_tax_code_id, String, nil?: true
+
+          # @!attribute redirect_purchase_url
+          #   The URL to redirect the customer to after a purchase.
+          #
+          #   @return [String, nil]
+          optional :redirect_purchase_url, String, nil?: true
+
+          # @!attribute route
+          #   The route of the product.
+          #
+          #   @return [String, nil]
+          optional :route, String, nil?: true
+
+          # @!attribute visibility
+          #   Visibility of a resource
+          #
+          #   @return [Symbol, WhopSDK::Models::Visibility, nil]
+          optional :visibility, enum: -> { WhopSDK::Visibility }, nil?: true
+
+          # @!method initialize(external_identifier:, title:, business_type: nil, collect_shipping_address: nil, custom_statement_descriptor: nil, description: nil, global_affiliate_percentage: nil, global_affiliate_status: nil, headline: nil, industry_type: nil, product_tax_code_id: nil, redirect_purchase_url: nil, route: nil, visibility: nil)
           #   Some parameter documentations has been truncated, see
-          #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Image} for more
+          #   {WhopSDK::Models::CheckoutConfigurationCreateParams::Plan::Product} for more
           #   details.
           #
-          #   An image for the plan. This will be visible on the product page to customers.
+          #   Pass this object to create a new product for this plan. We will use the product
+          #   external identifier to find or create an existing product.
+          #
+          #   @param external_identifier [String] A unique ID used to find or create a product. When provided during creation, we
+          #
+          #   @param title [String] The title of the product.
+          #
+          #   @param business_type [Symbol, WhopSDK::Models::BusinessTypes, nil] The different business types a company can be.
+          #
+          #   @param collect_shipping_address [Boolean, nil] Whether or not to collect shipping information at checkout from the customer.
+          #
+          #   @param custom_statement_descriptor [String, nil] The custom statement descriptor for the product i.e. WHOP\*SPORTS, must be
+          #   betwee
+          #
+          #   @param description [String, nil] A written description of the product.
+          #
+          #   @param global_affiliate_percentage [Float, nil] The percentage of the revenue that goes to the global affiliate program.
+          #
+          #   @param global_affiliate_status [Symbol, WhopSDK::Models::GlobalAffiliateStatus, nil] The different statuses of the global affiliate program for an access pass.
+          #
+          #   @param headline [String, nil] The headline of the product.
+          #
+          #   @param industry_type [Symbol, WhopSDK::Models::IndustryTypes, nil] The different industry types a company can be in.
+          #
+          #   @param product_tax_code_id [String, nil] The ID of the product tax code to apply to this product.
+          #
+          #   @param redirect_purchase_url [String, nil] The URL to redirect the customer to after a purchase.
           #
-          #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
+          #   @param route [String, nil] The route of the product.
           #
-          #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+          #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
         end
       end
     end

data/lib/whop_sdk/models/checkout_configuration_list_response.rb

@@ -35,7 +35,8 @@ module WhopSDK
       required :plan, -> { WhopSDK::Models::CheckoutConfigurationListResponse::Plan }
 
       # @!attribute purchase_url
-      #   The URL to redirect the user to after the checkout configuration is created
+      #   A URL you can send to customers to complete a checkout. It looks like
+      #   `/checkout/plan_xxxx?session={id}`
       #
       #   @return [String]
       required :purchase_url, String
@@ -47,11 +48,13 @@ module WhopSDK
       required :redirect_url, String, nil?: true
 
       # @!method initialize(id:, affiliate_code:, company_id:, metadata:, plan:, purchase_url:, redirect_url:)
-      #   A checkout configuration object. Can be used to create a reusable custom
-      #   configuration for a checkout, including attaching plans, affiliates and custom
-      #   metadata to the checkout. This configuration can be re-used by multiple users.
-      #   All successful payments and memberships resulting from a checkout will contain
-      #   the passed metadata.
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CheckoutConfigurationListResponse} for more details.
+      #
+      #           A checkout configuration object.
+      #           Can be used to create a reusable custom configuration for a checkout, including attaching plans, affiliates and custom metadata to the checkout.
+      #           This configuration can be re-used by multiple users.
+      #           All successful payments and memberships resulting from a checkout will contain the passed metadata.
       #
       #   @param id [String] The ID of the checkout configuration
       #
@@ -63,7 +66,7 @@ module WhopSDK
       #
       #   @param plan [WhopSDK::Models::CheckoutConfigurationListResponse::Plan] The plan to use for the checkout configuration
       #
-      #   @param purchase_url [String] The URL to redirect the user to after the checkout configuration is created
+      #   @param purchase_url [String] A URL you can send to customers to complete a checkout. It looks like `/checkout
       #
       #   @param redirect_url [String, nil] The URL to redirect the user to after the checkout configuration is created
 

data/lib/whop_sdk/models/company.rb

@@ -45,6 +45,13 @@ module WhopSDK
       #   @return [Integer]
       required :member_count, Integer
 
+      # @!attribute metadata
+      #   A key-value store of data for the account, created/updated by the platform that
+      #   made the account.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      required :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
       # @!attribute owner_user
       #   The user who owns this company
       #
@@ -87,7 +94,10 @@ module WhopSDK
       #   @return [Boolean]
       required :verified, WhopSDK::Internal::Type::Boolean
 
-      # @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, owner_user:, published_reviews_count:, route:, social_links:, title:, updated_at:, verified:)
+      # @!method initialize(id:, business_type:, created_at:, description:, industry_type:, logo:, member_count:, metadata:, owner_user:, published_reviews_count:, route:, social_links:, title:, updated_at:, verified:)
+      #   Some parameter documentations has been truncated, see {WhopSDK::Models::Company}
+      #   for more details.
+      #
       #   An object representing a (sanitized) company.
       #
       #   @param id [String] The ID (tag) of the company.
@@ -104,6 +114,8 @@ module WhopSDK
       #
       #   @param member_count [Integer] The number of members in the company.
       #
+      #   @param metadata [Hash{Symbol=>Object}, nil] A key-value store of data for the account, created/updated by the platform that
+      #
       #   @param owner_user [WhopSDK::Models::Company::OwnerUser] The user who owns this company
       #
       #   @param published_reviews_count [Integer] The number of reviews that have been published for the company.

data/lib/whop_sdk/models/company_create_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Companies#create
+    class CompanyCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #   The email of the user who the company will belong to.
+      #
+      #   @return [String]
+      required :email, String
+
+      # @!attribute parent_company_id
+      #   The company ID of the platform creating this company.
+      #
+      #   @return [String]
+      required :parent_company_id, String
+
+      # @!attribute title
+      #   The name of the company being created.
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute metadata
+      #   Additional metadata for the account
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, WhopSDK::Internal::Type::HashOf[WhopSDK::Internal::Type::Unknown], nil?: true
+
+      # @!method initialize(email:, parent_company_id:, title:, metadata: nil, request_options: {})
+      #   @param email [String] The email of the user who the company will belong to.
+      #
+      #   @param parent_company_id [String] The company ID of the platform creating this company.
+      #
+      #   @param title [String] The name of the company being created.
+      #
+      #   @param metadata [Hash{Symbol=>Object}, nil] Additional metadata for the account
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/company_list_params.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Companies#list
+    class CompanyListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute parent_company_id
+      #   The ID of the parent company to list sub companies for
+      #
+      #   @return [String]
+      required :parent_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
+
+      # @!method initialize(parent_company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, request_options: {})
+      #   @param parent_company_id [String] The ID of the parent company to list sub companies 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 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 request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end