whop_sdk 0.0.39 → 0.0.41

data/lib/whop_sdk/models/card_create_params.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Cards#create
+    class CardCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute assigned_user_id
+      #   The company member (a user\_ identifier) to assign the card to. Required for
+      #   company (business) card issuing accounts.
+      #
+      #   @return [String, nil]
+      optional :assigned_user_id, String
+
+      # @!attribute name
+      #   A display name for the card.
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute spend_limit
+      #   Spending limit amount, in dollars.
+      #
+      #   @return [Float, nil]
+      optional :spend_limit, Float
+
+      # @!attribute spend_limit_frequency
+      #   The spending limit window.
+      #
+      #   @return [Symbol, WhopSDK::Models::CardCreateParams::SpendLimitFrequency, nil]
+      optional :spend_limit_frequency, enum: -> { WhopSDK::CardCreateParams::SpendLimitFrequency }
+
+      # @!attribute transaction_limit
+      #   Per-transaction limit amount, in dollars.
+      #
+      #   @return [Float, nil]
+      optional :transaction_limit, Float
+
+      # @!attribute user_id
+      #   The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(account_id: nil, assigned_user_id: nil, name: nil, spend_limit: nil, spend_limit_frequency: nil, transaction_limit: nil, user_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CardCreateParams} for more details.
+      #
+      #   @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @param assigned_user_id [String] The company member (a user\_ identifier) to assign the card to. Required for
+      #   comp
+      #
+      #   @param name [String] A display name for the card.
+      #
+      #   @param spend_limit [Float] Spending limit amount, in dollars.
+      #
+      #   @param spend_limit_frequency [Symbol, WhopSDK::Models::CardCreateParams::SpendLimitFrequency] The spending limit window.
+      #
+      #   @param transaction_limit [Float] Per-transaction limit amount, in dollars.
+      #
+      #   @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # The spending limit window.
+      module SpendLimitFrequency
+        extend WhopSDK::Internal::Type::Enum
+
+        DAILY = :daily
+        WEEKLY = :weekly
+        MONTHLY = :monthly
+        ONE_TIME = :one_time
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/card_create_response.rb

