@paynow-gg/typescript-sdk 2.1.17 → 2.1.19

package/dist/esm/generated/management/types.d.ts

@@ -544,6 +544,50 @@ export interface ChangeSubscriptionPlanDto {
  * - `all`: Coverage for all chargebacks including disputes.
  */
 export type ChargebackCoverageTypeDto = "unspecified" | "none" | "fraudulent" | "all";
+/**
+ * Query parameters
+ */
+export type ChargebacksGetChargebacksQuery = {
+    /**
+     * The maximum number of items to return in a single request.
+     * @format int32
+     * @minimum 1
+     * @maximum 100
+     */
+    limit?: number;
+    /**
+     * Returns items after the specified ID.
+     * Used for forward pagination through results.
+     */
+    after?: FlakeId;
+    /**
+     * Returns items before the specified ID.
+     * Used for backward pagination through results.
+     */
+    before?: FlakeId;
+    /**
+     * Determines the sort order of returned items.
+     * When true, items are returned in ascending order.
+     * When false, items are returned in descending order.
+     */
+    asc?: boolean;
+    /**
+     * Filter by order ID.
+     */
+    order_id?: FlakeId;
+    /**
+     * Filter by customer ID.
+     */
+    customer_id?: FlakeId;
+    /**
+     * Filter by chargeback statuses.
+     */
+    status?: Array<TrustChargebackStatus>;
+    /**
+     * Filter by chargeback stage.
+     */
+    stage?: TrustChargebackStage;
+};
 export interface CheckForBanIDByIdentitiesRequestDto {
     identities: Array<BanIdentityDto>;
 }
@@ -2864,6 +2908,13 @@ export interface GetDistributionResponseDto_V2 {
     revenue_basis: RevenueBasisDto_V2;
     entries: Array<DistributionEntryDto_V2>;
 }
+export interface GetMatrixResponseDto_V2 {
+    matrix_type: MatrixTypeDto_V2;
+    revenue_basis: RevenueBasisDto_V2;
+    unit?: TimeSeriesUnitDto_V2;
+    columns: Array<MatrixHeaderDto_V2>;
+    rows: Array<MatrixRowDto_V2>;
+}
 /**
  * Represents a link to download a template's files as an archive.
  */
@@ -3419,6 +3470,41 @@ export interface LastPaymentErrorDto {
      */
     message: string;
 }
+/**
+ * Represents an invoice Stripe Billing raised for the store's subscription before the store moved to PayNow.
+ */
+export interface LegacyStoreInvoiceDto {
+    /**
+     * The Stripe identifier of the invoice, starting with 'in_'.
+     */
+    id: string;
+    /**
+     * The invoice number printed on the document.
+     */
+    number?: string | null;
+    /**
+     * What the invoice was raised for.
+     */
+    description?: string | null;
+    /**
+     * The lowercase ISO 4217 currency the invoice was raised in.
+     */
+    currency: string;
+    /**
+     * The invoice total in the smallest currency unit.
+     * @format int64
+     */
+    total: number;
+    /**
+     * Whether the invoice has been paid.
+     */
+    is_paid: boolean;
+    /**
+     * When the invoice was created.
+     * @format date-time
+     */
+    created_at: string;
+}
 /**
  * Link payment method details
  */
@@ -3548,6 +3634,30 @@ export type MarketingGetEmailTemplatesQuery = {
      */
     asc?: boolean;
 };
+export interface MatrixHeaderDto_V2 {
+    key: string;
+    /**
+     * @format date-time
+     */
+    interval_start?: string | null;
+    /**
+     * @format date-time
+     */
+    interval_end?: string | null;
+}
+export interface MatrixRowDto_V2 {
+    header: MatrixHeaderDto_V2;
+    total: MatrixValueDto_V2;
+    cells: Array<MatrixValueDto_V2>;
+}
+export type MatrixTypeDto_V2 = "unspecified" | "customer_purchase_retention";
+export interface MatrixValueDto_V2 {
+    /**
+     * @format int64
+     */
+    count: number;
+    earnings?: MoneyDto_V2;
+}
 /**
  * Represents an image or video uploaded to a store's media.
  */
@@ -6276,7 +6386,7 @@ export interface StartDownloadableFileUploadResponseDto {
     downloadable_file_id: FlakeId;
     upload_signed_url: string;
 }
-export type StatsDimensionTypeDto_V2 = "unspecified" | "product" | "gameserver" | "tag" | "affiliate_link" | "coupon" | "giftcard" | "payout_id" | "billing_email" | "sale";
+export type StatsDimensionTypeDto_V2 = "unspecified" | "product" | "gameserver" | "tag" | "affiliate_link" | "coupon" | "giftcard" | "payout_id" | "billing_email" | "sale" | "country";
 export type StatsDistributionTypeDto_V2 = "unspecified" | "order_country" | "payment_method" | "payment_acceptance" | "customer_lifecycle";
 /**
  * A 64-bit Steam account identifier. Accepts string or numeric format.
@@ -6402,6 +6512,57 @@ export interface StoreBillingStatusDto {
     subscription?: StoreSubscriptionDto;
     payment_method?: PaymentMethodDto;
 }
+/**
+ * Represents a chargeback or pre-chargeback inquiry raised against a payment.
+ */
+export interface StoreChargebackDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    order_id: FlakeId;
+    payment_id: FlakeId;
+    customer_id: FlakeId;
+    status: TrustChargebackStatus;
+    reason: TrustChargebackReason;
+    stage: TrustChargebackStage;
+    network_case_type: TrustChargebackNetworkCaseType;
+    /**
+     * The card network's reason code for the chargeback, if available.
+     */
+    network_reason_code?: string | null;
+    /**
+     * The disputed amount, in the smallest currency unit.
+     * @format int64
+     */
+    disputed_amount: number;
+    /**
+     * The three-letter ISO currency code of 'disputed_amount', in lowercase.
+     */
+    currency: string;
+    /**
+     * Whether the payment can still be refunded.
+     */
+    is_refundable: boolean;
+    /**
+     * The date and time the chargeback was opened.
+     * @format date-time
+     */
+    created_at: string;
+    /**
+     * The date and time the inquiry escalated to a claim, if it did.
+     * @format date-time
+     */
+    escalated_at?: string | null;
+    /**
+     * The date and time by which a response must be submitted, if one is required.
+     * @format date-time
+     */
+    response_deadline_at?: string | null;
+    /**
+     * The date and time the chargeback was closed, if it is closed.
+     * @format date-time
+     */
+    closed_at?: string | null;
+}
 /**
  * Query parameters
  */
