/** * Geins Management API * Geins Management API is a RESTful api that powers your applications and helps you manage your Geins services. Geins provides an easy-to-use and scalable solution for managing all aspects of an online store, from product listings and customer information to order processing and payment transactions. :::tip Tip With this API, you can build custom applications and integrate with third-party systems, feeds, dashboards and other bussiness logic apps. ::: ## Getting started Once you have created an account, you can start using the Management API by creating an `API User`. You can create as many API users as you need. Each `API user` is connected to a specific account so you can keep track of operations and manage keys. You can find all your API credentials in `Geins Merchant Center`. ### Fast track Use one of our [SDKs](https://docs.geins.io/docs/sdk/introduction) to get started quickly. The SDKs are available for the most popular programming languages and frameworks. Or, if you prefer to just take it for a test run: [![Run in Postman](https://run.pstmn.io/button.svg)](https://god.gw.postman.com/run-collection/25895885-aaf6598f-1a7c-4949-85d7-ba846c42d553?action=collection%2Ffork&collection-url=entityId%3D25895885-aaf6598f-1a7c-4949-85d7-ba846c42d553%26entityType%3Dcollection%26workspaceId%3Da2a179ce-158e-46b0-8d06-e9640f45112c) ### Authentication Two authentication methods are required: - `Basic Auth` - `API Key` All API credentials can be found in `Geins Merchant Center`. #### Basic Auth A Basic auth `Authorization` header needs to be included in every request. The value should be `Basic ` where `` is the Base64 encoding of your `API username` and `API password` joined by a single colon `:`. See [Wikipedia](https://en.wikipedia.org/wiki/Basic_access_authentication) for more information on Basic auth. #### API Key An `X-ApiKey` header needs to be included in every request. This header should contain the value of your `API key`. #### Example ```bash curl -X GET \"https://mgmtapi.geins.io/API/Market/List\" \\ -H \"Authorization: Basic [USER-CREDENTIALS-BASE64-ENCODED]\" \\ -H \"X-ApiKey: [API-KEY]\" ``` * * The version of the OpenAPI document: v1.10.1 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { APIOrderOrderComment, APIOrderTransactionData, BaseEnvelope, EnvelopeAPIOrderOrderCreationValidationStatus, EnvelopeInt, EnvelopeOrderCapture, OrderModelsOrder, OrderModelsOrderQuery, OrderModelsOrderStatus, OrderModelsOrderUpdate, OrderProcessedCapture, OrderValidateOrderCreationRequest } from '../models'; export interface AddOrderCommentRequest { id: number; orderComment: APIOrderOrderComment; } export interface CancelOrderRowRequest { orderId: number; orderRowId: number; skipRestock?: boolean; } export interface CountOrdersRequest { email: string; } export interface CreateOrderRequest { order: OrderModelsOrder; } export interface DeleteOrderRequest { id: number; operation: DeleteOrderOperationEnum; } export interface GetCaptureRequest { captureId: string; } export interface GetOrderIdRequest { id: number; include: string; combineProductContainerRows?: boolean; } export interface GetOrderPublicIdRequest { publicId: string; include: string; combineProductContainerRows?: boolean; } export interface PartialUpdateOfOrderRequest { id: number; order: OrderModelsOrderUpdate; } export interface QueryOrdersRequest { query: OrderModelsOrderQuery; } export interface SetCaptureAsProcessedRequest { processedCapture: OrderProcessedCapture; } export interface SetPaymentAsPaidRequest { paymentDetailId: number; } export interface UpdateOrderStatusRequest { id: number; status: UpdateOrderStatusStatusEnum; transactionId: string; secondaryTransactionId: string; } export interface UpdateTransactionDataRequest { id: number; transactionData: APIOrderTransactionData; } export interface ValidateOrderRequest { request: OrderValidateOrderCreationRequest; } /** * */ export declare class OrderApi extends runtime.BaseAPI { /** * Adds a comment to an order. This does not replace any previous comments. * Add order comment */ addOrderCommentRaw(requestParameters: AddOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Adds a comment to an order. This does not replace any previous comments. * Add order comment */ addOrderComment(requestParameters: AddOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Cancels an order row. Can only be done on an order that has not been delivered or cancelled. * Cancel order row */ cancelOrderRowRaw(requestParameters: CancelOrderRowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Cancels an order row. Can only be done on an order that has not been delivered or cancelled. * Cancel order row */ cancelOrderRow(requestParameters: CancelOrderRowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Gets the number of orders placed with the supplied email address. * Count orders */ countOrdersRaw(requestParameters: CountOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets the number of orders placed with the supplied email address. * Count orders */ countOrders(requestParameters: CountOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create a new order. * Create order */ createOrderRaw(requestParameters: CreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new order. * Create order */ createOrder(requestParameters: CreateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Create a new order id. * Create order id */ createOrderIdRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Create a new order id. * Create order id */ createOrderId(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Deletes or deactivates an order. * Delete order */ deleteOrderRaw(requestParameters: DeleteOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Deletes or deactivates an order. * Delete order */ deleteOrder(requestParameters: DeleteOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get capture */ getCaptureRaw(requestParameters: GetCaptureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get capture */ getCapture(requestParameters: GetCaptureRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get order by id. * Get order (id) */ getOrderIdRaw(requestParameters: GetOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get order by id. * Get order (id) */ getOrderId(requestParameters: GetOrderIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get order by public id. * Get order (public id) */ getOrderPublicIdRaw(requestParameters: GetOrderPublicIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get order by public id. * Get order (public id) */ getOrderPublicId(requestParameters: GetOrderPublicIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get a list of available order statuses. * Get order statuses */ getOrderStatusesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Get a list of available order statuses. * Get order statuses */ getOrderStatuses(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Partial update of an order */ partialUpdateOfOrderRaw(requestParameters: PartialUpdateOfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Partial update of an order */ partialUpdateOfOrder(requestParameters: PartialUpdateOfOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Queries orders. * Query orders */ queryOrdersRaw(requestParameters: QueryOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>>; /** * Queries orders. * Query orders */ queryOrders(requestParameters: QueryOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Sets a capture as processed (= captured). * Set capture as processed */ setCaptureAsProcessedRaw(requestParameters: SetCaptureAsProcessedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Sets a capture as processed (= captured). * Set capture as processed */ setCaptureAsProcessed(requestParameters: SetCaptureAsProcessedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Set payment as paid */ setPaymentAsPaidRaw(requestParameters: SetPaymentAsPaidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set payment as paid */ setPaymentAsPaid(requestParameters: SetPaymentAsPaidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Update order status */ updateOrderStatusRaw(requestParameters: UpdateOrderStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Update order status */ updateOrderStatus(requestParameters: UpdateOrderStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Updates transaction data on an order. * Update transaction data */ updateTransactionDataRaw(requestParameters: UpdateTransactionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Updates transaction data on an order. * Update transaction data */ updateTransactionData(requestParameters: UpdateTransactionDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Validates order data for order creation. * Validate order */ validateOrderRaw(requestParameters: ValidateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Validates order data for order creation. * Validate order */ validateOrder(requestParameters: ValidateOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const DeleteOrderOperationEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; }; export type DeleteOrderOperationEnum = typeof DeleteOrderOperationEnum[keyof typeof DeleteOrderOperationEnum]; /** * @export */ export declare const UpdateOrderStatusStatusEnum: { readonly NUMBER_0: 0; readonly NUMBER_1: 1; readonly NUMBER_2: 2; readonly NUMBER_3: 3; readonly NUMBER_4: 4; readonly NUMBER_5: 5; readonly NUMBER_6: 6; readonly NUMBER_7: 7; }; export type UpdateOrderStatusStatusEnum = typeof UpdateOrderStatusStatusEnum[keyof typeof UpdateOrderStatusStatusEnum];