@paynow-gg/typescript-sdk 2.1.5 → 2.1.7

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

@@ -267,6 +267,42 @@ export interface AlipayDetailsDto {
      */
     fingerprint?: string | null;
 }
+export interface ApiKeyDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    role_id: FlakeId;
+    /**
+     * The name of the API key.
+     */
+    name: string;
+    /**
+     * The secret token used to authenticate as this API key. Only returned when the
+     * key is created and when its token is reset.
+     */
+    token?: string | null;
+    /**
+     * When the API key's token was last reset.
+     * @format date-time
+     */
+    token_reset_at?: string | null;
+    created_by: ActorDto;
+    /**
+     * When the API key was created.
+     * @format date-time
+     */
+    created_at: string;
+    updated_by?: ActorDto;
+    /**
+     * When the API key was last updated.
+     * @format date-time
+     */
+    updated_at?: string | null;
+}
+export interface ApiKeyResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    api_key?: ApiKeyDto;
+}
 export interface AvailablePermissionDto {
     id: string;
     name: string;
@@ -1417,7 +1453,7 @@ export interface CreateTrialEligibilityOverrideDto {
 export interface CreateWebhookDto {
     url: string;
     subscribed_to: WebhookEventType;
-    type: WebhookType;
+    type: WebhookTypeDto;
     discord_description_template?: string | null;
     discord_title?: string | null;
     discord_color?: string | null;
@@ -1993,6 +2029,11 @@ export interface CustomVariableOptionRequestDto {
      */
     is_default: boolean;
 }
+export interface CustomVariableResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    custom_variable?: CustomVariableDto;
+}
 /**
  * Defines the type of input method for a custom variable.
  * - `dropdown`: Dropdown selection with predefined options.
@@ -2009,7 +2050,7 @@ export interface DashboardSearchHintDto {
     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 type DashboardSearchResultTypeDto = "unknown" | "orders" | "trials" | "subscriptions" | "customers" | "coupons" | "gameservers" | "products" | "sales" | "api_keys" | "bans" | "affiliate_links" | "tags" | "giftcards" | "stores" | "users" | "tickets" | "tier_groups" | "custom_variables" | "global_commands" | "webhooks" | "email_templates" | "email_deliveries";
 export interface DashboardStatsDto {
     store_id: FlakeId;
     /**
@@ -2540,6 +2581,11 @@ export interface EmailDeliveryDto {
      */
     opened_at?: string | null;
 }
+export interface EmailDeliveryResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    email_delivery?: EmailDeliveryDto;
+}
 export type EmailDeliveryStatusDto = "unspecified" | "pending" | "sent" | "delivered" | "deferred" | "bounced" | "dropped" | "failed";
 export interface EmailTemplateComponentDto {
     tag: string;
@@ -2571,6 +2617,11 @@ export interface EmailTemplateDto {
      */
     updated_at?: string | null;
 }
+export interface EmailTemplateResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    email_template?: EmailTemplateDto;
+}
 export type EmailTemplateStateDto = "unspecified" | "inactive" | "activating" | "active";
 export type EmailTemplateTypeDto = "unspecified" | "layout" | "password_reset" | "email_verification" | "email_change" | "email_changed_notification" | "forgot_password" | "logged_in_new_location" | "welcome_login" | "order_completed" | "refund_initiated" | "subscription_canceled" | "subscription_renewal_failed" | "subscription_price_changed" | "subscription_change_verification_code" | "subscription_renewal_upcoming" | "subscription_manage_login" | "subscription_manage_no_history" | "payout_created" | "payout_completed" | "store_invite" | "store_lock_changed" | "abandoned_checkout_recovery_attempt" | "purchase_follow_up_attempt" | "downloadable_file_granted" | "discord_invite_link" | "gift_card_created" | "trial_ending_soon" | "invoice_generated" | "payment_method_type_approval" | "store_trust_event" | "data_subject_request_export_completed";
 export interface ExecutedWebhookDto {
@@ -2989,6 +3040,11 @@ export interface GlobalCommandDto {
     updated_at?: string | null;
     updated_by?: ActorDto;
 }
+export interface GlobalCommandResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    global_command?: GlobalCommandDto;
+}
 /**
  * iDEAL payment method details
  */