@@ -0,0 +1,277 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Cards#create
+    class CardCreateResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   Card ID, prefixed `icrd_`.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute billing
+      #   The billing address.
+      #
+      #   @return [WhopSDK::Models::CardCreateResponse::Billing, nil]
+      required :billing, -> { WhopSDK::Models::CardCreateResponse::Billing }, nil?: true
+
+      # @!attribute canceled_at
+      #   When the card was canceled.
+      #
+      #   @return [Time, nil]
+      required :canceled_at, Time, nil?: true
+
+      # @!attribute created_at
+      #   When the card was created.
+      #
+      #   @return [Time, nil]
+      required :created_at, Time, nil?: true
+
+      # @!attribute expiration_month
+      #   Card expiration month.
+      #
+      #   @return [String, nil]
+      required :expiration_month, String, nil?: true
+
+      # @!attribute expiration_year
+      #   Card expiration year.
+      #
+      #   @return [String, nil]
+      required :expiration_year, String, nil?: true
+
+      # @!attribute last4
+      #   Last four digits of the card number. `null` for pending invitation cards.
+      #
+      #   @return [String, nil]
+      required :last4, String, nil?: true
+
+      # @!attribute limit
+      #   The spending limit configuration.
+      #
+      #   @return [WhopSDK::Models::CardCreateResponse::Limit, nil]
+      required :limit, -> { WhopSDK::Models::CardCreateResponse::Limit }, nil?: true
+
+      # @!attribute name
+      #   Card display name.
+      #
+      #   @return [String, nil]
+      required :name, String, nil?: true
+
+      # @!attribute object
+      #
+      #   @return [Symbol, WhopSDK::Models::CardCreateResponse::Object]
+      required :object, enum: -> { WhopSDK::Models::CardCreateResponse::Object }
+
+      # @!attribute spent_last_month
+      #   Total spend in the last 30 days, in cents.
+      #
+      #   @return [Integer, nil]
+      required :spent_last_month, Integer, nil?: true
+
+      # @!attribute status
+      #   The card status.
+      #
+      #   @return [Symbol, WhopSDK::Models::CardCreateResponse::Status, nil]
+      required :status, enum: -> { WhopSDK::Models::CardCreateResponse::Status }, nil?: true
+
+      # @!attribute type
+      #   The card type.
+      #
+      #   @return [Symbol, WhopSDK::Models::CardCreateResponse::Type, nil]
+      required :type, enum: -> { WhopSDK::Models::CardCreateResponse::Type }, nil?: true
+
+      # @!attribute user_id
+      #   Cardholder user ID, prefixed `user_`, when assigned.
+      #
+      #   @return [String, nil]
+      required :user_id, String, nil?: true
+
+      # @!attribute secrets
+      #   Sensitive card details. Present only on `GET /cards/:card_id` for active cards;
+      #   `null` when the card is inactive or details cannot be retrieved.
+      #
+      #   @return [WhopSDK::Models::CardCreateResponse::Secrets, nil]
+      optional :secrets, -> { WhopSDK::Models::CardCreateResponse::Secrets }, nil?: true
+
+      # @!method initialize(id:, billing:, canceled_at:, created_at:, expiration_month:, expiration_year:, last4:, limit:, name:, object:, spent_last_month:, status:, type:, user_id:, secrets: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::CardCreateResponse} for more details.
+      #
+      #   @param id [String] Card ID, prefixed `icrd_`.
+      #
+      #   @param billing [WhopSDK::Models::CardCreateResponse::Billing, nil] The billing address.
+      #
+      #   @param canceled_at [Time, nil] When the card was canceled.
+      #
+      #   @param created_at [Time, nil] When the card was created.
+      #
+      #   @param expiration_month [String, nil] Card expiration month.
+      #
+      #   @param expiration_year [String, nil] Card expiration year.
+      #
+      #   @param last4 [String, nil] Last four digits of the card number. `null` for pending invitation cards.
+      #
+      #   @param limit [WhopSDK::Models::CardCreateResponse::Limit, nil] The spending limit configuration.
+      #
+      #   @param name [String, nil] Card display name.
+      #
+      #   @param object [Symbol, WhopSDK::Models::CardCreateResponse::Object]
+      #
+      #   @param spent_last_month [Integer, nil] Total spend in the last 30 days, in cents.
+      #
+      #   @param status [Symbol, WhopSDK::Models::CardCreateResponse::Status, nil] The card status.
+      #
+      #   @param type [Symbol, WhopSDK::Models::CardCreateResponse::Type, nil] The card type.
+      #
+      #   @param user_id [String, nil] Cardholder user ID, prefixed `user_`, when assigned.
+      #
+      #   @param secrets [WhopSDK::Models::CardCreateResponse::Secrets, nil] Sensitive card details. Present only on `GET /cards/:card_id` for active cards;
+
+      # @see WhopSDK::Models::CardCreateResponse#billing
+      class Billing < WhopSDK::Internal::Type::BaseModel
+        # @!attribute city
+        #   Billing city.
+        #
+        #   @return [String, nil]
+        required :city, String, nil?: true
+
+        # @!attribute country_code
+        #   Billing country code.
+        #
+        #   @return [String, nil]
+        required :country_code, String, nil?: true
+
+        # @!attribute line1
+        #   Street address line 1.
+        #
+        #   @return [String, nil]
+        required :line1, String, nil?: true
+
+        # @!attribute line2
+        #   Street address line 2.
+        #
+        #   @return [String, nil]
+        required :line2, String, nil?: true
+
+        # @!attribute postal_code
+        #   Billing postal code.
+        #
+        #   @return [String, nil]
+        required :postal_code, String, nil?: true
+
+        # @!attribute region
+        #   Billing region or state.
+        #
+        #   @return [String, nil]
+        required :region, String, nil?: true
+
+        # @!method initialize(city:, country_code:, line1:, line2:, postal_code:, region:)
+        #   The billing address.
+        #
+        #   @param city [String, nil] Billing city.
+        #
+        #   @param country_code [String, nil] Billing country code.
+        #
+        #   @param line1 [String, nil] Street address line 1.
+        #
+        #   @param line2 [String, nil] Street address line 2.
+        #
+        #   @param postal_code [String, nil] Billing postal code.
+        #
+        #   @param region [String, nil] Billing region or state.
+      end
+
+      # @see WhopSDK::Models::CardCreateResponse#limit
+      class Limit < WhopSDK::Internal::Type::BaseModel
+        # @!attribute amount
+        #   The limit amount in dollars.
+        #
+        #   @return [Float]
+        required :amount, Float
+
+        # @!attribute frequency
+        #   Limit window, for example `per24HourPeriod` or `perAuthorization`.
+        #
+        #   @return [String]
+        required :frequency, String
+
+        # @!method initialize(amount:, frequency:)
+        #   The spending limit configuration.
+        #
+        #   @param amount [Float] The limit amount in dollars.
+        #
+        #   @param frequency [String] Limit window, for example `per24HourPeriod` or `perAuthorization`.
+      end
+
+      # @see WhopSDK::Models::CardCreateResponse#object
+      module Object
+        extend WhopSDK::Internal::Type::Enum
+
+        CARD = :card
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The card status.
+      #
+      # @see WhopSDK::Models::CardCreateResponse#status
+      module Status
+        extend WhopSDK::Internal::Type::Enum
+
+        ACTIVE = :active
+        FROZEN = :frozen
+        CANCELED = :canceled
+        INVITED = :invited
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The card type.
+      #
+      # @see WhopSDK::Models::CardCreateResponse#type
+      module Type
+        extend WhopSDK::Internal::Type::Enum
+
+        VIRTUAL = :virtual
+        PHYSICAL = :physical
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see WhopSDK::Models::CardCreateResponse#secrets
+      class Secrets < WhopSDK::Internal::Type::BaseModel
+        # @!attribute card_number
+        #   Full card number.
+        #
+        #   @return [String]
+        required :card_number, String
+
+        # @!attribute cvc
+        #   Card verification code.
+        #
+        #   @return [String]
+        required :cvc, String
+
+        # @!attribute name_on_card
+        #   Cardholder name printed on the card.
+        #
+        #   @return [String, nil]
+        required :name_on_card, String, nil?: true
+
+        # @!method initialize(card_number:, cvc:, name_on_card:)
+        #   Sensitive card details. Present only on `GET /cards/:card_id` for active cards;
+        #   `null` when the card is inactive or details cannot be retrieved.
+        #
+        #   @param card_number [String] Full card number.
+        #
+        #   @param cvc [String] Card verification code.
+        #
+        #   @param name_on_card [String, nil] Cardholder name printed on the card.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/card_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Cards#list
+    class CardListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute account_id
+      #   The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute user_id
+      #   The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @return [String, nil]
+      optional :user_id, String
+
+      # @!method initialize(account_id: nil, user_id: nil, request_options: {})
+      #   @param account_id [String] The owning account ID (a biz\_ identifier). Provide this or user_id.
+      #
+      #   @param user_id [String] The owning user ID (a user\_ identifier). Provide this or account_id.
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/card_list_response.rb

