@neynar/nodejs-sdk
Version:
SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)
284 lines (283 loc) • 14.1 kB
TypeScript
/**
* Neynar API
* The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 3.175.0
* Contact: team@neynar.com
*
* 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, BaseAPI } from '../base';
import type { Billing200Response } from '../models';
import type { Upgrade200Response } from '../models';
import type { UpgradePreview200Response } from '../models';
import type { UpgradeRequest } from '../models';
/**
* PortalApi - axios parameter creator
* @export
*/
export declare const PortalApiAxiosParamCreator: (configuration?: Configuration) => {
/**
* Retrieves billing and subscription details for the current organization, including plan status, product category, billing email, and effective plan.
* @summary Get billing information for the current organization
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Billing200Response>} A promise that resolves to a `Billing200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/billing)
*
*/
billing: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.
* @summary Process subscription upgrade with credit
* @param {UpgradeRequest} upgradeRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Upgrade200Response>} A promise that resolves to a `Upgrade200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade)
*
*/
upgrade: (upgradeRequest: UpgradeRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
/**
* Calculates the billing impact of changing to a new subscription plan, including available credit, charge amount, and whether the billing date or usage carryover changes.
* @summary Get upgrade preview with credit calculation
* @param {string} newPlan
* @param {UpgradePreviewProductCategoryEnum} [productCategory]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<UpgradePreview200Response>} A promise that resolves to a `UpgradePreview200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade-preview)
*
*/
upgradePreview: (newPlan: string, productCategory?: UpgradePreviewProductCategoryEnum, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};
/**
* PortalApi - functional programming interface
* @export
*/
export declare const PortalApiFp: (configuration?: Configuration) => {
/**
* Retrieves billing and subscription details for the current organization, including plan status, product category, billing email, and effective plan.
* @summary Get billing information for the current organization
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Billing200Response>} A promise that resolves to a `Billing200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/billing)
*
*/
billing(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Billing200Response>>;
/**
* Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.
* @summary Process subscription upgrade with credit
* @param {UpgradeRequest} upgradeRequest
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Upgrade200Response>} A promise that resolves to a `Upgrade200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade)
*
*/
upgrade(upgradeRequest: UpgradeRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Upgrade200Response>>;
/**
* Calculates the billing impact of changing to a new subscription plan, including available credit, charge amount, and whether the billing date or usage carryover changes.
* @summary Get upgrade preview with credit calculation
* @param {string} newPlan
* @param {UpgradePreviewProductCategoryEnum} [productCategory]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<UpgradePreview200Response>} A promise that resolves to a `UpgradePreview200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade-preview)
*
*/
upgradePreview(newPlan: string, productCategory?: UpgradePreviewProductCategoryEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpgradePreview200Response>>;
};
/**
* PortalApi - factory interface
* @export
*/
export declare const PortalApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
* Retrieves billing and subscription details for the current organization, including plan status, product category, billing email, and effective plan.
* @summary Get billing information for the current organization
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Billing200Response>} A promise that resolves to a `Billing200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/billing)
*
*/
billing(options?: RawAxiosRequestConfig): AxiosPromise<Billing200Response>;
/**
* Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.
* @summary Process subscription upgrade with credit
* @param {PortalApiUpgradeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<Upgrade200Response>} A promise that resolves to a `Upgrade200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade)
*
*/
upgrade(requestParameters: PortalApiUpgradeRequest, options?: RawAxiosRequestConfig): AxiosPromise<Upgrade200Response>;
/**
* Calculates the billing impact of changing to a new subscription plan, including available credit, charge amount, and whether the billing date or usage carryover changes.
* @summary Get upgrade preview with credit calculation
* @param {PortalApiUpgradePreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<UpgradePreview200Response>} A promise that resolves to a `UpgradePreview200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade-preview)
*
*/
upgradePreview(requestParameters: PortalApiUpgradePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradePreview200Response>;
};
/**
* PortalApi - interface
* @export
* @interface PortalApi
*/
export interface PortalApiInterface {
/**
* Retrieves billing and subscription details for the current organization, including plan status, product category, billing email, and effective plan.
* @summary Get billing information for the current organization
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PortalApiInterface
* @returns {Promise<Billing200Response>} A promise that resolves to a `Billing200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/billing)
*
*/
billing(options?: RawAxiosRequestConfig): AxiosPromise<Billing200Response>;
/**
* Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.
* @summary Process subscription upgrade with credit
* @param {PortalApiUpgradeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PortalApiInterface
* @returns {Promise<Upgrade200Response>} A promise that resolves to a `Upgrade200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade)
*
*/
upgrade(requestParameters: PortalApiUpgradeRequest, options?: RawAxiosRequestConfig): AxiosPromise<Upgrade200Response>;
/**
* Calculates the billing impact of changing to a new subscription plan, including available credit, charge amount, and whether the billing date or usage carryover changes.
* @summary Get upgrade preview with credit calculation
* @param {PortalApiUpgradePreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PortalApiInterface
* @returns {Promise<UpgradePreview200Response>} A promise that resolves to a `UpgradePreview200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade-preview)
*
*/
upgradePreview(requestParameters: PortalApiUpgradePreviewRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpgradePreview200Response>;
}
/**
* Request parameters for upgrade operation in PortalApi.
* @export
* @interface PortalApiUpgradeRequest
*/
export interface PortalApiUpgradeRequest {
/**
*
*
*
*
* @type {UpgradeRequest}
* @memberof PortalApiUpgrade
*/
readonly upgradeRequest: UpgradeRequest;
}
/**
* Request parameters for upgradePreview operation in PortalApi.
* @export
* @interface PortalApiUpgradePreviewRequest
*/
export interface PortalApiUpgradePreviewRequest {
/**
*
*
*
*
* @type {string}
* @memberof PortalApiUpgradePreview
*/
readonly newPlan: string;
/**
*
*
*
*
* @type {'API' | 'STUDIO'}
* @memberof PortalApiUpgradePreview
*/
readonly productCategory?: UpgradePreviewProductCategoryEnum;
}
/**
* PortalApi - object-oriented interface
* @export
* @class PortalApi
* @extends {BaseAPI}
*/
export declare class PortalApi extends BaseAPI implements PortalApiInterface {
/**
* Retrieves billing and subscription details for the current organization, including plan status, product category, billing email, and effective plan.
* @summary Get billing information for the current organization
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PortalApi
* @returns {Promise<Billing200Response>} A promise that resolves to a `Billing200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/billing)
*
*/
billing(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Billing200Response, any, {}>>;
/**
* Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.
* @summary Process subscription upgrade with credit
* @param {PortalApiUpgradeRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PortalApi
* @returns {Promise<Upgrade200Response>} A promise that resolves to a `Upgrade200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade)
*
*/
upgrade(requestParameters: PortalApiUpgradeRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Upgrade200Response, any, {}>>;
/**
* Calculates the billing impact of changing to a new subscription plan, including available credit, charge amount, and whether the billing date or usage carryover changes.
* @summary Get upgrade preview with credit calculation
* @param {PortalApiUpgradePreviewRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof PortalApi
* @returns {Promise<UpgradePreview200Response>} A promise that resolves to a `UpgradePreview200Response` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/upgrade-preview)
*
*/
upgradePreview(requestParameters: PortalApiUpgradePreviewRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UpgradePreview200Response, any, {}>>;
}
/**
* @export
*/
export declare const UpgradePreviewProductCategoryEnum: {
readonly Api: "API";
readonly Studio: "STUDIO";
};
export type UpgradePreviewProductCategoryEnum = typeof UpgradePreviewProductCategoryEnum[keyof typeof UpgradePreviewProductCategoryEnum];