/* tslint:disable */ /* eslint-disable */ /** * 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 { exists, mapValues } from '../runtime'; /** * A refund row. * @export * @interface RefundRow */ export interface RefundRow { /** * * @type {number} * @memberof RefundRow */ orderId?: number; /** * * @type {number} * @memberof RefundRow */ refundRowId?: number; /** * The order row id that this refund row belongs to, if any. * @type {number} * @memberof RefundRow */ orderRowId?: number; /** * The refund amount. This can be different than the corresponding order row value. * @type {number} * @memberof RefundRow */ refundAmount?: number; /** * If true, the refund amount of this refund row is added to the customer's balance. * @type {boolean} * @memberof RefundRow */ toBalance?: boolean; /** * If true, the refund row is marked as settled. * @type {boolean} * @memberof RefundRow */ settled?: boolean; /** * The date when the refund row was marked as settled. * @type {Date} * @memberof RefundRow */ settledOn?: Date; /** * The date the refund row was created. * @type {Date} * @memberof RefundRow */ createdOn?: Date; /** * If true, the refund row is marked for investigation. * @type {boolean} * @memberof RefundRow */ investigation?: boolean; /** * The kind of source transaction the refund is derived from. * 0 = Default. A regular refund of the order or order row. * 1 = InstanceCost. Return cost type, used in drawing cost for instance. * 2 = Shipping. Refund shipping type, used to refund shipping. * 3 = InvoiceFee. Refund invoice fee. * 0 = Default. A regular refund of the order or order row. * 1 = InstanceCost. Return cost type, used in drawing cost for instance. * 2 = Shipping. Refund shipping type, used to refund shipping. * 3 = InvoiceFee. Refund invoice fee. * @type {number} * @memberof RefundRow */ refundType?: RefundRowRefundTypeEnum; } /** * @export */ export const RefundRowRefundTypeEnum = { NUMBER_0: 0, NUMBER_1: 1, NUMBER_2: 2, NUMBER_3: 3 } as const; export type RefundRowRefundTypeEnum = typeof RefundRowRefundTypeEnum[keyof typeof RefundRowRefundTypeEnum]; /** * Check if a given object implements the RefundRow interface. */ export function instanceOfRefundRow(value: object): boolean { let isInstance = true; return isInstance; } export function RefundRowFromJSON(json: any): RefundRow { return RefundRowFromJSONTyped(json, false); } export function RefundRowFromJSONTyped(json: any, ignoreDiscriminator: boolean): RefundRow { if ((json === undefined) || (json === null)) { return json; } return { 'orderId': !exists(json, 'OrderId') ? undefined : json['OrderId'], 'refundRowId': !exists(json, 'RefundRowId') ? undefined : json['RefundRowId'], 'orderRowId': !exists(json, 'OrderRowId') ? undefined : json['OrderRowId'], 'refundAmount': !exists(json, 'RefundAmount') ? undefined : json['RefundAmount'], 'toBalance': !exists(json, 'ToBalance') ? undefined : json['ToBalance'], 'settled': !exists(json, 'Settled') ? undefined : json['Settled'], 'settledOn': !exists(json, 'SettledOn') ? undefined : (new Date(json['SettledOn'])), 'createdOn': !exists(json, 'CreatedOn') ? undefined : (new Date(json['CreatedOn'])), 'investigation': !exists(json, 'Investigation') ? undefined : json['Investigation'], 'refundType': !exists(json, 'RefundType') ? undefined : json['RefundType'], }; } export function RefundRowToJSON(value?: RefundRow | null): any { if (value === undefined) { return undefined; } if (value === null) { return null; } return { 'OrderId': value.orderId, 'RefundRowId': value.refundRowId, 'OrderRowId': value.orderRowId, 'RefundAmount': value.refundAmount, 'ToBalance': value.toBalance, 'Settled': value.settled, 'SettledOn': value.settledOn === undefined ? undefined : (value.settledOn.toISOString()), 'CreatedOn': value.createdOn === undefined ? undefined : (value.createdOn.toISOString()), 'Investigation': value.investigation, 'RefundType': value.refundType, }; }