whop_sdk 0.0.2 → 0.0.4

data/lib/whop_sdk/models/plan.rb

@@ -81,6 +81,12 @@ module WhopSDK
       #   @return [Integer, nil]
       required :member_count, Integer, nil?: true
 
+      # @!attribute payment_method_configuration
+      #   The explicit payment method configuration for the plan, if any.
+      #
+      #   @return [WhopSDK::Models::Plan::PaymentMethodConfiguration, nil]
+      required :payment_method_configuration, -> { WhopSDK::Plan::PaymentMethodConfiguration }, nil?: true
+
       # @!attribute plan_type
       #   Indicates if the plan is a one time payment or recurring.
       #
@@ -111,18 +117,36 @@ module WhopSDK
       #   @return [Float]
       required :renewal_price, Float
 
+      # @!attribute stock
+      #   The number of units available for purchase. Only displayed to authorized actors
+      #
+      #   @return [Integer, nil]
+      required :stock, Integer, nil?: true
+
       # @!attribute tax_type
       #   The tax type for the plan.
       #
       #   @return [Symbol, WhopSDK::Models::TaxType]
       required :tax_type, enum: -> { WhopSDK::TaxType }
 
+      # @!attribute title
+      #   The title of the plan. This will be visible on the product page to customers.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
       # @!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 unlimited_stock
+      #   Limits/doesn't limit the number of units available for purchase.
+      #
+      #   @return [Boolean]
+      required :unlimited_stock, WhopSDK::Internal::Type::Boolean
+
       # @!attribute updated_at
       #   When the plan was last updated.
       #
@@ -135,7 +159,7 @@ module WhopSDK
       #   @return [Symbol, WhopSDK::Models::Visibility]
       required :visibility, enum: -> { WhopSDK::Visibility }
 
-      # @!method initialize(id:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, tax_type:, trial_period_days:, updated_at:, visibility:)
+      # @!method initialize(id:, billing_period:, collect_tax:, company:, created_at:, currency:, custom_fields:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, tax_type:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
       #   An object representing a (sanitized) plan of an access pass.
       #
       #   @param id [String] The internal ID of the plan.
@@ -164,6 +188,8 @@ module WhopSDK
       #
       #   @param member_count [Integer, nil] The number of members for the plan.
       #
+      #   @param payment_method_configuration [WhopSDK::Models::Plan::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan, if any.
+      #
       #   @param plan_type [Symbol, WhopSDK::Models::PlanType] Indicates if the plan is a one time payment or recurring.
       #
       #   @param product [WhopSDK::Models::Plan::Product, nil] The access pass for the plan.
@@ -174,10 +200,16 @@ module WhopSDK
       #
       #   @param renewal_price [Float] The price a person has to pay for a plan on the renewal purchase.
       #
+      #   @param stock [Integer, nil] The number of units available for purchase. Only displayed to authorized actors
+      #
       #   @param tax_type [Symbol, WhopSDK::Models::TaxType] The tax type for the plan.
       #
+      #   @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 unlimited_stock [Boolean] Limits/doesn't limit the number of units available for purchase.
+      #
       #   @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.
@@ -271,6 +303,45 @@ module WhopSDK
         #   @param id [String] The ID of the invoice.
       end
 
+      # @see WhopSDK::Models::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::Plan::PaymentMethodConfiguration} for more details.
+        #
+        #   The explicit payment method configuration for the plan, if any.
+        #
+        #   @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::Plan#product
       class Product < WhopSDK::Internal::Type::BaseModel
         # @!attribute id

data/lib/whop_sdk/models/plan_create_params.rb

@@ -20,7 +20,7 @@ module WhopSDK
       required :product_id, String
 
       # @!attribute billing_period
-      #   The interval at which the plan charges (renewal plans).
+      #   The interval in days at which the plan charges (renewal plans).
       #
       #   @return [Integer, nil]
       optional :billing_period, Integer, nil?: true
@@ -54,8 +54,8 @@ module WhopSDK
       # @!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
+      #   @return [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID, nil]
+      optional :image, union: -> { WhopSDK::PlanCreateParams::Image }, nil?: true
 
       # @!attribute initial_price
       #   An additional amount charged upon first purchase. Use only if a one time payment
