@whop/sdk 0.0.28 → 0.0.30

package/src/resources/dispute-alerts.ts

@@ -0,0 +1,404 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as DisputesAPI from './disputes';
+import * as PaymentsAPI from './payments';
+import * as Shared from './shared';
+import { APIPromise } from '../core/api-promise';
+import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class DisputeAlerts extends APIResource {
+  /**
+   * Retrieves the details of an existing dispute alert.
+   *
+   * Required permissions:
+   *
+   * - `payment:dispute_alert:read`
+   * - `payment:basic:read`
+   * - `member:email:read`
+   * - `member:basic:read`
+   * - `member:phone:read`
+   * - `payment:dispute:read`
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<DisputeAlertRetrieveResponse> {
+    return this._client.get(path`/dispute_alerts/${id}`, options);
+  }
+
+  /**
+   * Returns a paginated list of dispute alerts for a company, with optional
+   * filtering by creation date.
+   *
+   * Required permissions:
+   *
+   * - `payment:dispute_alert:read`
+   * - `payment:basic:read`
+   * - `payment:dispute:read`
+   */
+  list(
+    query: DisputeAlertListParams,
+    options?: RequestOptions,
+  ): PagePromise<DisputeAlertListResponsesCursorPage, DisputeAlertListResponse> {
+    return this._client.getAPIList('/dispute_alerts', CursorPage<DisputeAlertListResponse>, {
+      query,
+      ...options,
+    });
+  }
+}
+
+export type DisputeAlertListResponsesCursorPage = CursorPage<DisputeAlertListResponse>;
+
+/**
+ * The type of dispute alert.
+ */
+export type DisputeAlertType = 'dispute' | 'dispute_rdr' | 'fraud';
+
+/**
+ * A dispute alert represents an early warning notification from a payment
+ * processor about a potential dispute or chargeback.
+ */
+export interface DisputeAlertRetrieveResponse {
+  /**
+   * The unique identifier of the dispute alert.
+   */
+  id: string;
+
+  /**
+   * The type of the dispute alert.
+   */
+  alert_type: DisputeAlertType;
+
+  /**
+   * The alerted amount in the specified currency.
+   */
+  amount: number;
+
+  /**
+   * Whether this alert incurs a charge.
+   */
+  charge_for_alert: boolean;
+
+  /**
+   * The time the dispute alert was created.
+   */
+  created_at: string;
+
+  /**
+   * The three-letter ISO currency code for the alerted amount.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The dispute associated with the dispute alert.
+   */
+  dispute: DisputeAlertRetrieveResponse.Dispute | null;
+
+  /**
+   * The payment associated with the dispute alert.
+   */
+  payment: DisputeAlertRetrieveResponse.Payment | null;
+
+  /**
+   * The date of the original transaction.
+   */
+  transaction_date: string | null;
+}
+
+export namespace DisputeAlertRetrieveResponse {
+  /**
+   * The dispute associated with the dispute alert.
+   */
+  export interface Dispute {
+    /**
+     * The unique identifier for the dispute.
+     */
+    id: string;
+
+    /**
+     * The disputed amount in the specified currency, formatted as a decimal.
+     */
+    amount: number;
+
+    /**
+     * The datetime the dispute was created.
+     */
+    created_at: string | null;
+
+    /**
+     * The three-letter ISO currency code for the disputed amount.
+     */
+    currency: Shared.Currency;
+
+    /**
+     * A human-readable reason for the dispute.
+     */
+    reason: string | null;
+
+    /**
+     * The current status of the dispute lifecycle, such as needs_response,
+     * under_review, won, or lost.
+     */
+    status: DisputesAPI.DisputeStatuses;
+  }
+
+  /**
+   * The payment associated with the dispute alert.
+   */
+  export interface Payment {
+    /**
+     * The unique identifier for the payment.
+     */
+    id: string;
+
+    /**
+     * The reason why a specific payment was billed
+     */
+    billing_reason: PaymentsAPI.BillingReasons | null;
+
+    /**
+     * Possible card brands that a payment token can have
+     */
+    card_brand: PaymentsAPI.CardBrands | null;
+
+    /**
+     * The last four digits of the card used to make this payment. Null if the payment
+     * was not made with a card.
+     */
+    card_last4: string | null;
+
+    /**
+     * The datetime the payment was created.
+     */
+    created_at: string;
+
+    /**
+     * The available currencies on the platform
+     */
+    currency: Shared.Currency | null;
+
+    /**
+     * When an alert came in that this transaction will be disputed
+     */
+    dispute_alerted_at: string | null;
+
+    /**
+     * The member attached to this payment.
+     */
+    member: Payment.Member | null;
+
+    /**
+     * The membership attached to this payment.
+     */
+    membership: Payment.Membership | null;
+
+    /**
+     * The time at which this payment was successfully collected. Null if the payment
+     * has not yet succeeded. As a Unix timestamp.
+     */
+    paid_at: string | null;
+
+    /**
+     * The different types of payment methods that can be used.
+     */
+    payment_method_type: PaymentsAPI.PaymentMethodTypes | null;
+
+    /**
+     * The subtotal to show to the creator (excluding buyer fees).
+     */
+    subtotal: number | null;
+
+    /**
+     * The total to show to the creator (excluding buyer fees).
+     */
+    total: number | null;
+
+    /**
+     * The total in USD to show to the creator (excluding buyer fees).
+     */
+    usd_total: number | null;
+
+    /**
+     * The user that made this payment.
+     */
+    user: Payment.User | null;
+  }
+
+  export namespace Payment {
+    /**
+     * The member attached to this payment.
+     */
+    export interface Member {
+      /**
+       * The unique identifier for the company member.
+       */
+      id: string;
+
+      /**
+       * The phone number for the member, if available.
+       */
+      phone: string | null;
+    }
+
+    /**
+     * The membership attached to this payment.
+     */
+    export interface Membership {
+      /**
+       * The unique identifier for the membership.
+       */
+      id: string;
+
+      /**
+       * The state of the membership.
+       */
+      status: Shared.MembershipStatus;
+    }
+
+    /**
+     * The user that made this payment.
+     */
+    export interface User {
+      /**
+       * The unique identifier for the user.
+       */
+      id: string;
+
+      /**
+       * The user's email address. Requires the member:email:read permission to access.
+       * Null if not authorized.
+       */
+      email: string | null;
+
+      /**
+       * The user's display name shown on their public profile.
+       */
+      name: string | null;
+
+      /**
+       * The user's unique username shown on their public profile.
+       */
+      username: string;
+    }
+  }
+}
+
+/**
+ * A dispute alert represents an early warning notification from a payment
+ * processor about a potential dispute or chargeback.
+ */
+export interface DisputeAlertListResponse {
+  /**
+   * The unique identifier of the dispute alert.
+   */
+  id: string;
+
+  /**
+   * The type of the dispute alert.
+   */
+  alert_type: DisputeAlertType;
+
+  /**
+   * The alerted amount in the specified currency.
+   */
+  amount: number;
+
+  /**
+   * Whether this alert incurs a charge.
+   */
+  charge_for_alert: boolean;
+
+  /**
+   * The time the dispute alert was created.
+   */
+  created_at: string;
+
+  /**
+   * The three-letter ISO currency code for the alerted amount.
+   */
+  currency: Shared.Currency;
+
+  /**
+   * The dispute associated with the dispute alert.
+   */
+  dispute: DisputeAlertListResponse.Dispute | null;
+
+  /**
+   * The payment associated with the dispute alert.
+   */
+  payment: DisputeAlertListResponse.Payment | null;
+
+  /**
+   * The date of the original transaction.
+   */
+  transaction_date: string | null;
+}
+
+export namespace DisputeAlertListResponse {
+  /**
+   * The dispute associated with the dispute alert.
+   */
+  export interface Dispute {
+    /**
+     * The unique identifier for the dispute.
+     */
+    id: string;
+  }
+
+  /**
+   * The payment associated with the dispute alert.
+   */
+  export interface Payment {
+    /**
+     * The unique identifier for the payment.
+     */
+    id: string;
+  }
+}
+
+export interface DisputeAlertListParams extends CursorPageParams {
+  /**
+   * The unique identifier of the company to list dispute alerts for.
+   */
+  company_id: string;
+
+  /**
+   * Returns the elements in the list that come before the specified cursor.
+   */
+  before?: string | null;
+
+  /**
+   * Only return dispute alerts created after this timestamp.
+   */
+  created_after?: string | null;
+
+  /**
+   * Only return dispute alerts created before this timestamp.
+   */
+  created_before?: string | null;
+
+  /**
+   * The direction of the sort.
+   */
+  direction?: Shared.Direction | null;
+
+  /**
+   * Returns the first _n_ elements from the list.
+   */
+  first?: number | null;
+
+  /**
+   * Returns the last _n_ elements from the list.
+   */
+  last?: number | null;
+}
+
+export declare namespace DisputeAlerts {
+  export {
+    type DisputeAlertType as DisputeAlertType,
+    type DisputeAlertRetrieveResponse as DisputeAlertRetrieveResponse,
+    type DisputeAlertListResponse as DisputeAlertListResponse,
+    type DisputeAlertListResponsesCursorPage as DisputeAlertListResponsesCursorPage,
+    type DisputeAlertListParams as DisputeAlertListParams,
+  };
+}

