@plentymarkets/shop-api 0.88.0

package/server/api/doApplyConfiguration/index.d.ts

@@ -0,0 +1,20 @@
+import { Data } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doApplyConfiguration - Apply current configuration.
+ *
+ * @remarks
+ * * Calls /rest/storefront/deploy
+ * * This method is used to apply the current configuration.
+ *
+ * @param requireBuild - If true, the configuration is applied and the storefront is rebuilt.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doApplyConfiguration(true);
+ * ```
+ */
+export declare const doApplyConfiguration: (context: PlentysystemsIntegrationContext, requireBuild?: boolean) => Promise<Data<string>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doApplyConfiguration/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doApplyConfiguration/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACvC,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,oBAAoB,YACtB,+BAA+B,iBAC1B,OAAO,KACpB,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAStB,CAAC"}

package/server/api/doApprovePayPalTransaction/index.d.ts

@@ -0,0 +1,26 @@
+import { Data, PayPalApproveOrder, PayPalApproveTransactionParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doApprovePayPalTransaction - checks the PayPal transaction and approves it.
+ *
+ * @remarks
+ * * Calls /rest/payment/payPal/smart_payment/{params.transactionId}/{params.payerId}/capture
+ * * This method is used to approve the PayPal transaction.
+ * * It will only change the status of the PayPal transaction if the user has approved the transaction on the PayPal side.
+ *
+ * @param { PayPalApproveTransactionParams } params
+ * transactionId: string - The transaction ID of the PayPal transaction.
+ * payerId: string - The PayPal payer ID of the PayPal transaction.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doApprovePayPalTransaction({
+ *     transactionId: '7PE78730EB4411431',
+ *     payerId: 'A676SPCN9SBDQ'
+ * });
+ * ```
+ */
+export declare const doApprovePayPalTransaction: (context: PlentysystemsIntegrationContext, params: PayPalApproveTransactionParams) => Promise<Data<PayPalApproveOrder>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doApprovePayPalTransaction/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doApprovePayPalTransaction/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,8BAA8B,EAAE,MAAM,iBAAiB,CAAC;AAC3F,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,0BAA0B,YAE1B,+BAA+B,UAChC,8BAA8B,KACrC,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAelC,CAAC"}

package/server/api/doCapturePayPalOrder/index.d.ts

