@revkeen/sdk 1.20260312.41

package/api/resources/orders/client/Client.d.ts

@@ -0,0 +1,123 @@
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient.js";
+import * as core from "../../../../core/index.js";
+import * as RevKeen from "../../../index.js";
+export declare namespace OrdersClient {
+    type Options = BaseClientOptions;
+    interface RequestOptions extends BaseRequestOptions {
+    }
+}
+/**
+ * One-off purchases with lifecycle operations: create, pay, cancel, and fulfill.
+ *
+ * **Required Scopes:**
+ * - `orders:read` - List and retrieve orders
+ * - `orders:write` - Create, cancel, fulfill orders
+ *
+ * **MCP Tools:** `orders_list`, `orders_create`, `orders_cancel`, `orders_fulfill`
+ */
+export declare class OrdersClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<OrdersClient.Options>;
+    constructor(options: OrdersClient.Options);
+    /**
+     * List all orders for the authenticated merchant. Supports filtering and cursor-based pagination.
+     *
+     * @param {RevKeen.OrdersListRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.UnauthorizedError}
+     *
+     * @example
+     *     await client.orders.list()
+     */
+    list(request?: RevKeen.OrdersListRequest, requestOptions?: OrdersClient.RequestOptions): core.HttpResponsePromise<RevKeen.OrderListResponse>;
+    private __list;
+    /**
+     * Creates a new order with line items. Orders start in draft status.
+     *
+     * @param {RevKeen.CreateOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.create({
+     *         line_items: [{
+     *                 description: "description",
+     *                 unit_price: 1
+     *             }]
+     *     })
+     */
+    create(request: RevKeen.CreateOrderRequest, requestOptions?: OrdersClient.RequestOptions): core.HttpResponsePromise<RevKeen.Order>;
+    private __create;
+    /**
+     * Retrieves an order by its ID, including line items.
+     *
+     * @param {RevKeen.OrdersRetrieveRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.retrieve({
+     *         id: "id"
+     *     })
+     */
+    retrieve(request: RevKeen.OrdersRetrieveRequest, requestOptions?: OrdersClient.RequestOptions): core.HttpResponsePromise<RevKeen.Order>;
+    private __retrieve;
+    /**
+     * Process payment for an order. Creates an invoice and charges the customer's payment method.
+     *
+     * @param {RevKeen.PayOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.pay({
+     *         id: "id"
+     *     })
+     */
+    pay(request: RevKeen.PayOrderRequest, requestOptions?: OrdersClient.RequestOptions): core.HttpResponsePromise<RevKeen.Order>;
+    private __pay;
+    /**
+     * Cancels an order. Only orders that haven't been paid or fulfilled can be canceled.
+     *
+     * @param {RevKeen.CancelOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.cancel({
+     *         id: "id"
+     *     })
+     */
+    cancel(request: RevKeen.CancelOrderRequest, requestOptions?: OrdersClient.RequestOptions): core.HttpResponsePromise<RevKeen.Order>;
+    private __cancel;
+    /**
+     * Mark an order as fulfilled. Optionally include shipping tracking information.
+     *
+     * @param {RevKeen.FulfillOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.fulfill({
+     *         id: "id"
+     *     })
+     */
+    fulfill(request: RevKeen.FulfillOrderRequest, requestOptions?: OrdersClient.RequestOptions): core.HttpResponsePromise<RevKeen.Order>;
+    private __fulfill;
+}
+//# sourceMappingURL=Client.d.ts.map

package/api/resources/orders/client/Client.js

