whop_sdk 2.3.0 → 2.5.0

data/lib/whop_sdk/members/logs/client.rb

@@ -15,7 +15,7 @@ module Whop_sdk
           @environment = environment
         end
 
-        # Lists activity for a member and all of their non-drafted memberships, most recent first.
+        # Lists activity for a member and all of their memberships that are not `drafted`, most recent first.
         #
         # @param request_options [Hash]
         # @param params [Hash]

data/lib/whop_sdk/members/notes/client.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Members
+    module Notes
+      class Client
+        # @param client [Whop_sdk::Internal::Http::RawClient]
+        # @param base_url [String, nil]
+        # @param environment [Hash[Symbol, String], nil]
+        #
+        # @return [void]
+        def initialize(client:, base_url: nil, environment: nil)
+          @client = client
+          @base_url = base_url
+          @environment = environment
+        end
+
+        # Lists a member's notes, newest first. Notes are visible to the account's team.
+        #
+        # @param request_options [Hash]
+        # @param params [Hash]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :member_id
+        # @option params [Integer, nil] :first
+        # @option params [String, nil] :after
+        # @option params [Integer, nil] :last
+        # @option params [String, nil] :before
+        #
+        # @example
+        #   client.members.notes.list(member_id: "member_id")
+        #
+        # @return [Whop_sdk::Members::Notes::Types::ListNotesResponse]
+        def list(request_options: {}, **params)
+          params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+          query_params = {}
+          query_params["first"] = params[:first] if params.key?(:first)
+          query_params["after"] = params[:after] if params.key?(:after)
+          query_params["last"] = params[:last] if params.key?(:last)
+          query_params["before"] = params[:before] if params.key?(:before)
+
+          Whop_sdk::Internal::CursorItemIterator.new(
+            cursor_field: :end_cursor,
+            item_field: :data,
+            initial_cursor: query_params["after"]
+          ) do |next_cursor|
+            query_params["after"] = next_cursor
+            request = Whop_sdk::Internal::JSON::Request.new(
+              base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+              method: "GET",
+              path: "members/#{URI.encode_uri_component(params[:member_id].to_s)}/notes",
+              query: query_params,
+              request_options: request_options
+            )
+            begin
+              response = @client.send(request)
+            rescue Net::HTTPRequestTimeout
+              raise Whop_sdk::Errors::TimeoutError
+            end
+            code = response.code.to_i
+            if code.between?(200, 299)
+              parsed_response = (response.body.to_s.empty? ? nil : Whop_sdk::Members::Notes::Types::ListNotesResponse.load(response.body))
+              [parsed_response, response]
+            else
+              error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+              raise error_class.new(response.body, code: code)
+            end
+          end
+        end
+
+        # Adds a note to a member. Notes are visible to the account's team.
+        #
+        # @param request_options [Hash]
+        # @param params [Whop_sdk::Members::Notes::Types::CreateNotesRequest]
+        # @option request_options [String] :base_url
+        # @option request_options [Hash{String => Object}] :additional_headers
+        # @option request_options [Hash{String => Object}] :additional_query_parameters
+        # @option request_options [Hash{String => Object}] :additional_body_parameters
+        # @option request_options [Integer] :timeout_in_seconds
+        # @option params [String] :member_id
+        #
+        # @example
+        #   client.members.notes.create(
+        #     member_id: "member_id",
+        #     content: "Wants a call next week."
+        #   )
+        #
+        # @return [Whop_sdk::Types::MemberNote]
+        def create(request_options: {}, **params)
+          params = Whop_sdk::Internal::Types::Utils.normalize_keys(params)
+          request_data = Whop_sdk::Members::Notes::Types::CreateNotesRequest.new(params).to_h
+          non_body_param_names = %w[member_id]
+          body = request_data.except(*non_body_param_names)
+
+          request = Whop_sdk::Internal::JSON::Request.new(
+            base_url: request_options[:base_url] || @base_url || @environment&.dig(:api),
+            method: "POST",
+            path: "members/#{URI.encode_uri_component(params[:member_id].to_s)}/notes",
+            body: body,
+            request_options: request_options
+          )
+          begin
+            response = @client.send(request)
+          rescue Net::HTTPRequestTimeout
+            raise Whop_sdk::Errors::TimeoutError
+          end
+          code = response.code.to_i
+          if code.between?(200, 299)
+            (response.body.to_s.empty? ? nil : Whop_sdk::Types::MemberNote.load(response.body))
+          else
+            error_class = Whop_sdk::Errors::ResponseError.subclass_for_code(code)
+            raise error_class.new(response.body, code: code)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/members/notes/types/create_notes_request.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Members
+    module Notes
+      module Types
+        class CreateNotesRequest < Internal::Types::Model
+          field :member_id, -> { String }, optional: false, nullable: false
+
+          field :content, -> { String }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/members/notes/types/list_notes_request.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Members
+    module Notes
+      module Types
+        class ListNotesRequest < Internal::Types::Model
+          field :member_id, -> { String }, optional: false, nullable: false
+
+          field :first, -> { Integer }, optional: true, nullable: false
+
+          field :after, -> { String }, optional: true, nullable: false
+
+          field :last, -> { Integer }, optional: true, nullable: false
+
+          field :before, -> { String }, optional: true, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/members/notes/types/list_notes_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Members
+    module Notes
+      module Types
+        class ListNotesResponse < Internal::Types::Model
+          field :data, -> { Internal::Types::Array[Whop_sdk::Types::MemberNote] }, optional: false, nullable: false
+
+          field :page_info, -> { Whop_sdk::Members::Notes::Types::ListNotesResponsePageInfo }, optional: false, nullable: false
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/members/notes/types/list_notes_response_page_info.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Members
+    module Notes
+      module Types
+        class ListNotesResponsePageInfo < Internal::Types::Model
+          field :end_cursor, -> { String }, optional: false, nullable: true
+
+          field :has_next_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+          field :has_previous_page, -> { Internal::Types::Boolean }, optional: false, nullable: false
+
+          field :start_cursor, -> { String }, optional: false, nullable: true
+        end
+      end
+    end
+  end
+end

