@devite/shopware-client 1.0.1 → 1.1.0

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

@@ -0,0 +1,126 @@
+import { ShopwareDocument } from "#types/api/admin/document/ShopwareDocument";
+import { ShopwareDocumentBaseConfig } from "#types/api/admin/document/baseConfig/ShopwareDocumentBaseConfig";
+import { ShopwareDocumentBaseConfigSalesChannel } from "#types/api/admin/document/baseConfig/ShopwareDocumentBaseConfigSalesChannel";
+import { ShopwareDocumentType } from "#types/api/admin/document/ShopwareDocumentType";
+import { Criteria } from "#types/api/global/query/Criteria";
+import { Aggregation } from "#types/api/global/aggregation/Aggregation";
+/** Document Management **/
+export interface NumberReservationResponse {
+    number?: string;
+}
+export interface UploadResponse {
+    documentId?: string;
+    documentDeepLink?: string;
+}
+/** Documents **/
+export interface DocumentListResponse {
+    total?: number;
+    data?: Array<ShopwareDocument>;
+}
+export type DocumentCreateRequest = ShopwareDocument;
+export type DocumentCreateResponse = {
+    data: ShopwareDocument;
+};
+export type DocumentListSearchRequest = Criteria;
+export interface DocumentListSearchResponse {
+    total?: number;
+    data?: Array<ShopwareDocument>;
+}
+export interface DocumentSingleResponse {
+    data: ShopwareDocument;
+}
+export type DocumentUpdateRequest = ShopwareDocument;
+export type DocumentUpdateResponse = {
+    data: ShopwareDocument;
+};
+export interface DocumentAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface DocumentAggregationResponse {
+    total?: number;
+    data?: Array<ShopwareDocument>;
+}
+/** Document Base Configs **/
+export interface BaseConfigListResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentBaseConfig>;
+}
+export type BaseConfigCreateRequest = ShopwareDocumentBaseConfig;
+export type BaseConfigCreateResponse = {
+    data: ShopwareDocumentBaseConfig;
+};
+export type BaseConfigListSearchRequest = Criteria;
+export interface BaseConfigListSearchResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentBaseConfig>;
+}
+export interface BaseConfigSingleResponse {
+    data: ShopwareDocumentBaseConfig;
+}
+export type BaseConfigUpdateRequest = ShopwareDocumentBaseConfig;
+export type BaseConfigUpdateResponse = {
+    data: ShopwareDocumentBaseConfig;
+};
+export interface BaseConfigAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface BaseConfigAggregationResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentBaseConfig>;
+}
+/** Document Base Config Sales Channels **/
+export interface BaseConfigSalesChannelListResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentBaseConfigSalesChannel>;
+}
+export type BaseConfigSalesChannelCreateRequest = ShopwareDocumentBaseConfigSalesChannel;
+export type BaseConfigSalesChannelCreateResponse = {
+    data: ShopwareDocumentBaseConfigSalesChannel;
+};
+export type BaseConfigSalesChannelListSearchRequest = Criteria;
+export interface BaseConfigSalesChannelListSearchResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentBaseConfigSalesChannel>;
+}
+export interface BaseConfigSalesChannelSingleResponse {
+    data: ShopwareDocumentBaseConfigSalesChannel;
+}
+export type BaseConfigSalesChannelUpdateRequest = ShopwareDocumentBaseConfigSalesChannel;
+export type BaseConfigSalesChannelUpdateResponse = {
+    data: ShopwareDocumentBaseConfigSalesChannel;
+};
+export interface BaseConfigSalesChannelAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface BaseConfigSalesChannelAggregationResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentBaseConfigSalesChannel>;
+}
+/** Document Types **/
+export interface DocumentTypeListResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentType>;
+}
+export type DocumentTypeCreateRequest = ShopwareDocumentType;
+export type DocumentTypeCreateResponse = {
+    data: ShopwareDocumentType;
+};
+export type DocumentTypeListSearchRequest = Criteria;
+export interface DocumentTypeListSearchResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentType>;
+}
+export interface DocumentTypeSingleResponse {
+    data: ShopwareDocumentType;
+}
+export type DocumentTypeUpdateRequest = ShopwareDocumentType;
+export type DocumentTypeUpdateResponse = {
+    data: ShopwareDocumentType;
+};
+export interface DocumentTypeAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface DocumentTypeAggregationResponse {
+    total?: number;
+    data?: Array<ShopwareDocumentType>;
+}

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

