@neynar/nodejs-sdk 3.137.2 → 3.170.0

package/build/api/apis/organization-api.js

@@ -0,0 +1,138 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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.170.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.
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganizationApi = exports.OrganizationApiFactory = exports.OrganizationApiFp = exports.OrganizationApiAxiosParamCreator = void 0;
+const axios_1 = __importDefault(require("axios"));
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * OrganizationApi - axios parameter creator
+ * @export
+ */
+const OrganizationApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * 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: async (options = {}) => {
+            const localVarPath = `/portal/organization/billing`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication ApiKeyAuth required
+            await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "x-api-key", configuration);
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    };
+};
+exports.OrganizationApiAxiosParamCreator = OrganizationApiAxiosParamCreator;
+/**
+ * OrganizationApi - functional programming interface
+ * @export
+ */
+const OrganizationApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.OrganizationApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * 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)
+         *
+         */
+        async billing(options) {
+            var _a, _b, _c;
+            const localVarAxiosArgs = await localVarAxiosParamCreator.billing(options);
+            const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+            const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['OrganizationApi.billing']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+            return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    };
+};
+exports.OrganizationApiFp = OrganizationApiFp;
+/**
+ * OrganizationApi - factory interface
+ * @export
+ */
+const OrganizationApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.OrganizationApiFp)(configuration);
+    return {
+        /**
+         * 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) {
+            return localVarFp.billing(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.OrganizationApiFactory = OrganizationApiFactory;
+/**
+ * OrganizationApi - object-oriented interface
+ * @export
+ * @class OrganizationApi
+ * @extends {BaseAPI}
+ */
+class OrganizationApi extends base_1.BaseAPI {
+    /**
+     * 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 OrganizationApi
+     * @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) {
+        return (0, exports.OrganizationApiFp)(this.configuration).billing(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.OrganizationApi = OrganizationApi;

package/build/api/apis/portal-api.d.ts

@@ -0,0 +1,283 @@
+/**
+ * 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.170.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];