nmkr-studio-api
Version:
Typesafe API Client to work with the NMKR Studio V2 API
219 lines (218 loc) • 10.4 kB
TypeScript
import type { AdditionalPayoutWalletsClass } from '../models/AdditionalPayoutWalletsClass';
import type { ApiErrorResultClass } from '../models/ApiErrorResultClass';
import type { Blockchain } from '../models/Blockchain';
import type { CreateBurningEndpointClass } from '../models/CreateBurningEndpointClass';
import type { CreateNewProjectResultClass } from '../models/CreateNewProjectResultClass';
import type { CreateProjectClassV2 } from '../models/CreateProjectClassV2';
import type { GetDiscountsClass } from '../models/GetDiscountsClass';
import type { GetNotificationsClass } from '../models/GetNotificationsClass';
import type { GetRefundsClass } from '../models/GetRefundsClass';
import type { GetSaleconditionsClass } from '../models/GetSaleconditionsClass';
import type { GetTransactionsClass } from '../models/GetTransactionsClass';
import type { IdentityInformationClass } from '../models/IdentityInformationClass';
import type { NftCountsClass } from '../models/NftCountsClass';
import type { NftProjectsDetails } from '../models/NftProjectsDetails';
import type { NotificationsClassV2 } from '../models/NotificationsClassV2';
import type { PriceDiscountClassV2 } from '../models/PriceDiscountClassV2';
import type { PricelistClass } from '../models/PricelistClass';
import type { PricelistClassV2 } from '../models/PricelistClassV2';
import type { ProjectSortOptions } from '../models/ProjectSortOptions';
import type { SaleconditionsClassV2 } from '../models/SaleconditionsClassV2';
import type { TransactionsExportOptions } from '../models/TransactionsExportOptions';
import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
export declare class ProjectsService {
readonly httpRequest: BaseHttpRequest;
constructor(httpRequest: BaseHttpRequest);
/**
* Creates a burning endpoint for a specific address
* When you call this endpoint, a Burning Address is created for this project. All NFTs associated with this project (same policyid) that are sent to this endpoint will be deleted (burned). All other NFTs will be sent back.
* The policy of the project must still be active.If it is already locked, it can no longer be deleted.
* @returns CreateBurningEndpointClass The burning address was created successfully
* @throws ApiError
*/
getV2CreateBurningAddress({ projectuid, addressactiveinhours, blockchain, }: {
projectuid: string;
addressactiveinhours: number;
blockchain?: Blockchain;
}): CancelablePromise<CreateBurningEndpointClass>;
/**
* Creates a new Project
* WIth this Controller you can create a new project
* @returns CreateNewProjectResultClass Returns the UploadNftResult Class
* @throws ApiError
*/
postV2CreateProject({ requestBody, }: {
requestBody?: CreateProjectClassV2;
}): CancelablePromise<CreateNewProjectResultClass>;
/**
* Deletes a project
* With this call you can delete a project
* @returns ApiErrorResultClass Returns the Apiresultclass with the information about the address incl. the assigned NFTs
* @throws ApiError
*/
getV2DeleteProject({ projectuid }: {
projectuid: string;
}): CancelablePromise<ApiErrorResultClass>;
/**
* Returns the additional payout wallets for a project (project uid)
* @returns AdditionalPayoutWalletsClass Returns an array of the PayoutWalletsClass
* @throws ApiError
*/
getV2GetAdditionalPayoutWallets({ projectuid, }: {
projectuid: string;
}): CancelablePromise<Array<AdditionalPayoutWalletsClass>>;
/**
* Returns the count of the sold, reserved and free nfts (project uid)
* You will get the count of all sold, reserved and free nfts of a particular project
* @returns NftCountsClass Returns the NftCountsClass
* @throws ApiError
*/
getV2GetCounts({ projectuid }: {
projectuid: string;
}): CancelablePromise<NftCountsClass>;
/**
* Returns the discounts for this project (project uid)
* If you call this function, you will get all active discounts for this project
* @returns GetDiscountsClass Returns an array of the GetDiscountsClass
* @throws ApiError
*/
getV2GetDiscounts({ projectuid }: {
projectuid: string;
}): CancelablePromise<Array<GetDiscountsClass>>;
/**
* Returns information about the identities (if the identity token was created) of a project
* You will receive all identities which are connected to this project
* @returns IdentityInformationClass Returns the Identities (if available)
* @throws ApiError
*/
getV2GetIdentityAccounts({ policyid }: {
policyid: string;
}): CancelablePromise<IdentityInformationClass>;
/**
* Returns the notifications for this project (project uid)
* @returns GetNotificationsClass Returns an array of the GetNotificationsClass
* @throws ApiError
*/
getV2GetNotifications({ projectuid, }: {
projectuid: string;
}): CancelablePromise<Array<GetNotificationsClass>>;
/**
* Returns the actual valid pricelist for this project (project uid)
* You will get the predefined prices for one or more NFTs
* @returns PricelistClass Returns an array of the PricelistClass
* @throws ApiError
*/
getV2GetPricelist({ projectuid, returnAllPrices, }: {
projectuid: string;
returnAllPrices?: boolean;
}): CancelablePromise<Array<PricelistClass>>;
/**
* Returns detail information about a project
* You will receive all information about this project
* @returns NftProjectsDetails Returns the NftProjectsDetails Class
* @throws ApiError
*/
getV2GetProjectDetails({ projectuid }: {
projectuid: string;
}): CancelablePromise<NftProjectsDetails>;
/**
* Returns all Transactions of a project
* @returns GetTransactionsClass Returns the result as ZIP File
* @returns any Returns the results as CSV File
* @throws ApiError
*/
getV2GetProjectTransactions({ projectuid, fromdate, todate, exportOptions, }: {
projectuid: string;
fromdate?: string;
todate?: string;
exportOptions?: TransactionsExportOptions;
}): CancelablePromise<Array<GetTransactionsClass> | any>;
/**
* Returns all Refunds of a project
* @returns GetRefundsClass Returns the result as ZIP File
* @returns any Returns the results as CSV File
* @throws ApiError
*/
getV2GetRefunds({ projectuid, fromdate, todate, exportOptions, }: {
projectuid: string;
fromdate?: string;
todate?: string;
exportOptions?: TransactionsExportOptions;
}): CancelablePromise<Array<GetRefundsClass> | any>;
/**
* Returns the saleconditions for this project (project uid)
* If you call this funtion, you will get all active saleconditions for this project
* @returns GetSaleconditionsClass Returns an array of the GetSaleconditionsClass
* @throws ApiError
*/
getV2GetSaleConditions({ projectuid, }: {
projectuid: string;
}): CancelablePromise<Array<GetSaleconditionsClass>>;
/**
* Lists all your projects
* You will receive a list with all of your projects
*
* IMPORTANT:
* This function uses an internal cache. All results will be cached for 10 seconds. You do not need to call this function more than once in 10 seconds, because the results will be the same.
* @returns NftProjectsDetails Returns the NftProjectsDetails Class
* @throws ApiError
*/
getV2ListProjects({ optionalSortOrder, }: {
optionalSortOrder?: ProjectSortOptions;
}): CancelablePromise<Array<NftProjectsDetails>>;
/**
* Lists all your projects with pagination
* You will receive a list with all of your projects
*
* IMPORTANT:
* This function uses an internal cache. All results will be cached for 10 seconds. You do not need to call this function more than once in 10 seconds, because the results will be the same.
* @returns NftProjectsDetails Returns the NftProjectsDetails Class
* @throws ApiError
*/
getV2ListProjects1({ count, page, optionalSortOrder, }: {
count: number;
page: number;
optionalSortOrder?: ProjectSortOptions;
}): CancelablePromise<Array<NftProjectsDetails>>;
/**
* Updates the discounts of a project
* WIth this Controller you can update the discounts of a project. All old entries will be deleted. If you want to clear the discounts, just send an empty array
* @returns any The discounts was successfully updated
* @throws ApiError
*/
putV2UpdateDiscounts({ projectuid, requestBody, }: {
projectuid: string;
requestBody?: Array<PriceDiscountClassV2>;
}): CancelablePromise<any>;
/**
* Updates the notifications of a project
* WIth this Controller you can update the notifications. All old entries will be deleted. If you want to clear the notifications, just send an empty array
* @returns GetNotificationsClass The notifications was successfully updated
* @throws ApiError
*/
postV2UpdateNotifications({ projectuid, requestBody, }: {
projectuid: string;
requestBody?: Array<NotificationsClassV2>;
}): CancelablePromise<Array<GetNotificationsClass>>;
/**
* Updates a pricelist of a project
* WIth this Controller you can update a pricelist of a project. All old entries will be deleted. If you want to clear the pricelist, just send an empty array
* @returns any The pricelist was successfully updated
* @throws ApiError
*/
putV2UpdatePricelist({ projectuid, requestBody, }: {
projectuid: string;
requestBody?: Array<PricelistClassV2>;
}): CancelablePromise<any>;
/**
* Updates the saleconditions of a project
* WIth this Controller you can update the saleconditions of a project. All old entries will be deleted. If you want to clear the saleconditions, just send an empty array
* @returns any The saleconditions was successfully updated
* @throws ApiError
*/
putV2UpdateSaleConditions({ projectuid, requestBody, }: {
projectuid: string;
requestBody?: Array<SaleconditionsClassV2>;
}): CancelablePromise<any>;
}