@@ -0,0 +1,89 @@
+import { Flow } from "#types/api/admin/flow/Flow";
+import { FlowSequence } from "#types/api/admin/flow/FlowSequence";
+import { FlowTemplate } from "#types/api/admin/flow/FlowTemplate";
+import { Criteria } from "#types/api/global/query/Criteria";
+import { Aggregation } from "#types/api/global/aggregation/Aggregation";
+/** Flows **/
+export interface FlowListResponse {
+    total?: number;
+    data?: Array<Flow>;
+}
+export type FlowCreateRequest = Flow;
+export type FlowCreateResponse = {
+    data: Flow;
+};
+export type FlowListSearchRequest = Criteria;
+export interface FlowListSearchResponse {
+    total?: number;
+    data?: Array<Flow>;
+}
+export interface FlowSingleResponse {
+    data: Flow;
+}
+export type FlowUpdateRequest = Flow;
+export type FlowUpdateResponse = {
+    data: Flow;
+};
+export interface FlowAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface FlowAggregationResponse {
+    total?: number;
+    data?: Array<Flow>;
+}
+/** Flow Sequences **/
+export interface FlowSequenceListResponse {
+    total?: number;
+    data?: Array<FlowSequence>;
+}
+export type FlowSequenceCreateRequest = FlowSequence;
+export type FlowSequenceCreateResponse = {
+    data: FlowSequence;
+};
+export type FlowSequenceListSearchRequest = Criteria;
+export interface FlowSequenceListSearchResponse {
+    total?: number;
+    data?: Array<FlowSequence>;
+}
+export interface FlowSequenceSingleResponse {
+    data: FlowSequence;
+}
+export type FlowSequenceUpdateRequest = FlowSequence;
+export type FlowSequenceUpdateResponse = {
+    data: FlowSequence;
+};
+export interface FlowSequenceAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface FlowSequenceAggregationResponse {
+    total?: number;
+    data?: Array<FlowSequence>;
+}
+/** Flow Templates **/
+export interface FlowTemplateListResponse {
+    total?: number;
+    data?: Array<FlowTemplate>;
+}
+export type FlowTemplateCreateRequest = FlowTemplate;
+export type FlowTemplateCreateResponse = {
+    data: FlowTemplate;
+};
+export type FlowTemplateListSearchRequest = Criteria;
+export interface FlowTemplateListSearchResponse {
+    total?: number;
+    data?: Array<FlowTemplate>;
+}
+export interface FlowTemplateSingleResponse {
+    data: FlowTemplate;
+}
+export type FlowTemplateUpdateRequest = FlowTemplate;
+export type FlowTemplateUpdateResponse = {
+    data: FlowTemplate;
+};
+export interface FlowTemplateAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface FlowTemplateAggregationResponse {
+    total?: number;
+    data?: Array<FlowTemplate>;
+}

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

@@ -0,0 +1,89 @@
+import { ImportExportFile } from "#types/api/admin/importExport/ImportExportFile";
+import { ImportExportLog } from "#types/api/admin/importExport/ImportExportLog";
+import { ImportExportProfile } from "#types/api/admin/importExport/ImportExportProfile";
+import { Criteria } from "#types/api/global/query/Criteria";
+import { Aggregation } from "#types/api/global/aggregation/Aggregation";
+/** Files **/
+export interface FileListResponse {
+    total?: number;
+    data?: Array<ImportExportFile>;
+}
+export type FileCreateRequest = ImportExportFile;
+export type FileCreateResponse = {
+    data: ImportExportFile;
+};
+export type FileListSearchRequest = Criteria;
+export interface FileListSearchResponse {
+    total?: number;
+    data?: Array<ImportExportFile>;
+}
+export interface FileSingleResponse {
+    data: ImportExportFile;
+}
+export type FileUpdateRequest = ImportExportFile;
+export type FileUpdateResponse = {
+    data: ImportExportFile;
+};
+export interface FileAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface FileAggregationResponse {
+    total?: number;
+    data?: Array<ImportExportFile>;
+}
+/** Logs **/
+export interface LogListResponse {
+    total?: number;
+    data?: Array<ImportExportLog>;
+}
+export type LogCreateRequest = ImportExportLog;
+export type LogCreateResponse = {
+    data: ImportExportLog;
+};
+export type LogListSearchRequest = Criteria;
+export interface LogListSearchResponse {
+    total?: number;
+    data?: Array<ImportExportLog>;
+}
+export interface LogSingleResponse {
+    data: ImportExportLog;
+}
+export type LogUpdateRequest = ImportExportLog;
+export type LogUpdateResponse = {
+    data: ImportExportLog;
+};
+export interface LogAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface LogAggregationResponse {
+    total?: number;
+    data?: Array<ImportExportLog>;
+}
+/** Profiles **/
+export interface ProfileListResponse {
+    total?: number;
+    data?: Array<ImportExportProfile>;
+}
+export type ProfileCreateRequest = ImportExportProfile;
+export type ProfileCreateResponse = {
+    data: ImportExportProfile;
+};
+export type ProfileListSearchRequest = Criteria;
+export interface ProfileListSearchResponse {
+    total?: number;
+    data?: Array<ImportExportProfile>;
+}
+export interface ProfileSingleResponse {
+    data: ImportExportProfile;
+}
+export type ProfileUpdateRequest = ImportExportProfile;
+export type ProfileUpdateResponse = {
+    data: ImportExportProfile;
+};
+export interface ProfileAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface ProfileAggregationResponse {
+    total?: number;
+    data?: Array<ImportExportProfile>;
+}

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