data/lib/whop_sdk/members/types/list_members_request.rb

@@ -12,6 +12,16 @@ module Whop_sdk
 
         field :user_ids, -> { String }, optional: true, nullable: false
 
+        field :most_recent_actions, -> { Whop_sdk::Members::Types::ListMembersRequestMostRecentActionsItem }, optional: true, nullable: false
+
+        field :membership_status, -> { Whop_sdk::Members::Types::ListMembersRequestMembershipStatus }, optional: true, nullable: false
+
+        field :product_ids, -> { String }, optional: true, nullable: false
+
+        field :plan_ids, -> { String }, optional: true, nullable: false
+
+        field :promo_code_ids, -> { String }, optional: true, nullable: false
+
         field :query, -> { String }, optional: true, nullable: false
 
         field :created_after, -> { String }, optional: true, nullable: false

data/lib/whop_sdk/members/types/list_members_request_membership_status.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Members
+    module Types
+      module ListMembersRequestMembershipStatus
+        extend Whop_sdk::Internal::Types::Enum
+
+        ACTIVE = "active"
+        INACTIVE = "inactive"
+      end
+    end
+  end
+end

data/lib/whop_sdk/members/types/list_members_request_most_recent_actions_item.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Members
+    module Types
+      module ListMembersRequestMostRecentActionsItem
+        extend Whop_sdk::Internal::Types::Enum
+
+        CANCELING = "canceling"
+        CHURNED = "churned"
+        FINISHED_SPLIT_PAY = "finished_split_pay"
+        PAUSED = "paused"
+        PAID_SUBSCRIBER = "paid_subscriber"
+        PAID_ONCE = "paid_once"
+        EXPIRING = "expiring"
+        JOINED = "joined"
+        LEFT = "left"
+        TRIALING = "trialing"
+        PENDING_ENTRY = "pending_entry"
+        RENEWING = "renewing"
+        PAST_DUE = "past_due"
+      end
+    end
+  end
+end