@@ -7266,54 +7427,6 @@ export interface StoreUpsellSettingsDto {
     updated_at: string;
     updated_by: ActorDto;
 }
-/**
- * Represents an invoice Stripe Billing raised for the store's subscription before the store moved to PayNow.
- */
-export interface StripeStoreInvoiceDto {
-    /**
-     * The Stripe identifier of the invoice, starting with 'in_'.
-     */
-    id: string;
-    /**
-     * The invoice number printed on the document.
-     */
-    number?: string | null;
-    /**
-     * What the invoice was raised for.
-     */
-    description?: string | null;
-    /**
-     * The lowercase ISO 4217 currency the invoice was raised in.
-     */
-    currency: string;
-    /**
-     * The invoice total in the smallest currency unit.
-     * @format int64
-     */
-    total: number;
-    /**
-     * Whether the invoice has been paid.
-     */
-    is_paid: boolean;
-    /**
-     * When the invoice was created.
-     * @format date-time
-     */
-    created_at: string;
-}
-/**
- * Represents a page of the store's Stripe Billing invoices, newest first.
- */
-export interface StripeStoreInvoicesDto {
-    /**
-     * The invoices on this page.
-     */
-    invoices: Array<StripeStoreInvoiceDto>;
-    /**
-     * Whether more invoices follow. Pass the last invoice's 'id' as 'starting_after' to fetch them.
-     */
-    has_more: boolean;
-}
 /**
  * Represents a billing amount breakdown for a subscription.
  */
@@ -8198,6 +8311,14 @@ export interface SubscriptionsSummaryForRangeDto_V2 {
      * @format int64
      */
     churned_subscription_count: number;
+    /**
+     * @format int64
+     */
+    renewal_due_count: number;
+    /**
+     * @format int64
+     */
+    renewal_paid_count: number;
 }
 /**
  * Represents the current state of a subscription.
@@ -8554,6 +8675,47 @@ export interface TrialsSummaryForRangeDto_V2 {
  * - `completed`: The trial has been completed.
  */
 export type TrialStatusDto = "created" | "active" | "canceled" | "completed";
+/**
+ * Specifies the type of case the card network opened for the chargeback.
+ * - `unspecified`: No card network case type is available, for example for PayPal disputes.
+ * - `chargeback`: A formal chargeback where the disputed funds are withdrawn.
+ * - `inquiry`: A pre-chargeback inquiry from the issuer.
+ * - `compliance`: A network compliance case filed outside the regular dispute process.
+ * - `block`: The network blocked the dispute before it became a chargeback. No funds move.
+ * - `resolution`: The dispute was resolved by automatically refunding the customer.
+ */
+export type TrustChargebackNetworkCaseType = "unspecified" | "chargeback" | "inquiry" | "compliance" | "block" | "resolution";
+/**
+ * Specifies the reason the customer gave for the chargeback.
+ * - `invalid`: The reason is unknown.
+ * - `product_not_received`: The customer says the product or service was not received.
+ * - `product_not_as_described`: The customer says the product or service was not as described.
+ * - `unauthorized`: The customer says they did not authorize the payment.
+ * - `credit_not_processed`: The customer says a promised refund or credit was not processed.
+ * - `duplicate_charge`: The customer says they were charged more than once.
+ * - `incorrect_amount`: The customer says they were charged the wrong amount.
+ * - `subscription_canceled`: The customer says they were charged after canceling a subscription.
+ * - `general`: Any other reason.
+ */
+export type TrustChargebackReason = "invalid" | "product_not_received" | "product_not_as_described" | "unauthorized" | "credit_not_processed" | "duplicate_charge" | "incorrect_amount" | "subscription_canceled" | "general";
+/**
+ * Specifies the stage of a chargeback.
+ * - `invalid`: The stage is unknown.
+ * - `inquiry`: A pre-chargeback inquiry. No funds are withdrawn yet, and a refund may resolve it.
+ * - `claim`: A formal claim where the disputed funds are at stake.
+ */
+export type TrustChargebackStage = "invalid" | "inquiry" | "claim";
+/**
+ * Specifies the status of a chargeback.
+ * - `invalid`: The status is unknown.
+ * - `needs_response`: The chargeback is open and awaiting a response.
+ * - `under_review`: A response was submitted and the chargeback is being reviewed.
+ * - `won`: The chargeback was resolved in the store's favor.
+ * - `lost`: The chargeback was resolved in the customer's favor.
+ * - `closed`: The inquiry was closed without escalating to a chargeback.
+ * - `prevented`: The chargeback was prevented before it was filed, see 'network_case_type' for how.
+ */
+export type TrustChargebackStatus = "invalid" | "needs_response" | "under_review" | "won" | "lost" | "closed" | "prevented";
 export interface TrustStoreRequirementDto {
     id: FlakeId;
     store_id: FlakeId;