@@ -0,0 +1,372 @@
+// This file was auto-generated by Fern from our API Definition.
+import { normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders } from "../../../../core/headers.js";
+import * as core from "../../../../core/index.js";
+import * as environments from "../../../../environments.js";
+import { handleNonStatusCodeError } from "../../../../errors/handleNonStatusCodeError.js";
+import * as errors from "../../../../errors/index.js";
+import * as RevKeen from "../../../index.js";
+/**
+ * One-off purchases with lifecycle operations: create, pay, cancel, and fulfill.
+ *
+ * **Required Scopes:**
+ * - `orders:read` - List and retrieve orders
+ * - `orders:write` - Create, cancel, fulfill orders
+ *
+ * **MCP Tools:** `orders_list`, `orders_create`, `orders_cancel`, `orders_fulfill`
+ */
+export class OrdersClient {
+    constructor(options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+    /**
+     * List all orders for the authenticated merchant. Supports filtering and cursor-based pagination.
+     *
+     * @param {RevKeen.OrdersListRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.UnauthorizedError}
+     *
+     * @example
+     *     await client.orders.list()
+     */
+    list(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__list(request, requestOptions));
+    }
+    async __list(request = {}, requestOptions) {
+        const { customer_id: customerId, status, billing_type: billingType, created_gte: createdGte, created_lte: createdLte, limit, starting_after: startingAfter, ending_before: endingBefore, } = request;
+        const _queryParams = {
+            customer_id: customerId,
+            status: status != null ? status : undefined,
+            billing_type: billingType != null ? billingType : undefined,
+            created_gte: createdGte,
+            created_lte: createdLte,
+            limit,
+            starting_after: startingAfter,
+            ending_before: endingBefore,
+        };
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await (this._options.fetcher ?? core.fetcher)({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.RevKeenEnvironment.Default, "orders"),
+            method: "GET",
+            headers: _headers,
+            queryParameters: { ..._queryParams, ...requestOptions?.queryParams },
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new RevKeen.UnauthorizedError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.RevKeenError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/orders");
+    }
+    /**
+     * Creates a new order with line items. Orders start in draft status.
+     *
+     * @param {RevKeen.CreateOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.create({
+     *         line_items: [{
+     *                 description: "description",
+     *                 unit_price: 1
+     *             }]
+     *     })
+     */
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    }
+    async __create(request, requestOptions) {
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await (this._options.fetcher ?? core.fetcher)({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.RevKeenEnvironment.Default, "orders"),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
+            requestType: "json",
+            body: request,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new RevKeen.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new RevKeen.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new RevKeen.NotFoundError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.RevKeenError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/orders");
+    }
+    /**
+     * Retrieves an order by its ID, including line items.
+     *
+     * @param {RevKeen.OrdersRetrieveRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.retrieve({
+     *         id: "id"
+     *     })
+     */
+    retrieve(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__retrieve(request, requestOptions));
+    }
+    async __retrieve(request, requestOptions) {
+        const { id } = request;
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await (this._options.fetcher ?? core.fetcher)({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.RevKeenEnvironment.Default, `orders/${core.url.encodePathParam(id)}`),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 401:
+                    throw new RevKeen.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new RevKeen.NotFoundError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.RevKeenError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/orders/{id}");
+    }
+    /**
+     * Process payment for an order. Creates an invoice and charges the customer's payment method.
+     *
+     * @param {RevKeen.PayOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.pay({
+     *         id: "id"
+     *     })
+     */
+    pay(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__pay(request, requestOptions));
+    }
+    async __pay(request, requestOptions) {
+        const { id, ..._body } = request;
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await (this._options.fetcher ?? core.fetcher)({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.RevKeenEnvironment.Default, `orders/${core.url.encodePathParam(id)}/pay`),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
+            requestType: "json",
+            body: _body,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new RevKeen.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new RevKeen.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new RevKeen.NotFoundError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.RevKeenError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/orders/{id}/pay");
+    }
+    /**
+     * Cancels an order. Only orders that haven't been paid or fulfilled can be canceled.
+     *
+     * @param {RevKeen.CancelOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.cancel({
+     *         id: "id"
+     *     })
+     */
+    cancel(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__cancel(request, requestOptions));
+    }
+    async __cancel(request, requestOptions) {
+        const { id, ..._body } = request;
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await (this._options.fetcher ?? core.fetcher)({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.RevKeenEnvironment.Default, `orders/${core.url.encodePathParam(id)}/cancel`),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
+            requestType: "json",
+            body: _body,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new RevKeen.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new RevKeen.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new RevKeen.NotFoundError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.RevKeenError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/orders/{id}/cancel");
+    }
+    /**
+     * Mark an order as fulfilled. Optionally include shipping tracking information.
+     *
+     * @param {RevKeen.FulfillOrderRequest} request
+     * @param {OrdersClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link RevKeen.BadRequestError}
+     * @throws {@link RevKeen.UnauthorizedError}
+     * @throws {@link RevKeen.NotFoundError}
+     *
+     * @example
+     *     await client.orders.fulfill({
+     *         id: "id"
+     *     })
+     */
+    fulfill(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__fulfill(request, requestOptions));
+    }
+    async __fulfill(request, requestOptions) {
+        const { id, ..._body } = request;
+        const _authRequest = await this._options.authProvider.getAuthRequest();
+        const _headers = mergeHeaders(_authRequest.headers, this._options?.headers, requestOptions?.headers);
+        const _response = await (this._options.fetcher ?? core.fetcher)({
+            url: core.url.join((await core.Supplier.get(this._options.baseUrl)) ??
+                (await core.Supplier.get(this._options.environment)) ??
+                environments.RevKeenEnvironment.Default, `orders/${core.url.encodePathParam(id)}/fulfill`),
+            method: "POST",
+            headers: _headers,
+            contentType: "application/json",
+            queryParameters: requestOptions?.queryParams,
+            requestType: "json",
+            body: _body,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body, rawResponse: _response.rawResponse };
+        }
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 400:
+                    throw new RevKeen.BadRequestError(_response.error.body, _response.rawResponse);
+                case 401:
+                    throw new RevKeen.UnauthorizedError(_response.error.body, _response.rawResponse);
+                case 404:
+                    throw new RevKeen.NotFoundError(_response.error.body, _response.rawResponse);
+                default:
+                    throw new errors.RevKeenError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/orders/{id}/fulfill");
+    }
+}
+//# sourceMappingURL=Client.js.map