@paynow-gg/typescript-sdk 2.0.1 → 2.0.3

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

@@ -243,6 +243,11 @@ export interface AffiliateLinkDto {
  * - `last_referer`: The most recent affiliate link the customer followed is credited.
  */
 export type AffiliateLinkRefererTypeDto = "invalid" | "first_referer" | "last_referer";
+export interface AffiliateLinkResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    affiliate_link?: AffiliateLinkDto;
+}
 /**
  * Alipay payment method details
  */
@@ -258,6 +263,11 @@ export interface AlipayDetailsDto {
      */
     fingerprint?: string | null;
 }
+export interface AvailablePermissionDto {
+    id: string;
+    name: string;
+    description: string;
+}
 /**
  * Bancontact payment method details
  */
@@ -313,6 +323,11 @@ export interface BanIdentityDto {
     ban_type: BanType;
     ban_type_value: string;
 }
+export interface BanResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    ban?: BanDto;
+}
 /**
  * Query parameters
  */
@@ -497,6 +512,21 @@ export interface CheckoutPaymentInfoDto {
      */
     checkout_url?: string | null;
 }
+export interface CheckoutStyleDto {
+    store_id: FlakeId;
+    font_family?: string | null;
+    /**
+     * @format int32
+     */
+    border_radius?: number | null;
+    color_primary?: string | null;
+    color_elements?: string | null;
+    color_input?: string | null;
+    color_background?: string | null;
+    color_text?: string | null;
+    color_outline?: string | null;
+    url_background?: string | null;
+}
 export interface CommandAttemptDto {
     id: FlakeId;
     store_id: FlakeId;
@@ -660,6 +690,11 @@ export type CouponFilterStatusDto = "all" | "active" | "inactive";
  * - `generated`: Coupon's that were created by the system (basket recover, etc.).
  */
 export type CouponFilterTypeDto = "all" | "manual" | "generated";
+export interface CouponResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    coupon?: CouponDto;
+}
 /**
  * Query parameters
  */
@@ -863,6 +898,19 @@ export interface CreateCheckoutSessionResponseDto {
      */
     url: string;
 }
