fake-iamport-server
Version:
Fake iamport server for testing
95 lines (94 loc) • 3.15 kB
TypeScript
/**
* @packageDocumentation
* @module api.functional.receipts
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
import type { IConnection } from "@nestia/fetcher";
import type { IIamportReceipt } from "../../structures/IIamportReceipt";
import type { IIamportResponse } from "../../structures/IIamportResponse";
/**
* 현금 영수증 조회하기.
*
* @param imp_uid 귀속 결제의 {@link IIamportPayment.imp_uid }
* @returns 현금 영수증 정보
* @security bearer
* @author Samchon
*
* @controller FakeIamportReceiptsController.at
* @path GET /receipts/:imp_uid
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
export declare function at(connection: IConnection, imp_uid: string): Promise<at.Output>;
export declare namespace at {
type Output = IIamportResponse<IIamportReceipt>;
const METADATA: {
readonly method: "GET";
readonly path: "/receipts/:imp_uid";
readonly request: null;
readonly response: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly status: 200;
};
const path: (imp_uid: string) => string;
}
/**
* 현금 영수증 발행하기.
*
* @param imp_uid 귀속 결제의 {@link IIamportPayment.imp_uid }
* @param input 현금 영수증 입력 정보
* @returns 현금 영수증 정보
* @security bearer
* @author Samchon
*
* @controller FakeIamportReceiptsController.create
* @path POST /receipts/:imp_uid
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
export declare function create(connection: IConnection, imp_uid: string, input: IIamportReceipt.ICreate): Promise<create.Output>;
export declare namespace create {
type Input = IIamportReceipt.ICreate;
type Output = IIamportResponse<IIamportReceipt>;
const METADATA: {
readonly method: "POST";
readonly path: "/receipts/:imp_uid";
readonly request: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly response: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly status: 201;
};
const path: (imp_uid: string) => string;
}
/**
* 현금 영수증 취소하기.
*
* @param imp_uid 귀속 결제의 {@link IIamportPayment.imp_uid }
* @returns 취소된 현금 영수증 정보
* @security bearer
* @author Samchon
*
* @controller FakeIamportReceiptsController.erase
* @path DELETE /receipts/:imp_uid
* @nestia Generated by Nestia - https://github.com/samchon/nestia
*/
export declare function erase(connection: IConnection, imp_uid: string): Promise<erase.Output>;
export declare namespace erase {
type Output = IIamportResponse<IIamportReceipt>;
const METADATA: {
readonly method: "DELETE";
readonly path: "/receipts/:imp_uid";
readonly request: null;
readonly response: {
readonly type: "application/json";
readonly encrypted: false;
};
readonly status: 200;
};
const path: (imp_uid: string) => string;
}