@plentymarkets/shop-api 0.88.0

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

@@ -0,0 +1,33 @@
+import { Address, Data, DoSaveAddressParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doSaveAddress - Create a new billing or shipping address to the current session (guest or logged in).
+ *
+ * @remarks
+ * * Calls /rest/storefront/contact/addresses/
+ * * This method is used to create a new billing or shipping address
+ *
+ * @param { DoSaveAddressParams } params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doSaveAddress({
+ *     typeId: AddressType.Billing,
+ *     addressData: {
+ *       country: '12',
+ *       firstName: 'John',
+ *       lastName: 'Doe',
+ *       streetName: 'Main Street',
+ *       apartment: '1',
+ *       city: 'New York',
+ *       state: null,
+ *       zipCode: '12345',
+ *       phoneNumber: null
+ *     }
+ * });
+ * ```
+ */
+export declare const doSaveAddress: (context: PlentysystemsIntegrationContext, params: DoSaveAddressParams) => Promise<Data<Address[]>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doSaveAddress/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,OAAO,EAEP,IAAI,EACJ,mBAAmB,EACpB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAGtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,aAAa,YACf,+BAA+B,UAChC,mBAAmB,KAC1B,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAyBzB,CAAC"}

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

@@ -0,0 +1,25 @@
+import { Data, NewsletterParams, NewsletterSubscribeResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doSubscribeNewsletter - to subscribe to the newsletter
+ *
+ * @remarks
+ * * Calls /rest/io/customer/newsletter
+ * * This method is used to subscribe to the newsletter
+ *
+ * @param {NewsletterParams} params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.doSubscribeNewsletter({
+ *     email: 'test@plentymarkets.com',
+ *     firstName: 'John',
+ *     lastName: 'Doe',
+ *     emailFolder: 10
+ * });
+ * ```
+ */
+export declare const doSubscribeNewsletter: (context: PlentysystemsIntegrationContext, params: NewsletterParams) => Promise<Data<NewsletterSubscribeResponse>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doSubscribeNewsletter/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AACtF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,eAAO,MAAM,qBAAqB,YACvB,+BAA+B,UAChC,gBAAgB,KACvB,OAAO,CAAC,IAAI,CAAC,2BAA2B,CAAC,CAS3C,CAAC"}

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

@@ -0,0 +1,28 @@
+import { Data, UploadFileForOrderPropertyParams, UploadFileForOrderPropertyResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method doUploadOrderPropertyFile - Uploads a file for an order property.
+ *
+ * @remarks
+ * * Calls /rest/io/order/property/file
+ * * This method is used to upload a file for an order property.
+ *
+ * @param { UploadFileForOrderPropertyParams } params
+ * base64: string;
+ * filename: string;
+ * type: string;
+ *
+ * @returns
+ * The name of the uploaded file
+ *
+ * @example
+ * ``` ts
+ * const { data, error } = await sdk.boilerplate.doUploadOrderPropertyFile({
+ *   base64: 'base64_file_string',
+ *   filename: 'filename.png',
+ *   type: 'image/png'
+ * });
+ * ```
+ */
+export declare const doUploadOrderPropertyFile: (context: PlentysystemsIntegrationContext, params: UploadFileForOrderPropertyParams) => Promise<Data<UploadFileForOrderPropertyResponse>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/doUploadOrderPropertyFile/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,gCAAgC,EAAE,kCAAkC,EAAE,MAAM,iBAAiB,CAAC;AAC7G,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,yBAAyB,YAC3B,+BAA+B,UAChC,gCAAgC,KACvC,OAAO,CAAC,IAAI,CAAC,kCAAkC,CAAC,CA0BlD,CAAC"}

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

@@ -0,0 +1,19 @@
+import { type ActiveShippingCountry, Data } from '../../types/api';
+import { type PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getActiveShippingCountries -  Used to get all active shipping countries.
+ *
+ * @remarks
+ * * Calls /rest/storefront/countries.
+ * * Method should be used to get all active shipping countries.
+ *
+ * @returns
+ * A collection of ActiveShippingCountry items.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getActiveShippingCountries();
+ * ```
+ */
+export declare const getActiveShippingCountries: (context: PlentysystemsIntegrationContext) => Promise<Data<ActiveShippingCountry[]>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getActiveShippingCountries/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,qBAAqB,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACnE,OAAO,EAAE,KAAK,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAE3E;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,0BAA0B,YAC5B,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,CAAC,CAMvC,CAAC"}

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

@@ -0,0 +1,21 @@
+import { Address, Data, GetAddressesParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getAddresses - Get billing or shipping addresses from the current session (guest or logged in).
+ *
+ * @remarks
+ * * Calls /rest/storefront/contact/addresses
+ * * This method is used to get all billing or shipping addresses
+ *
+ * @param { GetAddressesParams } params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getAddresses({typeId: AddressType.Billing});
+ * const { data } = await useSdk().plentysystems.getAddresses({typeId: AddressType.Shipping});
+ * ```
+ */
+export declare const getAddresses: (context: PlentysystemsIntegrationContext, params: GetAddressesParams) => Promise<Data<Address[]>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getAddresses/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAe,IAAI,EAAE,kBAAkB,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAGtE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,YAAY,YACd,+BAA+B,UAChC,kBAAkB,KACzB,OAAO,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAmBzB,CAAC"}

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

@@ -0,0 +1,18 @@
+import { type AggregatedCountries, Data } from '../../types/api';
+import { type PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getAggregatedCountries - Used to get a combined list of active shipping countries and EU geo-regulated countries.
+ *
+ * @remarks
+ * * Calls /rest/storefront/countries/with-geo-regulated.
+ * * Method should be used to get a combined list of:
+ * - Active shipping countries
+ * - EU geo-regulated countries
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getAggregatedCountries();
+ * ```
+ */
+export declare const getAggregatedCountries: (context: PlentysystemsIntegrationContext) => Promise<Data<AggregatedCountries>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getAggregatedCountries/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,mBAAmB,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,KAAK,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAE3E;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,sBAAsB,YACxB,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,mBAAmB,CAAC,CASnC,CAAC"}

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

@@ -0,0 +1,19 @@
+import { AuthenticatedReviewSearchParams, Data, PlentysystemsIntegrationContext, Review } from '../../types';
+/**
+ * Method getAuthenticatedReview - Gets product reviews from current active user account.
+ *
+ * @remarks
+ * * Calls /rest/feedbacks/user/${itemId}/${variationId}
+ * * This method is used to get product reviews that are made by the currently active user account.
+ *
+ * @param { AuthenticatedReviewSearchParams } params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getAuthenticatedReview({ itemId: 1100, variationId: 1890 });
+ * ```
+ */
+export declare const getAuthenticatedReview: (context: PlentysystemsIntegrationContext, params: AuthenticatedReviewSearchParams) => Promise<Data<Review>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getAuthenticatedReview/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,+BAA+B,EAC/B,IAAI,EACJ,+BAA+B,EAC/B,MAAM,EACP,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;;;GAeG;AACH,eAAO,MAAM,sBAAsB,YAEpB,+BAA+B,UAChC,+BAA+B,KACtC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAYtB,CAAC"}

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

@@ -0,0 +1,18 @@
+import { Cart, Data } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getCart - returns the cart data from the current session.
+ *
+ * @remarks
+ * * Calls /rest/storefront/session/
+ * * This method is used to get the cart data from the current session.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getCart();
+ * ```
+ */
+export declare const getCart: (context: PlentysystemsIntegrationContext) => Promise<Data<Cart>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getCart/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,IAAI,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACjE,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,OAAO,YACT,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,CAOpB,CAAC"}

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

@@ -0,0 +1,18 @@
+import { CategoryTemplate, CategoryTemplateParams, Data } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getCategoryTemplate - Used to get category template instance.
+ *
+ *
+ * @param params
+ * CategoryTemplateParams
+ *
+ * @returns
+ * CategoryTemplate
+ * @example
+ * ``` ts
+ * const { data } = await getCategoryTemplate(() => useSdk().plentysystems.getCategoryTemplate(1));
+ * ```
+ */
+export declare const getCategoryTemplate: (context: PlentysystemsIntegrationContext, params: CategoryTemplateParams) => Promise<Data<CategoryTemplate>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getCategoryTemplate/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACjF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AAEH,eAAO,MAAM,mBAAmB,YACrB,+BAA+B,UAChC,sBAAsB,KAC7B,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAWhC,CAAC"}

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

@@ -0,0 +1,16 @@
+import { CategoryTreeItem, Data } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * getCategoryTree - method for retriving the list with the categories and subcategories ready to be consumed by tree navigation
+ *
+ * @remarks
+ * calls /rest/storefront/categories and returns a list of CategoryTreeItems, subcategories are set in children prop.
+ *
+ * @returns
+ *
+ * @example
+ * const { data, error } = await useAsyncData(() => sdk.plentysystems.getCategoryTree());
+ * ```
+ */
+export declare const getCategoryTree: (context: PlentysystemsIntegrationContext) => Promise<Data<CategoryTreeItem[]>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getCategoryTree/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,eAAe,YACjB,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,CAUlC,CAAC"}

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

@@ -0,0 +1,28 @@
+import { Data, PayPalExecuteParams, PayPalExecutePayment } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getExecutePayPalOrder - checks the PayPal payment status and changed the plenty order status accordingly
+ *
+ * @remarks
+ * * Calls rest/payment/payPal/{params.mode}/{params.plentyOrderId}/{params.paypalTransactionId}/{params.paypalMerchantId}/execute-payment
+ * * This method is used to check the PayPal payment status and changed the plenty order status accordingly
+ *
+ * @param { PayPalExecuteParams } params
+ * mode: string - mode of the payment (e.g. paypal)
+ * plentyOrderId: number - plenty order id
+ * paypalOrderId: string - PayPal transaction id
+ * paypalMerchantId: string - PayPal merchant id
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getExecutePayPalOrder({
+ *     plentyOrderId: 1606,
+ *     paypalTransactionId: '6GY88326V4505594A',
+ *     mode: 'paypal',
+ * });
+ * ```
+ */
+export declare const getExecutePayPalOrder: (context: PlentysystemsIntegrationContext, params: PayPalExecuteParams) => Promise<Data<PayPalExecutePayment>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getExecutePayPalOrder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,mBAAmB,EACnB,oBAAoB,EACrB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,eAAO,MAAM,qBAAqB,YACvB,+BAA+B,UAChC,mBAAmB,KAC1B,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAQpC,CAAC"}

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

@@ -0,0 +1,33 @@
+import { Facet, FacetSearchCriteria, Data } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getFacet - Used to get the category facets.
+ *
+ * @remarks
+ * * Calls /rest/storefront/items
+ * * Method should be used to get the category facets.
+ *
+ * @param { FacetSearchCriteria } params
+ * categoryId: id of the category.
+ * page: current page number.
+ * itemsPerPage: number of items per page.
+ * sort: type of sorting.
+ * facets: search facet
+ *
+ * @returns
+ * Category facets.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getFacet({
+ *     categoryId: '17',
+ *     categorySlug: "armchair-stool",
+ *     page: 1,
+ *     itemsPerPage: 20,
+ *     sort: 'sorting.price.avg_asc',
+ *     facets: 'feedback-2'
+ * });
+ * ```
+ */
+export declare const getFacet: (context: PlentysystemsIntegrationContext, params: FacetSearchCriteria) => Promise<Data<Facet>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getFacet/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,KAAK,EAGL,mBAAmB,EACnB,IAAI,EACL,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4BG;AACH,eAAO,MAAM,QAAQ,YACV,+BAA+B,UAChC,mBAAmB,KAC1B,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,CA0DrB,CAAC"}

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

@@ -0,0 +1,16 @@
+import { Data, InitResult } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getInit - get current session and the category tree
+ *
+ * @remarks
+ * * calls /rest/storefront/init and returns user session and the category tree
+ *
+ * @returns
+ * Promise<{data: InitResult}>
+ *
+ * @example
+ * const { data, error } = await useAsyncData(() => sdk.plentysystems.getInit());
+ */
+export declare const getInit: (context: PlentysystemsIntegrationContext) => Promise<Data<InitResult>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getInit/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAc,IAAI,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC/D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,OAAO,YACT,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAyB1B,CAAC"}

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

@@ -0,0 +1,21 @@
+import { Data, LegalInformationResponse, LegalTextsParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getLegalTexts- Method that returns content consumable in legal text pages
+ *
+ * @remarks
+ * calls /rest/storefront/legal
+ * response should contain a prop htmlText which contains html formated information.
+ *
+ * @param params
+ * type: LegalTextsParams - type of legal texts
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data, error } = await useAsyncData(() => sdk.plentysystems.getLegalTexts(params));
+ * ```
+ */
+export declare const getLegalTexts: (context: PlentysystemsIntegrationContext, params: LegalTextsParams) => Promise<Data<LegalInformationResponse>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getLegalTexts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,wBAAwB,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,aAAa,YACf,+BAA+B,UAChC,gBAAgB,KACvB,OAAO,CAAC,IAAI,CAAC,wBAAwB,CAAC,CAOxC,CAAC"}

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

@@ -0,0 +1,27 @@
+import { Data, GetOfferError, Offer, OfferSearchParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getOffer - gets the Offer data.
+ *
+ * @remarks
+ * * Calls /rest/storefront/offers/${params.offerId}
+ * * Method uses OfferSearchParams
+ *
+ * @param { OfferSearchParams } params
+ * offerId: int;
+ * accessKey: string;
+ * postcode: string;
+ *
+ * @returns Offer | GetOfferError
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getOffer({
+ *   offerId: '138',
+ *   accessKey: '4L95RS31F',
+ *   postcode: '34131'
+ * });
+ * ```
+ */
+export declare const getOffer: (context: PlentysystemsIntegrationContext, params: OfferSearchParams) => Promise<Data<Offer | GetOfferError>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getOffer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,QAAQ,YACV,+BAA+B,UAChC,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,CAiBrC,CAAC"}

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

@@ -0,0 +1,29 @@
+import { Data, GetOrderError, Order, OrderSearchParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getOrder - Used to get the order data.
+ *
+ * @remarks
+ * * Calls /rest/storefront/orders/${params.orderId}
+ * * Method should be used to get the order data.
+ *
+ * @param { OrderSearchParams } params
+ * orderId: string;
+ * accessKey: string;
+ * name: string;
+ * postcode: string;
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getOrder({
+ *   orderId: '1383',
+ *   name: 'Backpack Gaia',
+ *   accessKey: '1231234',
+ *   postcode: '012799'
+ * });
+ * ```
+ */
+export declare const getOrder: (context: PlentysystemsIntegrationContext, params: OrderSearchParams) => Promise<Data<Order | GetOrderError>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getOrder/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,aAAa,EAAE,KAAK,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAC;AAChF,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,eAAO,MAAM,QAAQ,YACV,+BAA+B,UAChC,iBAAiB,KACxB,OAAO,CAAC,IAAI,CAAC,KAAK,GAAG,aAAa,CAAC,CA4BrC,CAAC"}

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

@@ -0,0 +1,26 @@
+import { Data, OrderDocumentParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getOrderDocument - Used to get the document file.
+ *
+ * @remarks
+ * * Calls /rest/storefront/order/document/preview/${docReferenceId}/?orderId=${orderId}&accessKey=${accessKey}
+ * * Method should be used to get the document file in array buffer format.
+ *
+ * @param { OrderDocumentParams } params
+ * document: the order document.
+ * accessKey: order access key.
+ *
+ * @returns { Promise<{ data: number[] }> }
+ * The document file in an array buffer format.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getOrderDocument({
+ *     document: {},
+ *     accessKey: '',
+ * });
+ * ```
+ */
+export declare const getOrderDocument: (context: PlentysystemsIntegrationContext, params: OrderDocumentParams) => Promise<Data<number[]>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getOrderDocument/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,mBAAmB,EAAE,MAAM,iBAAiB,CAAC;AAC5D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,gBAAgB,YAClB,+BAA+B,UAChC,mBAAmB,KAC1B,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAiBxB,CAAC"}

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

@@ -0,0 +1,26 @@
+import { Data, OrderPropertyFileParams, OrderPropertyFileResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getOrderPropertyFile - Get the order property file.
+ *
+ * @remarks
+ * * Calls /rest/storefront/order-property-file/{hash}/{fileName} endpoint.
+ * * Method should be used to get the document file in base64 encoded format.
+ *
+ * @param { OrderPropertyFileParams } params
+ * hash: file hash
+ * fileName: file name
+ *
+ * @returns { Promise<{ data: OrderPropertyFileResponse }> }
+ * The document file in base64 encoded format with type.
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getOrderPropertyFile({
+ *     hash: 'abcdefgh,
+ *     fileName: 'test.png',
+ * });
+ * ```
+ */
+export declare const getOrderPropertyFile: (context: PlentysystemsIntegrationContext, params: OrderPropertyFileParams) => Promise<Data<OrderPropertyFileResponse>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getOrderPropertyFile/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,uBAAuB,EAAE,yBAAyB,EAAE,MAAM,iBAAiB,CAAC;AAC3F,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,oBAAoB,YACtB,+BAA+B,UAChC,uBAAuB,KAC9B,OAAO,CAAC,IAAI,CAAC,yBAAyB,CAAC,CASzC,CAAC"}

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

@@ -0,0 +1,22 @@
+import { Data, GetOrdersResponse, UseUserOrderSearchParams } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getOrders - Used to get the orders from the user.
+ *
+ * @remarks
+ * * Calls /rest/storefront/orders
+ * * This method is used to get the orders from the user.
+ *
+ * @param { UseUserOrderSearchParams } params
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getOrders({
+ *     page: 0
+ * });
+ * ```
+ */
+export declare const getOrders: (context: PlentysystemsIntegrationContext, params: UseUserOrderSearchParams) => Promise<Data<GetOrdersResponse>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getOrders/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,iBAAiB,EAEjB,wBAAwB,EACzB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;;GAiBG;AACH,eAAO,MAAM,SAAS,YACX,+BAA+B,UAChC,wBAAwB,KAC/B,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAiBjC,CAAC"}

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

@@ -0,0 +1,18 @@
+import { Data, PayPalConfigResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getPayPalDataClientToken - get PayPal data client token
+ *
+ * @remarks
+ * * Calls the /rest/payment/payPal/client_token endpoint.
+ * * This method is used to get the PayPal client token and client id.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getPayPalDataClientToken();
+ * ```
+ */
+export declare const getPayPalDataClientToken: (context: PlentysystemsIntegrationContext) => Promise<Data<PayPalConfigResponse>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getPayPalDataClientToken/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,wBAAwB,YACnB,+BAA+B,KAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAQnF,CAAC"}

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

@@ -0,0 +1,18 @@
+import { Data, PayPalConfigResponse } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getPayPalMerchantAndClientIds - get PayPal data merchant id and client id
+ *
+ * @remarks
+ * * Calls the /rest/paypal/merchant_and_client_ids endpoint.
+ * * This method is used to get the PayPal merchant id and client id.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getPayPalMerchantAndClientIds();
+ * ```
+ */
+export declare const getPayPalMerchantAndClientIds: (context: PlentysystemsIntegrationContext) => Promise<Data<PayPalConfigResponse>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getPayPalMerchantAndClientIds/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,oBAAoB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,6BAA6B,YACtB,+BAA+B,KAAG,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAQnF,CAAC"}

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

@@ -0,0 +1,21 @@
+import { Data, PayPalGetOrderDetailsParams, PayPalOrderStatus } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getPayPalOrderDetails - get the details of an PayPal order.
+ *
+ * @remarks
+ * * Calls the /rest/payment/payPal/order_details/payPalPayerId/paypalOrderId endpoint.
+ * * This method is used to get the details of an PayPal order.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getPayPalOrderDetails({
+ *  payPalPayerId: 'payPalPayerId',
+ *  paypalOrderId: 'paypalOrderId',
+ * });
+ * ```
+ */
+export declare const getPayPalOrderDetails: (context: PlentysystemsIntegrationContext, params: PayPalGetOrderDetailsParams) => Promise<Data<PayPalOrderStatus>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getPayPalOrderDetails/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,IAAI,EACJ,2BAA2B,EAC3B,iBAAiB,EAClB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;;;;GAgBG;AACH,eAAO,MAAM,qBAAqB,YAErB,+BAA+B,UAChC,2BAA2B,KAClC,OAAO,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAWjC,CAAC"}

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

@@ -0,0 +1,18 @@
+import { Data, PaymentProviders } from '../../types/api';
+import { PlentysystemsIntegrationContext } from '../../types/context';
+/**
+ * Method getPaymentProviders - Used to get all available payment providers in the shop
+ *
+ * @remarks
+ * * Calls /rest/storefront/checkout/payment/providers/
+ * * This method is used to get all available payment providers in the shop.
+ *
+ * @returns
+ *
+ * @example
+ * ``` ts
+ * const { data } = await useSdk().plentysystems.getPaymentProviders();
+ * ```
+ */
+export declare const getPaymentProviders: (context: PlentysystemsIntegrationContext) => Promise<Data<PaymentProviders>>;
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api/getPaymentProviders/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACzD,OAAO,EAAE,+BAA+B,EAAE,MAAM,qBAAqB,CAAC;AAEtE;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,mBAAmB,YACrB,+BAA+B,KACvC,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAQhC,CAAC"}