@@ -0,0 +1,28 @@
+import { Data, PayPalApproveOrder, PayPalCaptureOrderParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doCapturePayPalOrder - (re-)captures a PayPal order.
+ *
+ * @remarks
+ * * Calls for capturing /rest/payment/payPal/smart_payment/{params.paypalOrderId}/{params.paypalPayerId}/capture
+ * * Calls for re-capturing /rest/payment/payPal/smart_payment/${params.paypalOrderId}/${params.paypalPayerId}/${params.plentyOrderId}/reinit_capture_order
+ * * This method is used to (re-)capture a PayPal order.
+ * * Response can have an error string, which is a human-readable error message.
+ *
+ * @param { PayPalCaptureOrderParams } params
+ * paypalOrderId: string - The PayPal order ID of the PayPal order.
+ * paypalPayerId: string - The PayPal payer ID of the PayPal order.
+ * plentyOrderId?: number - The order ID
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doCapturePayPalOrder({
+ *    paypalOrderId: '7PE78730EB4411431',
+ *    paypalPayerId: 'A676SPCN9SBDQ',
+ * });
+ * ```
+ */
+export declare const doCapturePayPalOrder: (context: PlentysystemsIntegrationContext, params: PayPalCaptureOrderParams) => Promise<Data<PayPalApproveOrder>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doCapturePayPalOrder/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doCapturePayPalOrder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AACrF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,oBAAoB,YACtB,+BAA+B,UAChC,wBAAwB,KAC/B,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAYlC,CAAC"}

package/server/api/doChangeUserPassword/index.d.ts

@@ -0,0 +1,24 @@
+import { Data, UserChangePasswordParams, UserChangeResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doChangeUserPassword - changes user password
+ *
+ * @remarks
+ * * Calls /rest/io/customer/password/
+ * * This method is used to change the password of the logged-in user.
+ *
+ * @param { UserChangePasswordParams } params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doChangeUserPassword({
+ *     oldPassword: 'Testuser1234',
+ *     password: 'Testuser1234',
+ *     password2: 'Testuser1234'
+ * });
+ * ```
+ */
+export declare const doChangeUserPassword: (context: PlentysystemsIntegrationContext, params: UserChangePasswordParams) => Promise<Data<UserChangeResponse>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doChangeUserPassword/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doChangeUserPassword/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACrF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,oBAAoB,YACtB,+BAA+B,UAChC,wBAAwB,KAC/B,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAQlC,CAAC"}

package/server/api/doCreatePayPalCreditCardTransaction/index.d.ts

@@ -0,0 +1,22 @@
+import { Data, PayPalCreditCardTransaction } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doCreatePayPalCreditCardTransaction - creates a PayPal credit card transaction.
+ *
+ * @remarks
+ * * Calls /rest/payment/payPal/smart_payment/create_order
+ * * This method creates a PayPal credit card transaction.
+ *
+ * @returns
+ * id: string = The ID of the PayPal credit card transaction.
+ * status: string = The status of the PayPal credit card transaction, e.g. CREATED
+ * links: PayPalLink[] = Links to the PayPal credit card transaction.
+ * payPalPayerId: string = The PayPal payer ID of the PayPal credit card transaction.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doCreatePayPalCreditCardTransaction();
+ * ```
+ */
+export declare const doCreatePayPalCreditCardTransaction: (context: PlentysystemsIntegrationContext) => Promise<Data<PayPalCreditCardTransaction>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doCreatePayPalCreditCardTransaction/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doCreatePayPalCreditCardTransaction/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AACpE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,mCAAmC,YAC9B,+BAA+B,KAAG,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAW1F,CAAC"}

package/server/api/doCreatePayPalTransaction/index.d.ts

@@ -0,0 +1,21 @@
+import { Data, PayPalCreateOrder, PayPalCreateTransactionParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doCreatePayPalTransaction - creates a PayPal transaction from the current cart
+ *
+ * @remarks
+ * * Calls /rest/payment/payPal/smart_payment/create/{params.fundingSource}/
+ * * This method is used to create a PayPal transaction from the current cart.
+ *
+ * @param { PayPalCreateTransactionParams } params
+ * fundingSource: string - PayPal funding source
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doCreatePayPalTransaction({ fundingSource: 'paypal' });
+ * ```
+ */
+export declare const doCreatePayPalTransaction: (context: PlentysystemsIntegrationContext, params: PayPalCreateTransactionParams) => Promise<Data<PayPalCreateOrder>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doCreatePayPalTransaction/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doCreatePayPalTransaction/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iBAAiB,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AACzF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,yBAAyB,YAEzB,+BAA+B,UAChC,6BAA6B,KACpC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAWjC,CAAC"}

package/server/api/doCustomerContactMail/index.d.ts

@@ -0,0 +1,27 @@
+import { CustomerContactEmailParams, Data } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doCustomerContactMail - process customer contact request.
+ * ##  *! ROUTE IS NOT FUNCTIONAL*
+ * This is route is not functional because reCAPTCHA is not implemented yet.
+ *
+ * @remarks
+ * * Calls /rest/io/customer/contact/mail/
+ * * This method is used to send the contact request.
+ *
+ * @param { CustomerContactEmailParams } params
+ * name: string - The name of the sender.
+ * email: string - The email of the sender.
+ * message: string - The message.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await sdk.boilerplate.doCustomerContactMail({
+ *   name: '',
+ *   email: '',
+ *   message: '',
+ * });
+ * ```
+ */
+export declare const doCustomerContactMail: (context: PlentysystemsIntegrationContext, params: CustomerContactEmailParams) => Promise<Data<null>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doCustomerContactMail/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doCustomerContactMail/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,0BAA0B,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,qBAAqB,YACvB,+BAA+B,UAChC,0BAA0B,KACjC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAMpB,CAAC"}

package/server/api/doEmailConfirmation/index.d.ts

@@ -0,0 +1,22 @@
+import { Data, NewsletterEmailConfirmationParams, PlentysystemsIntegrationContext } from '../../types';
+/**
+ * Method doEmailConfirmation - Confirm newsletter email
+ *
+ * @remarks
+ * * Calls /rest/storefront/newsletter-opt-in
+ * * This method is used to confirm email address
+ *
+ * @param { NewsletterEmailConfirmationParams } params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doEmailConfirmation({
+ *       newsletterEmailId: '10',
+ *       authString: 'dkadjkaJKSDASKJ#3290DAS'
+ * });
+ * ```
+ */
+export declare const doEmailConfirmation: (context: PlentysystemsIntegrationContext, params: NewsletterEmailConfirmationParams) => Promise<Data<boolean>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doEmailConfirmation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doEmailConfirmation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,iCAAiC,EACjC,+BAA+B,EAChC,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;;;;;GAkBG;AAEH,eAAO,MAAM,mBAAmB,YACrB,+BAA+B,UAChC,iCAAiC,KACxC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAYvB,CAAC"}

package/server/api/doExecutePayment/index.d.ts

@@ -0,0 +1,27 @@
+import { Data, ExecutePaymentParams, GetPaymentResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doExecutePayment - Used to execute the payment.
+ *
+ * @remarks
+ * * Calls /rest/storefront/checkout/payment/execute
+ * * Method should be used to execute the payment.
+ *
+ * @param { ExecutePaymentParams } params
+ * orderId: number,
+ * paymentId: number,
+ *
+ * @returns
+ * type: null,
+ * value: null
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doExecutePayment({
+ *   orderId: 1123,
+ *   paymentId: 123
+ * });
+ * ```
+ */
+export declare const doExecutePayment: (context: PlentysystemsIntegrationContext, params: ExecutePaymentParams) => Promise<Data<GetPaymentResponse>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doExecutePayment/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doExecutePayment/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,gBAAgB,YAClB,+BAA+B,UAChC,oBAAoB,KAC3B,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAWlC,CAAC"}

package/server/api/doHandleAllowPaymentApplePay/index.d.ts

@@ -0,0 +1,19 @@
+import { Data, PayPalAllowApplePayRequest } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doHandleAllowPaymentApplePay - Used to allow payment for Apple Pay.
+ *
+ * @remarks
+ * * Calls /rest/payment/payPal/applePay/handle_allowed
+ * * Used to update the availability for Apple Pay.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doHandleAllowPaymentApplePay({
+ *  canMakePayments: true,
+ * });
+ * ```
+ * @param params PayPalAllowApplePayRequest
+ */
+export declare const doHandleAllowPaymentApplePay: (context: PlentysystemsIntegrationContext, params: PayPalAllowApplePayRequest) => Promise<Data<[]>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doHandleAllowPaymentApplePay/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doHandleAllowPaymentApplePay/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,4BAA4B,YAC9B,+BAA+B,UAChC,0BAA0B,KACjC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAQlB,CAAC"}

package/server/api/doHandleAllowPaymentGooglePay/index.d.ts

@@ -0,0 +1,19 @@
+import { Data, PayPalAllowGooglePayResponse, PayPalGooglePayPaymentMethods } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doHandleAllowPaymentGooglePay - Used to allow payment for Google Pay.
+ *
+ * @remarks
+ * * Calls /rest/payment/payPal/googlePay/handle_allowed_payment_methods
+ * * Used to update the availability for Google Pay.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doHandleAllowPaymentGooglePay({
+ *  allowedPaymentMethods: []
+ * });
+ * ```
+ * @param params PayPalGooglePayPaymentMethods
+ */
+export declare const doHandleAllowPaymentGooglePay: (context: PlentysystemsIntegrationContext, params: PayPalGooglePayPaymentMethods) => Promise<Data<PayPalAllowGooglePayResponse>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doHandleAllowPaymentGooglePay/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doHandleAllowPaymentGooglePay/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,4BAA4B,EAAE,6BAA6B,EAAE,MAAM,iBAAiB,CAAC;AACpG,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,6BAA6B,YAC/B,+BAA+B,UAChC,6BAA6B,KACpC,OAAO,CAAC,IAAI,CAAC,4BAA4B,CAAC,CAQ5C,CAAC"}

package/server/api/doLogin/index.d.ts

@@ -0,0 +1,23 @@
+import { Data, LoginParams, UserChangeResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doLogin - logs in as user with email and password
+ *
+ * @remarks
+ *
+ * Calls /rest/storefront/contact/login/
+ * This method should be used when a customer wants to log in with email and password.
+ *
+ * @param params
+ * email: string - customer's email
+ * password: string - customer's password
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * await useSdk().plentysystems.doLogin({ email: email, password: password});
+ * ```
+ */
+export declare const doLogin: (context: PlentysystemsIntegrationContext, params: LoginParams) => Promise<Data<UserChangeResponse>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doLogin/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doLogin/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACxE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,OAAO,YACT,+BAA+B,UAChC,WAAW,KAClB,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAWlC,CAAC"}

package/server/api/doLoginAsGuest/index.d.ts

@@ -0,0 +1,21 @@
+import { Data, LoginAsGuestParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doLoginAsGuest - logs in as a guest.
+ *
+ * @remarks
+ * * Calls /rest/storefront/guest/
+ * * This method should be used when a customer wants to log in as a guest.
+ *
+ * @param { LoginAsGuestParams } params
+ * email: string - customer's email
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * await useSdk().plentysystems.doLoginAsGuest({email: 'guest.plenty@example.com'});
+ * ```
+ */
+export declare const doLoginAsGuest: (context: PlentysystemsIntegrationContext, params: LoginAsGuestParams) => Promise<Data<null>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doLoginAsGuest/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doLoginAsGuest/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,cAAc,YAChB,+BAA+B,UAChC,kBAAkB,KACzB,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAQpB,CAAC"}

package/server/api/doLogoutUser/index.d.ts

@@ -0,0 +1,18 @@
+import { Data } from 'src/types';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doLogoutUser - Logs out the currently logged-in user/guest.
+ *
+ * @remarks
+ * * Calls /rest/storefront/contact/logout/
+ * * This method can be used to log out the currently logged-in user/guest.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * await useSdk().plentysystems.doLogoutUser();
+ * ```
+ */
+export declare const doLogoutUser: (context: PlentysystemsIntegrationContext) => Promise<Data<null>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doLogoutUser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doLogoutUser/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,YACd,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CASpB,CAAC"}

package/server/api/doMakeOrderReturn/index.d.ts

@@ -0,0 +1,28 @@
+import { Data, MakeOrderReturnParams, Order } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doMakeOrderReturn - Used to execute the order return.
+ *
+ * @remarks
+ * * Calls /rest/storefront/returns
+ * * Method should be used to execute the order return.
+ *
+ * @param { MakeOrderReturnParams } params
+ * params: a string derived from the url of the order
+ *
+ * @returns Order
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doMakeOrderReturn({
+ *   orderId: 123456,
+ *   orderAccessKey: 'ABCDEFGH',
+ *   110: {
+ *     quantitiy: 2,
+ *     returnReasonId: 1,
+ *   }
+ * });
+ * ```
+ */
+export declare const doMakeOrderReturn: (context: PlentysystemsIntegrationContext, params: MakeOrderReturnParams) => Promise<Data<Order>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doMakeOrderReturn/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doMakeOrderReturn/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,qBAAqB,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACrE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,iBAAiB,YACnB,+BAA+B,UAChC,qBAAqB,KAC5B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAMrB,CAAC"}

package/server/api/doMigrateGuestOrderToCustomer/index.d.ts

@@ -0,0 +1,29 @@
+import { Data, MigrateGuestOrderToCustomerParams, Order } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doMigrateGuestOrderToCustomer - Used to migrate a guest order to the logged-in customer.
+ *
+ * @remarks
+ * * Calls /rest/storefront/order/migrate-guest
+ * * Method should be used to migrate a guest order to the logged-in customer.
+ *
+ * @param { MakeOrderReturnParams } params
+ * orderId: number - The ID of the order to be migrated.
+ * accessKey: string - The access key of the order to be migrated.
+ * postcodes: string - The postcode of the order for validation.
+ * name: string - The lastname of the order for validation.
+ *
+ * @returns Order
+ *
+ * @example
+ * ``` ts
+ * const { data, error } = await useSdk().plentysystems.doMigrateGuestOrderToCustomer({
+ *   orderId: 123456,
+ *   orderAccessKey: 'ABCDEFGH',
+ *   postcode: '12345',
+ *   name: 'Doe'
+ * });
+ * ```
+ */
+export declare const doMigrateGuestOrderToCustomer: (context: PlentysystemsIntegrationContext, params: MigrateGuestOrderToCustomerParams) => Promise<Data<Order>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doMigrateGuestOrderToCustomer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doMigrateGuestOrderToCustomer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,iCAAiC,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,6BAA6B,YAC/B,+BAA+B,UAChC,iCAAiC,KACxC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAMrB,CAAC"}

package/server/api/doOrderAgainInformation/index.d.ts

@@ -0,0 +1,23 @@
+import { Data, GetOrderAgainInformationParams, GetOrderAgainInformationResponse } from '../../types/api';
+import { type PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doOrderAgainInformation - Used to get the order with the current prices.
+ *
+ * @remarks
+ * * Calls /rest/storefront/orders/order-again-information
+ * * This method is used to get the order with the current prices.
+ *
+ * @param { GetOrderAgainInformationParams } params
+ *
+ * @returns { Data<GetOrderAgainInformationResponse> }
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doOrderAgainInformation({
+ *     orderId: "12345",
+ *     accessKey: "ABC123"
+ * });
+ * ```
+ */
+export declare const doOrderAgainInformation: (context: PlentysystemsIntegrationContext, params: GetOrderAgainInformationParams) => Promise<Data<GetOrderAgainInformationResponse>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doOrderAgainInformation/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doOrderAgainInformation/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,8BAA8B,EAC9B,gCAAgC,EACjC,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAE3E;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,uBAAuB,YACzB,+BAA+B,UAChC,8BAA8B,KACrC,OAAO,CAAC,IAAI,CAAC,gCAAgC,CAAC,CAQhD,CAAC"}

package/server/api/doPlaceOrder/index.d.ts

@@ -0,0 +1,18 @@
+import { Data, Order } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doPlaceOrder - Used to place an order.
+ *
+ * @remarks
+ * * Calls /rest/storefront/orders
+ * * Method should be used to place an order.
+ *
+ * @returns Order
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doPlaceOrder();
+ * ```
+ */
+export declare const doPlaceOrder: (context: PlentysystemsIntegrationContext) => Promise<Data<Order>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doPlaceOrder/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doPlaceOrder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,YAAY,YACd,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CAKrB,CAAC"}

package/server/api/doPreparePayment/index.d.ts

@@ -0,0 +1,24 @@
+import { Data, PreparePaymentResult } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doPreparePayment - Used to prepare the payment.
+ *
+ * @remarks
+ * * Calls /rest/storefront/checkout/payment
+ * * Method should be used to prepare the payment.
+ *
+ * @param { PreparePaymentResult } params
+ * orderId: number,
+ * paymentId: number,
+ *
+ * @returns
+ * type: strig,
+ * value: null
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doPreparePayment();
+ * ```
+ */
+export declare const doPreparePayment: (context: PlentysystemsIntegrationContext) => Promise<Data<PreparePaymentResult>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doPreparePayment/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doPreparePayment/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;GAmBG;AACH,eAAO,MAAM,gBAAgB,YAClB,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAKpC,CAAC"}

package/server/api/doRegisterUser/index.d.ts

@@ -0,0 +1,25 @@
+import { Data, RegisterParams, UserChangeResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doRegisterUser - Creates a new user account.
+ *
+ * @remarks
+ * * Calls /rest/io/customer/
+ * * This method is used to register a new user account.
+ *
+ * @param { RegisterParams } params
+ * email: string - User email address.
+ * password: string - User password.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doRegisterUser({
+ *     email: email,
+ *     password: 'Testuser1234'
+ * });
+ * ```
+ */
+export declare const doRegisterUser: (context: PlentysystemsIntegrationContext, params: RegisterParams) => Promise<Data<UserChangeResponse>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doRegisterUser/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doRegisterUser/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AAC3E,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,cAAc,YAChB,+BAA+B,UAChC,cAAc,KACrB,OAAO,CAAC,IAAI,CAAC,kBAAkB,CAAC,CAoBlC,CAAC"}

package/server/api/doRejectOffer/index.d.ts

@@ -0,0 +1,16 @@
+import { Data, GetOfferReject, OfferSearchParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * @remarks
+ * * Calls /rest/storefront/offers/reject
+ * * Method should be used to reject an offer.
+ *
+ * @returns string
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doRejectOffer(params);
+ * ```
+ */
+export declare const doRejectOffer: (context: PlentysystemsIntegrationContext, params: OfferSearchParams) => Promise<Data<GetOfferReject>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doRejectOffer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doRejectOffer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,cAAc,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAC1E,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,aAAa,YACf,+BAA+B,UAChC,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,cAAc,CAAC,CAmB9B,CAAC"}

package/server/api/doReview/index.d.ts

@@ -0,0 +1,29 @@
+import { CreateReviewParams, Data, PlentysystemsIntegrationContext, Review } from '../../types';
+/**
+ * Method doReview - Create a new product review.
+ *
+ * @remarks
+ * * Calls /rest/feedbacks/feedback/create
+ * * This method is used to create a new product review.
+ *
+ * @param { CreateReviewParams } params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doReview({
+ *     ratingValue: 3,
+ *     authorName: 'John Doe',
+ *     title: 'Great product',
+ *     message: 'That's an awesome product',
+ *     type: 'review',
+ *     targetId: 1890,
+ *     honeypot: '',
+ *     titleMissing: false,
+ *     ratingMissing: false,
+ * });
+ * ```
+ */
+export declare const doReview: (context: PlentysystemsIntegrationContext, params: CreateReviewParams) => Promise<Data<Review>>;
+//# sourceMappingURL=index.d.ts.map

package/server/api/doReview/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doReview/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,IAAI,EAAE,+BAA+B,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,eAAO,MAAM,QAAQ,YACV,+BAA+B,UAChC,kBAAkB,KACzB,OAAO,CAAC,IAAI,CAAE,MAAM,CAAC,CASvB,CAAC"}