data/lib/whop_sdk/members/types/list_members_request_order.rb

@@ -9,6 +9,7 @@ module Whop_sdk
         CREATED_AT = "created_at"
         JOINED_AT = "joined_at"
         LAST_ACCESSED_AT = "last_accessed_at"
+        MOST_RECENT_ACTION_AT = "most_recent_action_at"
         USD_TOTAL_SPENT = "usd_total_spent"
       end
     end

data/lib/whop_sdk/memberships/client.rb

@@ -27,9 +27,14 @@ module Whop_sdk
       # @option request_options [Integer] :timeout_in_seconds
       # @option params [String, nil] :account_id
       # @option params [String, nil] :user_id
+      # @option params [String, nil] :member_id
       # @option params [Whop_sdk::Memberships::Types::ListMembershipsRequestStatus, nil] :status
+      # @option params [Whop_sdk::Memberships::Types::ListMembershipsRequestStatusesItem, nil] :statuses
       # @option params [String, nil] :product_id
+      # @option params [String, nil] :product_ids
       # @option params [String, nil] :plan_id
+      # @option params [String, nil] :plan_ids
+      # @option params [String, nil] :promo_code_ids
       # @option params [String, nil] :created_after
       # @option params [String, nil] :created_before
       # @option params [Whop_sdk::Memberships::Types::ListMembershipsRequestOrder, nil] :order
@@ -40,7 +45,11 @@ module Whop_sdk
       # @option params [String, nil] :before
       #
       # @example
-      #   client.memberships.list
+      #   client.memberships.list(
+      #     product_ids: ["prod_xxxxxxxxxxxxx"],
+      #     plan_ids: ["plan_xxxxxxxxxxxxx"],
+      #     promo_code_ids: ["promo_xxxxxxxxxxxxxx"]
+      #   )
       #
       # @return [Whop_sdk::Memberships::Types::ListMembershipsResponse]
       def list(request_options: {}, **params)
@@ -48,9 +57,14 @@ module Whop_sdk
         query_params = {}
         query_params["account_id"] = params[:account_id] if params.key?(:account_id)
         query_params["user_id"] = params[:user_id] if params.key?(:user_id)
+        query_params["member_id"] = params[:member_id] if params.key?(:member_id)
         query_params["status"] = params[:status] if params.key?(:status)
+        query_params["statuses"] = params[:statuses] if params.key?(:statuses)
         query_params["product_id"] = params[:product_id] if params.key?(:product_id)
+        query_params["product_ids"] = params[:product_ids] if params.key?(:product_ids)
         query_params["plan_id"] = params[:plan_id] if params.key?(:plan_id)
+        query_params["plan_ids"] = params[:plan_ids] if params.key?(:plan_ids)
+        query_params["promo_code_ids"] = params[:promo_code_ids] if params.key?(:promo_code_ids)
         query_params["created_after"] = params[:created_after] if params.key?(:created_after)
         query_params["created_before"] = params[:created_before] if params.key?(:created_before)
         query_params["order"] = params[:order] if params.key?(:order)
@@ -89,10 +103,9 @@ module Whop_sdk
         end
       end
 
-      # Sends an email inviting one recipient to join the account through a free variant. Identify the recipient by
-      # exactly one of `user_id` or `email`. The invitation is bound to that recipient; after signing in, accepting it
-      # immediately grants the membership without checkout. This Experimental endpoint is available only to accounts
-      # enabled for membership invitations.
+      # Emails one recipient an invitation to a free variant's membership. The invitation is bound to that recipient;
+      # after signing in, accepting it immediately grants the membership without checkout. This Experimental endpoint is
+      # available only to accounts enabled for membership invitations.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Memberships::Types::InviteMembershipsRequestBody]
@@ -169,12 +182,7 @@ module Whop_sdk
         end
       end
 