package/src/resources/experiences.ts

@@ -63,10 +63,6 @@ export class Experiences extends APIResource {
    * Returns a paginated list of experiences belonging to a company, with optional
    * filtering by product and app.
    *
-   * Required permissions:
-   *
-   * - `experience:hidden_experience:read`
-   *
    * @example
    * ```ts
    * // Automatically fetches more pages as needed.

package/src/resources/index.ts

@@ -119,6 +119,14 @@ export {
   type CourseListParams,
   type CourseListResponsesCursorPage,
 } from './courses';
+export {
+  DisputeAlerts,
+  type DisputeAlertType,
+  type DisputeAlertRetrieveResponse,
+  type DisputeAlertListResponse,
+  type DisputeAlertListParams,
+  type DisputeAlertListResponsesCursorPage,
+} from './dispute-alerts';
 export {
   Disputes,
   type Dispute,
@@ -290,7 +298,6 @@ export {
 } from './plans';
 export {
   Products,
-  type IndustryGroups,
   type ProductDeleteResponse,
   type ProductCreateParams,
   type ProductUpdateParams,
@@ -412,6 +419,7 @@ export {
   type DisputeUpdatedWebhookEvent,
   type RefundCreatedWebhookEvent,
   type RefundUpdatedWebhookEvent,
+  type DisputeAlertCreatedWebhookEvent,
   type MembershipCancelAtPeriodEndChangedWebhookEvent,
   type UnwrapWebhookEvent,
   type WebhookCreateParams,

package/src/resources/messages.ts

@@ -254,6 +254,11 @@ export interface MessageCreateParams {
    */
   attachments?: Array<MessageCreateParams.Attachment> | null;
 
+  /**
+   * Automatically detect URLs in the message and generate link previews.
+   */
+  auto_detect_links?: boolean | null;
+
   /**
    * A poll to attach to this message, allowing recipients to vote on options.
    */

package/src/resources/payments.ts

@@ -2,7 +2,6 @@
 
 import { APIResource } from '../core/resource';
 import * as PaymentsAPI from './payments';
-import * as ProductsAPI from './products';
 import * as Shared from './shared';
 import { APIPromise } from '../core/api-promise';
 import { CursorPage, type CursorPageParams, PagePromise } from '../core/pagination';
@@ -271,6 +270,7 @@ export type CardBrands =
   | 'china_union_payuzcard'
   | 'codensa'
   | 'cabal'
+  | 'hipercard'
   | 'unknown';
 
 /**
@@ -1027,11 +1027,6 @@ export declare namespace PaymentCreateParams {
          */
         title: string;
 
-        /**
-         * The different business types a company can be.
-         */
-        business_type?: Shared.BusinessTypes | null;
-
         /**
          * Whether or not to collect shipping information at checkout from the customer.
          */
@@ -1064,16 +1059,6 @@ export declare namespace PaymentCreateParams {
          */
         headline?: string | null;
 
-        /**
-         * The different industry groups a company can be in.
-         */
-        industry_group?: ProductsAPI.IndustryGroups | null;
-
-        /**
-         * The different industry types a company can be in.
-         */
-        industry_type?: Shared.IndustryTypes | null;
-
         /**
          * The ID of the product tax code to apply to this product.
          */

package/src/resources/products.ts

@@ -115,145 +115,6 @@ export class Products extends APIResource {
   }
 }
 
-/**
- * The different industry groups a company can be in.
- */
-export type IndustryGroups =
-  | 'academic_and_test_prep'
-  | 'accessories'
-  | 'agriculture_and_farming'
-  | 'ai_and_automation_agencies'
-  | 'ai_and_automation_software'
-  | 'arts_and_crafts'
-  | 'automotive'
-  | 'b2b_and_professional_marketplaces'
-  | 'baby_and_kids'
-  | 'beauty_and_personal_care'
-  | 'beauty_and_wellness'
-  | 'business_and_entrepreneurship'
-  | 'business_and_money_groups'
-  | 'career_and_professional'
-  | 'charity_and_cause_events'
-  | 'class_action_settlement'
-  | 'clothing_and_apparel'
-  | 'communication_and_messaging_software'
-  | 'community_and_education_software'
-  | 'consulting'
-  | 'content_and_clipping_agencies'
-  | 'creative_and_content_creation'
-  | 'creative_and_content_groups'
-  | 'creative_and_education'
-  | 'creative_gigs'
-  | 'creative_services'
-  | 'customer_support_agencies'
-  | 'dating_and_relationships'
-  | 'delivery_and_logistics'
-  | 'dental_and_vision'
-  | 'dermatology_and_skin'
-  | 'design_and_creative_agencies'
-  | 'developer_and_technical_tools'
-  | 'development_agencies'
-  | 'digital_and_education_marketplaces'
-  | 'digital_goods_and_accounts'
-  | 'e_commerce_software'
-  | 'education_and_business_events'
-  | 'education_and_childcare'
-  | 'electronics_and_gadgets'
-  | 'entertainment_and_leisure'
-  | 'entertainment_events'
-  | 'family_and_community_events'
-  | 'finance_and_investing'
-  | 'fitness_and_athletics'
-  | 'fitness_and_health_groups'
-  | 'fitness_and_recreation'
-  | 'fitness_equipment_and_gear'
-  | 'food_and_beverage'
-  | 'food_and_beverages'
-  | 'food_and_hospitality_marketplaces'
-  | 'funeral_and_death_care'
-  | 'gaming_and_entertainment_software'
-  | 'gaming_groups'
-  | 'genetic_and_specialized'
-  | 'government_and_public'
-  | 'health_and_wellness'
-  | 'health_and_wellness_services'
-  | 'healthcare'
-  | 'healthcare_and_wellness_software'
-  | 'hobbies_and_lifestyle'
-  | 'hobby_and_interest_groups'
-  | 'home_and_living'
-  | 'home_and_trade_services'
-  | 'home_and_trade_storefronts'
-  | 'home_improvement_and_tools'
-  | 'home_services_gigs'
-  | 'hospitality_and_lodging'
-  | 'industrial_and_manufacturing'
-  | 'industry_specific_software'
-  | 'language_and_communication'
-  | 'legal_and_compliance'
-  | 'lifestyle_and_culture'
-  | 'lifestyle_and_personal_growth_groups'
-  | 'lifestyle_and_wellness_events'
-  | 'logistics_and_transportation_services'
-  | 'marketing_agencies'
-  | 'marketing_and_advertising'
-  | 'marketing_and_sales_software'
-  | 'media_and_publishing_companies'
-  | 'mental_health_and_behavioral'
-  | 'miscellaneous'
-  | 'music_and_performing_arts'
-  | 'news_and_politics'
-  | 'nonprofit_and_charity'
-  | 'office_and_business_supplies'
-  | 'outdoor_and_sports'
-  | 'personal_development'
-  | 'personal_finance'
-  | 'personal_services'
-  | 'pet_services'
-  | 'pets_and_animals'
-  | 'primary_and_general_care'
-  | 'product_marketplaces'
-  | 'productivity_and_business_ops'
-  | 'professional_gigs'
-  | 'professional_services'
-  | 'professional_services_storefront'
-  | 'publishing_and_info_products'
-  | 'real_estate'
-  | 'real_estate_software'
-  | 'recruiting_and_staffing'
-  | 'rehabilitation_and_therapy'
-  | 'rental_marketplaces'
-  | 'retail'
-  | 'sales_agencies'
-  | 'sales_and_revenue'
-  | 'security_and_investigations'
-  | 'security_and_privacy_software'
-  | 'service_marketplaces'
-  | 'sleep_and_chronic_conditions'
-  | 'social_and_networking_events'
-  | 'specialized_gigs'
-  | 'specialty_medical_care'
-  | 'spirituality_and_mindfulness'
-  | 'spirituality_and_personal_growth'
-  | 'sports_and_fitness_events'
-  | 'sports_betting_and_gambling'
-  | 'sports_betting_groups'
-  | 'supplements_and_nutrition'
-  | 'sustainability_and_eco_products'
-  | 'task_and_errands'
-  | 'tech_and_ai'
-  | 'tech_and_dev_groups'
-  | 'tech_and_development'
-  | 'trading_and_finance_software'
-  | 'trading_and_investing'
-  | 'trading_and_investing_groups'
-  | 'transportation'
-  | 'veterinary'
-  | 'video_games_and_esports'
-  | 'weight_and_metabolic_health'
-  | 'wellness_and_alternative'
-  | 'womens_and_mens_health';
-
 /**
  * Represents `true` or `false` values.
  */
@@ -270,11 +131,6 @@ export interface ProductCreateParams {
    */
   title: string;
 
-  /**
-   * The different business types a company can be.
-   */
-  business_type?: Shared.BusinessTypes | null;
-
   /**
    * Whether the checkout flow collects a shipping address from the customer.
    */
@@ -324,16 +180,6 @@ export interface ProductCreateParams {
    */
   headline?: string | null;
 
-  /**
-   * The different industry groups a company can be in.
-   */
-  industry_group?: IndustryGroups | null;
-
-  /**
-   * The different industry types a company can be in.
-   */
-  industry_type?: Shared.IndustryTypes | null;
-
   /**
    * The commission rate as a percentage that members earn through the member
    * affiliate program.
@@ -455,11 +301,6 @@ export namespace ProductCreateParams {
 }
 
 export interface ProductUpdateParams {
-  /**
-   * The different business types a company can be.
-   */
-  business_type?: Shared.BusinessTypes | null;
-
   /**
    * Whether the checkout flow collects a shipping address from the customer.
    */
@@ -509,16 +350,6 @@ export interface ProductUpdateParams {
    */
   headline?: string | null;
 
-  /**
-   * The different industry groups a company can be in.
-   */
-  industry_group?: IndustryGroups | null;
-
-  /**
-   * The different industry types a company can be in.
-   */
-  industry_type?: Shared.IndustryTypes | null;
-
   /**
    * The commission rate as a percentage that members earn through the member
    * affiliate program.
@@ -642,7 +473,6 @@ export interface ProductListParams extends CursorPageParams {
 
 export declare namespace Products {
   export {
-    type IndustryGroups as IndustryGroups,
     type ProductDeleteResponse as ProductDeleteResponse,
     type ProductCreateParams as ProductCreateParams,
     type ProductUpdateParams as ProductUpdateParams,