+export interface CreateCheckoutStyleDto {
+    font_family?: string;
+    /**
+     * @format int32
+     */
+    border_radius?: number | null;
+    color_primary?: string;
+    color_elements?: string;
+    color_input?: string;
+    color_background?: string;
+    color_text?: string;
+    color_outline?: string;
+}
 export interface CreateCouponDto {
     enabled: boolean;
     code: string;
@@ -916,11 +964,7 @@ export interface CreateCouponDto {
  */
 export interface CreateCustomerPortalSessionRequestDto {
     flow: CustomerPortalSessionFlowDto;
-    /**
-     * How long the portal session stays valid, in seconds. When unset, a default expiry is used.
-     * @format int64
-     */
-    expires_in_seconds?: number | null;
+    expires_in?: Period;
     /**
      * URL to redirect the customer back to after completing the portal flow
      */
@@ -971,6 +1015,10 @@ export interface CreateGiftCardDto {
      */
     expires_at?: string | null;
 }
+export interface CreateInviteDto {
+    role_id: FlakeId;
+    user_email: string;
+}
 export interface CreateNavLinkDto {
     tag_id: FlakeId;
     parent_node_id?: string;
@@ -992,6 +1040,11 @@ export interface CreateRefundRequestDto {
      */
     refund_from_connected_user_balance?: boolean | null;
 }
+export interface CreateRoleDto {
+    name: string;
+    description: string;
+    permissions?: Record<string, boolean>;
+}
 export interface CreateSaleDto {
     enabled: boolean;
     name: string;
@@ -1254,6 +1307,11 @@ export interface CustomerPortalSessionFlowDto {
  * - `minecraft_uuid`: Minecraft profile platform - the ID param must be a Minecraft UUID.
  */
 export type CustomerProfilePlatform = "invalid" | "steam" | "minecraft" | "paynow_name" | "paynow" | "minecraft_java_name" | "minecraft_bedrock_name" | "xbox_xuid" | "minecraft_uuid";
+export interface CustomerResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    customer: CustomerDto;
+}
 /**
  * Query parameters
  */
@@ -1577,6 +1635,43 @@ export interface CustomVariableOptionRequestDto {
             Customers can enter numeric values (subject to validation).
  */
 export type CustomVariableType = "dropdown" | "text" | "number";
+/**
+ * Query parameters
+ */
+export type DashboardSearchDashboardQuery = {
+    query?: string;
+    search_hints?: Record<string, string>;
+    search_result_type?: DashboardSearchResultTypeDto;
+    /**
+     * 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;
+};
+export interface DashboardSearchHintDto {
+    prefix: string;
+    example: string;
+    description: string;
+}
+export type DashboardSearchResultTypeDto = "unknown" | "orders" | "trials" | "subscriptions" | "customers" | "coupons" | "gameservers" | "products" | "sales" | "api_keys" | "bans" | "affiliate_links" | "tags" | "giftcards" | "stores" | "users" | "tickets";
 export interface DashboardStatsDto {
     store_id: FlakeId;
     /**
@@ -2125,10 +2220,30 @@ export interface ExecutedWebhookDto {
     status_code: number;
     response?: string | null;
 }
+export interface FinishCheckoutStyleBackgroundImageUploadRequestDto {
+    image_id: string;
+}
 export interface FinishEmailBrandingImageUploadRequestDto {
     image_id: string;
     dark_mode: boolean;
 }
+export interface FinishProductImageUploadRequestDto {
+    /**
+     * The ID of the uploaded image returned by the server.
+     */
+    image_id: string;
+}
+export interface FinishStoreLogoUploadRequestDto {
+    /**
+     * The ID of the uploaded image returned by the server.
+     */
+    image_id: string;
+    /**
+     * Which logo the upload replaces. 1 is the default logo, 2 the square logo.
+     * @format int32
+     */
+    logo_type: number;
+}
 export interface FinishTagImageUploadUrlRequestDto {
     /**
      * The ID of the uploaded image returned by the server.
@@ -2232,6 +2347,15 @@ export interface GameServerLinkDto {
     last_fetched_commands_at?: string | null;
     last_fetched_commands_from_ip?: string | null;
 }
+export interface GameserverResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    gameserver?: GameServerDto;
+}
+export interface GetCheckoutStyleBackgroundImageUploadUrlResponseDto {
+    id: string;
+    upload_url: string;
+}
 export interface GetDimensionStatsResponseDto_V2 {
     dimension_type: StatsDimensionTypeDto_V2;
     revenue_basis: RevenueBasisDto_V2;
@@ -2245,6 +2369,26 @@ export interface GetEmailBrandingImageUploadUrlResponseDto {
     upload_url: string;
     image_id: string;
 }
+export interface GetProductImageUploadUrlResponseDto {
+    /**
+     * The ID of the direct image upload URL.
+     */
+    id: string;
+    /**
+     * The URL to upload the image to.
+     */
+    upload_url: string;
+}
+export interface GetStoreLogoUploadUrlResponseDto {
+    /**
+     * The ID of the direct image upload URL.
+     */
+    id: string;
+    /**
+     * The URL to upload the logo to.
+     */
+    upload_url: string;
+}
 export interface GetTagImageUploadUrlResponseDto {
     /**
      * The ID of the direct image upload URL.
@@ -2315,6 +2459,11 @@ export interface GiftCardDto {
     canceled_at?: string | null;
     canceled_by?: ActorDto;
 }
+export interface GiftcardResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    giftcard?: GiftCardDto;
+}
 /**
  * Query parameters
  */
@@ -2594,6 +2743,37 @@ export interface IntervalTagStatsDto {
      */
     total_earnings: number;
 }
+export interface InviteDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    /**
+     * The token the invited user redeems to accept the invite.
+     */
+    token: string;
+    role_id: FlakeId;
+    /**
+     * The email address the invite was sent to.
+     */
+    user_email: string;
+    created_by: ActorDto;
+    /**
+     * When the invite was created.
+     * @format date-time
+     */
+    created_at: string;
+    updated_by?: ActorDto;
+    /**
+     * When the invite was last updated.
+     * @format date-time
+     */
+    updated_at?: string | null;
+    /**
+     * When the invite was accepted. Unset while the invite is still pending.
+     * @format date-time
+     */
+    accepted_at?: string | null;
+    accepted_by_user?: ActorDto;
+}
 export interface InvoiceDownloadUrlResponseDto {
     /**
      * Temporary URL the invoice document can be downloaded from
@@ -3344,6 +3524,11 @@ export interface OrderLinePayoutSplitDto {
      */
     platform_fee: number;
 }
+export interface OrderResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    order?: OrderDto;
+}
 /**
  * Query parameters
  */
@@ -3870,6 +4055,20 @@ export interface PaymentMethodTypeFeeOverrideDto {
      */
     fee_cents: number;
     countries: Array<string>;
+    card_brands: Array<string>;
+    card_networks: Array<string>;
+    card_funding_types: Array<string>;
+    card_regulated_statuses: Array<string>;
+    card_product_categories: Array<string>;
+    fee_schedule_id?: FlakeId;
+    /**
+     * @format date-time
+     */
+    begins_at: string;
+    /**
+     * @format date-time
+     */
+    ends_at?: string | null;
 }
 /**
  * Represents payout split results for multi-party payments
@@ -4548,6 +4747,15 @@ export interface ProductPricingRegionOverrideDto {
     tax_inclusive?: boolean | null;
 }
 export type ProductRemoveAfterIntervalScale = "invalid" | "day" | "week" | "month";
+export interface ProductResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    /**
+     * @format int64
+     */
+    total: number;
+    product?: ProductDto;
+}
 /**
  * Query parameters
  */
@@ -5069,6 +5277,23 @@ export interface ResendWebhookDto {
     webhook_id: FlakeId;
 }
 export type RevenueBasisDto_V2 = "unspecified" | "gross" | "gross_excluding_taxes" | "net";
+export interface RoleDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    name: string;
+    description: string;
+    permissions?: Record<string, boolean> | null;
+    created_by: ActorDto;
+    /**
+     * @format date-time
+     */
+    created_at: string;
+    updated_by?: ActorDto;
+    /**
+     * @format date-time
+     */
+    updated_at?: string | null;
+}
 export type SaleDiscountTypeDto = "percent" | "amount";
 /**
  * Represents a detailed view of a Sale, including configuration and audit information.
@@ -5136,6 +5361,11 @@ export interface SaleDto {
     updated_at?: string | null;
 }
 export type SaleDurationDto = "unspecified" | "once" | "forever" | "repeating";
+export interface SaleResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    sale?: SaleDto;
+}
 /**
  * Object representing a sales tax jurisdiction and its associated taxes.
  */
@@ -5176,6 +5406,91 @@ export interface SalesTaxJurisdictionTaxDto {
      */
     tax_rate: string;
 }
+export interface SearchDashboardResponseDto {
+    stores: Array<StoreResult>;
+    customers: Array<CustomerResult>;
+    orders: Array<OrderResult>;
+    gameservers: Array<GameserverResult>;
+    products: Array<ProductResult>;
+    coupons: Array<CouponResult>;
+    sales: Array<SaleResult>;
+    giftcards: Array<GiftcardResult>;
+    tags: Array<TagsResult>;
+    affiliate_links: Array<AffiliateLinkResult>;
+    trials: Array<TrialResult>;
+    subscriptions: Array<SubscriptionResult>;
+    bans: Array<BanResult>;
+    facets: {
+        /**
+         * @format int64
+         */
+        unknown?: number;
+        /**
+         * @format int64
+         */
+        orders?: number;
+        /**
+         * @format int64
+         */
+        trials?: number;
+        /**
+         * @format int64
+         */
+        subscriptions?: number;
+        /**
+         * @format int64
+         */
+        customers?: number;
+        /**
+         * @format int64
+         */
+        coupons?: number;
+        /**
+         * @format int64
+         */
+        gameservers?: number;
+        /**
+         * @format int64
+         */
+        products?: number;
+        /**
+         * @format int64
+         */
+        sales?: number;
+        /**
+         * @format int64
+         */
+        api_keys?: number;
+        /**
+         * @format int64
+         */
+        bans?: number;
+        /**
+         * @format int64
+         */
+        affiliate_links?: number;
+        /**
+         * @format int64
+         */
+        tags?: number;
+        /**
+         * @format int64
+         */
+        giftcards?: number;
+        /**
+         * @format int64
+         */
+        stores?: number;
+        /**
+         * @format int64
+         */
+        users?: number;
+        /**
+         * @format int64
+         */
+        tickets?: number;
+    };
+}
 export interface SetDiscordActionDto {
     discord_server_id: FlakeId;
     action_type: DiscordActionType;
@@ -5240,6 +5555,15 @@ export interface SteamSkinsInventoryItemDetailsDto {
      */
     price: number;
 }
+/**
+ * Query parameters
+ */
+export type StoreDeleteStoreLogoQuery = {
+    /**
+     * @format int32
+     */
+    type?: number;
+};
 /**
  * Represents a PayNow store and its associated configuration.
  */
@@ -5551,6 +5875,11 @@ export type StoreRequirementCategory = "invalid" | "business" | "kyc" | "complia
  */
 export type StoreRequirementStatus = "invalid" | "pending" | "under_review" | "requires_revision" | "approved" | "expired" | "waived" | "rejected_final";
 export type StoreRestrictionFlagDto = "none" | "payments_disabled" | "payouts_disabled";
+export interface StoreResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    store: StoreDto;
+}
 export interface StoreTrustDto {
     store_id: FlakeId;
     status: StoreTrustStatusDto;
@@ -6447,6 +6776,11 @@ export interface SubscriptionLineDto {
 export interface SubscriptionPaymentMethodUpdateFlowDto {
     subscription_id: FlakeId;
 }
+export interface SubscriptionResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    subscription?: SubscriptionDto;
+}
 /**
  * Query parameters
  */
@@ -6546,6 +6880,11 @@ export interface TagDto {
     updated_at?: string | null;
     updated_by?: ActorDto;
 }
+export interface TagsResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    tag?: TagDto;
+}
 export interface TierGroupDto {
     id: FlakeId;
     store_id: FlakeId;
@@ -6739,6 +7078,11 @@ export interface TrialEligibilityOverrideDto {
     deleted_at?: string | null;
     deleted_by?: ActorDto;
 }
+export interface TrialResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    trial?: TrialDto;
+}
 /**
  * Query parameters
  */
@@ -6993,6 +7337,19 @@ export interface UpdateAffiliateLinkDto {
     commission_amount_steps?: Array<AffiliateLinkCommissionAmountStepDto>;
     last_commission_amount_step_repeats?: boolean;
 }
+export interface UpdateCheckoutStyleDto {
+    font_family?: string;
+    /**
+     * @format int32
+     */
+    border_radius?: number | null;
+    color_primary?: string;
+    color_elements?: string;
+    color_input?: string;
+    color_background?: string;
+    color_text?: string;
+    color_outline?: string;
+}
 export interface UpdateCouponDto {
     enabled?: boolean;
     code?: string;
@@ -7081,6 +7438,10 @@ export interface UpdateGiftCardDto {
      */
     expires_at?: string | null;
 }
+export interface UpdateInviteDto {
+    role_id?: FlakeId;
+    user_email?: string;
+}
 export interface UpdateNavLinkDto {
     tag_id?: FlakeId;
     parent_node_id?: string;
@@ -7102,6 +7463,11 @@ export interface UpdateProductSortOrderRequestDto {
      */
     product_ids: Array<FlakeId>;
 }
+export interface UpdateRoleDto {
+    name?: string;
+    description?: string;
+    permissions?: Record<string, boolean>;
+}
 export interface UpdateSaleDto {
     enabled?: boolean;
     name?: string;