@simpleapps-com/augur-api
Version:
TypeScript client library for Augur microservices API endpoints
99 lines • 3.26 kB
TypeScript
import { type TransUserCreateParams } from '../schemas';
import type { P21ApisClient } from '../client';
type ExecuteRequest = P21ApisClient['executeRequest'];
/**
* Creates the transUser resource methods
* OpenAPI Path: /trans-user → transUser.*
* @description User management and CRUD operations following OpenAPI path mirroring pattern
*/
export declare function createTransUserResource(executeRequest: ExecuteRequest): {
/**
* Create new transaction user - OpenAPI Path: /trans-user
*/
create: (params?: TransUserCreateParams) => Promise<{
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Get transaction user details by user UID - OpenAPI Path: /trans-user/{usersUid}
*/
get: (usersUid: number, params?: {
userId?: string;
}) => Promise<{
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Update transaction user by user UID - OpenAPI Path: /trans-user/{usersUid}
*/
update: (usersUid: number, params?: {
userId?: string;
}) => Promise<{
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
/**
* Delete transaction user by user UID - OpenAPI Path: /trans-user/{usersUid}
*/
delete: (usersUid: number, params?: {
userId?: string;
}) => Promise<{
params: Record<string, unknown> | unknown[];
options: Record<string, unknown> | unknown[];
status: number;
message: string;
count: number;
total: number;
totalResults: number;
data?: unknown;
}>;
};
/**
* Creates the transUserData resource methods (data-only versions)
*/
export declare function createTransUserDataResource(transUser: ReturnType<typeof createTransUserResource>): {
/**
* Create user and return only data without response metadata
*/
create: (params?: TransUserCreateParams) => Promise<unknown>;
/**
* Get user and return only data without response metadata
*/
get: (usersUid: number, params?: {
userId?: string;
}) => Promise<unknown>;
/**
* Update user and return only data without response metadata
*/
update: (usersUid: number, params?: {
userId?: string;
}) => Promise<unknown>;
/**
* Delete user and return only data without response metadata
*/
delete: (usersUid: number, params?: {
userId?: string;
}) => Promise<unknown>;
};
export type TransUserResource = ReturnType<typeof createTransUserResource>;
export type TransUserDataResource = ReturnType<typeof createTransUserDataResource>;
export {};
//# sourceMappingURL=trans-user.d.ts.map