@jacob-registry-repo/sdk 1.0.0

package/api/resources/apiKeys/client/Client.ts

@@ -0,0 +1,443 @@
+// This file was auto-generated by Fern from our API Definition.
+
+import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient.js";
+import { type NormalizedClientOptionsWithAuth, normalizeClientOptionsWithAuth } from "../../../../BaseClient.js";
+import { mergeHeaders, mergeOnlyDefinedHeaders } 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 AcqClient from "../../../index.js";
+
+export declare namespace ApiKeysClient {
+    export type Options = BaseClientOptions;
+
+    export interface RequestOptions extends BaseRequestOptions {}
+}
+
+export class ApiKeysClient {
+    protected readonly _options: NormalizedClientOptionsWithAuth<ApiKeysClient.Options>;
+
+    constructor(options: ApiKeysClient.Options) {
+        this._options = normalizeClientOptionsWithAuth(options);
+    }
+
+    /**
+     * Get the currently active API key pair (publishable + secret) for the merchant
+     *
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.apiKeys.getActiveApiKeys()
+     */
+    public getActiveApiKeys(
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): core.HttpResponsePromise<AcqClient.V1Response> {
+        return core.HttpResponsePromise.fromPromise(this.__getActiveApiKeys(requestOptions));
+    }
+
+    private async __getActiveApiKeys(
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): Promise<core.WithRawResponse<AcqClient.V1Response>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-Publishable-Key": requestOptions?.publishableKey ?? this._options?.publishableKey,
+                "X-Secret-Key": requestOptions?.secretKey ?? this._options?.secretKey,
+            }),
+            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.AcqClientEnvironment.Default,
+                "merchants/api-keys",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as AcqClient.V1Response, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            throw new errors.AcqClientError({
+                statusCode: _response.error.statusCode,
+                body: _response.error.body,
+                rawResponse: _response.rawResponse,
+            });
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/merchants/api-keys");
+    }
+
+    /**
+     * Generate a new API key for the merchant. Requires 2FA code if 2FA is enabled.
+     *
+     * @param {AcqClient.V1GenerateApiKeyRequest} request
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AcqClient.ForbiddenError}
+     *
+     * @example
+     *     await client.apiKeys.generateApiKey({
+     *         environment: "production",
+     *         name: "My Production Key"
+     *     })
+     */
+    public generateApiKey(
+        request: AcqClient.V1GenerateApiKeyRequest,
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): core.HttpResponsePromise<AcqClient.V1GenerateApiKeyResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__generateApiKey(request, requestOptions));
+    }
+
+    private async __generateApiKey(
+        request: AcqClient.V1GenerateApiKeyRequest,
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): Promise<core.WithRawResponse<AcqClient.V1GenerateApiKeyResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-Publishable-Key": requestOptions?.publishableKey ?? this._options?.publishableKey,
+                "X-Secret-Key": requestOptions?.secretKey ?? this._options?.secretKey,
+            }),
+            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.AcqClientEnvironment.Default,
+                "merchants/api-keys",
+            ),
+            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,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as AcqClient.V1GenerateApiKeyResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 403:
+                    throw new AcqClient.ForbiddenError(
+                        _response.error.body as AcqClient.V1Response,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.AcqClientError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "POST", "/merchants/api-keys");
+    }
+
+    /**
+     * Reset API key and generate a new one. Requires 2FA code if 2FA is enabled.
+     *
+     * @param {AcqClient.V1ResetApiKeyRequest} request
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AcqClient.ForbiddenError}
+     *
+     * @example
+     *     await client.apiKeys.resetApiKey()
+     */
+    public resetApiKey(
+        request: AcqClient.V1ResetApiKeyRequest = {},
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): core.HttpResponsePromise<AcqClient.V1GenerateApiKeyResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__resetApiKey(request, requestOptions));
+    }
+
+    private async __resetApiKey(
+        request: AcqClient.V1ResetApiKeyRequest = {},
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): Promise<core.WithRawResponse<AcqClient.V1GenerateApiKeyResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-Publishable-Key": requestOptions?.publishableKey ?? this._options?.publishableKey,
+                "X-Secret-Key": requestOptions?.secretKey ?? this._options?.secretKey,
+            }),
+            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.AcqClientEnvironment.Default,
+                "merchants/api-keys",
+            ),
+            method: "PUT",
+            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,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as AcqClient.V1GenerateApiKeyResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 403:
+                    throw new AcqClient.ForbiddenError(
+                        _response.error.body as AcqClient.V1Response,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.AcqClientError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "PUT", "/merchants/api-keys");
+    }
+
+    /**
+     * Get usage metrics for the current API key (last 30 days)
+     *
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.apiKeys.getApiKeyUsageMetrics()
+     */
+    public getApiKeyUsageMetrics(
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): core.HttpResponsePromise<AcqClient.V1ApiKeyMetricsResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__getApiKeyUsageMetrics(requestOptions));
+    }
+
+    private async __getApiKeyUsageMetrics(
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): Promise<core.WithRawResponse<AcqClient.V1ApiKeyMetricsResponse>> {
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-Publishable-Key": requestOptions?.publishableKey ?? this._options?.publishableKey,
+                "X-Secret-Key": requestOptions?.secretKey ?? this._options?.secretKey,
+            }),
+            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.AcqClientEnvironment.Default,
+                "merchants/api-keys/:id/metrics",
+            ),
+            method: "GET",
+            headers: _headers,
+            queryParameters: requestOptions?.queryParams,
+            timeoutMs: (requestOptions?.timeoutInSeconds ?? this._options?.timeoutInSeconds ?? 60) * 1000,
+            maxRetries: requestOptions?.maxRetries ?? this._options?.maxRetries,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as AcqClient.V1ApiKeyMetricsResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            throw new errors.AcqClientError({
+                statusCode: _response.error.statusCode,
+                body: _response.error.body,
+                rawResponse: _response.rawResponse,
+            });
+        }
+
+        return handleNonStatusCodeError(
+            _response.error,
+            _response.rawResponse,
+            "GET",
+            "/merchants/api-keys/:id/metrics",
+        );
+    }
+
+    /**
+     * Get a specific API key by its ID
+     *
+     * @param {AcqClient.GetMerchantsApiKeysIdRequest} request
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @example
+     *     await client.apiKeys.getApiKeyById({
+     *         id: 1
+     *     })
+     */
+    public getApiKeyById(
+        request: AcqClient.GetMerchantsApiKeysIdRequest,
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): core.HttpResponsePromise<AcqClient.V1GetApiKeyResponse> {
+        return core.HttpResponsePromise.fromPromise(this.__getApiKeyById(request, requestOptions));
+    }
+
+    private async __getApiKeyById(
+        request: AcqClient.GetMerchantsApiKeysIdRequest,
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): Promise<core.WithRawResponse<AcqClient.V1GetApiKeyResponse>> {
+        const { id } = request;
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-Publishable-Key": requestOptions?.publishableKey ?? this._options?.publishableKey,
+                "X-Secret-Key": requestOptions?.secretKey ?? this._options?.secretKey,
+            }),
+            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.AcqClientEnvironment.Default,
+                `merchants/api-keys/${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,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as AcqClient.V1GetApiKeyResponse, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            throw new errors.AcqClientError({
+                statusCode: _response.error.statusCode,
+                body: _response.error.body,
+                rawResponse: _response.rawResponse,
+            });
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "GET", "/merchants/api-keys/{id}");
+    }
+
+    /**
+     * Revoke an existing API key by its ID. Requires 2FA code if 2FA is enabled.
+     *
+     * @param {AcqClient.V1TwoFaTokenDto} request
+     * @param {ApiKeysClient.RequestOptions} requestOptions - Request-specific configuration.
+     *
+     * @throws {@link AcqClient.ForbiddenError}
+     *
+     * @example
+     *     await client.apiKeys.revokeApiKey({
+     *         id: 1
+     *     })
+     */
+    public revokeApiKey(
+        request: AcqClient.V1TwoFaTokenDto,
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): core.HttpResponsePromise<AcqClient.V1Response> {
+        return core.HttpResponsePromise.fromPromise(this.__revokeApiKey(request, requestOptions));
+    }
+
+    private async __revokeApiKey(
+        request: AcqClient.V1TwoFaTokenDto,
+        requestOptions?: ApiKeysClient.RequestOptions,
+    ): Promise<core.WithRawResponse<AcqClient.V1Response>> {
+        const { id, ..._body } = request;
+        const _authRequest: core.AuthRequest = await this._options.authProvider.getAuthRequest();
+        const _headers: core.Fetcher.Args["headers"] = mergeHeaders(
+            _authRequest.headers,
+            this._options?.headers,
+            mergeOnlyDefinedHeaders({
+                "X-Publishable-Key": requestOptions?.publishableKey ?? this._options?.publishableKey,
+                "X-Secret-Key": requestOptions?.secretKey ?? this._options?.secretKey,
+            }),
+            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.AcqClientEnvironment.Default,
+                `merchants/api-keys/${core.url.encodePathParam(id)}`,
+            ),
+            method: "DELETE",
+            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,
+            withCredentials: true,
+            abortSignal: requestOptions?.abortSignal,
+            fetchFn: this._options?.fetch,
+            logging: this._options.logging,
+        });
+        if (_response.ok) {
+            return { data: _response.body as AcqClient.V1Response, rawResponse: _response.rawResponse };
+        }
+
+        if (_response.error.reason === "status-code") {
+            switch (_response.error.statusCode) {
+                case 403:
+                    throw new AcqClient.ForbiddenError(
+                        _response.error.body as AcqClient.V1Response,
+                        _response.rawResponse,
+                    );
+                default:
+                    throw new errors.AcqClientError({
+                        statusCode: _response.error.statusCode,
+                        body: _response.error.body,
+                        rawResponse: _response.rawResponse,
+                    });
+            }
+        }
+
+        return handleNonStatusCodeError(_response.error, _response.rawResponse, "DELETE", "/merchants/api-keys/{id}");
+    }
+}

package/api/resources/apiKeys/client/index.ts

@@ -0,0 +1 @@
+export * from "./requests/index.js";

package/api/resources/apiKeys/client/requests/GetMerchantsApiKeysIdRequest.ts

@@ -0,0 +1,12 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: 1
+ *     }
+ */
+export interface GetMerchantsApiKeysIdRequest {
+    /** API Key ID */
+    id: number;
+}

package/api/resources/apiKeys/client/requests/V1GenerateApiKeyRequest.ts

@@ -0,0 +1,33 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         environment: "production",
+ *         name: "My Production Key"
+ *     }
+ */
+export interface V1GenerateApiKeyRequest {
+    /**
+     * Callback configuration (merchant webhook settings) - OPTIONAL
+     * If not provided during API key creation, merchants can configure these later via /callback-config endpoints
+     */
+    callbackUrl?: string;
+    environment: V1GenerateApiKeyRequest.Environment;
+    eventTypes?: string[];
+    /** days, optional (0 = no expiry) */
+    expiresIn?: number;
+    name: string;
+    permissions?: string[];
+    redirectUrl?: string;
+    twoFACode?: string;
+    webhookSecret?: string;
+}
+
+export namespace V1GenerateApiKeyRequest {
+    export const Environment = {
+        Production: "production",
+        Sandbox: "sandbox",
+    } as const;
+    export type Environment = (typeof Environment)[keyof typeof Environment];
+}

package/api/resources/apiKeys/client/requests/V1ResetApiKeyRequest.ts

@@ -0,0 +1,10 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {}
+ */
+export interface V1ResetApiKeyRequest {
+    reason?: string;
+    twoFACode?: string;
+}

package/api/resources/apiKeys/client/requests/V1TwoFaTokenDto.ts

@@ -0,0 +1,13 @@
+// This file was auto-generated by Fern from our API Definition.
+
+/**
+ * @example
+ *     {
+ *         id: 1
+ *     }
+ */
+export interface V1TwoFaTokenDto {
+    /** API Key ID */
+    id: number;
+    twoFACode?: string;
+}

package/api/resources/apiKeys/client/requests/index.ts

@@ -0,0 +1,4 @@
+export type { GetMerchantsApiKeysIdRequest } from "./GetMerchantsApiKeysIdRequest.js";
+export type { V1GenerateApiKeyRequest } from "./V1GenerateApiKeyRequest.js";
+export type { V1ResetApiKeyRequest } from "./V1ResetApiKeyRequest.js";
+export type { V1TwoFaTokenDto } from "./V1TwoFaTokenDto.js";

package/api/resources/apiKeys/index.ts

@@ -0,0 +1 @@
+export * from "./client/index.js";