@paynow-gg/typescript-sdk 2.1.6 → 2.1.8

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

@@ -641,10 +641,11 @@ export interface CheckoutStyleDto {
      */
     color_outline?: string | null;
     /**
-     * The URL of the image shown behind the checkout, or null when none has been uploaded. It cannot
-     * be set directly; upload an image through the background image endpoints instead.
+     * The URL of the image shown behind the checkout, or null when there is none. It cannot be set
+     * directly; set 'background_media_asset_id' instead.
      */
     url_background?: string | null;
+    background_media_asset_id?: FlakeId;
 }
 export interface CommandAttemptDto {
     id: FlakeId;
@@ -1082,6 +1083,7 @@ export interface CreateCheckoutStyleDto {
      * default.
      */
     color_outline?: string;
+    background_media_asset_id?: FlakeId;
 }
 export interface CreateCouponDto {
     /**
@@ -1191,8 +1193,8 @@ export interface CreateDownloadableFileDownloadUrlResponseDto {
 }
 export interface CreateEmailBrandingDto {
     color: string;
-    header_image_light_url?: string;
-    header_image_dark_url?: string;
+    header_image_light_media_asset_id?: FlakeId;
+    header_image_dark_media_asset_id?: FlakeId;
 }
 export interface CreateEmailTemplateDto {
     email_template_type: EmailTemplateTypeDto;
@@ -1271,6 +1273,37 @@ export interface CreateInviteDto {
      */
     user_email: string;
 }
+/**
+ * Represents a request to start uploading a media file.
+ */
+export interface CreateMediaUploadRequestDto {
+    /**
+     * The MIME type of the file. One of 'image/png', 'image/jpeg', 'image/webp', 'image/gif' or 'video/mp4'.
+     * @example "image/png"
+     */
+    content_type: string;
+    /**
+     * The size of the file in bytes, at most 20 MB (20971520 bytes).
+     * @format int64
+     * @example 524288
+     */
+    size_bytes: number;
+}
+/**
+ * Represents a started media upload.
+ */
+export interface CreateMediaUploadResponseDto {
+    media_asset_id: FlakeId;
+    /**
+     * The URL to upload the file to with a PUT request, sending the file as the raw request body.
+     */
+    upload_url: string;
+    /**
+     * The date and time after which 'upload_url' stops accepting the upload.
+     * @format date-time
+     */
+    expires_at: string;
+}
 export interface CreateNavLinkDto {
     tag_id: FlakeId;
     /**
@@ -1395,6 +1428,8 @@ export interface CreateStoreDto {
      * The integration type used by the store.
      */
     integration_type?: string;
+    logo_media_asset_id?: FlakeId;
+    logo_square_media_asset_id?: FlakeId;
     /**
      * Username prefix used to identify Minecraft Bedrock players (e.g. ".").
      */
@@ -1453,7 +1488,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;
@@ -2558,6 +2593,8 @@ export interface EmailBrandingDto {
     color: string;
     header_image_light_url?: string | null;
     header_image_dark_url?: string | null;
+    header_image_light_media_asset_id?: FlakeId;
+    header_image_dark_media_asset_id?: FlakeId;
 }
 export interface EmailDeliveryDto {
     id: FlakeId;
@@ -2640,36 +2677,6 @@ 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.
-     */
-    image_id: string;
-}
 /**
  * Represents the result of importing an uploaded template archive into a template.
  */
@@ -2820,10 +2827,6 @@ export interface GameserverResult {
     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;
@@ -2833,40 +2836,6 @@ export interface GetDistributionResponseDto_V2 {
     distribution_type: StatsDistributionTypeDto_V2;
     entries: Array<DistributionEntryDto_V2>;
 }
-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.
-     */
-    id: string;
-    /**
-     * The URL to upload the image to.
-     */
-    upload_url: string;
-}
 /**
  * Represents a link to download a template's files as an archive.
  */
@@ -3191,6 +3160,10 @@ export interface InlineProductCreateDto {
      * The IDs of associated custom variables.
      */
     custom_variable_ids?: Array<FlakeId> | null;
+    /**
+     * The IDs of the media assets to show as the product's images, in display order.
+     */
+    media_asset_ids?: Array<FlakeId> | null;
     /**
      * Indicates if applying gift cards should be disabled on the product.
      */
@@ -3489,12 +3462,6 @@ export interface MarketingCouponConfigurationDto {
     usable_on_subscriptions: boolean;
     expires_after?: Period;
 }
-/**
- * Query parameters
- */
-export type MarketingGetEmailBrandingImageUploadUrlQuery = {
-    dark_mode?: boolean;
-};
 /**
  * Query parameters
  */
@@ -3558,6 +3525,71 @@ export type MarketingGetEmailTemplatesQuery = {
      */
     asc?: boolean;
 };
+/**
+ * Represents an image or video uploaded to a store's media.
+ */
+export interface MediaAssetDto {
+    id: FlakeId;
+    store_id: FlakeId;
+    /**
+     * The public URL the media is served from.
+     */
+    url: string;
+    type: MediaAssetTypeDto;
+    /**
+     * The MIME type of the media, for example 'image/png'.
+     */
+    content_type: string;
+    /**
+     * The size of the media in bytes.
+     * @format int64
+     */
+    size_bytes: number;
+    /**
+     * The date and time the media asset was created.
+     * @format date-time
+     */
+    created_at: string;
+}
+/**
+ * Specifies the kind of media an asset holds.
+ * - `unknown`: The type is unknown.
+ * - `image`: An image (PNG, JPEG, WEBP or GIF).
+ * - `video`: A video (MP4).
+ */
+export type MediaAssetTypeDto = "unknown" | "image" | "video";
+/**
+ * Query parameters
+ */
+export type MediaListMediaAssetsQuery = {
+    /**
+     * Only return media of this type.
+     */
+    type?: MediaAssetTypeDto;
+    /**
+     * 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 MoneyDto_V2 {
     /**
      * The ISO 4217 currency code, e.g. "USD", "GBP".
@@ -5144,6 +5176,10 @@ export interface ProductDto {
      * The URL to the product image.
      */
     image_url?: string | null;
+    /**
+     * The product's images in display order. The first image is the primary image.
+     */
+    images: Array<ProductImageDto>;
     /**
      * The unique slug for the product.
      */
@@ -5301,6 +5337,17 @@ export interface ProductGameServerDto {
      */
     enabled: boolean;
 }
+/**
+ * Represents one of a product's images.
+ */
+export interface ProductImageDto {
+    media_asset_id: FlakeId;
+    /**
+     * The public URL the image is served from.
+     */
+    url: string;
+    type: MediaAssetTypeDto;
+}
 export interface ProductPayoutSplitDto {
     user_id: FlakeId;
     /**
@@ -5731,7 +5778,7 @@ export interface QueuedWebhookDto {
      * @format date-time
      */
     created_at: string;
-    state: WebhookState;
+    state: WebhookStateDto;
     /**
      * @format date-time
      */
@@ -6188,6 +6235,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";
 /**
@@ -6386,6 +6437,8 @@ export interface StoreDto {
      * URL of the store's square/icon logo image.
      */
     logo_square_url?: string | null;
+    logo_media_asset_id?: FlakeId;
+    logo_square_media_asset_id?: FlakeId;
     /**
      * Username prefix used to identify Minecraft Bedrock players (e.g. ".").
      */
@@ -8137,6 +8190,7 @@ export interface TagDto {
      * The Image URL associated with the tag.
      */
     image_url?: string | null;
+    media_asset_id?: FlakeId;
     /**
      * Indicates whether this tag is enabled.
      */
@@ -8673,6 +8727,7 @@ export interface UpdateCheckoutStyleDto {
      * default.
      */
     color_outline?: string;
+    background_media_asset_id?: FlakeId;
 }
 export interface UpdateCouponDto {
     /**
@@ -8768,8 +8823,8 @@ export interface UpdateCouponDto {
 }
 export interface UpdateEmailBrandingDto {
     color?: string;
-    header_image_light_url?: string;
-    header_image_dark_url?: string;
+    header_image_light_media_asset_id?: FlakeId;
+    header_image_dark_media_asset_id?: FlakeId;
 }
 export interface UpdateEmailTemplateDto {
     name?: string;
@@ -8970,6 +9025,8 @@ export interface UpdateStoreDto {
      * When set to true, the store is processing real transactions in live mode.
      */
     live_mode?: boolean;
+    logo_media_asset_id?: FlakeId;
+    logo_square_media_asset_id?: FlakeId;
     /**
      * Username prefix used to identify Minecraft Bedrock players (e.g. ".").
      */
@@ -9338,6 +9395,10 @@ export interface UpsertProductRequestDto {
      * The IDs of associated custom variables.
      */
     custom_variable_ids?: Array<FlakeId> | null;
+    /**
+     * The IDs of the media assets to show as the product's images, in display order.
+     */
+    media_asset_ids?: Array<FlakeId> | null;
     /**
      * Indicates if applying gift cards should be disabled on the product.
      */
@@ -9426,6 +9487,7 @@ export interface UpsertTagRequestDto {
     slug?: string | null;
     description?: string | null;
     enabled?: boolean | null;
+    media_asset_id?: FlakeId;
 }
 /**
  * A validation error.
@@ -9482,7 +9544,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.
@@ -9490,7 +9552,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;
     /**
@@ -9499,24 +9561,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>;