@whop/sdk 0.0.26 → 0.0.28

package/resources/disputes.d.ts

@@ -6,7 +6,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class Disputes extends APIResource {
     /**
-     * Retrieves a Dispute by ID
+     * Retrieves the details of an existing dispute.
      *
      * Required permissions:
      *
@@ -21,7 +21,9 @@ export declare class Disputes extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<Dispute>;
     /**
-     * Lists disputes the current actor has access to
+     * Returns a paginated list of disputes for a company, with optional filtering by
+     * creation date. A dispute represents a chargeback or inquiry filed by a customer
+     * against a payment.
      *
      * Required permissions:
      *
@@ -66,151 +68,172 @@ export declare class Disputes extends APIResource {
 }
 export type DisputeListResponsesCursorPage = CursorPage<DisputeListResponse>;
 /**
- * An object representing a dispute against a company.
+ * A dispute is a chargeback or payment challenge filed against a company,
+ * including evidence and response status.
  */
 export interface Dispute {
     /**
-     * The internal ID of the dispute.
+     * The unique identifier for the dispute.
      */
     id: string;
     /**
-     * An IP access log for the user from Whop.
+     * A log of IP-based access activity for the customer on Whop, submitted as
+     * evidence in the dispute.
      */
     access_activity_log: string | null;
     /**
-     * The amount of the dispute (formatted).
+     * The disputed amount in the specified currency, formatted as a decimal.
      */
     amount: number;
     /**
-     * The billing address of the user from their payment details.
+     * The customer's billing address from their payment details, submitted as evidence
+     * in the dispute.
      */
     billing_address: string | null;
     /**
-     * The cancellation policy for this dispute
+     * The cancellation policy document uploaded as dispute evidence. Null if no
+     * cancellation policy has been provided.
      */
     cancellation_policy_attachment: Dispute.CancellationPolicyAttachment | null;
     /**
-     * A cancellation policy disclosure from the company.
+     * A text disclosure describing the company's cancellation policy, submitted as
+     * dispute evidence.
      */
     cancellation_policy_disclosure: string | null;
     /**
-     * The company the dispute is against.
+     * The company that the dispute was filed against.
      */
     company: Dispute.Company | null;
     /**
-     * When it was made.
+     * The datetime the dispute was created.
      */
     created_at: string | null;
     /**
-     * The currency of the dispute.
+     * The three-letter ISO currency code for the disputed amount.
      */
     currency: Shared.Currency;
     /**
-     * The customer communication for this dispute
+     * Evidence of customer communication or product usage, uploaded as a dispute
+     * attachment. Null if not provided.
      */
     customer_communication_attachment: Dispute.CustomerCommunicationAttachment | null;
     /**
-     * The email of the customer from their payment details. This is submitted in the
-     * evidence packet to the payment processor. You can change it before submitting
-     * the dispute.
+     * The customer's email address from their payment details, included in the
+     * evidence packet sent to the payment processor. Editable before submission.
      */
     customer_email_address: string | null;
     /**
-     * The name of the customer from their payment details. This is submitted in the
-     * evidence packet to the payment processor. You can change it before submitting
-     * the dispute.
+     * The customer's full name from their payment details, included in the evidence
+     * packet sent to the payment processor. Editable before submission.
      */
     customer_name: string | null;
     /**
-     * Whether or not the dispute data can be edited.
+     * Whether the dispute evidence can still be edited and submitted. Returns true
+     * only when the dispute status requires a response.
      */
     editable: boolean | null;
     /**
-     * The last date the dispute is allow to be submitted by.
+     * The deadline by which dispute evidence must be submitted. Null if no response
+     * deadline is set.
      */
     needs_response_by: string | null;
     /**
-     * Additional notes the company chooses to submit regarding the dispute.
+     * Additional freeform notes submitted by the company as part of the dispute
+     * evidence.
      */
     notes: string | null;
     /**
-     * The payment that got disputed
+     * The original payment that was disputed.
      */
     payment: Dispute.Payment | null;
     /**
-     * The plan that got disputed
+     * The plan associated with the disputed payment. Null if the dispute is not linked
+     * to a specific plan.
      */
     plan: Dispute.Plan | null;
     /**
-     * The product that got disputed
+     * The product associated with the disputed payment. Null if the dispute is not
+     * linked to a specific product.
      */
     product: Dispute.Product | null;
     /**
-     * The description of the product from the company.
+     * A description of the product or service provided, submitted as dispute evidence.
      */
     product_description: string | null;
     /**
-     * The reason for the dispute
+     * A human-readable reason for the dispute.
      */
     reason: string | null;
     /**
-     * The refund policy for this dispute
+     * The refund policy document uploaded as dispute evidence. Null if no refund
+     * policy has been provided.
      */
     refund_policy_attachment: Dispute.RefundPolicyAttachment | null;
     /**
-     * A refund policy disclosure from the company.
+     * A text disclosure describing the company's refund policy, submitted as dispute
+     * evidence.
      */
     refund_policy_disclosure: string | null;
     /**
-     * A description on why the refund is being refused by the company.
+     * An explanation from the company for why a refund was refused, submitted as
+     * dispute evidence.
      */
     refund_refusal_explanation: string | null;
     /**
-     * When the product was delivered by the company.
+     * The date when the product or service was delivered to the customer, submitted as
+     * dispute evidence.
      */
     service_date: string | null;
     /**
-     * The status of the dispute (mimics stripe's dispute status).
+     * The current status of the dispute lifecycle, such as needs_response,
+     * under_review, won, or lost.
      */
     status: DisputeStatuses;
     /**
-     * An attachment that did not fit into the other categories
+     * An additional attachment that does not fit into the standard evidence
+     * categories. Null if not provided.
      */
     uncategorized_attachment: Dispute.UncategorizedAttachment | null;
     /**
-     * Whether or not the dispute is a Visa Rapid Dispute Resolution.
+     * Whether the dispute was automatically resolved through Visa Rapid Dispute
+     * Resolution (RDR).
      */
     visa_rdr: boolean;
 }
 export declare namespace Dispute {
     /**
-     * The cancellation policy for this dispute
+     * The cancellation policy document uploaded as dispute evidence. Null if no
+     * cancellation policy has been provided.
      */
     interface CancellationPolicyAttachment {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
     /**
-     * The company the dispute is against.
+     * The company that the dispute was filed against.
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -219,33 +242,38 @@ export declare namespace Dispute {
         title: string;
     }
     /**
-     * The customer communication for this dispute
+     * Evidence of customer communication or product usage, uploaded as a dispute
+     * attachment. Null if not provided.
      */
     interface CustomerCommunicationAttachment {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
     /**
-     * The payment that got disputed
+     * The original payment that was disputed.
      */
     interface Payment {
         /**
-         * The payment ID
+         * The unique identifier for the payment.
          */
         id: string;
         /**
@@ -257,11 +285,12 @@ export declare namespace Dispute {
          */
         card_brand: PaymentsAPI.CardBrands | null;
         /**
-         * The last 4 digits of the card used to make the payment.
+         * 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
+         * The datetime the payment was created.
          */
         created_at: string;
         /**
@@ -281,7 +310,8 @@ export declare namespace Dispute {
          */
         membership: Payment.Membership | null;
         /**
-         * The datetime the payment was paid
+         * 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;
         /**
@@ -311,7 +341,7 @@ export declare namespace Dispute {
          */
         interface Member {
             /**
-             * The ID of the member
+             * The unique identifier for the company member.
              */
             id: string;
             /**
@@ -324,7 +354,7 @@ export declare namespace Dispute {
          */
         interface Membership {
             /**
-             * The internal ID of the membership.
+             * The unique identifier for the membership.
              */
             id: string;
             /**
@@ -337,86 +367,100 @@ export declare namespace Dispute {
          */
         interface User {
             /**
-             * The internal ID of the user.
+             * The unique identifier for the user.
              */
             id: string;
             /**
-             * The email of the user
+             * The user's email address. Requires the member:email:read permission to access.
+             * Null if not authorized.
              */
             email: string | null;
             /**
-             * The name of the user from their Whop account.
+             * The user's display name shown on their public profile.
              */
             name: string | null;
             /**
-             * The username of the user from their Whop account.
+             * The user's unique username shown on their public profile.
              */
             username: string;
         }
     }
     /**
-     * The plan that got disputed
+     * The plan associated with the disputed payment. Null if the dispute is not linked
+     * to a specific plan.
      */
     interface Plan {
         /**
-         * The internal ID of the plan.
+         * The unique identifier for the plan.
          */
         id: string;
     }
     /**
-     * The product that got disputed
+     * The product associated with the disputed payment. Null if the dispute is not
+     * linked to a specific product.
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
-         * The title of the product. Use for Whop 4.0.
+         * The display name of the product shown to customers on the product page and in
+         * search results.
          */
         title: string;
     }
     /**
-     * The refund policy for this dispute
+     * The refund policy document uploaded as dispute evidence. Null if no refund
+     * policy has been provided.
      */
     interface RefundPolicyAttachment {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
     /**
-     * An attachment that did not fit into the other categories
+     * An additional attachment that does not fit into the standard evidence
+     * categories. Null if not provided.
      */
     interface UncategorizedAttachment {
         /**
-         * The ID of the attachment
+         * Represents a unique identifier that is Base64 obfuscated. It is often used to
+         * refetch an object or as key for a cache. The ID type appears in a JSON response
+         * as a String; however, it is not intended to be human-readable. When expected as
+         * an input type, any string (such as `"VXNlci0xMA=="`) or integer (such as `4`)
+         * input value will be accepted as an ID.
          */
         id: string;
         /**
-         * The attachment's content type (e.g., image/jpg, video/mp4)
+         * The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).
          */
         content_type: string | null;
         /**
-         * The name of the file
+         * The original filename of the uploaded attachment, including its file extension.
          */
         filename: string | null;
         /**
-         * This is the URL you use to render optimized attachments on the client. This
-         * should be used for apps.
+         * A pre-optimized URL for rendering this attachment on the client. This should be
+         * used for displaying attachments in apps.
          */
         url: string | null;
     }
@@ -426,69 +470,76 @@ export declare namespace Dispute {
  */
 export type DisputeStatuses = 'warning_needs_response' | 'warning_under_review' | 'warning_closed' | 'needs_response' | 'under_review' | 'won' | 'lost' | 'closed' | 'other';
 /**
- * An object representing a dispute against a company.
+ * A dispute is a chargeback or payment challenge filed against a company,
+ * including evidence and response status.
  */
 export interface DisputeListResponse {
     /**
-     * The internal ID of the dispute.
+     * The unique identifier for the dispute.
      */
     id: string;
     /**
-     * The amount of the dispute (formatted).
+     * The disputed amount in the specified currency, formatted as a decimal.
      */
     amount: number;
     /**
-     * The company the dispute is against.
+     * The company that the dispute was filed against.
      */
     company: DisputeListResponse.Company | null;
     /**
-     * When it was made.
+     * The datetime the dispute was created.
      */
     created_at: string | null;
     /**
-     * The currency of the dispute.
+     * The three-letter ISO currency code for the disputed amount.
      */
     currency: Shared.Currency;
     /**
-     * Whether or not the dispute data can be edited.
+     * Whether the dispute evidence can still be edited and submitted. Returns true
+     * only when the dispute status requires a response.
      */
     editable: boolean | null;
     /**
-     * The last date the dispute is allow to be submitted by.
+     * The deadline by which dispute evidence must be submitted. Null if no response
+     * deadline is set.
      */
     needs_response_by: string | null;
     /**
-     * The payment that got disputed
+     * The original payment that was disputed.
      */
     payment: DisputeListResponse.Payment | null;
     /**
-     * The plan that got disputed
+     * The plan associated with the disputed payment. Null if the dispute is not linked
+     * to a specific plan.
      */
     plan: DisputeListResponse.Plan | null;
     /**
-     * The product that got disputed
+     * The product associated with the disputed payment. Null if the dispute is not
+     * linked to a specific product.
      */
     product: DisputeListResponse.Product | null;
     /**
-     * The reason for the dispute
+     * A human-readable reason for the dispute.
      */
     reason: string | null;
     /**
-     * The status of the dispute (mimics stripe's dispute status).
+     * The current status of the dispute lifecycle, such as needs_response,
+     * under_review, won, or lost.
      */
     status: DisputeStatuses;
     /**
-     * Whether or not the dispute is a Visa Rapid Dispute Resolution.
+     * Whether the dispute was automatically resolved through Visa Rapid Dispute
+     * Resolution (RDR).
      */
     visa_rdr: boolean;
 }
 export declare namespace DisputeListResponse {
     /**
-     * The company the dispute is against.
+     * The company that the dispute was filed against.
      */
     interface Company {
         /**
-         * The ID of the company
+         * The unique identifier for the company.
          */
         id: string;
         /**
@@ -497,40 +548,43 @@ export declare namespace DisputeListResponse {
         title: string;
     }
     /**
-     * The payment that got disputed
+     * The original payment that was disputed.
      */
     interface Payment {
         /**
-         * The payment ID
+         * The unique identifier for the payment.
          */
         id: string;
     }
     /**
-     * The plan that got disputed
+     * The plan associated with the disputed payment. Null if the dispute is not linked
+     * to a specific plan.
      */
     interface Plan {
         /**
-         * The internal ID of the plan.
+         * The unique identifier for the plan.
          */
         id: string;
     }
     /**
-     * The product that got disputed
+     * The product associated with the disputed payment. Null if the dispute is not
+     * linked to a specific product.
      */
     interface Product {
         /**
-         * The internal ID of the public product.
+         * The unique identifier for the product.
          */
         id: string;
         /**
-         * The title of the product. Use for Whop 4.0.
+         * The display name of the product shown to customers on the product page and in
+         * search results.
          */
         title: string;
     }
 }
 export interface DisputeListParams extends CursorPageParams {
     /**
-     * The ID of the company to list disputes for
+     * The unique identifier of the company to list disputes for.
      */
     company_id: string;
     /**
@@ -538,11 +592,11 @@ export interface DisputeListParams extends CursorPageParams {
      */
     before?: string | null;
     /**
-     * The minimum creation date to filter by
+     * Only return disputes created after this timestamp.
      */
     created_after?: string | null;
     /**
-     * The maximum creation date to filter by
+     * Only return disputes created before this timestamp.
      */
     created_before?: string | null;
     /**
@@ -560,65 +614,66 @@ export interface DisputeListParams extends CursorPageParams {
 }
 export interface DisputeUpdateEvidenceParams {
     /**
-     * An IP access log for the user from Whop.
+     * An IP access activity log showing the customer used the service.
      */
     access_activity_log?: string | null;
     /**
-     * The billing address of the user from their payment details.
+     * The billing address associated with the customer's payment method.
      */
     billing_address?: string | null;
     /**
-     * A file containing the cancellation policy from the company.
+     * A file upload containing the company's cancellation policy document.
      */
     cancellation_policy_attachment?: DisputeUpdateEvidenceParams.CancellationPolicyAttachment | null;
     /**
-     * A cancellation policy disclosure from the company.
+     * The company's cancellation policy text to submit as evidence.
      */
     cancellation_policy_disclosure?: string | null;
     /**
-     * A file containing the customer communication from the company (An image).
+     * A file upload containing evidence of customer communication. Must be a JPEG,
+     * PNG, GIF, or PDF.
      */
     customer_communication_attachment?: DisputeUpdateEvidenceParams.CustomerCommunicationAttachment | null;
     /**
-     * The email of the customer from their payment details.
+     * The email address of the customer associated with the disputed payment.
      */
     customer_email_address?: string | null;
     /**
-     * The name of the customer from their payment details.
+     * The full name of the customer associated with the disputed payment.
      */
     customer_name?: string | null;
     /**
-     * Additional notes the company chooses to submit regarding the dispute.
+     * Additional notes or context to submit as part of the dispute evidence.
      */
     notes?: string | null;
     /**
-     * The description of the product from the company.
+     * A description of the product or service that was provided to the customer.
      */
     product_description?: string | null;
     /**
-     * A file containing the refund policy from the company.
+     * A file upload containing the company's refund policy document.
      */
     refund_policy_attachment?: DisputeUpdateEvidenceParams.RefundPolicyAttachment | null;
     /**
-     * A refund policy disclosure from the company.
+     * The company's refund policy text to submit as evidence.
      */
     refund_policy_disclosure?: string | null;
     /**
-     * A description on why the refund is being refused by the company.
+     * An explanation of why the refund request was refused.
      */
     refund_refusal_explanation?: string | null;
     /**
-     * When the product was delivered by the company.
+     * The date when the product or service was delivered to the customer.
      */
     service_date?: string | null;
     /**
-     * A file that does not fit in the other categories.
+     * A file upload for evidence that does not fit into the other categories.
      */
     uncategorized_attachment?: DisputeUpdateEvidenceParams.UncategorizedAttachment | null;
 }
 export declare namespace DisputeUpdateEvidenceParams {
     /**
-     * A file containing the cancellation policy from the company.
+     * A file upload containing the company's cancellation policy document.
      */
     interface CancellationPolicyAttachment {
         /**
@@ -627,7 +682,8 @@ export declare namespace DisputeUpdateEvidenceParams {
         id: string;
     }
     /**
-     * A file containing the customer communication from the company (An image).
+     * A file upload containing evidence of customer communication. Must be a JPEG,
+     * PNG, GIF, or PDF.
      */
     interface CustomerCommunicationAttachment {
         /**
@@ -636,7 +692,7 @@ export declare namespace DisputeUpdateEvidenceParams {
         id: string;
     }
     /**
-     * A file containing the refund policy from the company.
+     * A file upload containing the company's refund policy document.
      */
     interface RefundPolicyAttachment {
         /**
@@ -645,7 +701,7 @@ export declare namespace DisputeUpdateEvidenceParams {
         id: string;
     }
     /**
-     * A file that does not fit in the other categories.
+     * A file upload for evidence that does not fit into the other categories.
      */
     interface UncategorizedAttachment {
         /**