@zennify/sdk-js 1.47.1 → 2.0.0

package/types/lib/api/sdk.gen.d.ts

@@ -0,0 +1,235 @@
+import { type Client, type Options as Options2, type TDataShape } from "./client";
+import type { AddModeratorToStoreData, AddModeratorToStoreErrors, AddModeratorToStoreResponses, CreateStoreCouponData, CreateStoreCouponErrors, CreateStoreCouponResponses, CreateStoreData, CreateStoreDiscordEmojisData, CreateStoreDiscordEmojisErrors, CreateStoreDiscordEmojisResponses, CreateStoreDiscordPanelData, CreateStoreDiscordPanelErrors, CreateStoreDiscordPanelResponses, CreateStoreEditOrderData, CreateStoreEditOrderErrors, CreateStoreEditOrderResponses, CreateStoreErrors, CreateStoreProductData, CreateStoreProductErrors, CreateStoreProductResponses, CreateStoreRenewOrderData, CreateStoreRenewOrderErrors, CreateStoreRenewOrderResponses, CreateStoreResponses, DeleteStoreCouponData, DeleteStoreCouponErrors, DeleteStoreCouponResponses, DeleteStoreDiscordPanelData, DeleteStoreDiscordPanelErrors, DeleteStoreDiscordPanelResponses, DeleteStoreDiscordServerData, DeleteStoreDiscordServerErrors, DeleteStoreDiscordServerResponses, DeleteStoreMediaData, DeleteStoreMediaErrors, DeleteStoreMediaResponses, DeleteStoreProductData, DeleteStoreProductErrors, DeleteStoreProductResponses, EditStoreModeratorData, EditStoreModeratorErrors, EditStoreModeratorResponses, EditUserData, EditUserErrors, EditUserResponses, GetApiReferenceData, GetApiReferenceResponses, GetServiceApiSchemaData, GetServiceApiSchemaResponses, GetServiceDataData, GetServiceDataResponses, GetServiceHealthData, GetServiceHealthResponses, GetStoreCouponData, GetStoreCouponErrors, GetStoreCouponResponses, GetStoreCouponsData, GetStoreCouponsErrors, GetStoreCouponsResponses, GetStoreData, GetStoreDiscordBotData, GetStoreDiscordBotErrors, GetStoreDiscordBotResponses, GetStoreDiscordPanelsData, GetStoreDiscordPanelsErrors, GetStoreDiscordPanelsResponses, GetStoreDiscordServersData, GetStoreDiscordServersErrors, GetStoreDiscordServersResponses, GetStoreErrors, GetStoreProductData, GetStoreProductErrors, GetStoreProductResponses, GetStoreProductStockData, GetStoreProductStockErrors, GetStoreProductStockResponses, GetStoreRankingCustomersData, GetStoreRankingCustomersErrors, GetStoreRankingCustomersResponses, GetStoreResponses, GetStoresData, GetStoresErrors, GetStoresResponses, GetStoreStatsProductsData, GetStoreStatsProductsErrors, GetStoreStatsProductsResponses, GetTransactionData, GetTransactionErrors, GetTransactionResponses, GetUserByIdData, GetUserByIdErrors, GetUserByIdResponses, GetUserData, GetUserErrors, GetUserResponses, ListStoreProductsData, ListStoreProductsErrors, ListStoreProductsResponses, ListTransactionsData, ListTransactionsErrors, ListTransactionsResponses, PostStoreDiscordPanelMessageData, PostStoreDiscordPanelMessageErrors, PostStoreDiscordPanelMessageResponses, PostStoreProductDiscordMessageData, PostStoreProductDiscordMessageErrors, PostStoreProductDiscordMessageResponses, RemoveStoreModeratorData, RemoveStoreModeratorErrors, RemoveStoreModeratorResponses, SetupEfiData, SetupEfiErrors, SetupEfiResponses, SetupWebhookData, SetupWebhookErrors, SetupWebhookResponses, UpdatePaymentMethodData, UpdatePaymentMethodErrors, UpdatePaymentMethodResponses, UpdatePixKeyData, UpdatePixKeyErrors, UpdatePixKeyResponses, UpdateStoreCouponData, UpdateStoreCouponErrors, UpdateStoreCouponResponses, UpdateStoreData, UpdateStoreDiscordBotTokenData, UpdateStoreDiscordBotTokenErrors, UpdateStoreDiscordBotTokenResponses, UpdateStoreDiscordChannelsData, UpdateStoreDiscordChannelsErrors, UpdateStoreDiscordChannelsResponses, UpdateStoreDiscordPanelData, UpdateStoreDiscordPanelErrors, UpdateStoreDiscordPanelResponses, UpdateStoreErrors, UpdateStoreProductData, UpdateStoreProductErrors, UpdateStoreProductResponses, UpdateStoreProductStockData, UpdateStoreProductStockErrors, UpdateStoreProductStockItemData, UpdateStoreProductStockItemErrors, UpdateStoreProductStockItemResponses, UpdateStoreProductStockResponses, UpdateStoreResponses, UpdateTransactionData, UpdateTransactionErrors, UpdateTransactionResponses, UpdateUserAvatarData, UpdateUserAvatarErrors, UpdateUserAvatarResponses, UploadStoreMediaData, UploadStoreMediaErrors, UploadStoreMediaResponses, WalletBalanceData, WalletBalanceErrors, WalletBalanceResponses, WalletWithdrawData, WalletWithdrawErrors, WalletWithdrawResponses } from "./types.gen";
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Return service health data, including cache and database status.
+ */
+export declare const getServiceHealth: <ThrowOnError extends boolean = false>(options?: Options<GetServiceHealthData, ThrowOnError>) => import("./client").RequestResult<GetServiceHealthResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Return current OpenAPI specification.
+ */
+export declare const getServiceApiSchema: <ThrowOnError extends boolean = false>(options?: Options<GetServiceApiSchemaData, ThrowOnError>) => import("./client").RequestResult<GetServiceApiSchemaResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Delete a store Discord sale panel.
+ */
+export declare const deleteStoreDiscordPanel: <ThrowOnError extends boolean = false>(options: Options<DeleteStoreDiscordPanelData, ThrowOnError>) => import("./client").RequestResult<DeleteStoreDiscordPanelResponses, DeleteStoreDiscordPanelErrors, ThrowOnError, "fields">;
+/**
+ * Update a store Discord sale panel.
+ */
+export declare const updateStoreDiscordPanel: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreDiscordPanelData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreDiscordPanelResponses, UpdateStoreDiscordPanelErrors, ThrowOnError, "fields">;
+/**
+ * List store Discord sale panels.
+ */
+export declare const getStoreDiscordPanels: <ThrowOnError extends boolean = false>(options: Options<GetStoreDiscordPanelsData, ThrowOnError>) => import("./client").RequestResult<GetStoreDiscordPanelsResponses, GetStoreDiscordPanelsErrors, ThrowOnError, "fields">;
+/**
+ * Create a store Discord sale panel.
+ */
+export declare const createStoreDiscordPanel: <ThrowOnError extends boolean = false>(options: Options<CreateStoreDiscordPanelData, ThrowOnError>) => import("./client").RequestResult<CreateStoreDiscordPanelResponses, CreateStoreDiscordPanelErrors, ThrowOnError, "fields">;
+/**
+ * Ask the store Discord bot to post a panel message in a channel.
+ */
+export declare const postStoreDiscordPanelMessage: <ThrowOnError extends boolean = false>(options: Options<PostStoreDiscordPanelMessageData, ThrowOnError>) => import("./client").RequestResult<PostStoreDiscordPanelMessageResponses, PostStoreDiscordPanelMessageErrors, ThrowOnError, "fields">;
+/**
+ * Ask the store Discord bot to post a product message in a channel.
+ */
+export declare const postStoreProductDiscordMessage: <ThrowOnError extends boolean = false>(options: Options<PostStoreProductDiscordMessageData, ThrowOnError>) => import("./client").RequestResult<PostStoreProductDiscordMessageResponses, PostStoreProductDiscordMessageErrors, ThrowOnError, "fields">;
+/**
+ * Delete a store product.
+ */
+export declare const deleteStoreProduct: <ThrowOnError extends boolean = false>(options: Options<DeleteStoreProductData, ThrowOnError>) => import("./client").RequestResult<DeleteStoreProductResponses, DeleteStoreProductErrors, ThrowOnError, "fields">;
+/**
+ * Access a store product.
+ */
+export declare const getStoreProduct: <ThrowOnError extends boolean = false>(options: Options<GetStoreProductData, ThrowOnError>) => import("./client").RequestResult<GetStoreProductResponses, GetStoreProductErrors, ThrowOnError, "fields">;
+/**
+ * Update a store product.
+ */
+export declare const updateStoreProduct: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreProductData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreProductResponses, UpdateStoreProductErrors, ThrowOnError, "fields">;
+/**
+ * List products from a store.
+ */
+export declare const listStoreProducts: <ThrowOnError extends boolean = false>(options: Options<ListStoreProductsData, ThrowOnError>) => import("./client").RequestResult<ListStoreProductsResponses, ListStoreProductsErrors, ThrowOnError, "fields">;
+/**
+ * Create a store product.
+ */
+export declare const createStoreProduct: <ThrowOnError extends boolean = false>(options: Options<CreateStoreProductData, ThrowOnError>) => import("./client").RequestResult<CreateStoreProductResponses, CreateStoreProductErrors, ThrowOnError, "fields">;
+/**
+ * Update a product stock item.
+ */
+export declare const updateStoreProductStockItem: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreProductStockItemData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreProductStockItemResponses, UpdateStoreProductStockItemErrors, ThrowOnError, "fields">;
+/**
+ * List available stock items for a product.
+ */
+export declare const getStoreProductStock: <ThrowOnError extends boolean = false>(options: Options<GetStoreProductStockData, ThrowOnError>) => import("./client").RequestResult<GetStoreProductStockResponses, GetStoreProductStockErrors, ThrowOnError, "fields">;
+/**
+ * Add or remove product stock items and update stock lock settings.
+ */
+export declare const updateStoreProductStock: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreProductStockData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreProductStockResponses, UpdateStoreProductStockErrors, ThrowOnError, "fields">;
+/**
+ * Return current OpenAPI specification.
+ */
+export declare const getApiReference: <ThrowOnError extends boolean = false>(options?: Options<GetApiReferenceData, ThrowOnError>) => import("./client").RequestResult<GetApiReferenceResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Returns basic service data, focused on website functionality (such as home statistics), but is a public route.
+ */
+export declare const getServiceData: <ThrowOnError extends boolean = false>(options?: Options<GetServiceDataData, ThrowOnError>) => import("./client").RequestResult<GetServiceDataResponses, unknown, ThrowOnError, "fields">;
+/**
+ * Update store Discord channel bindings.
+ */
+export declare const updateStoreDiscordChannels: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreDiscordChannelsData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreDiscordChannelsResponses, UpdateStoreDiscordChannelsErrors, ThrowOnError, "fields">;
+/**
+ * Create Discord emojis in a store bot guild.
+ */
+export declare const createStoreDiscordEmojis: <ThrowOnError extends boolean = false>(options: Options<CreateStoreDiscordEmojisData, ThrowOnError>) => import("./client").RequestResult<CreateStoreDiscordEmojisResponses, CreateStoreDiscordEmojisErrors, ThrowOnError, "fields">;
+/**
+ * Get the configured Discord bot status for a store.
+ */
+export declare const getStoreDiscordBot: <ThrowOnError extends boolean = false>(options: Options<GetStoreDiscordBotData, ThrowOnError>) => import("./client").RequestResult<GetStoreDiscordBotResponses, GetStoreDiscordBotErrors, ThrowOnError, "fields">;
+/**
+ * Remove a store Discord bot from a guild.
+ */
+export declare const deleteStoreDiscordServer: <ThrowOnError extends boolean = false>(options: Options<DeleteStoreDiscordServerData, ThrowOnError>) => import("./client").RequestResult<DeleteStoreDiscordServerResponses, DeleteStoreDiscordServerErrors, ThrowOnError, "fields">;
+/**
+ * List Discord guilds cached for a store bot.
+ */
+export declare const getStoreDiscordServers: <ThrowOnError extends boolean = false>(options: Options<GetStoreDiscordServersData, ThrowOnError>) => import("./client").RequestResult<GetStoreDiscordServersResponses, GetStoreDiscordServersErrors, ThrowOnError, "fields">;
+/**
+ * Update a store Discord bot token.
+ */
+export declare const updateStoreDiscordBotToken: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreDiscordBotTokenData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreDiscordBotTokenResponses, UpdateStoreDiscordBotTokenErrors, ThrowOnError, "fields">;
+/**
+ * Delete a store coupon.
+ */
+export declare const deleteStoreCoupon: <ThrowOnError extends boolean = false>(options: Options<DeleteStoreCouponData, ThrowOnError>) => import("./client").RequestResult<DeleteStoreCouponResponses, DeleteStoreCouponErrors, ThrowOnError, "fields">;
+/**
+ * Access a store coupon.
+ */
+export declare const getStoreCoupon: <ThrowOnError extends boolean = false>(options: Options<GetStoreCouponData, ThrowOnError>) => import("./client").RequestResult<GetStoreCouponResponses, GetStoreCouponErrors, ThrowOnError, "fields">;
+/**
+ * Update a store coupon.
+ */
+export declare const updateStoreCoupon: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreCouponData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreCouponResponses, UpdateStoreCouponErrors, ThrowOnError, "fields">;
+/**
+ * List store coupons.
+ */
+export declare const getStoreCoupons: <ThrowOnError extends boolean = false>(options: Options<GetStoreCouponsData, ThrowOnError>) => import("./client").RequestResult<GetStoreCouponsResponses, GetStoreCouponsErrors, ThrowOnError, "fields">;
+/**
+ * Create a store coupon.
+ */
+export declare const createStoreCoupon: <ThrowOnError extends boolean = false>(options: Options<CreateStoreCouponData, ThrowOnError>) => import("./client").RequestResult<CreateStoreCouponResponses, CreateStoreCouponErrors, ThrowOnError, "fields">;
+/**
+ * Create an order to edit store addons or limits.
+ */
+export declare const createStoreEditOrder: <ThrowOnError extends boolean = false>(options: Options<CreateStoreEditOrderData, ThrowOnError>) => import("./client").RequestResult<CreateStoreEditOrderResponses, CreateStoreEditOrderErrors, ThrowOnError, "fields">;
+/**
+ * Create an order to renew a store.
+ */
+export declare const createStoreRenewOrder: <ThrowOnError extends boolean = false>(options: Options<CreateStoreRenewOrderData, ThrowOnError>) => import("./client").RequestResult<CreateStoreRenewOrderResponses, CreateStoreRenewOrderErrors, ThrowOnError, "fields">;
+/**
+ * Detach media from store entities.
+ */
+export declare const deleteStoreMedia: <ThrowOnError extends boolean = false>(options: Options<DeleteStoreMediaData, ThrowOnError>) => import("./client").RequestResult<DeleteStoreMediaResponses, DeleteStoreMediaErrors, ThrowOnError, "fields">;
+/**
+ * Upload a media file and attach it to store entities.
+ */
+export declare const uploadStoreMedia: <ThrowOnError extends boolean = false>(options: Options<UploadStoreMediaData, ThrowOnError>) => import("./client").RequestResult<UploadStoreMediaResponses, UploadStoreMediaErrors, ThrowOnError, "fields">;
+/**
+ * Delete a store moderator.
+ */
+export declare const removeStoreModerator: <ThrowOnError extends boolean = false>(options: Options<RemoveStoreModeratorData, ThrowOnError>) => import("./client").RequestResult<RemoveStoreModeratorResponses, RemoveStoreModeratorErrors, ThrowOnError, "fields">;
+/**
+ * Update a store moderator.
+ */
+export declare const editStoreModerator: <ThrowOnError extends boolean = false>(options: Options<EditStoreModeratorData, ThrowOnError>) => import("./client").RequestResult<EditStoreModeratorResponses, EditStoreModeratorErrors, ThrowOnError, "fields">;
+/**
+ * Create a store moderator invite.
+ */
+export declare const addModeratorToStore: <ThrowOnError extends boolean = false>(options: Options<AddModeratorToStoreData, ThrowOnError>) => import("./client").RequestResult<AddModeratorToStoreResponses, AddModeratorToStoreErrors, ThrowOnError, "fields">;
+/**
+ * Access store customers ranking, updated in real time.
+ */
+export declare const getStoreRankingCustomers: <ThrowOnError extends boolean = false>(options: Options<GetStoreRankingCustomersData, ThrowOnError>) => import("./client").RequestResult<GetStoreRankingCustomersResponses, GetStoreRankingCustomersErrors, ThrowOnError, "fields">;
+/**
+ * Access store product statistics, real-time updated.
+ */
+export declare const getStoreStatsProducts: <ThrowOnError extends boolean = false>(options: Options<GetStoreStatsProductsData, ThrowOnError>) => import("./client").RequestResult<GetStoreStatsProductsResponses, GetStoreStatsProductsErrors, ThrowOnError, "fields">;
+/**
+ * Access store data.
+ */
+export declare const getStore: <ThrowOnError extends boolean = false>(options: Options<GetStoreData, ThrowOnError>) => import("./client").RequestResult<GetStoreResponses, GetStoreErrors, ThrowOnError, "fields">;
+/**
+ * Update store settings.
+ */
+export declare const updateStore: <ThrowOnError extends boolean = false>(options: Options<UpdateStoreData, ThrowOnError>) => import("./client").RequestResult<UpdateStoreResponses, UpdateStoreErrors, ThrowOnError, "fields">;
+/**
+ * List stores owned or moderated by the current user.
+ */
+export declare const getStores: <ThrowOnError extends boolean = false>(options?: Options<GetStoresData, ThrowOnError>) => import("./client").RequestResult<GetStoresResponses, GetStoresErrors, ThrowOnError, "fields">;
+/**
+ * Create a checkout order for a new store.
+ */
+export declare const createStore: <ThrowOnError extends boolean = false>(options?: Options<CreateStoreData, ThrowOnError>) => import("./client").RequestResult<CreateStoreResponses, CreateStoreErrors, ThrowOnError, "fields">;
+/**
+ * List transactions for the authenticated user.
+ */
+export declare const listTransactions: <ThrowOnError extends boolean = false>(options?: Options<ListTransactionsData, ThrowOnError>) => import("./client").RequestResult<ListTransactionsResponses, ListTransactionsErrors, ThrowOnError, "fields">;
+/**
+ * Access a transaction by id or Pix E2E id.
+ */
+export declare const getTransaction: <ThrowOnError extends boolean = false>(options: Options<GetTransactionData, ThrowOnError>) => import("./client").RequestResult<GetTransactionResponses, GetTransactionErrors, ThrowOnError, "fields">;
+/**
+ * Update transaction status or metadata.
+ */
+export declare const updateTransaction: <ThrowOnError extends boolean = false>(options: Options<UpdateTransactionData, ThrowOnError>) => import("./client").RequestResult<UpdateTransactionResponses, UpdateTransactionErrors, ThrowOnError, "fields">;
+/**
+ * Access current user data
+ */
+export declare const getUserById: <ThrowOnError extends boolean = false>(options: Options<GetUserByIdData, ThrowOnError>) => import("./client").RequestResult<GetUserByIdResponses, GetUserByIdErrors, ThrowOnError, "fields">;
+/**
+ * Update users's avatar
+ */
+export declare const updateUserAvatar: <ThrowOnError extends boolean = false>(options?: Options<UpdateUserAvatarData, ThrowOnError>) => import("./client").RequestResult<UpdateUserAvatarResponses, UpdateUserAvatarErrors, ThrowOnError, "fields">;
+/**
+ * Access current user data
+ */
+export declare const getUser: <ThrowOnError extends boolean = false>(options?: Options<GetUserData, ThrowOnError>) => import("./client").RequestResult<GetUserResponses, GetUserErrors, ThrowOnError, "fields">;
+/**
+ * Edit current user data
+ */
+export declare const editUser: <ThrowOnError extends boolean = false>(options?: Options<EditUserData, ThrowOnError>) => import("./client").RequestResult<EditUserResponses, EditUserErrors, ThrowOnError, "fields">;
+/**
+ * Update the user's preferred payment method.
+ */
+export declare const updatePaymentMethod: <ThrowOnError extends boolean = false>(options?: Options<UpdatePaymentMethodData, ThrowOnError>) => import("./client").RequestResult<UpdatePaymentMethodResponses, UpdatePaymentMethodErrors, ThrowOnError, "fields">;
+/**
+ * Configures the user's Efí account with certificate, Pix key, and OAuth credentials.
+ */
+export declare const setupEfi: <ThrowOnError extends boolean = false>(options?: Options<SetupEfiData, ThrowOnError>) => import("./client").RequestResult<SetupEfiResponses, SetupEfiErrors, ThrowOnError, "fields">;
+/**
+ * Update the user's semiauto Pix key.
+ */
+export declare const updatePixKey: <ThrowOnError extends boolean = false>(options?: Options<UpdatePixKeyData, ThrowOnError>) => import("./client").RequestResult<UpdatePixKeyResponses, UpdatePixKeyErrors, ThrowOnError, "fields">;
+/**
+ * Returns the user's Zennify Wallet balance.
+ */
+export declare const walletBalance: <ThrowOnError extends boolean = false>(options?: Options<WalletBalanceData, ThrowOnError>) => import("./client").RequestResult<WalletBalanceResponses, WalletBalanceErrors, ThrowOnError, "fields">;
+/**
+ * Requests a withdrawal from the user's Zennify Wallet.
+ */
+export declare const walletWithdraw: <ThrowOnError extends boolean = false>(options?: Options<WalletWithdrawData, ThrowOnError>) => import("./client").RequestResult<WalletWithdrawResponses, WalletWithdrawErrors, ThrowOnError, "fields">;
+/**
+ * Setup an HTTP webhook for the user.
+ */
+export declare const setupWebhook: <ThrowOnError extends boolean = false>(options?: Options<SetupWebhookData, ThrowOnError>) => import("./client").RequestResult<SetupWebhookResponses, SetupWebhookErrors, ThrowOnError, "fields">;