@devite/shopware-client 1.6.0 → 1.6.1

package/dist/index.cjs

@@ -379,7 +379,7 @@ function createRestEndpoint(client, resourceIdentifier, dataName) {
 }
 
 class AppClient extends Client {
-  apps = createRestEndpoint(this, "/app", "app");
+  apps = createRestEndpoint(this, "app", "app");
   actionButtons = createRestEndpoint(
     this,
     "app-action-button",
@@ -390,13 +390,13 @@ class AppClient extends Client {
     "app-administration-snippet",
     "app administration snippet"
   );
-  cmsBlocks = createRestEndpoint(this, "/app-cms-block", "app cms block");
+  cmsBlocks = createRestEndpoint(this, "app-cms-block", "app cms block");
   flowActions = createRestEndpoint(
     this,
     "app-flow-action",
     "app flow action"
   );
-  flowEvents = createRestEndpoint(this, "/app-flow-event", "app flow event");
+  flowEvents = createRestEndpoint(this, "app-flow-event", "app flow event");
   paymentMethods = createRestEndpoint(
     this,
     "app-payment-method",
@@ -412,30 +412,30 @@ class AppClient extends Client {
     "app-shipping-method",
     "app shipping method"
   );
-  templates = createRestEndpoint(this, "/app-template", "app template");
+  templates = createRestEndpoint(this, "app-template", "app template");
 }
 
 let CategoryClient$1 = class CategoryClient extends Client {
-  categories = createRestEndpoint(this, "/category", "category");
-  mainCategories = createRestEndpoint(this, "/main-category", "main category");
+  categories = createRestEndpoint(this, "category", "category");
+  mainCategories = createRestEndpoint(this, "main-category", "main category");
 };
 
 let ContentClient$1 = class ContentClient extends Client {
-  cmsBlocks = createRestEndpoint(this, "/cms-block", "cms block");
-  cmsPages = createRestEndpoint(this, "/cms-page", "cms page");
-  cmsSections = createRestEndpoint(this, "/cms-section", "cms section");
-  cmsSlots = createRestEndpoint(this, "/cms-slot", "cms slot");
-  landingPages = createRestEndpoint(this, "/landing-page", "landing page");
-  themes = createRestEndpoint(this, "/theme", "theme");
+  cmsBlocks = createRestEndpoint(this, "cms-block", "cms block");
+  cmsPages = createRestEndpoint(this, "cms-page", "cms page");
+  cmsSections = createRestEndpoint(this, "cms-section", "cms section");
+  cmsSlots = createRestEndpoint(this, "cms-slot", "cms slot");
+  landingPages = createRestEndpoint(this, "landing-page", "landing page");
+  themes = createRestEndpoint(this, "theme", "theme");
 };
 
 let CountryClient$1 = class CountryClient extends Client {
-  countries = createRestEndpoint(this, "/country", "country");
-  states = createRestEndpoint(this, "/country-state", "country-state");
+  countries = createRestEndpoint(this, "country", "country");
+  states = createRestEndpoint(this, "country-state", "country-state");
 };
 
 class CountryClient extends Client {
-  currencies = createRestEndpoint(this, "/currency", "currency");
+  currencies = createRestEndpoint(this, "currency", "currency");
   currencyRoundings = createRestEndpoint(
     this,
     "currency-country-rounding",
@@ -444,7 +444,7 @@ class CountryClient extends Client {
 }
 
 class CustomDataClient extends Client {
-  entities = createRestEndpoint(this, "/custom-entity", "custom entity");
+  entities = createRestEndpoint(this, "custom-entity", "custom entity");
   fieldSets = createRestEndpoint(
     this,
     "custom-field-set",
@@ -455,7 +455,7 @@ class CustomDataClient extends Client {
     "custom-field-set-relation",
     "custom field set relation"
   );
-  fields = createRestEndpoint(this, "/custom-field", "custom field");
+  fields = createRestEndpoint(this, "custom-field", "custom field");
 }
 
 class CustomerClient extends Client {
@@ -474,9 +474,9 @@ class CustomerClient extends Client {
     throw new ShopwareError("Failed to generate impersonation token", response);
   }
   /** Rest Endpoints **/
-  customers = createRestEndpoint(this, "/customer", "customer");
-  addresses = createRestEndpoint(this, "/address", "customer address");
-  groups = createRestEndpoint(this, "/customer-group", "customer group");
+  customers = createRestEndpoint(this, "customer", "customer");
+  addresses = createRestEndpoint(this, "address", "customer address");
+  groups = createRestEndpoint(this, "customer-group", "customer group");
   recoveries = createRestEndpoint(
     this,
     "customer-recovery",
@@ -495,7 +495,7 @@ class CustomerClient extends Client {
 }
 
 class DeliveryTimeClient extends Client {
-  deliveryTimes = createRestEndpoint(this, "/delivery-time", "delivery time");
+  deliveryTimes = createRestEndpoint(this, "delivery-time", "delivery time");
 }
 
 let DocumentClient$1 = class DocumentClient extends Client {
@@ -541,8 +541,22 @@ let DocumentClient$1 = class DocumentClient extends Client {
     if (response.statusCode === 200) return response.body.data;
     throw new ShopwareError("Failed to upload file from url", response);
   }
+  /**
+   * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
+   */
+  async download(id, deepLinkCode, download, fileType) {
+    const response = await this.get(`/_action/document/${id}/${deepLinkCode}`, {
+      query: { download, fileType },
+      headers: {
+        Accept: fileType === "pdf" ? "application/pdf" : fileType === "html" ? "text/html" : "application/octet-stream"
+      }
+    });
+    if (response.statusCode === 200)
+      return response.body.data;
+    throw new ShopwareError("Failed to download document", response);
+  }
   /** Rest Endpoints **/
-  documents = createRestEndpoint(this, "/document", "document");
+  documents = createRestEndpoint(this, "document", "document");
   documentTypes = createRestEndpoint(
     this,
     "document-type",
@@ -561,9 +575,9 @@ let DocumentClient$1 = class DocumentClient extends Client {
 };
 
 class FlowClient extends Client {
-  flows = createRestEndpoint(this, "/flow", "flow");
-  sequences = createRestEndpoint(this, "/flow-sequence", "flow sequence");
-  flowTemplates = createRestEndpoint(this, "/flow-template", "flow template");
+  flows = createRestEndpoint(this, "flow", "flow");
+  sequences = createRestEndpoint(this, "flow-sequence", "flow sequence");
+  flowTemplates = createRestEndpoint(this, "flow-template", "flow template");
 }
 
 class ImportExportClient extends Client {
@@ -585,12 +599,12 @@ class ImportExportClient extends Client {
 }
 
 class IntegrationClient extends Client {
-  integrations = createRestEndpoint(this, "/integration", "integration");
+  integrations = createRestEndpoint(this, "integration", "integration");
 }
 
 class LocaleClient extends Client {
-  locales = createRestEndpoint(this, "/locale", "locale");
-  languages = createRestEndpoint(this, "/language", "language");
+  locales = createRestEndpoint(this, "locale", "locale");
+  languages = createRestEndpoint(this, "language", "language");
 }
 
 class MailClient extends Client {
@@ -635,7 +649,7 @@ class MailClient extends Client {
     "header-footer",
     "mail header/footer"
   );
-  templates = createRestEndpoint(this, "/template", "mail template");
+  templates = createRestEndpoint(this, "template", "mail template");
   templateTypes = createRestEndpoint(
     this,
     "template-type",
@@ -672,13 +686,13 @@ class MediaClient extends Client {
     throw new ShopwareError("Failed to upload asset from url", response);
   }
   /** Rest Endpoints **/
-  media = createRestEndpoint(this, "/media", "media");
+  media = createRestEndpoint(this, "media", "media");
   defaultFolders = createRestEndpoint(
     this,
     "media-default-folder",
     "default media folder"
   );
-  folders = createRestEndpoint(this, "/media-folder", "media folder");
+  folders = createRestEndpoint(this, "media-folder", "media folder");
   folderConfigs = createRestEndpoint(
     this,
     "media-folder-configuration",
@@ -705,7 +719,7 @@ let NewsletterClient$1 = class NewsletterClient extends Client {
 };
 
 class NumberRangeClient extends Client {
-  numberRanges = createRestEndpoint(this, "/number-range", "number range");
+  numberRanges = createRestEndpoint(this, "number-range", "number range");
   numberRangeSalesChannels = createRestEndpoint(
     this,
     "number-range-sales-channel",
@@ -735,7 +749,7 @@ let OrderClient$1 = class OrderClient extends Client {
     });
     if (response.statusCode === 200)
       return response.body.data;
-    throw new ShopwareError("Failed to download merged document", response);
+    throw new ShopwareError("Failed to download merged documents", response);
   }
   /**
    * @param documentTypeName - The `technicalName` of the document type.
@@ -749,18 +763,6 @@ let OrderClient$1 = class OrderClient extends Client {
     if (response.statusCode === 200) return;
     throw new ShopwareError("Failed to create documents", response);
   }
-  /**
-   * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
-   */
-  async download(id, deepLinkCode, download) {
-    const response = await this.get(`/_action/document/${id}/download/${deepLinkCode}`, {
-      query: { download },
-      headers: { Accept: "application/octet-stream" }
-    });
-    if (response.statusCode === 200)
-      return response.body.data;
-    throw new ShopwareError("Failed to download merged document", response);
-  }
   /** Order Management **/
   /**
    * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
@@ -819,16 +821,16 @@ let OrderClient$1 = class OrderClient extends Client {
     throw new ShopwareError("Failed to transition delivery state", response);
   }
   /** Rest Endpoints **/
-  orders = createRestEndpoint(this, "/order", "order");
-  addresses = createRestEndpoint(this, "/order-address", "order address");
-  customers = createRestEndpoint(this, "/order-customer", "order customer");
-  deliveries = createRestEndpoint(this, "/order-delivery", "order delivery");
+  orders = createRestEndpoint(this, "order", "order");
+  addresses = createRestEndpoint(this, "order-address", "order address");
+  customers = createRestEndpoint(this, "order-customer", "order customer");
+  deliveries = createRestEndpoint(this, "order-delivery", "order delivery");
   deliveryPositions = createRestEndpoint(
     this,
     "order-delivery-position",
     "order delivery position"
   );
-  lineItems = createRestEndpoint(this, "/order-line-item", "order line item");
+  lineItems = createRestEndpoint(this, "order-line-item", "order line item");
   lineItemDownloads = createRestEndpoint(
     this,
     "order-line-item-download",
@@ -865,11 +867,11 @@ class PaymentMethodClient extends Client {
 }
 
 class PluginClient extends Client {
-  plugins = createRestEndpoint(this, "/plugin", "plugin");
+  plugins = createRestEndpoint(this, "plugin", "plugin");
 }
 
 let ProductClient$1 = class ProductClient extends Client {
-  products = createRestEndpoint(this, "/product", "product");
+  products = createRestEndpoint(this, "product", "product");
   configuratorSettings = createRestEndpoint(
     this,
     "product-configurator-setting",
@@ -890,7 +892,7 @@ let ProductClient$1 = class ProductClient extends Client {
     "product-download",
     "product download"
   );
-  exports = createRestEndpoint(this, "/product-export", "product export");
+  exports = createRestEndpoint(this, "product-export", "product export");
   featureSets = createRestEndpoint(
     this,
     "product-feature-set",
@@ -906,9 +908,9 @@ let ProductClient$1 = class ProductClient extends Client {
     "product-manufacturer",
     "product manufacturer"
   );
-  media = createRestEndpoint(this, "/product-media", "product media");
-  prices = createRestEndpoint(this, "/product-price", "product price");
-  reviews = createRestEndpoint(this, "/product-review", "product review");
+  media = createRestEndpoint(this, "product-media", "product media");
+  prices = createRestEndpoint(this, "product-price", "product price");
+  reviews = createRestEndpoint(this, "product-review", "product review");
   searchConfigs = createRestEndpoint(
     this,
     "product-search-config",
@@ -924,8 +926,8 @@ let ProductClient$1 = class ProductClient extends Client {
     "product-search-keyword",
     "product search keyword"
   );
-  sortings = createRestEndpoint(this, "/product-sorting", "product sorting");
-  streams = createRestEndpoint(this, "/product-stream", "product stream");
+  sortings = createRestEndpoint(this, "product-sorting", "product sorting");
+  streams = createRestEndpoint(this, "product-stream", "product stream");
   streamFilters = createRestEndpoint(
     this,
     "product-stream-filter",
@@ -939,8 +941,8 @@ let ProductClient$1 = class ProductClient extends Client {
 };
 
 class PromotionClient extends Client {
-  promotions = createRestEndpoint(this, "/promotion", "promotion");
-  discounts = createRestEndpoint(this, "/promotion-discount", "discount");
+  promotions = createRestEndpoint(this, "promotion", "promotion");
+  discounts = createRestEndpoint(this, "promotion-discount", "discount");
   discountPrices = createRestEndpoint(
     this,
     "promotion-discount-price",
@@ -977,12 +979,12 @@ class PropertyGroupClient extends Client {
 }
 
 class RuleClient extends Client {
-  rules = createRestEndpoint(this, "/rule", "rule");
-  conditions = createRestEndpoint(this, "/rule-condition", "rule condition");
+  rules = createRestEndpoint(this, "rule", "rule");
+  conditions = createRestEndpoint(this, "rule-condition", "rule condition");
 }
 
 class SalesChannelClient extends Client {
-  salesChannels = createRestEndpoint(this, "/sales-channel", "sales channel");
+  salesChannels = createRestEndpoint(this, "sales-channel", "sales channel");
   analytics = createRestEndpoint(
     this,
     "sales-channel-analytics",
@@ -1001,19 +1003,19 @@ class SalesChannelClient extends Client {
 }
 
 class SalutationClient extends Client {
-  salutations = createRestEndpoint(this, "/salutation", "salutation");
+  salutations = createRestEndpoint(this, "salutation", "salutation");
 }
 
 class ScriptClient extends Client {
-  scripts = createRestEndpoint(this, "/script", "script");
+  scripts = createRestEndpoint(this, "script", "script");
 }
 
 class SecurityClient extends Client {
-  aclRoles = createRestEndpoint(this, "/acl-role", "acl role");
+  aclRoles = createRestEndpoint(this, "acl-role", "acl role");
 }
 
 let SeoClient$1 = class SeoClient extends Client {
-  urls = createRestEndpoint(this, "/seo-url", "seo url");
+  urls = createRestEndpoint(this, "seo-url", "seo url");
   urlTemplates = createRestEndpoint(
     this,
     "seo-url-template",
@@ -1035,12 +1037,12 @@ class ShippingMethodClient extends Client {
 }
 
 class SnippetClient extends Client {
-  snippets = createRestEndpoint(this, "/snippet", "snippet");
-  sets = createRestEndpoint(this, "/snippet-set", "snippet set");
+  snippets = createRestEndpoint(this, "snippet", "snippet");
+  sets = createRestEndpoint(this, "snippet-set", "snippet set");
 }
 
 class StateMachineClient extends Client {
-  stateMachines = createRestEndpoint(this, "/state-machine", "state machine");
+  stateMachines = createRestEndpoint(this, "state-machine", "state machine");
   states = createRestEndpoint(
     this,
     "state-machine-state",
@@ -1224,8 +1226,8 @@ let SystemClient$1 = class SystemClient extends Client {
     throw new ShopwareError("Failed to clear invalidated caches", response);
   }
   /** Rest Endpoints **/
-  logsEntries = createRestEndpoint(this, "/log-entry", "log entry");
-  notifications = createRestEndpoint(this, "/notification", "notification");
+  logsEntries = createRestEndpoint(this, "log-entry", "log entry");
+  notifications = createRestEndpoint(this, "notification", "notification");
   configEntries = createRestEndpoint(
     this,
     "system-config",
@@ -1239,29 +1241,29 @@ let SystemClient$1 = class SystemClient extends Client {
 };
 
 class TagClient extends Client {
-  tags = createRestEndpoint(this, "/tag", "tag");
+  tags = createRestEndpoint(this, "tag", "tag");
 }
 
 class TaxClient extends Client {
-  taxes = createRestEndpoint(this, "/tax", "tax");
-  providers = createRestEndpoint(this, "/tax-provider", "tax provider");
-  rules = createRestEndpoint(this, "/tax-rule", "tax rule");
-  ruleTypes = createRestEndpoint(this, "/tax-rule-type", "tax rule type");
+  taxes = createRestEndpoint(this, "tax", "tax");
+  providers = createRestEndpoint(this, "tax-provider", "tax provider");
+  rules = createRestEndpoint(this, "tax-rule", "tax rule");
+  ruleTypes = createRestEndpoint(this, "tax-rule-type", "tax rule type");
 }
 
 class UnitClient extends Client {
-  units = createRestEndpoint(this, "/unit", "unit");
+  units = createRestEndpoint(this, "unit", "unit");
 }
 
 class UserClient extends Client {
-  users = createRestEndpoint(this, "/user", "user");
+  users = createRestEndpoint(this, "user", "user");
   accessKeys = createRestEndpoint(this, "user-access-key", "user access key");
-  userConfigs = createRestEndpoint(this, "/user-config", "user config");
-  userRecoveries = createRestEndpoint(this, "/user-recovery", "user recovery");
+  userConfigs = createRestEndpoint(this, "user-config", "user config");
+  userRecoveries = createRestEndpoint(this, "user-recovery", "user recovery");
 }
 
 class WebhookClient extends Client {
-  webhooks = createRestEndpoint(this, "/webhook", "webhook");
+  webhooks = createRestEndpoint(this, "webhook", "webhook");
   eventLogs = createRestEndpoint(
     this,
     "webhook-event-log",

package/dist/index.d.cts

@@ -38,7 +38,7 @@ import { CustomerRecovery as CustomerRecovery$1 } from '#types/api/admin/custome
 import { CustomerWishlist as CustomerWishlist$1 } from '#types/api/admin/customer/wishlist/CustomerWishlist';
 import { CustomerWishlistProduct as CustomerWishlistProduct$1 } from '#types/api/admin/customer/wishlist/CustomerWishlistProduct';
 import { DeliveryTime as DeliveryTime$1 } from '#types/api/admin/DeliveryTime';
-import { NumberReservationResponse, UploadResponse } from '#types/clients/admin/DocumentClient';
+import { NumberReservationResponse, UploadResponse, DownloadResponse } from '#types/clients/admin/DocumentClient';
 import { ShopwareDocument as ShopwareDocument$1 } from '#types/api/admin/document/ShopwareDocument';
 import { ShopwareDocumentType as ShopwareDocumentType$1 } from '#types/api/admin/document/ShopwareDocumentType';
 import { ShopwareDocumentBaseConfig as ShopwareDocumentBaseConfig$1 } from '#types/api/admin/document/baseConfig/ShopwareDocumentBaseConfig';
@@ -121,7 +121,7 @@ import { MediaThumbnail as MediaThumbnail$2 } from '#types/api/store/media/Media
 import { ShopwareDocumentBaseConfig as ShopwareDocumentBaseConfig$2 } from '#types/api/store/document/ShopwareDocumentBaseConfig';
 import { ShopwareDocumentType as ShopwareDocumentType$2 } from '#types/api/store/document/ShopwareDocumentType';
 import { ShopwareDocument as ShopwareDocument$2 } from '#types/api/store/document/ShopwareDocument';
-import { DownloadMergedRequest, DownloadMergedResponse, DocumentListCreateRequest, DownloadResponse, StateTransitionRequest, StateTransitionResponse } from '#types/clients/admin/OrderClient';
+import { DownloadMergedRequest, DownloadMergedResponse, DocumentListCreateRequest, StateTransitionRequest, StateTransitionResponse } from '#types/clients/admin/OrderClient';
 import { Order as Order$2 } from '#types/api/admin/order/Order';
 import { OrderAddress as OrderAddress$2 } from '#types/api/admin/order/OrderAddress';
 import { OrderCustomer as OrderCustomer$2 } from '#types/api/admin/order/OrderCustomer';
@@ -1228,6 +1228,10 @@ declare class DocumentClient$1 extends Client {
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
      */
     uploadFromUrl(id: string, extension: string, url: string, fileName?: string): Promise<UploadResponse>;
+    /**
+     * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
+     */
+    download(id: string, deepLinkCode: string, download?: boolean, fileType?: string): Promise<DownloadResponse>;
     /** Rest Endpoints **/
     documents: {
         getList: (query?: Criteria) => Promise<{
@@ -3777,10 +3781,6 @@ declare class OrderClient$1 extends Client {
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
      */
     createDocuments(documentTypeName: string, request: DocumentListCreateRequest): Promise<void>;
-    /**
-     * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
-     */
-    download(id: string, deepLinkCode: string, download?: boolean): Promise<DownloadResponse>;
     /** Order Management **/
     /**
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed

package/dist/index.d.mts

@@ -38,7 +38,7 @@ import { CustomerRecovery as CustomerRecovery$1 } from '#types/api/admin/custome
 import { CustomerWishlist as CustomerWishlist$1 } from '#types/api/admin/customer/wishlist/CustomerWishlist';
 import { CustomerWishlistProduct as CustomerWishlistProduct$1 } from '#types/api/admin/customer/wishlist/CustomerWishlistProduct';
 import { DeliveryTime as DeliveryTime$1 } from '#types/api/admin/DeliveryTime';
-import { NumberReservationResponse, UploadResponse } from '#types/clients/admin/DocumentClient';
+import { NumberReservationResponse, UploadResponse, DownloadResponse } from '#types/clients/admin/DocumentClient';
 import { ShopwareDocument as ShopwareDocument$1 } from '#types/api/admin/document/ShopwareDocument';
 import { ShopwareDocumentType as ShopwareDocumentType$1 } from '#types/api/admin/document/ShopwareDocumentType';
 import { ShopwareDocumentBaseConfig as ShopwareDocumentBaseConfig$1 } from '#types/api/admin/document/baseConfig/ShopwareDocumentBaseConfig';
@@ -121,7 +121,7 @@ import { MediaThumbnail as MediaThumbnail$2 } from '#types/api/store/media/Media
 import { ShopwareDocumentBaseConfig as ShopwareDocumentBaseConfig$2 } from '#types/api/store/document/ShopwareDocumentBaseConfig';
 import { ShopwareDocumentType as ShopwareDocumentType$2 } from '#types/api/store/document/ShopwareDocumentType';
 import { ShopwareDocument as ShopwareDocument$2 } from '#types/api/store/document/ShopwareDocument';
-import { DownloadMergedRequest, DownloadMergedResponse, DocumentListCreateRequest, DownloadResponse, StateTransitionRequest, StateTransitionResponse } from '#types/clients/admin/OrderClient';
+import { DownloadMergedRequest, DownloadMergedResponse, DocumentListCreateRequest, StateTransitionRequest, StateTransitionResponse } from '#types/clients/admin/OrderClient';
 import { Order as Order$2 } from '#types/api/admin/order/Order';
 import { OrderAddress as OrderAddress$2 } from '#types/api/admin/order/OrderAddress';
 import { OrderCustomer as OrderCustomer$2 } from '#types/api/admin/order/OrderCustomer';
@@ -1228,6 +1228,10 @@ declare class DocumentClient$1 extends Client {
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
      */
     uploadFromUrl(id: string, extension: string, url: string, fileName?: string): Promise<UploadResponse>;
+    /**
+     * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
+     */
+    download(id: string, deepLinkCode: string, download?: boolean, fileType?: string): Promise<DownloadResponse>;
     /** Rest Endpoints **/
     documents: {
         getList: (query?: Criteria) => Promise<{
@@ -3777,10 +3781,6 @@ declare class OrderClient$1 extends Client {
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
      */
     createDocuments(documentTypeName: string, request: DocumentListCreateRequest): Promise<void>;
-    /**
-     * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
-     */
-    download(id: string, deepLinkCode: string, download?: boolean): Promise<DownloadResponse>;
     /** Order Management **/
     /**
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed

package/dist/index.d.ts

@@ -38,7 +38,7 @@ import { CustomerRecovery as CustomerRecovery$1 } from '#types/api/admin/custome
 import { CustomerWishlist as CustomerWishlist$1 } from '#types/api/admin/customer/wishlist/CustomerWishlist';
 import { CustomerWishlistProduct as CustomerWishlistProduct$1 } from '#types/api/admin/customer/wishlist/CustomerWishlistProduct';
 import { DeliveryTime as DeliveryTime$1 } from '#types/api/admin/DeliveryTime';
-import { NumberReservationResponse, UploadResponse } from '#types/clients/admin/DocumentClient';
+import { NumberReservationResponse, UploadResponse, DownloadResponse } from '#types/clients/admin/DocumentClient';
 import { ShopwareDocument as ShopwareDocument$1 } from '#types/api/admin/document/ShopwareDocument';
 import { ShopwareDocumentType as ShopwareDocumentType$1 } from '#types/api/admin/document/ShopwareDocumentType';
 import { ShopwareDocumentBaseConfig as ShopwareDocumentBaseConfig$1 } from '#types/api/admin/document/baseConfig/ShopwareDocumentBaseConfig';
@@ -121,7 +121,7 @@ import { MediaThumbnail as MediaThumbnail$2 } from '#types/api/store/media/Media
 import { ShopwareDocumentBaseConfig as ShopwareDocumentBaseConfig$2 } from '#types/api/store/document/ShopwareDocumentBaseConfig';
 import { ShopwareDocumentType as ShopwareDocumentType$2 } from '#types/api/store/document/ShopwareDocumentType';
 import { ShopwareDocument as ShopwareDocument$2 } from '#types/api/store/document/ShopwareDocument';
-import { DownloadMergedRequest, DownloadMergedResponse, DocumentListCreateRequest, DownloadResponse, StateTransitionRequest, StateTransitionResponse } from '#types/clients/admin/OrderClient';
+import { DownloadMergedRequest, DownloadMergedResponse, DocumentListCreateRequest, StateTransitionRequest, StateTransitionResponse } from '#types/clients/admin/OrderClient';
 import { Order as Order$2 } from '#types/api/admin/order/Order';
 import { OrderAddress as OrderAddress$2 } from '#types/api/admin/order/OrderAddress';
 import { OrderCustomer as OrderCustomer$2 } from '#types/api/admin/order/OrderCustomer';
@@ -1228,6 +1228,10 @@ declare class DocumentClient$1 extends Client {
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
      */
     uploadFromUrl(id: string, extension: string, url: string, fileName?: string): Promise<UploadResponse>;
+    /**
+     * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
+     */
+    download(id: string, deepLinkCode: string, download?: boolean, fileType?: string): Promise<DownloadResponse>;
     /** Rest Endpoints **/
     documents: {
         getList: (query?: Criteria) => Promise<{
@@ -3777,10 +3781,6 @@ declare class OrderClient$1 extends Client {
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
      */
     createDocuments(documentTypeName: string, request: DocumentListCreateRequest): Promise<void>;
-    /**
-     * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
-     */
-    download(id: string, deepLinkCode: string, download?: boolean): Promise<DownloadResponse>;
     /** Order Management **/
     /**
      * @throws {ShopwareError | import('ofetch').FetchError} if the request failed

package/dist/index.mjs

@@ -377,7 +377,7 @@ function createRestEndpoint(client, resourceIdentifier, dataName) {
 }
 
 class AppClient extends Client {
-  apps = createRestEndpoint(this, "/app", "app");
+  apps = createRestEndpoint(this, "app", "app");
   actionButtons = createRestEndpoint(
     this,
     "app-action-button",
@@ -388,13 +388,13 @@ class AppClient extends Client {
     "app-administration-snippet",
     "app administration snippet"
   );
-  cmsBlocks = createRestEndpoint(this, "/app-cms-block", "app cms block");
+  cmsBlocks = createRestEndpoint(this, "app-cms-block", "app cms block");
   flowActions = createRestEndpoint(
     this,
     "app-flow-action",
     "app flow action"
   );
-  flowEvents = createRestEndpoint(this, "/app-flow-event", "app flow event");
+  flowEvents = createRestEndpoint(this, "app-flow-event", "app flow event");
   paymentMethods = createRestEndpoint(
     this,
     "app-payment-method",
@@ -410,30 +410,30 @@ class AppClient extends Client {
     "app-shipping-method",
     "app shipping method"
   );
-  templates = createRestEndpoint(this, "/app-template", "app template");
+  templates = createRestEndpoint(this, "app-template", "app template");
 }
 
 let CategoryClient$1 = class CategoryClient extends Client {
-  categories = createRestEndpoint(this, "/category", "category");
-  mainCategories = createRestEndpoint(this, "/main-category", "main category");
+  categories = createRestEndpoint(this, "category", "category");
+  mainCategories = createRestEndpoint(this, "main-category", "main category");
 };
 
 let ContentClient$1 = class ContentClient extends Client {
-  cmsBlocks = createRestEndpoint(this, "/cms-block", "cms block");
-  cmsPages = createRestEndpoint(this, "/cms-page", "cms page");
-  cmsSections = createRestEndpoint(this, "/cms-section", "cms section");
-  cmsSlots = createRestEndpoint(this, "/cms-slot", "cms slot");
-  landingPages = createRestEndpoint(this, "/landing-page", "landing page");
-  themes = createRestEndpoint(this, "/theme", "theme");
+  cmsBlocks = createRestEndpoint(this, "cms-block", "cms block");
+  cmsPages = createRestEndpoint(this, "cms-page", "cms page");
+  cmsSections = createRestEndpoint(this, "cms-section", "cms section");
+  cmsSlots = createRestEndpoint(this, "cms-slot", "cms slot");
+  landingPages = createRestEndpoint(this, "landing-page", "landing page");
+  themes = createRestEndpoint(this, "theme", "theme");
 };
 
 let CountryClient$1 = class CountryClient extends Client {
-  countries = createRestEndpoint(this, "/country", "country");
-  states = createRestEndpoint(this, "/country-state", "country-state");
+  countries = createRestEndpoint(this, "country", "country");
+  states = createRestEndpoint(this, "country-state", "country-state");
 };
 
 class CountryClient extends Client {
-  currencies = createRestEndpoint(this, "/currency", "currency");
+  currencies = createRestEndpoint(this, "currency", "currency");
   currencyRoundings = createRestEndpoint(
     this,
     "currency-country-rounding",
@@ -442,7 +442,7 @@ class CountryClient extends Client {
 }
 
 class CustomDataClient extends Client {
-  entities = createRestEndpoint(this, "/custom-entity", "custom entity");
+  entities = createRestEndpoint(this, "custom-entity", "custom entity");
   fieldSets = createRestEndpoint(
     this,
     "custom-field-set",
@@ -453,7 +453,7 @@ class CustomDataClient extends Client {
     "custom-field-set-relation",
     "custom field set relation"
   );
-  fields = createRestEndpoint(this, "/custom-field", "custom field");
+  fields = createRestEndpoint(this, "custom-field", "custom field");
 }
 
 class CustomerClient extends Client {
@@ -472,9 +472,9 @@ class CustomerClient extends Client {
     throw new ShopwareError("Failed to generate impersonation token", response);
   }
   /** Rest Endpoints **/
-  customers = createRestEndpoint(this, "/customer", "customer");
-  addresses = createRestEndpoint(this, "/address", "customer address");
-  groups = createRestEndpoint(this, "/customer-group", "customer group");
+  customers = createRestEndpoint(this, "customer", "customer");
+  addresses = createRestEndpoint(this, "address", "customer address");
+  groups = createRestEndpoint(this, "customer-group", "customer group");
   recoveries = createRestEndpoint(
     this,
     "customer-recovery",
@@ -493,7 +493,7 @@ class CustomerClient extends Client {
 }
 
 class DeliveryTimeClient extends Client {
-  deliveryTimes = createRestEndpoint(this, "/delivery-time", "delivery time");
+  deliveryTimes = createRestEndpoint(this, "delivery-time", "delivery time");
 }
 
 let DocumentClient$1 = class DocumentClient extends Client {
@@ -539,8 +539,22 @@ let DocumentClient$1 = class DocumentClient extends Client {
     if (response.statusCode === 200) return response.body.data;
     throw new ShopwareError("Failed to upload file from url", response);
   }
+  /**
+   * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
+   */
+  async download(id, deepLinkCode, download, fileType) {
+    const response = await this.get(`/_action/document/${id}/${deepLinkCode}`, {
+      query: { download, fileType },
+      headers: {
+        Accept: fileType === "pdf" ? "application/pdf" : fileType === "html" ? "text/html" : "application/octet-stream"
+      }
+    });
+    if (response.statusCode === 200)
+      return response.body.data;
+    throw new ShopwareError("Failed to download document", response);
+  }
   /** Rest Endpoints **/
-  documents = createRestEndpoint(this, "/document", "document");
+  documents = createRestEndpoint(this, "document", "document");
   documentTypes = createRestEndpoint(
     this,
     "document-type",
@@ -559,9 +573,9 @@ let DocumentClient$1 = class DocumentClient extends Client {
 };
 
 class FlowClient extends Client {
-  flows = createRestEndpoint(this, "/flow", "flow");
-  sequences = createRestEndpoint(this, "/flow-sequence", "flow sequence");
-  flowTemplates = createRestEndpoint(this, "/flow-template", "flow template");
+  flows = createRestEndpoint(this, "flow", "flow");
+  sequences = createRestEndpoint(this, "flow-sequence", "flow sequence");
+  flowTemplates = createRestEndpoint(this, "flow-template", "flow template");
 }
 
 class ImportExportClient extends Client {
@@ -583,12 +597,12 @@ class ImportExportClient extends Client {
 }
 
 class IntegrationClient extends Client {
-  integrations = createRestEndpoint(this, "/integration", "integration");
+  integrations = createRestEndpoint(this, "integration", "integration");
 }
 
 class LocaleClient extends Client {
-  locales = createRestEndpoint(this, "/locale", "locale");
-  languages = createRestEndpoint(this, "/language", "language");
+  locales = createRestEndpoint(this, "locale", "locale");
+  languages = createRestEndpoint(this, "language", "language");
 }
 
 class MailClient extends Client {
@@ -633,7 +647,7 @@ class MailClient extends Client {
     "header-footer",
     "mail header/footer"
   );
-  templates = createRestEndpoint(this, "/template", "mail template");
+  templates = createRestEndpoint(this, "template", "mail template");
   templateTypes = createRestEndpoint(
     this,
     "template-type",
@@ -670,13 +684,13 @@ class MediaClient extends Client {
     throw new ShopwareError("Failed to upload asset from url", response);
   }
   /** Rest Endpoints **/
-  media = createRestEndpoint(this, "/media", "media");
+  media = createRestEndpoint(this, "media", "media");
   defaultFolders = createRestEndpoint(
     this,
     "media-default-folder",
     "default media folder"
   );
-  folders = createRestEndpoint(this, "/media-folder", "media folder");
+  folders = createRestEndpoint(this, "media-folder", "media folder");
   folderConfigs = createRestEndpoint(
     this,
     "media-folder-configuration",
@@ -703,7 +717,7 @@ let NewsletterClient$1 = class NewsletterClient extends Client {
 };
 
 class NumberRangeClient extends Client {
-  numberRanges = createRestEndpoint(this, "/number-range", "number range");
+  numberRanges = createRestEndpoint(this, "number-range", "number range");
   numberRangeSalesChannels = createRestEndpoint(
     this,
     "number-range-sales-channel",
@@ -733,7 +747,7 @@ let OrderClient$1 = class OrderClient extends Client {
     });
     if (response.statusCode === 200)
       return response.body.data;
-    throw new ShopwareError("Failed to download merged document", response);
+    throw new ShopwareError("Failed to download merged documents", response);
   }
   /**
    * @param documentTypeName - The `technicalName` of the document type.
@@ -747,18 +761,6 @@ let OrderClient$1 = class OrderClient extends Client {
     if (response.statusCode === 200) return;
     throw new ShopwareError("Failed to create documents", response);
   }
-  /**
-   * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
-   */
-  async download(id, deepLinkCode, download) {
-    const response = await this.get(`/_action/document/${id}/download/${deepLinkCode}`, {
-      query: { download },
-      headers: { Accept: "application/octet-stream" }
-    });
-    if (response.statusCode === 200)
-      return response.body.data;
-    throw new ShopwareError("Failed to download merged document", response);
-  }
   /** Order Management **/
   /**
    * @throws {ShopwareError | import('ofetch').FetchError} if the request failed
@@ -817,16 +819,16 @@ let OrderClient$1 = class OrderClient extends Client {
     throw new ShopwareError("Failed to transition delivery state", response);
   }
   /** Rest Endpoints **/
-  orders = createRestEndpoint(this, "/order", "order");
-  addresses = createRestEndpoint(this, "/order-address", "order address");
-  customers = createRestEndpoint(this, "/order-customer", "order customer");
-  deliveries = createRestEndpoint(this, "/order-delivery", "order delivery");
+  orders = createRestEndpoint(this, "order", "order");
+  addresses = createRestEndpoint(this, "order-address", "order address");
+  customers = createRestEndpoint(this, "order-customer", "order customer");
+  deliveries = createRestEndpoint(this, "order-delivery", "order delivery");
   deliveryPositions = createRestEndpoint(
     this,
     "order-delivery-position",
     "order delivery position"
   );
-  lineItems = createRestEndpoint(this, "/order-line-item", "order line item");
+  lineItems = createRestEndpoint(this, "order-line-item", "order line item");
   lineItemDownloads = createRestEndpoint(
     this,
     "order-line-item-download",
@@ -863,11 +865,11 @@ class PaymentMethodClient extends Client {
 }
 
 class PluginClient extends Client {
-  plugins = createRestEndpoint(this, "/plugin", "plugin");
+  plugins = createRestEndpoint(this, "plugin", "plugin");
 }
 
 let ProductClient$1 = class ProductClient extends Client {
-  products = createRestEndpoint(this, "/product", "product");
+  products = createRestEndpoint(this, "product", "product");
   configuratorSettings = createRestEndpoint(
     this,
     "product-configurator-setting",
@@ -888,7 +890,7 @@ let ProductClient$1 = class ProductClient extends Client {
     "product-download",
     "product download"
   );
-  exports = createRestEndpoint(this, "/product-export", "product export");
+  exports = createRestEndpoint(this, "product-export", "product export");
   featureSets = createRestEndpoint(
     this,
     "product-feature-set",
@@ -904,9 +906,9 @@ let ProductClient$1 = class ProductClient extends Client {
     "product-manufacturer",
     "product manufacturer"
   );
-  media = createRestEndpoint(this, "/product-media", "product media");
-  prices = createRestEndpoint(this, "/product-price", "product price");
-  reviews = createRestEndpoint(this, "/product-review", "product review");
+  media = createRestEndpoint(this, "product-media", "product media");
+  prices = createRestEndpoint(this, "product-price", "product price");
+  reviews = createRestEndpoint(this, "product-review", "product review");
   searchConfigs = createRestEndpoint(
     this,
     "product-search-config",
@@ -922,8 +924,8 @@ let ProductClient$1 = class ProductClient extends Client {
     "product-search-keyword",
     "product search keyword"
   );
-  sortings = createRestEndpoint(this, "/product-sorting", "product sorting");
-  streams = createRestEndpoint(this, "/product-stream", "product stream");
+  sortings = createRestEndpoint(this, "product-sorting", "product sorting");
+  streams = createRestEndpoint(this, "product-stream", "product stream");
   streamFilters = createRestEndpoint(
     this,
     "product-stream-filter",
@@ -937,8 +939,8 @@ let ProductClient$1 = class ProductClient extends Client {
 };
 
 class PromotionClient extends Client {
-  promotions = createRestEndpoint(this, "/promotion", "promotion");
-  discounts = createRestEndpoint(this, "/promotion-discount", "discount");
+  promotions = createRestEndpoint(this, "promotion", "promotion");
+  discounts = createRestEndpoint(this, "promotion-discount", "discount");
   discountPrices = createRestEndpoint(
     this,
     "promotion-discount-price",
@@ -975,12 +977,12 @@ class PropertyGroupClient extends Client {
 }
 
 class RuleClient extends Client {
-  rules = createRestEndpoint(this, "/rule", "rule");
-  conditions = createRestEndpoint(this, "/rule-condition", "rule condition");
+  rules = createRestEndpoint(this, "rule", "rule");
+  conditions = createRestEndpoint(this, "rule-condition", "rule condition");
 }
 
 class SalesChannelClient extends Client {
-  salesChannels = createRestEndpoint(this, "/sales-channel", "sales channel");
+  salesChannels = createRestEndpoint(this, "sales-channel", "sales channel");
   analytics = createRestEndpoint(
     this,
     "sales-channel-analytics",
@@ -999,19 +1001,19 @@ class SalesChannelClient extends Client {
 }
 
 class SalutationClient extends Client {
-  salutations = createRestEndpoint(this, "/salutation", "salutation");
+  salutations = createRestEndpoint(this, "salutation", "salutation");
 }
 
 class ScriptClient extends Client {
-  scripts = createRestEndpoint(this, "/script", "script");
+  scripts = createRestEndpoint(this, "script", "script");
 }
 
 class SecurityClient extends Client {
-  aclRoles = createRestEndpoint(this, "/acl-role", "acl role");
+  aclRoles = createRestEndpoint(this, "acl-role", "acl role");
 }
 
 let SeoClient$1 = class SeoClient extends Client {
-  urls = createRestEndpoint(this, "/seo-url", "seo url");
+  urls = createRestEndpoint(this, "seo-url", "seo url");
   urlTemplates = createRestEndpoint(
     this,
     "seo-url-template",
@@ -1033,12 +1035,12 @@ class ShippingMethodClient extends Client {
 }
 
 class SnippetClient extends Client {
-  snippets = createRestEndpoint(this, "/snippet", "snippet");
-  sets = createRestEndpoint(this, "/snippet-set", "snippet set");
+  snippets = createRestEndpoint(this, "snippet", "snippet");
+  sets = createRestEndpoint(this, "snippet-set", "snippet set");
 }
 
 class StateMachineClient extends Client {
-  stateMachines = createRestEndpoint(this, "/state-machine", "state machine");
+  stateMachines = createRestEndpoint(this, "state-machine", "state machine");
   states = createRestEndpoint(
     this,
     "state-machine-state",
@@ -1222,8 +1224,8 @@ let SystemClient$1 = class SystemClient extends Client {
     throw new ShopwareError("Failed to clear invalidated caches", response);
   }
   /** Rest Endpoints **/
-  logsEntries = createRestEndpoint(this, "/log-entry", "log entry");
-  notifications = createRestEndpoint(this, "/notification", "notification");
+  logsEntries = createRestEndpoint(this, "log-entry", "log entry");
+  notifications = createRestEndpoint(this, "notification", "notification");
   configEntries = createRestEndpoint(
     this,
     "system-config",
@@ -1237,29 +1239,29 @@ let SystemClient$1 = class SystemClient extends Client {
 };
 
 class TagClient extends Client {
-  tags = createRestEndpoint(this, "/tag", "tag");
+  tags = createRestEndpoint(this, "tag", "tag");
 }
 
 class TaxClient extends Client {
-  taxes = createRestEndpoint(this, "/tax", "tax");
-  providers = createRestEndpoint(this, "/tax-provider", "tax provider");
-  rules = createRestEndpoint(this, "/tax-rule", "tax rule");
-  ruleTypes = createRestEndpoint(this, "/tax-rule-type", "tax rule type");
+  taxes = createRestEndpoint(this, "tax", "tax");
+  providers = createRestEndpoint(this, "tax-provider", "tax provider");
+  rules = createRestEndpoint(this, "tax-rule", "tax rule");
+  ruleTypes = createRestEndpoint(this, "tax-rule-type", "tax rule type");
 }
 
 class UnitClient extends Client {
-  units = createRestEndpoint(this, "/unit", "unit");
+  units = createRestEndpoint(this, "unit", "unit");
 }
 
 class UserClient extends Client {
-  users = createRestEndpoint(this, "/user", "user");
+  users = createRestEndpoint(this, "user", "user");
   accessKeys = createRestEndpoint(this, "user-access-key", "user access key");
-  userConfigs = createRestEndpoint(this, "/user-config", "user config");
-  userRecoveries = createRestEndpoint(this, "/user-recovery", "user recovery");
+  userConfigs = createRestEndpoint(this, "user-config", "user config");
+  userRecoveries = createRestEndpoint(this, "user-recovery", "user recovery");
 }
 
 class WebhookClient extends Client {
-  webhooks = createRestEndpoint(this, "/webhook", "webhook");
+  webhooks = createRestEndpoint(this, "webhook", "webhook");
   eventLogs = createRestEndpoint(
     this,
     "webhook-event-log",

package/dist/types/clients/admin/DocumentClient.d.ts

@@ -6,3 +6,4 @@ export interface UploadResponse {
     documentId?: string;
     documentDeepLink?: string;
 }
+export type DownloadResponse = Blob;

package/dist/types/clients/admin/OrderClient.d.ts

@@ -13,7 +13,6 @@ export type DocumentListCreateRequest = Array<{
     referencedDocumentId?: string;
     config?: ShopwareDocumentBaseConfig;
 }>;
-export type DownloadResponse = Blob;
 /** Order Management **/
 export interface StateTransitionRequest {
     sendMail?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devite/shopware-client",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "Third party API client for Shopware 6.",
   "repository": "devite-io/shopware-client",
   "license": "MIT",