whop_sdk 0.0.2

data/lib/whop_sdk/models/shipment_create_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Shipments#create
+    class ShipmentCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to create the shipment for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute payment_id
+      #   The ID of the payment to create the shipment for
+      #
+      #   @return [String]
+      required :payment_id, String
+
+      # @!attribute tracking_code
+      #   The tracking code for the shipment
+      #
+      #   @return [String]
+      required :tracking_code, String
+
+      # @!method initialize(company_id:, payment_id:, tracking_code:, request_options: {})
+      #   @param company_id [String] The ID of the company to create the shipment for
+      #
+      #   @param payment_id [String] The ID of the payment to create the shipment for
+      #
+      #   @param tracking_code [String] The tracking code for the shipment
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/shipment_list_params.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Shipments#list
+    class ShipmentListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!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 company_id
+      #   The ID of the company
+      #
+      #   @return [String, nil]
+      optional :company_id, String, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute payment_id
+      #   The ID of the payment
+      #
+      #   @return [String, nil]
+      optional :payment_id, String, nil?: true
+
+      # @!attribute user_id
+      #   The ID of the user
+      #
+      #   @return [String, nil]
+      optional :user_id, String, nil?: true
+
+      # @!method initialize(after: nil, before: nil, company_id: nil, first: nil, last: nil, payment_id: nil, user_id: nil, request_options: {})
+      #   @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 company_id [String, nil] The ID of the company
+      #
+      #   @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 payment_id [String, nil] The ID of the payment
+      #
+      #   @param user_id [String, nil] The ID of the user
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/shipment_list_response.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Shipments#list
+    class ShipmentListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The ID of the shipment
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute carrier
+      #   The carrier of the shipment
+      #
+      #   @return [Symbol, WhopSDK::Models::ShipmentCarrier]
+      required :carrier, enum: -> { WhopSDK::ShipmentCarrier }
+
+      # @!attribute created_at
+      #   The date and time the shipment was created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute delivery_estimate
+      #   The delivery estimate of the shipment
+      #
+      #   @return [Time, nil]
+      required :delivery_estimate, Time, nil?: true
+
+      # @!attribute payment
+      #   The payment of the shipment
+      #
+      #   @return [WhopSDK::Models::ShipmentListResponse::Payment]
+      required :payment, -> { WhopSDK::Models::ShipmentListResponse::Payment }
+
+      # @!attribute service
+      #   The service of the shipment
+      #
+      #   @return [String, nil]
+      required :service, String, nil?: true
+
+      # @!attribute status
+      #   The status of the shipment
+      #
+      #   @return [Symbol, WhopSDK::Models::ShipmentStatus]
+      required :status, enum: -> { WhopSDK::ShipmentStatus }
+
+      # @!attribute substatus
+      #   The substatus of a shipment
+      #
+      #   @return [Symbol, WhopSDK::Models::ShipmentSubstatus, nil]
+      required :substatus, enum: -> { WhopSDK::ShipmentSubstatus }, nil?: true
+
+      # @!attribute tracking_code
+      #   The tracking code of the shipment
+      #
+      #   @return [String]
+      required :tracking_code, String
+
+      # @!attribute updated_at
+      #   The date and time the shipment was last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!method initialize(id:, carrier:, created_at:, delivery_estimate:, payment:, service:, status:, substatus:, tracking_code:, updated_at:)
+      #   A shipment
+      #
+      #   @param id [String] The ID of the shipment
+      #
+      #   @param carrier [Symbol, WhopSDK::Models::ShipmentCarrier] The carrier of the shipment
+      #
+      #   @param created_at [Time] The date and time the shipment was created
+      #
+      #   @param delivery_estimate [Time, nil] The delivery estimate of the shipment
+      #
+      #   @param payment [WhopSDK::Models::ShipmentListResponse::Payment] The payment of the shipment
+      #
+      #   @param service [String, nil] The service of the shipment
+      #
+      #   @param status [Symbol, WhopSDK::Models::ShipmentStatus] The status of the shipment
+      #
+      #   @param substatus [Symbol, WhopSDK::Models::ShipmentSubstatus, nil] The substatus of a shipment
+      #
+      #   @param tracking_code [String] The tracking code of the shipment
+      #
+      #   @param updated_at [Time] The date and time the shipment was last updated
+
+      # @see WhopSDK::Models::ShipmentListResponse#payment
+      class Payment < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The payment ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   The payment of the shipment
+        #
+        #   @param id [String] The payment ID
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/shipment_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::Shipments#retrieve
+    class ShipmentRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/shipment_status.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The status of a shipment
+    module ShipmentStatus
+      extend WhopSDK::Internal::Type::Enum
+
+      UNKNOWN = :unknown
+      PRE_TRANSIT = :pre_transit
+      IN_TRANSIT = :in_transit
+      OUT_FOR_DELIVERY = :out_for_delivery
+      DELIVERED = :delivered
+      AVAILABLE_FOR_PICKUP = :available_for_pickup
+      RETURN_TO_SENDER = :return_to_sender
+      FAILURE = :failure
+      CANCELLED = :cancelled
+      ERROR = :error
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/shipment_substatus.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # The substatus of a shipment
+    module ShipmentSubstatus
+      extend WhopSDK::Internal::Type::Enum
+
+      ADDRESS_CORRECTION = :address_correction
+      ARRIVED_AT_DESTINATION = :arrived_at_destination
+      ARRIVED_AT_FACILITY = :arrived_at_facility
+      ARRIVED_AT_PICKUP_LOCATION = :arrived_at_pickup_location
+      AWAITING_INFORMATION = :awaiting_information
+      SUBSTATUS_CANCELLED = :substatus_cancelled
+      DAMAGED = :damaged
+      DELAYED = :delayed
+      DELIVERY_EXCEPTION = :delivery_exception
+      DEPARTED_FACILITY = :departed_facility
+      DEPARTED_ORIGIN_FACILITY = :departed_origin_facility
+      EXPIRED = :expired
+      SUBSTATUS_FAILURE = :substatus_failure
+      HELD = :held
+      SUBSTATUS_IN_TRANSIT = :substatus_in_transit
+      LABEL_CREATED = :label_created
+      LOST = :lost
+      MISSORTED = :missorted
+      SUBSTATUS_OUT_FOR_DELIVERY = :substatus_out_for_delivery
+      RECEIVED_AT_DESTINATION_FACILITY = :received_at_destination_facility
+      RECEIVED_AT_ORIGIN_FACILITY = :received_at_origin_facility
+      REFUSED = :refused
+      RETURN = :return
+      STATUS_UPDATE = :status_update
+      TRANSFERRED_TO_DESTINATION_CARRIER = :transferred_to_destination_carrier
+      TRANSIT_EXCEPTION = :transit_exception
+      SUBSTATUS_UNKNOWN = :substatus_unknown
+      WEATHER_DELAY = :weather_delay
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/whop_sdk/models/support_channel.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    class SupportChannel < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute company_id
+      #   The bot ID if this is a support chat
+      #
+      #   @return [String, nil]
+      required :company_id, String, nil?: true
+
+      # @!attribute custom_name
+      #   The custom name of the DM channel, if any
+      #
+      #   @return [String, nil]
+      required :custom_name, String, nil?: true
+
+      # @!attribute customer_user
+      #   The customer user if this is a support chat
+      #
+      #   @return [WhopSDK::Models::SupportChannel::CustomerUser, nil]
+      required :customer_user, -> { WhopSDK::SupportChannel::CustomerUser }, nil?: true
+
+      # @!attribute last_message_at
+      #   When the last message was sent
+      #
+      #   @return [Time, nil]
+      required :last_message_at, Time, nil?: true
+
+      # @!attribute resolved_at
+      #   When the support ticket was resolved (null if unresolved)
+      #
+      #   @return [Time, nil]
+      required :resolved_at, Time, nil?: true
+
+      # @!method initialize(id:, company_id:, custom_name:, customer_user:, last_message_at:, resolved_at:)
+      #   Represents a DM channel
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param company_id [String, nil] The bot ID if this is a support chat
+      #
+      #   @param custom_name [String, nil] The custom name of the DM channel, if any
+      #
+      #   @param customer_user [WhopSDK::Models::SupportChannel::CustomerUser, nil] The customer user if this is a support chat
+      #
+      #   @param last_message_at [Time, nil] When the last message was sent
+      #
+      #   @param resolved_at [Time, nil] When the support ticket was resolved (null if unresolved)
+
+      # @see WhopSDK::Models::SupportChannel#customer_user
+      class CustomerUser < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the user from their Whop account.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The customer user if this is a support chat
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param name [String, nil] The name of the user from their Whop account.
+        #
+        #   @param username [String] The username of the user from their Whop account.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/support_channel_create_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SupportChannels#create
+    class SupportChannelCreateParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to create the support chat in
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute user_id
+      #   The ID of the user to create the support chat for
+      #
+      #   @return [String]
+      required :user_id, String
+
+      # @!method initialize(company_id:, user_id:, request_options: {})
+      #   @param company_id [String] The ID of the company to create the support chat in
+      #
+      #   @param user_id [String] The ID of the user to create the support chat for
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/support_channel_list_params.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SupportChannels#list
+    class SupportChannelListParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!attribute company_id
+      #   The ID of the company to list chat channels for
+      #
+      #   @return [String]
+      required :company_id, String
+
+      # @!attribute after
+      #   Returns the elements in the list that come after the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :after, String, nil?: true
+
+      # @!attribute before
+      #   Returns the elements in the list that come before the specified cursor.
+      #
+      #   @return [String, nil]
+      optional :before, String, nil?: true
+
+      # @!attribute direction
+      #   The direction of the sort.
+      #
+      #   @return [Symbol, WhopSDK::Models::Direction, nil]
+      optional :direction, enum: -> { WhopSDK::Direction }, nil?: true
+
+      # @!attribute first
+      #   Returns the first _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :first, Integer, nil?: true
+
+      # @!attribute last
+      #   Returns the last _n_ elements from the list.
+      #
+      #   @return [Integer, nil]
+      optional :last, Integer, nil?: true
+
+      # @!attribute open_
+      #   Filter for tickets where customer sent the last message (needs response) AND not
+      #   resolved. Set to true to only return open channels, false to only return
+      #   resolved channels.
+      #
+      #   @return [Boolean, nil]
+      optional :open_, WhopSDK::Internal::Type::Boolean, nil?: true
+
+      # @!attribute order
+      #   Sort options for message channels
+      #
+      #   @return [Symbol, WhopSDK::Models::SupportChannelListParams::Order, nil]
+      optional :order, enum: -> { WhopSDK::SupportChannelListParams::Order }, nil?: true
+
+      # @!method initialize(company_id:, after: nil, before: nil, direction: nil, first: nil, last: nil, open_: nil, order: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {WhopSDK::Models::SupportChannelListParams} for more details.
+      #
+      #   @param company_id [String] The ID of the company to list chat channels 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 open_ [Boolean, nil] Filter for tickets where customer sent the last message (needs response) AND not
+      #
+      #   @param order [Symbol, WhopSDK::Models::SupportChannelListParams::Order, nil] Sort options for message channels
+      #
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+
+      # Sort options for message channels
+      module Order
+        extend WhopSDK::Internal::Type::Enum
+
+        CREATED_AT = :created_at
+        LAST_POST_SENT_AT = :last_post_sent_at
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/support_channel_list_response.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SupportChannels#list
+    class SupportChannelListResponse < WhopSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier for the entity
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute company_id
+      #   The bot ID if this is a support chat
+      #
+      #   @return [String, nil]
+      required :company_id, String, nil?: true
+
+      # @!attribute custom_name
+      #   The custom name of the DM channel, if any
+      #
+      #   @return [String, nil]
+      required :custom_name, String, nil?: true
+
+      # @!attribute customer_user
+      #   The customer user if this is a support chat
+      #
+      #   @return [WhopSDK::Models::SupportChannelListResponse::CustomerUser, nil]
+      required :customer_user, -> { WhopSDK::Models::SupportChannelListResponse::CustomerUser }, nil?: true
+
+      # @!attribute last_message_at
+      #   When the last message was sent
+      #
+      #   @return [Time, nil]
+      required :last_message_at, Time, nil?: true
+
+      # @!attribute resolved_at
+      #   When the support ticket was resolved (null if unresolved)
+      #
+      #   @return [Time, nil]
+      required :resolved_at, Time, nil?: true
+
+      # @!method initialize(id:, company_id:, custom_name:, customer_user:, last_message_at:, resolved_at:)
+      #   Represents a DM channel
+      #
+      #   @param id [String] The unique identifier for the entity
+      #
+      #   @param company_id [String, nil] The bot ID if this is a support chat
+      #
+      #   @param custom_name [String, nil] The custom name of the DM channel, if any
+      #
+      #   @param customer_user [WhopSDK::Models::SupportChannelListResponse::CustomerUser, nil] The customer user if this is a support chat
+      #
+      #   @param last_message_at [Time, nil] When the last message was sent
+      #
+      #   @param resolved_at [Time, nil] When the support ticket was resolved (null if unresolved)
+
+      # @see WhopSDK::Models::SupportChannelListResponse#customer_user
+      class CustomerUser < WhopSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   The internal ID of the user.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #   The name of the user from their Whop account.
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!attribute username
+        #   The username of the user from their Whop account.
+        #
+        #   @return [String]
+        required :username, String
+
+        # @!method initialize(id:, name:, username:)
+        #   The customer user if this is a support chat
+        #
+        #   @param id [String] The internal ID of the user.
+        #
+        #   @param name [String, nil] The name of the user from their Whop account.
+        #
+        #   @param username [String] The username of the user from their Whop account.
+      end
+    end
+  end
+end

data/lib/whop_sdk/models/support_channel_retrieve_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # @see WhopSDK::Resources::SupportChannels#retrieve
+    class SupportChannelRetrieveParams < WhopSDK::Internal::Type::BaseModel
+      extend WhopSDK::Internal::Type::RequestParameters::Converter
+      include WhopSDK::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [WhopSDK::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/whop_sdk/models/tax_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module WhopSDK
+  module Models
+    # Whether or not the tax is included in a plan's price (or if it hasn't been set
+    # up)
+    module TaxType
+      extend WhopSDK::Internal::Type::Enum
+
+      INCLUSIVE = :inclusive
+      EXCLUSIVE = :exclusive
+      UNSPECIFIED = :unspecified
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end