@@ -0,0 +1,30 @@
+import { Integration } from "#types/api/admin/integration/Integration";
+import { Criteria } from "#types/api/global/query/Criteria";
+import { Aggregation } from "#types/api/global/aggregation/Aggregation";
+export interface IntegrationListResponse {
+    total?: number;
+    data?: Array<Integration>;
+}
+export type IntegrationCreateRequest = Integration;
+export type IntegrationCreateResponse = {
+    data: Integration;
+};
+export type IntegrationListSearchRequest = Criteria;
+export interface IntegrationListSearchResponse {
+    total?: number;
+    data?: Array<Integration>;
+}
+export interface IntegrationSingleResponse {
+    data: Integration;
+}
+export type IntegrationUpdateRequest = Integration;
+export type IntegrationUpdateResponse = {
+    data: Integration;
+};
+export interface IntegrationAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface IntegrationAggregationResponse {
+    total?: number;
+    data?: Array<Integration>;
+}

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

@@ -0,0 +1,60 @@
+import { Locale } from "#types/api/admin/locale/Locale";
+import { Language } from "#types/api/admin/locale/Language";
+import { Criteria } from "#types/api/global/query/Criteria";
+import { Aggregation } from "#types/api/global/aggregation/Aggregation";
+/** Locales **/
+export interface LocaleListResponse {
+    total?: number;
+    data?: Array<Locale>;
+}
+export type LocaleCreateRequest = Locale;
+export type LocaleCreateResponse = {
+    data: Locale;
+};
+export type LocaleListSearchRequest = Criteria;
+export interface LocaleListSearchResponse {
+    total?: number;
+    data?: Array<Locale>;
+}
+export interface LocaleSingleResponse {
+    data: Locale;
+}
+export type LocaleUpdateRequest = Locale;
+export type LocaleUpdateResponse = {
+    data: Locale;
+};
+export interface LocaleAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface LocaleAggregationResponse {
+    total?: number;
+    data?: Array<Locale>;
+}
+/** Languages **/
+export interface LanguageListResponse {
+    total?: number;
+    data?: Array<Language>;
+}
+export type LanguageCreateRequest = Language;
+export type LanguageCreateResponse = {
+    data: Language;
+};
+export type LanguageListSearchRequest = Criteria;
+export interface LanguageListSearchResponse {
+    total?: number;
+    data?: Array<Language>;
+}
+export interface LanguageSingleResponse {
+    data: Language;
+}
+export type LanguageUpdateRequest = Language;
+export type LanguageUpdateResponse = {
+    data: Language;
+};
+export interface LanguageAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface LanguageAggregationResponse {
+    total?: number;
+    data?: Array<Language>;
+}

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

