@kloutit/kloutit-sdk
Version:
Kloutit SDK API for client integrations
1,279 lines (1,278 loc) • 41.7 kB
TypeScript
/**
* API Reference
* The Kloutit API is organized around [REST](https://en.wikipedia.org/wiki/REST), it accepts and returns [JSON-encoded](https://www.json.org) bodies, returning standard [HTTP response codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). You can interact with the API directly using your preferred HTTP/REST library.
*
* The version of the OpenAPI document: 2.0
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import type { Configuration } from './configuration';
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
import type { RequestArgs } from './base';
import { BaseAPI } from './base';
/**
*
* @export
* @interface Amount
*/
export interface Amount {
/**
*
* @type {number}
* @memberof Amount
*/
'value': number;
/**
*
* @type {Currencies}
* @memberof Amount
*/
'currency': Currencies;
}
/**
*
* @export
* @interface Case
*/
export interface Case {
/**
*
* @type {string}
* @memberof Case
*/
'id'?: string;
/**
*
* @type {boolean}
* @memberof Case
*/
'active'?: boolean;
/**
*
* @type {string}
* @memberof Case
*/
'createdAt'?: string;
/**
*
* @type {string}
* @memberof Case
*/
'updatedAt'?: string;
/**
*
* @type {boolean}
* @memberof Case
*/
'isDeleted'?: boolean;
/**
*
* @type {string}
* @memberof Case
*/
'deletedAt'?: string;
/**
*
* @type {CaseStatus}
* @memberof Case
*/
'status': CaseStatus;
/**
* Url of the terms and conditions applied to this case.
* @type {string}
* @memberof Case
*/
'termsUrl'?: string;
/**
* Filial identifier related to the case.
* @type {string}
* @memberof Case
*/
'filialIdentifier'?: string;
/**
*
* @type {string}
* @memberof Case
*/
'paymentProcessor'?: CasePaymentProcessorEnum;
/**
* Date when the customer made the purchase in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'purchaseDate': string;
/**
* Service that the customer bought.
* @type {string}
* @memberof Case
*/
'service'?: string;
/**
* Product that the customer bought.
* @type {string}
* @memberof Case
*/
'product'?: string;
/**
* Flag that indicates if the charge made is refundable regarding your company terms and conditions.
* @type {boolean}
* @memberof Case
*/
'isChargeRefundable': boolean;
/**
* Customer name.
* @type {string}
* @memberof Case
*/
'customerName'?: string;
/**
* Customer email
* @type {string}
* @memberof Case
*/
'customerEmail'?: string;
/**
* Customer phone.
* @type {string}
* @memberof Case
*/
'customerPhone'?: string;
/**
* Date when the service was provided or will be provided in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'serviceDate'?: string;
/**
* Flag that indicates if the service was provided or not.
* @type {boolean}
* @memberof Case
*/
'serviceWasProvided'?: boolean;
/**
* Check in date in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'checkinDate'?: string;
/**
* Check out date in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'checkoutDate'?: string;
/**
* Hotel name.
* @type {string}
* @memberof Case
*/
'hotelName'?: string;
/**
* Rate applied.
* @type {string}
* @memberof Case
*/
'rate'?: string;
/**
* Flag that indicates if the client made the checkin or not.
* @type {boolean}
* @memberof Case
*/
'checkinConfirmation'?: boolean;
/**
* Destination country.
* @type {string}
* @memberof Case
*/
'destinationCountry'?: string;
/**
* Departure date in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'departureDate'?: string;
/**
* Arrival date in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'arrivalDate'?: string;
/**
* Departure airport.
* @type {string}
* @memberof Case
*/
'departureAirport'?: string;
/**
* Arrival airport.
* @type {string}
* @memberof Case
*/
'arrivalAirport'?: string;
/**
* Departure city.
* @type {string}
* @memberof Case
*/
'departureCity'?: string;
/**
* Arrival city.
* @type {string}
* @memberof Case
*/
'arrivalCity'?: string;
/**
* Shipping city.
* @type {string}
* @memberof Case
*/
'shippingCity'?: string;
/**
* Shipping province.
* @type {string}
* @memberof Case
*/
'shippingProvince'?: string;
/**
* Shipping postal code.
* @type {string}
* @memberof Case
*/
'shippingPostalCode'?: string;
/**
* Shipping date in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'shippingDate'?: string;
/**
* Delivery date in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'deliveryDate'?: string;
/**
* Delivery company.
* @type {string}
* @memberof Case
*/
'deliveryCompany'?: string;
/**
* Flag that indicates if the customer received the product.
* @type {boolean}
* @memberof Case
*/
'deliveryConfirmation'?: boolean;
/**
* Start date in UTC and ISO 8601 format of the commitment that the customer has with the company.
* @type {string}
* @memberof Case
*/
'commitmentStartDate'?: string;
/**
* End date in UTC and ISO 8601 format of the commitment that the customer has with the company.
* @type {string}
* @memberof Case
*/
'commitmentEndDate'?: string;
/**
* Flag that indicates if the subscription is cancelled or active.
* @type {boolean}
* @memberof Case
*/
'isCancelled'?: boolean;
/**
* Product description.
* @type {string}
* @memberof Case
*/
'productDescription'?: string;
/**
* Chargeback expedient number.
* @type {string}
* @memberof Case
*/
'expedientNumber': string;
/**
* Chargeback notification date, when the merchant receives the chargeback notification, in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'notificationDate': string;
/**
*
* @type {CaseDisputeAmount}
* @memberof Case
*/
'disputeAmount': CaseDisputeAmount;
/**
*
* @type {ChargebackReason}
* @memberof Case
*/
'chargebackReason': ChargebackReason;
/**
* Deadline date to resolve this chargeback in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'deadline'?: string;
/**
* Date when the customer contacted to the merchant in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'contactDate'?: string;
/**
* Array of all the emails that the customer has sent regarding this dispute. The structure of each item contains: **sender**: *customer* or *company*, **date**, **content**: string containing the message
* @type {Array<CommunicationItem>}
* @memberof Case
*/
'communications'?: Array<CommunicationItem>;
/**
* Additional info related to the chargeback.
* @type {string}
* @memberof Case
*/
'additionalInfo'?: string;
/**
* Last 4 digits of the customer\'s credit card number.
* @type {string}
* @memberof Case
*/
'last4Digits'?: string;
/**
* Transaction id.
* @type {string}
* @memberof Case
*/
'transactionId'?: string;
/**
* Transaction date in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'transactionDate': string;
/**
* Purchase amount.
* @type {Amount}
* @memberof Case
*/
'purchaseAmount': Amount;
/**
* Customer bank name.
* @type {string}
* @memberof Case
*/
'bankName'?: string;
/**
* Card brand that the customer used to make the payment.
* @type {string}
* @memberof Case
*/
'cardBrand'?: string;
/**
* Flag that indicates if the purchase has been made with 3DS.
* @type {boolean}
* @memberof Case
*/
'is3DSPurchase'?: boolean;
/**
* Organization sector of the case.
* @type {string}
* @memberof Case
*/
'sector'?: CaseSectorEnum;
/**
* Date when the customer contacted to the seller in UTC and ISO 8601 format.
* @type {string}
* @memberof Case
*/
'sellerContactDate'?: string;
/**
* Seller additional infromation.
* @type {string}
* @memberof Case
*/
'sellerAdditionalInfo'?: string;
/**
* Seller name.
* @type {string}
* @memberof Case
*/
'sellerName'?: string;
/**
* Seller phone number.
* @type {string}
* @memberof Case
*/
'sellerPhone'?: string;
/**
* Seller email.
* @type {string}
* @memberof Case
*/
'sellerEmail'?: string;
}
export declare const CasePaymentProcessorEnum: {
readonly STRIPE: "STRIPE";
readonly CHECKOUT_COM: "CHECKOUT_COM";
readonly WORLDLINE: "WORLDLINE";
readonly REDSYS: "REDSYS";
readonly PAYPAL: "PAYPAL";
readonly MANGOPAY: "MANGOPAY";
readonly ADYEN: "ADYEN";
};
export type CasePaymentProcessorEnum = typeof CasePaymentProcessorEnum[keyof typeof CasePaymentProcessorEnum];
export declare const CaseSectorEnum: {
readonly DIGITAL_PRODUCT: "DIGITAL_PRODUCT";
readonly EDUCATION: "EDUCATION";
readonly FASHION: "FASHION";
readonly FOOD: "FOOD";
readonly GAMING: "GAMING";
readonly HEALTH_BEAUTY: "HEALTH_BEAUTY";
readonly HOME: "HOME";
readonly LEISURE: "LEISURE";
readonly MARKETPLACE: "MARKETPLACE";
readonly PHONE: "PHONE";
readonly SOFTWARE: "SOFTWARE";
readonly SPORT: "SPORT";
readonly SUBSCRIPTION: "SUBSCRIPTION";
readonly SUPPLY: "SUPPLY";
readonly TECHNOLOGY: "TECHNOLOGY";
readonly TRANSPORT: "TRANSPORT";
readonly TRAVEL_AIRLINE: "TRAVEL_AIRLINE";
readonly TRAVEL_HOTEL: "TRAVEL_HOTEL";
};
export type CaseSectorEnum = typeof CaseSectorEnum[keyof typeof CaseSectorEnum];
/**
* Amount that the customer claims.
* @export
* @interface CaseDisputeAmount
*/
export interface CaseDisputeAmount {
/**
*
* @type {number}
* @memberof CaseDisputeAmount
*/
'value': number;
/**
*
* @type {Currencies}
* @memberof CaseDisputeAmount
*/
'currency': Currencies;
}
/**
* Sector of the case. It must be one of the sectors of the organization, for instance: EDUCATION, SOFTWARE, TRAVEL_HOTEL,...
* @export
* @enum {string}
*/
export declare const CaseSector: {
readonly DIGITAL_PRODUCT: "DIGITAL_PRODUCT";
readonly EDUCATION: "EDUCATION";
readonly FASHION: "FASHION";
readonly FOOD: "FOOD";
readonly GAMING: "GAMING";
readonly HEALTH_BEAUTY: "HEALTH_BEAUTY";
readonly HOME: "HOME";
readonly LEISURE: "LEISURE";
readonly MARKETPLACE: "MARKETPLACE";
readonly PHONE: "PHONE";
readonly SOFTWARE: "SOFTWARE";
readonly SPORT: "SPORT";
readonly SUBSCRIPTION: "SUBSCRIPTION";
readonly SUPPLY: "SUPPLY";
readonly TECHNOLOGY: "TECHNOLOGY";
readonly TRANSPORT: "TRANSPORT";
readonly TRAVEL_AIRLINE: "TRAVEL_AIRLINE";
readonly TRAVEL_HOTEL: "TRAVEL_HOTEL";
};
export type CaseSector = typeof CaseSector[keyof typeof CaseSector];
/**
* Current status of the case.
* @export
* @enum {string}
*/
export declare const CaseStatus: {
readonly PENDING: "PENDING";
readonly GENERATING: "GENERATING";
readonly GENERATED: "GENERATED";
readonly ALLEGING: "ALLEGING";
readonly ALLEGED: "ALLEGED";
readonly WON: "WON";
readonly LOST: "LOST";
readonly ACCEPTED: "ACCEPTED";
readonly EXPIRED: "EXPIRED";
};
export type CaseStatus = typeof CaseStatus[keyof typeof CaseStatus];
/**
* Reason why the customer is requesting the chargeback.
* @export
* @enum {string}
*/
export declare const ChargebackReason: {
readonly FRAUD: "FRAUD";
readonly PRODUCT_SERVICE_NOT_RECEIVED: "PRODUCT_SERVICE_NOT_RECEIVED";
readonly DEFECTIVE_PRODUCT_SERVICE: "DEFECTIVE_PRODUCT_SERVICE";
readonly PRODUCT_SERVICE_NOT_AS_DESCRIBED: "PRODUCT_SERVICE_NOT_AS_DESCRIBED";
readonly INCORRECT_DUPLICATED_CHARGES: "INCORRECT_DUPLICATED_CHARGES";
readonly PRODUCT_SERVICE_CANCELLED: "PRODUCT_SERVICE_CANCELLED";
readonly REFUND_NOT_RECEIVED: "REFUND_NOT_RECEIVED";
readonly RECURRENT_OPERATION_CANCELLED: "RECURRENT_OPERATION_CANCELLED";
};
export type ChargebackReason = typeof ChargebackReason[keyof typeof ChargebackReason];
/**
*
* @export
* @interface ClientWebhookEventDto
*/
export interface ClientWebhookEventDto {
/**
* The type of the webhook event
* @type {string}
* @memberof ClientWebhookEventDto
*/
'eventType': string;
/**
* The expedient number of the case that the webhook event is related to
* @type {string}
* @memberof ClientWebhookEventDto
*/
'expedientNumber': string;
/**
* The details of the case that the webhook event is related to
* @type {object}
* @memberof ClientWebhookEventDto
*/
'details': object;
}
/**
*
* @export
* @interface CommunicationItem
*/
export interface CommunicationItem {
/**
*
* @type {string}
* @memberof CommunicationItem
*/
'sender': string;
/**
*
* @type {string}
* @memberof CommunicationItem
*/
'content': string;
/**
*
* @type {string}
* @memberof CommunicationItem
*/
'date': string;
}
/**
*
* @export
* @enum {string}
*/
export declare const Currencies: {
readonly EUR: "EUR";
readonly GBP: "GBP";
readonly CHF: "CHF";
readonly NOK: "NOK";
readonly DKK: "DKK";
readonly SEK: "SEK";
readonly BGN: "BGN";
readonly HRK: "HRK";
readonly CZK: "CZK";
readonly HUF: "HUF";
readonly PLN: "PLN";
readonly RON: "RON";
readonly ISK: "ISK";
readonly RUB: "RUB";
readonly MKD: "MKD";
readonly RSD: "RSD";
readonly ARS: "ARS";
readonly BOB: "BOB";
readonly BRL: "BRL";
readonly CLP: "CLP";
readonly COP: "COP";
readonly CRC: "CRC";
readonly CUP: "CUP";
readonly DOP: "DOP";
readonly GTQ: "GTQ";
readonly HNL: "HNL";
readonly MXN: "MXN";
readonly NIO: "NIO";
readonly PAB: "PAB";
readonly PYG: "PYG";
readonly PEN: "PEN";
readonly SRD: "SRD";
readonly UYU: "UYU";
readonly VES: "VES";
readonly USD: "USD";
readonly CAD: "CAD";
readonly CNY: "CNY";
readonly JPY: "JPY";
readonly INR: "INR";
readonly KRW: "KRW";
readonly IDR: "IDR";
readonly MYR: "MYR";
readonly PHP: "PHP";
readonly SGD: "SGD";
readonly THB: "THB";
readonly VND: "VND";
readonly HKD: "HKD";
readonly TWD: "TWD";
readonly TRY: "TRY";
readonly AUD: "AUD";
readonly NZD: "NZD";
readonly FJD: "FJD";
readonly PGK: "PGK";
readonly WST: "WST";
readonly VUV: "VUV";
};
export type Currencies = typeof Currencies[keyof typeof Currencies];
/**
*
* @export
* @interface FileItem
*/
export interface FileItem {
/**
* File name
* @type {string}
* @memberof FileItem
*/
'name': string;
/**
* Uploaded file date
* @type {string}
* @memberof FileItem
*/
'uploadedAt': string;
/**
* File size in bytes
* @type {number}
* @memberof FileItem
*/
'size': number;
/**
* File mimetype
* @type {string}
* @memberof FileItem
*/
'mimetype': string;
}
/**
*
* @export
* @interface MissingFieldDto
*/
export interface MissingFieldDto {
/**
*
* @type {string}
* @memberof MissingFieldDto
*/
'field': string;
/**
*
* @type {string}
* @memberof MissingFieldDto
*/
'type': string;
/**
*
* @type {boolean}
* @memberof MissingFieldDto
*/
'required': boolean;
}
/**
*
* @export
* @interface MissingFieldsDto
*/
export interface MissingFieldsDto {
/**
* Array of all the Case entity fields that are found missing for the evaluated case
* @type {Array<MissingFieldDto>}
* @memberof MissingFieldsDto
*/
'missingFields': Array<MissingFieldDto>;
}
/**
*
* @export
* @interface UpdateCaseParams
*/
export interface UpdateCaseParams {
/**
* Terms and Conditions URL. Only applies for sectors: TRAVEL_AIRLINE, TRAVEL_HOTEL and LEISURE.
* @type {string}
* @memberof UpdateCaseParams
*/
'termsUrl'?: string;
/**
* Filial identifier related to the case. This should be the NIF, VAT or other unique identifier that is configured for your organization in Kloutit. If you do not have filials in your organization, leave this field empty.
* @type {string}
* @memberof UpdateCaseParams
*/
'filialIdentifier'?: string;
/**
* Date when the customer made the purchase in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'purchaseDate'?: string;
/**
* Service that the customer bought.
* @type {string}
* @memberof UpdateCaseParams
*/
'service'?: string;
/**
* Product that the customer bought.
* @type {string}
* @memberof UpdateCaseParams
*/
'product'?: string;
/**
* Flag that indicates if the charge made is refundable regarding your company terms and conditions.
* @type {boolean}
* @memberof UpdateCaseParams
*/
'isChargeRefundable'?: boolean;
/**
* Customer name.
* @type {string}
* @memberof UpdateCaseParams
*/
'customerName'?: string;
/**
* Customer email
* @type {string}
* @memberof UpdateCaseParams
*/
'customerEmail'?: string;
/**
* Customer phone.
* @type {string}
* @memberof UpdateCaseParams
*/
'customerPhone'?: string;
/**
* Date when the service was provided or will be provided in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'serviceDate'?: string;
/**
* Flag that indicates if the service was provided or not.
* @type {boolean}
* @memberof UpdateCaseParams
*/
'serviceWasProvided'?: boolean;
/**
* Check in date in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'checkinDate'?: string;
/**
* Check out date in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'checkoutDate'?: string;
/**
* Hotel name.
* @type {string}
* @memberof UpdateCaseParams
*/
'hotelName'?: string;
/**
* Rate applied.
* @type {string}
* @memberof UpdateCaseParams
*/
'rate'?: string;
/**
* Flag that indicates if the client made the checkin or not.
* @type {boolean}
* @memberof UpdateCaseParams
*/
'checkinConfirmation'?: boolean;
/**
* Destination country.
* @type {string}
* @memberof UpdateCaseParams
*/
'destinationCountry'?: string;
/**
* Departure date in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'departureDate'?: string;
/**
* Arrival date in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'arrivalDate'?: string;
/**
* Departure airport.
* @type {string}
* @memberof UpdateCaseParams
*/
'departureAirport'?: string;
/**
* Arrival airport.
* @type {string}
* @memberof UpdateCaseParams
*/
'arrivalAirport'?: string;
/**
* Departure city.
* @type {string}
* @memberof UpdateCaseParams
*/
'departureCity'?: string;
/**
* Arrival city.
* @type {string}
* @memberof UpdateCaseParams
*/
'arrivalCity'?: string;
/**
* Shipping city.
* @type {string}
* @memberof UpdateCaseParams
*/
'shippingCity'?: string;
/**
* Shipping province.
* @type {string}
* @memberof UpdateCaseParams
*/
'shippingProvince'?: string;
/**
* Shipping postal code.
* @type {string}
* @memberof UpdateCaseParams
*/
'shippingPostalCode'?: string;
/**
* Shipping date in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'shippingDate'?: string;
/**
* Delivery date in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'deliveryDate'?: string;
/**
* Delivery company.
* @type {string}
* @memberof UpdateCaseParams
*/
'deliveryCompany'?: string;
/**
* Flag that indicates if the customer received the product.
* @type {boolean}
* @memberof UpdateCaseParams
*/
'deliveryConfirmation'?: boolean;
/**
* Start date in UTC and ISO 8601 format of the commitment that the customer has with the company.
* @type {string}
* @memberof UpdateCaseParams
*/
'commitmentStartDate'?: string;
/**
* End date in UTC and ISO 8601 format of the commitment that the customer has with the company.
* @type {string}
* @memberof UpdateCaseParams
*/
'commitmentEndDate'?: string;
/**
* Flag that indicates if the subscription is cancelled or active.
* @type {boolean}
* @memberof UpdateCaseParams
*/
'isCancelled'?: boolean;
/**
* Product description.
* @type {string}
* @memberof UpdateCaseParams
*/
'productDescription'?: string;
/**
* Date when the customer contacted to the merchant in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'contactDate'?: string;
/**
* Array of all the emails that the customer has sent regarding this dispute. The structure of each item contains: **sender**: *customer* or *company*, **date**, **content**: string containing the message
* @type {Array<CommunicationItem>}
* @memberof UpdateCaseParams
*/
'communications'?: Array<CommunicationItem>;
/**
* Additional info related to the chargeback.
* @type {string}
* @memberof UpdateCaseParams
*/
'additionalInfo'?: string;
/**
* Last 4 digits of the customer\'s credit card number.
* @type {string}
* @memberof UpdateCaseParams
*/
'last4Digits'?: string;
/**
* Transaction date in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'transactionDate'?: string;
/**
* Purchase amount.
* @type {Amount}
* @memberof UpdateCaseParams
*/
'purchaseAmount'?: Amount;
/**
* Customer bank name.
* @type {string}
* @memberof UpdateCaseParams
*/
'bankName'?: string;
/**
* Card brand that the customer used to make the payment.
* @type {string}
* @memberof UpdateCaseParams
*/
'cardBrand'?: string;
/**
* Flag that indicates if the purchase has been made with 3DS.
* @type {boolean}
* @memberof UpdateCaseParams
*/
'is3DSPurchase'?: boolean;
/**
*
* @type {CaseSector}
* @memberof UpdateCaseParams
*/
'sector'?: CaseSector;
/**
* Date when the customer contacted to the seller in UTC and ISO 8601 format.
* @type {string}
* @memberof UpdateCaseParams
*/
'sellerContactDate'?: string;
/**
* Seller additional infromation.
* @type {string}
* @memberof UpdateCaseParams
*/
'sellerAdditionalInfo'?: string;
/**
* Seller name.
* @type {string}
* @memberof UpdateCaseParams
*/
'sellerName'?: string;
/**
* Seller phone number.
* @type {string}
* @memberof UpdateCaseParams
*/
'sellerPhone'?: string;
/**
* Seller email.
* @type {string}
* @memberof UpdateCaseParams
*/
'sellerEmail'?: string;
}
/**
* HealthApi - axios parameter creator
* @export
*/
export declare const HealthApiAxiosParamCreator: (configuration?: Configuration) => {
/**
*
* @summary Health check
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
healthControllerHealth: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* HealthApi - functional programming interface
* @export
*/
export declare const HealthApiFp: (configuration?: Configuration) => {
/**
*
* @summary Health check
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
healthControllerHealth(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
};
/**
* HealthApi - factory interface
* @export
*/
export declare const HealthApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @summary Health check
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
healthControllerHealth(options?: RawAxiosRequestConfig): AxiosPromise<string>;
};
/**
* HealthApi - object-oriented interface
* @export
* @class HealthApi
* @extends {BaseAPI}
*/
export declare class HealthApi extends BaseAPI {
/**
*
* @summary Health check
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof HealthApi
*/
healthControllerHealth(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any>>;
}
/**
* KloutitCaseApi - axios parameter creator
* @export
*/
export declare const KloutitCaseApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Validates that the case has been updated with all the needed information. It indicates in the response if there are still some fields that could be informed to Kloutit before generating the dispute. It also informs the type and the required nature of each field.
* @summary Check case information
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
checkCase: (expedientNumber: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Submits that the case has been updated with all the needed information. If you have configured automated dispute generation in Kloutit, this endpoint will indicate that the case is ready and will trigger the defense generation automatically.
* @summary Submit completed case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
submitCompletedCase: (expedientNumber: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Updates data to enrich an existing case in order to generate a more complete defense and increase the chances of winning.
* @summary Update case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {UpdateCaseParams} updateCaseParams
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCase: (expedientNumber: string, updateCaseParams: UpdateCaseParams, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Uploads a file into an existing case. You need to send a request of type ``multipart/form-data``. This file can be attached as a customer evidence, company evidence or product related file (for marketplace). Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``
* @summary Upload file
* @param {string} expedientNumber
* @param {File} file A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol. Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``. Ensure that the file upload adheres to [RFC 2388](https://www.ietf.org/rfc/rfc2388.txt), which defines file transfers for the multipart/form-data protocol.
* @param {UploadFileTypeEnum} type Type of file: ``customer``, ``company`` or ``product`` (product only for marketplace)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
uploadFile: (expedientNumber: string, file: File, type: UploadFileTypeEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Verifies if the webhook event received has been sent by Kloutit
* @summary Verify webhook event
* @param {ClientWebhookEventDto} clientWebhookEventDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
verifyEvent: (clientWebhookEventDto: ClientWebhookEventDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* KloutitCaseApi - functional programming interface
* @export
*/
export declare const KloutitCaseApiFp: (configuration?: Configuration) => {
/**
* Validates that the case has been updated with all the needed information. It indicates in the response if there are still some fields that could be informed to Kloutit before generating the dispute. It also informs the type and the required nature of each field.
* @summary Check case information
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
checkCase(expedientNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* Submits that the case has been updated with all the needed information. If you have configured automated dispute generation in Kloutit, this endpoint will indicate that the case is ready and will trigger the defense generation automatically.
* @summary Submit completed case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
submitCompletedCase(expedientNumber: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
/**
* Updates data to enrich an existing case in order to generate a more complete defense and increase the chances of winning.
* @summary Update case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {UpdateCaseParams} updateCaseParams
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCase(expedientNumber: string, updateCaseParams: UpdateCaseParams, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Case>>;
/**
* Uploads a file into an existing case. You need to send a request of type ``multipart/form-data``. This file can be attached as a customer evidence, company evidence or product related file (for marketplace). Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``
* @summary Upload file
* @param {string} expedientNumber
* @param {File} file A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol. Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``. Ensure that the file upload adheres to [RFC 2388](https://www.ietf.org/rfc/rfc2388.txt), which defines file transfers for the multipart/form-data protocol.
* @param {UploadFileTypeEnum} type Type of file: ``customer``, ``company`` or ``product`` (product only for marketplace)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
uploadFile(expedientNumber: string, file: File, type: UploadFileTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<FileItem>>;
/**
* Verifies if the webhook event received has been sent by Kloutit
* @summary Verify webhook event
* @param {ClientWebhookEventDto} clientWebhookEventDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
verifyEvent(clientWebhookEventDto: ClientWebhookEventDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
};
/**
* KloutitCaseApi - factory interface
* @export
*/
export declare const KloutitCaseApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Validates that the case has been updated with all the needed information. It indicates in the response if there are still some fields that could be informed to Kloutit before generating the dispute. It also informs the type and the required nature of each field.
* @summary Check case information
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
checkCase(expedientNumber: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
* Submits that the case has been updated with all the needed information. If you have configured automated dispute generation in Kloutit, this endpoint will indicate that the case is ready and will trigger the defense generation automatically.
* @summary Submit completed case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
submitCompletedCase(expedientNumber: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
* Updates data to enrich an existing case in order to generate a more complete defense and increase the chances of winning.
* @summary Update case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {UpdateCaseParams} updateCaseParams
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCase(expedientNumber: string, updateCaseParams: UpdateCaseParams, options?: RawAxiosRequestConfig): AxiosPromise<Case>;
/**
* Uploads a file into an existing case. You need to send a request of type ``multipart/form-data``. This file can be attached as a customer evidence, company evidence or product related file (for marketplace). Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``
* @summary Upload file
* @param {string} expedientNumber
* @param {File} file A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol. Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``. Ensure that the file upload adheres to [RFC 2388](https://www.ietf.org/rfc/rfc2388.txt), which defines file transfers for the multipart/form-data protocol.
* @param {UploadFileTypeEnum} type Type of file: ``customer``, ``company`` or ``product`` (product only for marketplace)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
uploadFile(expedientNumber: string, file: File, type: UploadFileTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise<FileItem>;
/**
* Verifies if the webhook event received has been sent by Kloutit
* @summary Verify webhook event
* @param {ClientWebhookEventDto} clientWebhookEventDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
verifyEvent(clientWebhookEventDto: ClientWebhookEventDto, options?: RawAxiosRequestConfig): AxiosPromise<void>;
};
/**
* KloutitCaseApi - object-oriented interface
* @export
* @class KloutitCaseApi
* @extends {BaseAPI}
*/
export declare class KloutitCaseApi extends BaseAPI {
/**
* Validates that the case has been updated with all the needed information. It indicates in the response if there are still some fields that could be informed to Kloutit before generating the dispute. It also informs the type and the required nature of each field.
* @summary Check case information
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof KloutitCaseApi
*/
checkCase(expedientNumber: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
* Submits that the case has been updated with all the needed information. If you have configured automated dispute generation in Kloutit, this endpoint will indicate that the case is ready and will trigger the defense generation automatically.
* @summary Submit completed case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof KloutitCaseApi
*/
submitCompletedCase(expedientNumber: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
/**
* Updates data to enrich an existing case in order to generate a more complete defense and increase the chances of winning.
* @summary Update case
* @param {string} expedientNumber Case expedient number. This value must exist in Kloutit.
* @param {UpdateCaseParams} updateCaseParams
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof KloutitCaseApi
*/
updateCase(expedientNumber: string, updateCaseParams: UpdateCaseParams, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Case, any>>;
/**
* Uploads a file into an existing case. You need to send a request of type ``multipart/form-data``. This file can be attached as a customer evidence, company evidence or product related file (for marketplace). Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``
* @summary Upload file
* @param {string} expedientNumber
* @param {File} file A file to upload. Make sure that the specifications follow RFC 2388, which defines file transfers for the multipart/form-data protocol. Allowed formats are ``PDF``, ``JPG``, ``JPEG``, ``PNG``. Max. file size is ``10Mb``. Ensure that the file upload adheres to [RFC 2388](https://www.ietf.org/rfc/rfc2388.txt), which defines file transfers for the multipart/form-data protocol.
* @param {UploadFileTypeEnum} type Type of file: ``customer``, ``company`` or ``product`` (product only for marketplace)
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof KloutitCaseApi
*/
uploadFile(expedientNumber: string, file: File, type: UploadFileTypeEnum, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<FileItem, any>>;
/**
* Verifies if the webhook event received has been sent by Kloutit
* @summary Verify webhook event
* @param {ClientWebhookEventDto} clientWebhookEventDto
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof KloutitCaseApi
*/
verifyEvent(clientWebhookEventDto: ClientWebhookEventDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
}
/**
* @export
*/
export declare const UploadFileTypeEnum: {
readonly COMPANY: "COMPANY";
readonly CUSTOMER: "CUSTOMER";
readonly PRODUCT: "PRODUCT";
};
export type UploadFileTypeEnum = typeof UploadFileTypeEnum[keyof typeof UploadFileTypeEnum];