@@ -5675,7 +5731,7 @@ export interface QueuedWebhookDto {
      * @format date-time
      */
     created_at: string;
-    state: WebhookState;
+    state: WebhookStateDto;
     /**
      * @format date-time
      */
@@ -5981,6 +6037,13 @@ export interface SearchDashboardResponseDto {
     trials: Array<TrialResult>;
     subscriptions: Array<SubscriptionResult>;
     bans: Array<BanResult>;
+    api_keys: Array<ApiKeyResult>;
+    tier_groups: Array<TierGroupResult>;
+    custom_variables: Array<CustomVariableResult>;
+    global_commands: Array<GlobalCommandResult>;
+    webhooks: Array<WebhookResult>;
+    email_templates: Array<EmailTemplateResult>;
+    email_deliveries: Array<EmailDeliveryResult>;
     facets: {
         /**
          * @format int64
@@ -6050,6 +6113,30 @@ export interface SearchDashboardResponseDto {
          * @format int64
          */
         tickets?: number;
+        /**
+         * @format int64
+         */
+        tier_groups?: number;
+        /**
+         * @format int64
+         */
+        custom_variables?: number;
+        /**
+         * @format int64
+         */
+        global_commands?: number;
+        /**
+         * @format int64
+         */
+        webhooks?: number;
+        /**
+         * @format int64
+         */
+        email_templates?: number;
+        /**
+         * @format int64
+         */
+        email_deliveries?: number;
     };
 }
 export interface SetDiscordActionDto {
@@ -6101,6 +6188,10 @@ export interface StartDownloadableFileUploadRequestDto {
     file_content_type: string;
     description?: string | null;
 }
+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";
 export type StatsDistributionTypeDto_V2 = "unspecified" | "order_country" | "payment_method" | "payment_acceptance";
 /**
@@ -8086,6 +8177,11 @@ export interface TierGroupDto {
     updated_at?: string | null;
     updated_by?: ActorDto;
 }
+export interface TierGroupResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    tier_group?: TierGroupDto;
+}
 export interface TimeSeriesChartDto {
     chart: string;
     currency?: string | null;
@@ -9371,6 +9467,11 @@ export interface WebhookHistoryDto {
     page: number;
     history: Array<QueuedWebhookDto>;
 }
+export interface WebhookResult {
+    id: FlakeId;
+    store_id?: FlakeId;
+    webhook?: WebhookSubscriptionDto;
+}
 /**
  * Query parameters
  */
@@ -9385,7 +9486,7 @@ export type WebhooksGetHistoryQuery = {
      */
     state?: string;
 };
-export type WebhookState = "success" | "pending" | "failed" | "all";
+export type WebhookStateDto = "success" | "pending" | "failed" | "all";
 /**
  * Represents a webhook subscription: an endpoint that receives a request whenever one of the
  * subscribed events happens in the store.
@@ -9393,7 +9494,7 @@ export type WebhookState = "success" | "pending" | "failed" | "all";
 export interface WebhookSubscriptionDto {
     id: FlakeId;
     /**
-     * The URL each event is delivered to. For the 'discord_v1' type this is the Discord webhook URL.
+     * The URL each event is delivered to. For the 'DiscordV1' type this is the Discord webhook URL.
      */
     url: string;
     /**
@@ -9402,24 +9503,29 @@ export interface WebhookSubscriptionDto {
      */
     secret: string;
     subscribed_to: WebhookEventType;
-    type: WebhookType;
+    type: WebhookTypeDto;
     /**
      * The template rendered into the body of the Discord message, with webhook variables substituted.
-     * Only used by the 'discord_v1' type.
+     * Only used by the 'DiscordV1' type.
      */
     discord_description_template?: string | null;
     /**
-     * The title of the Discord embed. Only used by the 'discord_v1' type with the 'embed' format.
+     * The title of the Discord embed. Only used by the 'DiscordV1' type with the 'Embed' format.
      */
     discord_title?: string | null;
     /**
-     * The accent colour of the Discord embed, as a hex colour. Only used by the 'discord_v1' type
-     * with the 'embed' format.
+     * The accent colour of the Discord embed, as a hex colour. Only used by the 'DiscordV1' type
+     * with the 'Embed' format.
      */
     discord_color?: string | null;
     discord_format?: WebhookDiscordFormatDto;
 }
-export type WebhookType = "json_v1" | "discord_v1";
+/**
+ * Specifies the payload format a webhook delivers.
+ * - `JsonV1`: The event is posted as JSON. This is the default.
+ * - `DiscordV1`: The event is posted as a Discord message.
+ */
+export type WebhookTypeDto = "JsonV1" | "DiscordV1";
 export interface WebhookVariablesDto {
     event_type: WebhookEventType;
     variables: Array<string>;