/** * 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 { BaseEnvelope, EnvelopeListRefund, EnvelopeNullableGuid, EnvelopeRefund, OrderRefundModelsWriteNewRefund, OrderRefundModelsWriteProcessedRefund, OrderRefundModelsWriteRefundApproval, OrderRefundModelsWriteSettledRefund, OrderRefundModelsWriteSettledRefundRow, RefundQuery } from '../models'; export interface CreateRefundRequest { orderId: number; newRefund: OrderRefundModelsWriteNewRefund; } export interface DeleteRefundRowRequest { orderId: number; refundId: string; refundRowId: number; } export interface GetRefundRequest { orderId: number; refundId: string; } export interface ListRefundsRequest { orderId: number; } export interface QueryRefundsRequest { refundQuery: RefundQuery; } export interface SetRefundApprovalRequest { orderId: number; refundId: string; refundApproval: OrderRefundModelsWriteRefundApproval; } export interface SetRefundAsProcessedRequest { orderId: number; refundId: string; processedRefund: OrderRefundModelsWriteProcessedRefund; } export interface SetRefundAsSettledRequest { orderId: number; refundId: string; settledRefund: OrderRefundModelsWriteSettledRefund; } export interface SetRefundRowAsSettledRequest { orderId: number; refundId: string; refundRowId: number; settledRefundRow: OrderRefundModelsWriteSettledRefundRow; } /** * */ export declare class RefundApi extends runtime.BaseAPI { /** * Creates a new refund. * Creates refund */ createRefundRaw(requestParameters: CreateRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Creates a new refund. * Creates refund */ createRefund(requestParameters: CreateRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Delete a refund row. Can only be done if the refund row isn\'t settled. * Delete refund row */ deleteRefundRowRaw(requestParameters: DeleteRefundRowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Delete a refund row. Can only be done if the refund row isn\'t settled. * Delete refund row */ deleteRefundRow(requestParameters: DeleteRefundRowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get refund */ getRefundRaw(requestParameters: GetRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get refund */ getRefund(requestParameters: GetRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Get all refunds on an order. * List refunds */ listRefundsRaw(requestParameters: ListRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get all refunds on an order. * List refunds */ listRefunds(requestParameters: ListRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Queries all refunds. * Query refunds */ queryRefundsRaw(requestParameters: QueryRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Queries all refunds. * Query refunds */ queryRefunds(requestParameters: QueryRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Approve or deny a pending refund. * Set refund approval */ setRefundApprovalRaw(requestParameters: SetRefundApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Approve or deny a pending refund. * Set refund approval */ setRefundApproval(requestParameters: SetRefundApprovalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Sets a refund as processed and all refund rows within it as settled. * Set refund as processed */ setRefundAsProcessedRaw(requestParameters: SetRefundAsProcessedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Sets a refund as processed and all refund rows within it as settled. * Set refund as processed */ setRefundAsProcessed(requestParameters: SetRefundAsProcessedRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Sets all refund rows in a refund as settled. * Set refund as settled */ setRefundAsSettledRaw(requestParameters: SetRefundAsSettledRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Sets all refund rows in a refund as settled. * Set refund as settled */ setRefundAsSettled(requestParameters: SetRefundAsSettledRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * Set refund row as settled */ setRefundRowAsSettledRaw(requestParameters: SetRefundRowAsSettledRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Set refund row as settled */ setRefundRowAsSettled(requestParameters: SetRefundRowAsSettledRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; }