-      # Updates a membership: merge metadata key-value pairs, toggle `cancel_at_period_end` — `true` schedules the
-      # cancellation for the end of the current billing period, `false` reverses a pending one — or move future renewals
-      # to another of the customer's saved payment methods with `payment_method_id`, or set `billing_period_days` to
-      # change renewal cadence for an active, trialing, or past-due membership billed automatically by Whop. The current
-      # period end moves to the current period start plus the requested number of days, and future renewals use the same
-      # cadence. Invoice, externally billed, and canceling memberships are not supported.
+      # Updates a membership's metadata, scheduled cancellation, renewal payment method, or renewal cadence.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Memberships::Types::UpdateMembershipsRequest]
@@ -220,10 +228,8 @@ module Whop_sdk
       end
 
       # Applies a promo code to an `active` or `trialing` membership that does not already have one and has exactly one
-      # recurring item. The discount lands on the next invoice and follows the code's duration (`once`, `repeating`, or
-      # `forever`). Works for Stripe-billed memberships and memberships billed by Whop's billing engine, including
-      # payment-element and multi-PSP renewals. Stock, plan eligibility, and expiry are still checked. Memberships with
-      # multiple recurring items are rejected.
+      # recurring item, for Stripe-billed memberships and memberships billed by Whop's billing engine. The discount
+      # lands on the next invoice and follows the code's duration (`once`, `repeating`, or `forever`).
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Memberships::Types::ApplyPromoCodeMembershipsRequest]
@@ -268,14 +274,12 @@ module Whop_sdk
         end
       end
 
-      # Assigns an affiliate to a membership and pays them the commission you set on its future payments. Name the user
-      # with exactly one of `user_id`, `email`, or `username`. A user who is not yet an affiliate of your account
-      # becomes one, which also requires `affiliate:create`. Send a new `commission_type` or `commission_value` for the
-      # membership's current affiliate to change their commission; a membership that already has a different affiliate
-      # returns a conflict. Works for active or trialing memberships with one recurring plan that bill through Stripe or
-      # Whop's billing engine, and not for marketplace memberships, paused payments, or a scheduled cancellation. The
-      # payout cannot exceed 90% of the next renewal amount, and no past payments are recalculated. You cannot assign
-      # yourself.
+      # Assigns an affiliate to a membership and pays them the commission you set on its future payments; past payments
+      # are not recalculated. A user who is not yet an affiliate of your account becomes one, which also requires
+      # `affiliate:create`. Send a new `commission_type` or `commission_value` for the membership's current affiliate to
+      # change their commission; a membership that already has a different affiliate returns a conflict. Works for
+      # active or trialing memberships with one recurring variant that bill through Stripe or Whop's billing engine, and
+      # not for marketplace memberships, paused payments, or a scheduled cancellation. You cannot assign yourself.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Memberships::Types::AssignAffiliateMembershipsRequest]
@@ -322,8 +326,7 @@ module Whop_sdk
         end
       end
 
-      # Cancels a membership. Pass `cancel_at_period_end: true` to stop auto-renewal and keep access until the current
-      # billing period ends. Omit it (or pass `false`) to revoke access immediately. Buyers cannot cancel
+      # Cancels a membership, either immediately or at the end of the current billing period. Buyers cannot cancel
       # buy-now-pay-later (`splitit`, `sezzle`) or non-trial split-pay memberships.
       #
       # @param request_options [Hash]
@@ -456,9 +459,8 @@ module Whop_sdk
       end
 
       # Restores access to a `canceled` or `expired` membership that contains only one-time purchases and sets its