@@ -78,6 +78,15 @@ 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::PlanCreateParams::PaymentMethodConfiguration, nil]
+      optional :payment_method_configuration,
+               -> { WhopSDK::PlanCreateParams::PaymentMethodConfiguration },
+               nil?: true
+
       # @!attribute plan_type
       #   The type of plan that can be attached to an access pass
       #
@@ -97,6 +106,26 @@ module WhopSDK
       #   @return [Float, nil]
       optional :renewal_price, Float, nil?: true
 
+      # @!attribute stock
+      #   The number of units available for purchase.
+      #
+      #   @return [Integer, nil]
+      optional :stock, Integer, nil?: true
+
+      # @!attribute strike_through_initial_price
+      #   The price to display with a strikethrough for the initial price. Provided as a
+      #   number in dollars. Eg: 19.99 for $19.99
+      #
+      #   @return [Float, nil]
+      optional :strike_through_initial_price, Float, nil?: true
+
+      # @!attribute strike_through_renewal_price
+      #   The price to display with a strikethrough for the renewal price. Provided as a
+      #   number in dollars. Eg: 19.99 for $19.99
+      #
+      #   @return [Float, nil]
+      optional :strike_through_renewal_price, Float, nil?: true
+
       # @!attribute title
       #   The title of the plan. This will be visible on the product page to customers.
       #
@@ -109,13 +138,19 @@ module WhopSDK
       #   @return [Integer, nil]
       optional :trial_period_days, Integer, nil?: true
 
+      # @!attribute unlimited_stock
+      #   Limits/doesn't limit the number of units available for purchase.
+      #
+      #   @return [Boolean, nil]
+      optional :unlimited_stock, WhopSDK::Internal::Type::Boolean, 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: {})
+      # @!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, payment_method_configuration: nil, plan_type: nil, release_method: nil, renewal_price: nil, stock: nil, strike_through_initial_price: nil, strike_through_renewal_price: nil, title: nil, trial_period_days: nil, unlimited_stock: nil, visibility: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {WhopSDK::Models::PlanCreateParams} for more details.
       #
@@ -123,7 +158,7 @@ module WhopSDK
       #
       #   @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 billing_period [Integer, nil] The interval in days at which the plan charges (renewal plans).
       #
       #   @param currency [Symbol, WhopSDK::Models::Currency, nil] The available currencies on the platform
       #
@@ -133,7 +168,7 @@ module WhopSDK
       #
       #   @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 image [WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::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. Use only if a one time payment
       #
@@ -141,16 +176,26 @@ 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::PlanCreateParams::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 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 stock [Integer, nil] The number of units available for purchase.
+      #
+      #   @param strike_through_initial_price [Float, nil] The price to display with a strikethrough for the initial price. Provided as a n
+      #
+      #   @param strike_through_renewal_price [Float, nil] The price to display with a strikethrough for the renewal price. Provided as a n
+      #
       #   @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 unlimited_stock [Boolean, nil] Limits/doesn't limit the number of units available for purchase.
+      #
       #   @param visibility [Symbol, WhopSDK::Models::Visibility, nil] Visibility of a resource
       #
       #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
@@ -206,32 +251,96 @@ module WhopSDK
         #   @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.
+      # An image for the plan. This will be visible on the product page to customers.
+      module Image
+        extend WhopSDK::Internal::Type::Union
+
+        # Input for an attachment
+        variant -> { WhopSDK::PlanCreateParams::Image::AttachmentInputWithDirectUploadID }
+
+        # Input for an attachment
+        variant -> { WhopSDK::PlanCreateParams::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::PlanCreateParams::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::PlanCreateParams::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::PlanCreateParams::Image::AttachmentInputWithDirectUploadID, WhopSDK::Models::PlanCreateParams::Image::AttachmentInputWithID)]
+      end
+
+      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 [String, nil]
-        optional :id, String, nil?: true
+        #   @return [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>]
+        required :disabled, -> { WhopSDK::Internal::Type::ArrayOf[enum: WhopSDK::PaymentMethodTypes] }
 