@@ -0,0 +1,125 @@
+import { MailHeaderFooter } from "#types/api/admin/mail/MailHeaderFooter";
+import { MailTemplate } from "#types/api/admin/mail/template/MailTemplate";
+import { MailTemplateType } from "#types/api/admin/mail/template/MailTemplateType";
+import { Criteria } from "#types/api/global/query/Criteria";
+import { Aggregation } from "#types/api/global/aggregation/Aggregation";
+/** Operations **/
+export interface MailSendRequest {
+    recipients: Record<string, string>;
+    salesChannelId: string;
+    contentHtml: string;
+    contentPlain: string;
+    subject: string;
+    senderName: string;
+    senderEmail?: string;
+    mediaIds?: Array<string>;
+    binAttachments?: Array<{
+        content?: string;
+        fileName?: string;
+        mimeType?: string;
+    }>;
+    recipientsBcc?: Record<string, string>;
+    recipientsCc?: Record<string, string>;
+    replyTo?: Record<string, string>;
+    returnPath?: Record<string, string>;
+}
+export interface MailSendResponse {
+    size?: number;
+}
+export interface ContentValidationRequest {
+    contentHtml: string;
+    contentPlain: string;
+}
+export interface TemplatePreviewRequest {
+    mailTemplateType: {
+        templateData?: object;
+    };
+    mailTemplate: {
+        contentHtml?: string;
+    };
+}
+export type TemplatePreviewResponse = string;
+/** Header Footers **/
+export interface HeaderFooterListResponse {
+    total?: number;
+    data?: Array<MailHeaderFooter>;
+}
+export type HeaderFooterCreateRequest = MailHeaderFooter;
+export type HeaderFooterCreateResponse = {
+    data: MailHeaderFooter;
+};
+export type HeaderFooterListSearchRequest = Criteria;
+export interface HeaderFooterListSearchResponse {
+    total?: number;
+    data?: Array<MailHeaderFooter>;
+}
+export interface HeaderFooterSingleResponse {
+    data: MailHeaderFooter;
+}
+export type HeaderFooterUpdateRequest = MailHeaderFooter;
+export type HeaderFooterUpdateResponse = {
+    data: MailHeaderFooter;
+};
+export interface HeaderFooterAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface HeaderFooterAggregationResponse {
+    total?: number;
+    data?: Array<MailHeaderFooter>;
+}
+/** Templates **/
+export interface TemplateListResponse {
+    total?: number;
+    data?: Array<MailTemplate>;
+}
+export type TemplateCreateRequest = MailTemplate;
+export type TemplateCreateResponse = {
+    data: MailTemplate;
+};
+export type TemplateListSearchRequest = Criteria;
+export interface TemplateListSearchResponse {
+    total?: number;
+    data?: Array<MailTemplate>;
+}
+export interface TemplateSingleResponse {
+    data: MailTemplate;
+}
+export type TemplateUpdateRequest = MailTemplate;
+export type TemplateUpdateResponse = {
+    data: MailTemplate;
+};
+export interface TemplateAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface TemplateAggregationResponse {
+    total?: number;
+    data?: Array<MailTemplate>;
+}
+/** Template Types **/
+export interface TemplateTypeListResponse {
+    total?: number;
+    data?: Array<MailTemplateType>;
+}
+export type TemplateTypeCreateRequest = MailTemplateType;
+export type TemplateTypeCreateResponse = {
+    data: MailTemplateType;
+};
+export type TemplateTypeListSearchRequest = Criteria;
+export interface TemplateTypeListSearchResponse {
+    total?: number;
+    data?: Array<MailTemplateType>;
+}
+export interface TemplateTypeSingleResponse {
+    data: MailTemplateType;
+}
+export type TemplateTypeUpdateRequest = MailTemplateType;
+export type TemplateTypeUpdateResponse = {
+    data: MailTemplateType;
+};
+export interface TemplateTypeAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface TemplateTypeAggregationResponse {
+    total?: number;
+    data?: Array<MailTemplateType>;
+}

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