-      # `status` to `completed`. Lifetime memberships regain lifetime access. For memberships with an expiration, `days`
-      # sets `current_period_end` that many days from now; without it the original `current_period_end` is kept, so
-      # `days` is required once that has passed. Active and recurring memberships cannot be reactivated.
+      # `status` to `completed`. Lifetime memberships regain lifetime access; for memberships with an expiration, `days`
+      # sets the new `current_period_end`. Active and recurring memberships cannot be reactivated.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Memberships::Types::ReactivateMembershipsRequest]

data/lib/whop_sdk/memberships/types/cancel_memberships_request.rb

@@ -8,6 +8,8 @@ module Whop_sdk
 
         field :cancel_at_period_end, -> { Internal::Types::Boolean }, optional: true, nullable: false
 
+        field :feedback_option_id, -> { String }, optional: true, nullable: false
+
         field :reason, -> { String }, optional: true, nullable: false
       end
     end

data/lib/whop_sdk/memberships/types/list_memberships_request.rb

@@ -8,12 +8,22 @@ module Whop_sdk
 
         field :user_id, -> { String }, optional: true, nullable: false
 
+        field :member_id, -> { String }, optional: true, nullable: false
+
         field :status, -> { Whop_sdk::Memberships::Types::ListMembershipsRequestStatus }, optional: true, nullable: false
 
+        field :statuses, -> { Whop_sdk::Memberships::Types::ListMembershipsRequestStatusesItem }, optional: true, nullable: false
+
         field :product_id, -> { String }, optional: true, nullable: false
 
+        field :product_ids, -> { String }, optional: true, nullable: false
+
         field :plan_id, -> { String }, optional: true, nullable: false
 
+        field :plan_ids, -> { String }, optional: true, nullable: false
+
+        field :promo_code_ids, -> { String }, optional: true, nullable: false
+
         field :created_after, -> { String }, optional: true, nullable: false
 
         field :created_before, -> { String }, optional: true, nullable: false

data/lib/whop_sdk/memberships/types/list_memberships_request_status.rb

@@ -14,6 +14,10 @@ module Whop_sdk
         EXPIRED = "expired"
         CANCELING = "canceling"
         PAUSED = "paused"
+        EXPIRING = "expiring"
+        ONE_TIME = "one_time"
+        UNCLAIMED = "unclaimed"
+        BANNED = "banned"
       end
     end
   end

data/lib/whop_sdk/memberships/types/list_memberships_request_statuses_item.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Whop_sdk
+  module Memberships
+    module Types
+      module ListMembershipsRequestStatusesItem
+        extend Whop_sdk::Internal::Types::Enum
+
+        ACTIVE = "active"
+        TRIALING = "trialing"
+        PAST_DUE = "past_due"
+        COMPLETED = "completed"
+        CANCELED = "canceled"
+        EXPIRED = "expired"
+        CANCELING = "canceling"
+        PAUSED = "paused"
+        EXPIRING = "expiring"
+        ONE_TIME = "one_time"
+        UNCLAIMED = "unclaimed"
+        BANNED = "banned"
+      end
+    end
+  end
+end

data/lib/whop_sdk/messages/client.rb

@@ -14,8 +14,7 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Returns a paginated list of messages within a specific experience chat, DM, or group chat channel, sorted by
-      # creation time.
+      # Lists messages in an experience chat, DM, or group chat channel, sorted by creation time.
       #
       # Required permissions (one of):
       #  - `chat:read`
@@ -83,8 +82,8 @@ module Whop_sdk
         end
       end
 
-      # Send a new message in an experience chat, DM, or group chat channel. Supports text content, attachments, polls,
-      # and replies.
+      # Sends a message in an experience chat, DM, or group chat channel. Supports text content, attachments, polls, and
+      # replies.
       #
       # Required permissions (one of):
       #  - `chat:message:create`
@@ -173,7 +172,7 @@ module Whop_sdk
         end
       end
 