@@ -0,0 +1,287 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Cards#list
+    class CardListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<WhopSDK::Models::CardListResponse::Data>]
+      required :data, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Models::CardListResponse::Data] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<WhopSDK::Models::CardListResponse::Data>]
+
+      class Data < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   Card ID, prefixed `icrd_`.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute billing
+        #   The billing address.
+        #
+        #   @return [WhopSDK::Models::CardListResponse::Data::Billing, nil]
+        required :billing, -> { WhopSDK::Models::CardListResponse::Data::Billing }, nil?: true
+
+        # @!attribute canceled_at
+        #   When the card was canceled.
+        #
+        #   @return [Time, nil]
+        required :canceled_at, Time, nil?: true
+
+        # @!attribute created_at
+        #   When the card was created.
+        #
+        #   @return [Time, nil]
+        required :created_at, Time, nil?: true
+
+        # @!attribute expiration_month
+        #   Card expiration month.
+        #
+        #   @return [String, nil]
+        required :expiration_month, String, nil?: true
+
+        # @!attribute expiration_year
+        #   Card expiration year.
+        #
+        #   @return [String, nil]
+        required :expiration_year, String, nil?: true
+
+        # @!attribute last4
+        #   Last four digits of the card number. `null` for pending invitation cards.
+        #
+        #   @return [String, nil]
+        required :last4, String, nil?: true
+
+        # @!attribute limit
+        #   The spending limit configuration.
+        #
+        #   @return [WhopSDK::Models::CardListResponse::Data::Limit, nil]
+        required :limit, -> { WhopSDK::Models::CardListResponse::Data::Limit }, nil?: true
+
+        # @!attribute name
+        #   Card display name.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute object
+        #
+        #   @return [Symbol, WhopSDK::Models::CardListResponse::Data::Object]
+        required :object, enum: -> { WhopSDK::Models::CardListResponse::Data::Object }
+
+        # @!attribute spent_last_month
+        #   Total spend in the last 30 days, in cents.
+        #
+        #   @return [Integer, nil]
+        required :spent_last_month, Integer, nil?: true
+
+        # @!attribute status
+        #   The card status.
+        #
+        #   @return [Symbol, WhopSDK::Models::CardListResponse::Data::Status, nil]
+        required :status, enum: -> { WhopSDK::Models::CardListResponse::Data::Status }, nil?: true
+
+        # @!attribute type
+        #   The card type.
+        #
+        #   @return [Symbol, WhopSDK::Models::CardListResponse::Data::Type, nil]
+        required :type, enum: -> { WhopSDK::Models::CardListResponse::Data::Type }, nil?: true
+
+        # @!attribute user_id
+        #   Cardholder user ID, prefixed `user_`, when assigned.
+        #
+        #   @return [String, nil]
+        required :user_id, String, nil?: true
+
+        # @!attribute secrets
+        #   Sensitive card details. Present only on `GET /cards/:card_id` for active cards;
+        #   `null` when the card is inactive or details cannot be retrieved.
+        #
+        #   @return [WhopSDK::Models::CardListResponse::Data::Secrets, nil]
+        optional :secrets, -> { WhopSDK::Models::CardListResponse::Data::Secrets }, nil?: true
+
+        # @!method initialize(id:, billing:, canceled_at:, created_at:, expiration_month:, expiration_year:, last4:, limit:, name:, object:, spent_last_month:, status:, type:, user_id:, secrets: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {WhopSDK::Models::CardListResponse::Data} for more details.
+        #
+        #   @param id [String] Card ID, prefixed `icrd_`.
+        #
+        #   @param billing [WhopSDK::Models::CardListResponse::Data::Billing, nil] The billing address.
+        #
+        #   @param canceled_at [Time, nil] When the card was canceled.
+        #
+        #   @param created_at [Time, nil] When the card was created.
+        #
+        #   @param expiration_month [String, nil] Card expiration month.
+        #
+        #   @param expiration_year [String, nil] Card expiration year.
+        #
+        #   @param last4 [String, nil] Last four digits of the card number. `null` for pending invitation cards.
+        #
+        #   @param limit [WhopSDK::Models::CardListResponse::Data::Limit, nil] The spending limit configuration.
+        #
+        #   @param name [String, nil] Card display name.
+        #
+        #   @param object [Symbol, WhopSDK::Models::CardListResponse::Data::Object]
+        #
+        #   @param spent_last_month [Integer, nil] Total spend in the last 30 days, in cents.
+        #
+        #   @param status [Symbol, WhopSDK::Models::CardListResponse::Data::Status, nil] The card status.
+        #
+        #   @param type [Symbol, WhopSDK::Models::CardListResponse::Data::Type, nil] The card type.
+        #
+        #   @param user_id [String, nil] Cardholder user ID, prefixed `user_`, when assigned.
+        #
+        #   @param secrets [WhopSDK::Models::CardListResponse::Data::Secrets, nil] Sensitive card details. Present only on `GET /cards/:card_id` for active cards;
+
+        # @see WhopSDK::Models::CardListResponse::Data#billing
+        class Billing < WhopSDK::Internal::Type::BaseModel
+          # @!attribute city
+          #   Billing city.
+          #
+          #   @return [String, nil]
+          required :city, String, nil?: true
+
+          # @!attribute country_code
+          #   Billing country code.
+          #
+          #   @return [String, nil]
+          required :country_code, String, nil?: true
+
+          # @!attribute line1
+          #   Street address line 1.
+          #
+          #   @return [String, nil]
+          required :line1, String, nil?: true
+
+          # @!attribute line2
+          #   Street address line 2.
+          #
+          #   @return [String, nil]
+          required :line2, String, nil?: true
+
+          # @!attribute postal_code
+          #   Billing postal code.
+          #
+          #   @return [String, nil]
+          required :postal_code, String, nil?: true
+
+          # @!attribute region
+          #   Billing region or state.
+          #
+          #   @return [String, nil]
+          required :region, String, nil?: true
+
+          # @!method initialize(city:, country_code:, line1:, line2:, postal_code:, region:)
+          #   The billing address.
+          #
+          #   @param city [String, nil] Billing city.
+          #
+          #   @param country_code [String, nil] Billing country code.
+          #
+          #   @param line1 [String, nil] Street address line 1.
+          #
+          #   @param line2 [String, nil] Street address line 2.
+          #
+          #   @param postal_code [String, nil] Billing postal code.
+          #
+          #   @param region [String, nil] Billing region or state.
+        end
+
+        # @see WhopSDK::Models::CardListResponse::Data#limit
+        class Limit < WhopSDK::Internal::Type::BaseModel
+          # @!attribute amount
+          #   The limit amount in dollars.
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute frequency
+          #   Limit window, for example `per24HourPeriod` or `perAuthorization`.
+          #
+          #   @return [String]
+          required :frequency, String
+
+          # @!method initialize(amount:, frequency:)
+          #   The spending limit configuration.
+          #
+          #   @param amount [Float] The limit amount in dollars.
+          #
+          #   @param frequency [String] Limit window, for example `per24HourPeriod` or `perAuthorization`.
+        end
+
+        # @see WhopSDK::Models::CardListResponse::Data#object
+        module Object
+          extend WhopSDK::Internal::Type::Enum
+
+          CARD = :card
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The card status.
+        #
+        # @see WhopSDK::Models::CardListResponse::Data#status
+        module Status
+          extend WhopSDK::Internal::Type::Enum
+
+          ACTIVE = :active
+          FROZEN = :frozen
+          CANCELED = :canceled
+          INVITED = :invited
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The card type.
+        #
+        # @see WhopSDK::Models::CardListResponse::Data#type
+        module Type
+          extend WhopSDK::Internal::Type::Enum
+
+          VIRTUAL = :virtual
+          PHYSICAL = :physical
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # @see WhopSDK::Models::CardListResponse::Data#secrets
+        class Secrets < WhopSDK::Internal::Type::BaseModel
+          # @!attribute card_number
+          #   Full card number.
+          #
+          #   @return [String]
+          required :card_number, String
+
+          # @!attribute cvc
+          #   Card verification code.
+          #
+          #   @return [String]
+          required :cvc, String
+
+          # @!attribute name_on_card
+          #   Cardholder name printed on the card.
+          #
+          #   @return [String, nil]
+          required :name_on_card, String, nil?: true
+
+          # @!method initialize(card_number:, cvc:, name_on_card:)
+          #   Sensitive card details. Present only on `GET /cards/:card_id` for active cards;
+          #   `null` when the card is inactive or details cannot be retrieved.
+          #
+          #   @param card_number [String] Full card number.
+          #
+          #   @param cvc [String] Card verification code.
+          #
+          #   @param name_on_card [String, nil] Cardholder name printed on the card.
+        end
+      end
+    end
+  end
+end