@@ -0,0 +1,176 @@
+import { Media } from "#types/api/admin/media/Media";
+import { MediaDefaultFolder } from "#types/api/admin/media/folder/MediaDefaultFolder";
+import { MediaFolder } from "#types/api/admin/media/folder/MediaFolder";
+import { MediaFolderConfiguration } from "#types/api/admin/media/folder/configuration/MediaFolderConfiguration";
+import { MediaThumbnail } from "#types/api/admin/media/thumbnail/MediaThumbnail";
+import { MediaThumbnailSize } from "#types/api/admin/media/thumbnail/MediaThumbnailSize";
+import { Criteria } from "#types/api/global/query/Criteria";
+import { Aggregation } from "#types/api/global/aggregation/Aggregation";
+/** Media **/
+export interface MediaListResponse {
+    total?: number;
+    data?: Array<Media>;
+}
+export type MediaCreateRequest = Media;
+export type MediaCreateResponse = {
+    data: Media;
+};
+export type MediaListSearchRequest = Criteria;
+export interface MediaListSearchResponse {
+    total?: number;
+    data?: Array<Media>;
+}
+export interface MediaSingleResponse {
+    data: Media;
+}
+export type MediaUpdateRequest = Media;
+export type MediaUpdateResponse = {
+    data: Media;
+};
+export interface MediaAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface MediaAggregationResponse {
+    total?: number;
+    data?: Array<Media>;
+}
+/** Default Folders **/
+export interface DefaultFolderListResponse {
+    total?: number;
+    data?: Array<MediaDefaultFolder>;
+}
+export type DefaultFolderCreateRequest = MediaDefaultFolder;
+export type DefaultFolderCreateResponse = {
+    data: MediaDefaultFolder;
+};
+export type DefaultFolderListSearchRequest = Criteria;
+export interface DefaultFolderListSearchResponse {
+    total?: number;
+    data?: Array<MediaDefaultFolder>;
+}
+export interface DefaultFolderSingleResponse {
+    data: MediaDefaultFolder;
+}
+export type DefaultFolderUpdateRequest = MediaDefaultFolder;
+export type DefaultFolderUpdateResponse = {
+    data: MediaDefaultFolder;
+};
+export interface DefaultFolderAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface DefaultFolderAggregationResponse {
+    total?: number;
+    data?: Array<MediaDefaultFolder>;
+}
+/** Folders **/
+export interface FolderListResponse {
+    total?: number;
+    data?: Array<MediaFolder>;
+}
+export type FolderCreateRequest = MediaFolder;
+export type FolderCreateResponse = {
+    data: MediaFolder;
+};
+export type FolderListSearchRequest = Criteria;
+export interface FolderListSearchResponse {
+    total?: number;
+    data?: Array<MediaFolder>;
+}
+export interface FolderSingleResponse {
+    data: MediaFolder;
+}
+export type FolderUpdateRequest = MediaFolder;
+export type FolderUpdateResponse = {
+    data: MediaFolder;
+};
+export interface FolderAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface FolderAggregationResponse {
+    total?: number;
+    data?: Array<MediaFolder>;
+}
+/** Folder Configs **/
+export interface FolderConfigListResponse {
+    total?: number;
+    data?: Array<MediaFolderConfiguration>;
+}
+export type FolderConfigCreateRequest = MediaFolderConfiguration;
+export type FolderConfigCreateResponse = {
+    data: MediaFolderConfiguration;
+};
+export type FolderConfigListSearchRequest = Criteria;
+export interface FolderConfigListSearchResponse {
+    total?: number;
+    data?: Array<MediaFolderConfiguration>;
+}
+export interface FolderConfigSingleResponse {
+    data: MediaFolderConfiguration;
+}
+export type FolderConfigUpdateRequest = MediaFolderConfiguration;
+export type FolderConfigUpdateResponse = {
+    data: MediaFolderConfiguration;
+};
+export interface FolderConfigAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface FolderConfigAggregationResponse {
+    total?: number;
+    data?: Array<MediaFolderConfiguration>;
+}
+/** Thumbnails **/
+export interface ThumbnailListResponse {
+    total?: number;
+    data?: Array<MediaThumbnail>;
+}
+export type ThumbnailCreateRequest = MediaThumbnail;
+export type ThumbnailCreateResponse = {
+    data: MediaThumbnail;
+};
+export type ThumbnailListSearchRequest = Criteria;
+export interface ThumbnailListSearchResponse {
+    total?: number;
+    data?: Array<MediaThumbnail>;
+}
+export interface ThumbnailSingleResponse {
+    data: MediaThumbnail;
+}
+export type ThumbnailUpdateRequest = MediaThumbnail;
+export type ThumbnailUpdateResponse = {
+    data: MediaThumbnail;
+};
+export interface ThumbnailAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface ThumbnailAggregationResponse {
+    total?: number;
+    data?: Array<MediaThumbnail>;
+}
+/** Thumbnail Sizes **/
+export interface ThumbnailSizeListResponse {
+    total?: number;
+    data?: Array<MediaThumbnailSize>;
+}
+export type ThumbnailSizeCreateRequest = MediaThumbnailSize;
+export type ThumbnailSizeCreateResponse = {
+    data: MediaThumbnailSize;
+};
+export type ThumbnailSizeListSearchRequest = Criteria;
+export interface ThumbnailSizeListSearchResponse {
+    total?: number;
+    data?: Array<MediaThumbnailSize>;
+}
+export interface ThumbnailSizeSingleResponse {
+    data: MediaThumbnailSize;
+}
+export type ThumbnailSizeUpdateRequest = MediaThumbnailSize;
+export type ThumbnailSizeUpdateResponse = {
+    data: MediaThumbnailSize;
+};
+export interface ThumbnailSizeAggregationRequest {
+    aggregations: Array<Aggregation>;
+}
+export interface ThumbnailSizeAggregationResponse {
+    total?: number;
+    data?: Array<MediaThumbnailSize>;
+}