-      # Permanently delete a message from an experience chat, DM, or group chat channel. Only the message author or a
+      # Permanently deletes a message from an experience chat, DM, or group chat channel. Only the message author or a
       # channel admin can delete a message.
       #
       # Required permissions (one of):
@@ -217,8 +216,7 @@ module Whop_sdk
         end
       end
 
-      # Edit the content, attachments, or pinned status of an existing message in an experience chat, DM, or group chat
-      # channel.
+      # Edits the content, attachments, or pinned status of a message in an experience chat, DM, or group chat channel.
       #
       # Required permissions (one of):
       #  - `chat:message:create`

data/lib/whop_sdk/notifications/client.rb

@@ -14,10 +14,9 @@ module Whop_sdk
         @environment = environment
       end
 
-      # Lists the authenticated user's notifications, newest first. Requires a user credential — an account API key has
-      # no notification feed. Without filters the feed spans every experience the user belongs to plus the teams they
-      # are a member of. The `after` cursor is a notification `id` from a previous response; subsequent pages contain
-      # older notifications.
+      # Lists the authenticated user's notifications, newest first. Without filters the feed spans every experience the
+      # user belongs to plus the teams they are a member of. Requires a user credential — an account API key has no
+      # notification feed.
       #
       # @param request_options [Hash]
       # @param params [Hash]
@@ -162,9 +161,8 @@ module Whop_sdk
         end
       end
 
-      # Marks the authenticated user's notifications as read: one experience's (`experience_id`) or everything (`all:
-      # true`) — exactly one of the two. Requires a user credential. Responds with the refreshed badge rows for the
-      # affected scope.
+      # Marks the authenticated user's notifications as read, for one experience or all of them, and returns the
+      # refreshed badge rows for that scope. Requires a user credential.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::Notifications::Types::MarkReadNotificationsRequest]
@@ -201,8 +199,7 @@ module Whop_sdk
         end
       end
 
-      # Retrieves a single notification by id — either an `id` returned by List Notifications, or the ephemeral id
-      # delivered with a push/websocket event. Requires a user credential.
+      # Retrieves a single notification, from the feed or from a push or websocket event. Requires a user credential.
       #
       # @param request_options [Hash]
       # @param params [Hash]

data/lib/whop_sdk/notifications/topics/client.rb

@@ -16,7 +16,7 @@ module Whop_sdk
         end
 
         # Lists the platform's visible notification topics — the categories users can set notification preferences on.
-        # App-created topics are internal and not returned.
+        # App-created topics are not returned.
         #
         # @param request_options [Hash]
         # @param params [Hash]

data/lib/whop_sdk/partner_referral_requests/client.rb

@@ -84,9 +84,9 @@ module Whop_sdk
         end
       end
 
-      # Creates a referral link or sends a verified partner's attribution request to an existing business or user for
-      # approval. Whop sessions creating a link with their own active `authorized_user_id` enroll automatically. Manual
-      # requests always require a verified partner. Recipients do not need to join the partner program.
+      # Creates a referral link, or sends an attribution request to an existing business or user for approval. Links
+      # require an enrolled partner who is not suspended; attribution requests require an enrolled, verified partner.
+      # Recipients do not need to join the partner program.
       #
       # @param request_options [Hash]
       # @param params [Whop_sdk::PartnerReferralRequests::Types::CreatePartnerReferralRequestsRequestBody]

data/lib/whop_sdk/partner_referral_requests/types/create_partner_referral_requests_request_body_code.rb

@@ -5,8 +5,7 @@ module Whop_sdk
     module Types
       # Create your own referral link with an optional custom code and redemption limit. Without configuration, returns
       # your oldest saved link for the selected team membership, or your personal context when `authorized_user_id` is
-      # omitted, creating a random code when none exists. Only authorized staff can configure rewards or select another
-      # partner.
+      # omitted, creating a random code when none exists.
       class CreatePartnerReferralRequestsRequestBodyCode < Internal::Types::Model
         field :authorized_user_id, -> { String }, optional: true, nullable: false