-        # @!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 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 [String, nil]
-        optional :direct_upload_id, String, nil?: true
+        #   @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(id: nil, direct_upload_id: nil)
+        # @!method initialize(disabled:, enabled:, include_platform_defaults:)
         #   Some parameter documentations has been truncated, see
-        #   {WhopSDK::Models::PlanCreateParams::Image} for more details.
+        #   {WhopSDK::Models::PlanCreateParams::PaymentMethodConfiguration} for more
+        #   details.
+        #
+        #   The explicit payment method configuration for the plan. If not provided, the
+        #   platform or company's defaults will apply.
         #
-        #   An image for the plan. This will be visible on the product page to customers.
+        #   @param disabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly disabled. Only applie
         #
-        #   @param id [String, nil] The ID of an existing attachment object. Use this when updating a resource and k
+        #   @param enabled [Array<Symbol, WhopSDK::Models::PaymentMethodTypes>] An array of payment method identifiers that are explicitly enabled. This means t
         #
-        #   @param direct_upload_id [String, nil] This ID should be used the first time you upload an attachment. It is the ID of
+        #   @param include_platform_defaults [Boolean] Whether Whop's platform default payment method enablement settings are included
       end
     end
   end

data/lib/whop_sdk/models/plan_list_response.rb

@@ -70,6 +70,14 @@ module WhopSDK
       #   @return [Integer, nil]
       required :member_count, Integer, nil?: true
 
+      # @!attribute payment_method_configuration
+      #   The explicit payment method configuration for the plan, if any.
+      #
+      #   @return [WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration, nil]
+      required :payment_method_configuration,
+               -> { WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration },
+               nil?: true
+
       # @!attribute plan_type
       #   Indicates if the plan is a one time payment or recurring.
       #
@@ -100,12 +108,30 @@ module WhopSDK
       #   @return [Float]
       required :renewal_price, Float
 
+      # @!attribute stock
+      #   The number of units available for purchase. Only displayed to authorized actors
+      #
+      #   @return [Integer, nil]
+      required :stock, Integer, nil?: true
+
+      # @!attribute title
+      #   The title of the plan. This will be visible on the product page to customers.
+      #
+      #   @return [String, nil]
+      required :title, String, nil?: true
+
       # @!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 unlimited_stock
+      #   Limits/doesn't limit the number of units available for purchase.
+      #
+      #   @return [Boolean]
+      required :unlimited_stock, WhopSDK::Internal::Type::Boolean
+
       # @!attribute updated_at
       #   When the plan was last updated.
       #
@@ -118,7 +144,7 @@ module WhopSDK
       #   @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:)
+      # @!method initialize(id:, billing_period:, company:, created_at:, currency:, description:, expiration_days:, initial_price:, internal_notes:, invoice:, member_count:, payment_method_configuration:, plan_type:, product:, purchase_url:, release_method:, renewal_price:, stock:, title:, trial_period_days:, unlimited_stock:, updated_at:, visibility:)
       #   An object representing a (sanitized) plan of an access pass.
       #
       #   @param id [String] The internal ID of the plan.
@@ -143,6 +169,8 @@ module WhopSDK
       #
       #   @param member_count [Integer, nil] The number of members for the plan.
       #
+      #   @param payment_method_configuration [WhopSDK::Models::PlanListResponse::PaymentMethodConfiguration, nil] The explicit payment method configuration for the plan, if any.
+      #
       #   @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.
@@ -153,8 +181,14 @@ module WhopSDK
       #
       #   @param renewal_price [Float] The price a person has to pay for a plan on the renewal purchase.
       #
+      #   @param stock [Integer, nil] The number of units available for purchase. Only displayed to authorized actors
+      #
+      #   @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 unlimited_stock [Boolean] Limits/doesn't limit the number of units available for purchase.
+      #
       #   @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.
@@ -195,6 +229,46 @@ module WhopSDK
         #   @param id [String] The ID of the invoice.
       end
 
+      # @see WhopSDK::Models::PlanListResponse#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::PlanListResponse::PaymentMethodConfiguration} for more
+        #   details.
+        #
+        #   The explicit payment method configuration for the plan, if any.
+        #
+        #   @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::PlanListResponse#product
       class Product < WhopSDK::Internal::Type::BaseModel
         # @!attribute id