import type { RequestInit, RequestInfo } from "./internal/builtin-types.js"; import type { PromiseOrValue, MergedRequestInit, FinalizedRequestInit } from "./internal/types.js"; export type { Logger, LogLevel } from "./internal/utils/log.js"; import * as Opts from "./internal/request-options.js"; import * as Errors from "./core/error.js"; import * as Pagination from "./core/pagination.js"; import { type CursorPaginationParams, CursorPaginationResponse } from "./core/pagination.js"; import * as Uploads from "./core/uploads.js"; import * as API from "./resources/index.js"; import { APIPromise } from "./core/api-promise.js"; import { Billing, BillingCreateTopupInvoiceParams, BillingCreateTopupInvoiceResponse, BillingGetBalanceResponse, BillingListTransactionsParams, BillingListTransactionsResponse, BillingListTransactionsResponsesCursorPagination } from "./resources/billing.js"; import { BrandRetrieveResponse, Brands } from "./resources/brands.js"; import { Commission, CommissionListParams, CommissionStatus, CommissionType, Commissions, CommissionsCursorPagination, SettlementDirection } from "./resources/commissions.js"; import { Event, EventListParams, Events, EventsCursorPagination } from "./resources/events.js"; import { InstallationLink, MerchantConnectorCreateInstallationLinkParams, MerchantConnectors } from "./resources/merchant-connectors.js"; import { Cancellation, Order, OrderCancelParams, OrderListParams, Orders, OrdersCursorPagination } from "./resources/orders.js"; import { PaymentGateway, PaymentGatewaySession, PaymentGateways } from "./resources/payment-gateways.js"; import { Product, ProductAvailability, ProductImage, ProductLookupParams, ProductVariant, Products, VariantDimension } from "./resources/products.js"; import { Return, ReturnCreateParams, ReturnDenial, ReturnFailure, ReturnNextAction, ReturnReason, ReturnRefund, ReturnState, ReturnTimeline, Returns } from "./resources/returns.js"; import { Shipment, ShipmentListParams, ShipmentStatus, ShipmentTracking, Shipments, ShipmentsCursorPagination } from "./resources/shipments.js"; import { Betas, CheckoutSession } from "./resources/betas/betas.js"; import { BaseCheckoutIntent, Buyer, CheckoutIntent, CheckoutIntentConfirmParams, CheckoutIntentCreateParams, CheckoutIntentListParams, CheckoutIntentPurchaseParams, CheckoutIntentsCursorPagination, CheckoutIntentsResource, Money, Offer, PaymentMethod, VariantSelection } from "./resources/checkout-intents/checkout-intents.js"; import { TestHelpers } from "./resources/test-helpers/test-helpers.js"; import { type Fetch } from "./internal/builtin-types.js"; import { HeadersLike, NullableHeaders } from "./internal/headers.js"; import { FinalRequestOptions, RequestOptions } from "./internal/request-options.js"; import { type LogLevel, type Logger } from "./internal/utils/log.js"; declare const environments: { staging: string; production: string; }; type Environment = keyof typeof environments; export interface ClientOptions { /** * Rye API key. Format: `RYE/{environment}-abcdef` */ apiKey?: string | undefined; /** * Specifies the environment to use for the API. * * Each environment maps to a different base URL: * - `staging` corresponds to `https://staging.api.rye.com` * - `production` corresponds to `https://api.rye.com` */ environment?: Environment | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['CHECKOUT_INTENTS_BASE_URL']. */ baseURL?: string | null | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. * * @unit milliseconds */ timeout?: number | undefined; /** * Additional `RequestInit` options to be passed to `fetch` calls. * Properties will be overridden by per-request `fetchOptions`. */ fetchOptions?: MergedRequestInit | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we expect that `fetch` is defined globally. */ fetch?: Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 2 */ maxRetries?: number | undefined; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `null` in request options. */ defaultHeaders?: HeadersLike | undefined; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Record | undefined; /** * Set the log level. * * Defaults to process.env['CHECKOUT_INTENTS_LOG'] or 'warn' if it isn't set. */ logLevel?: LogLevel | undefined; /** * Set the logger. * * Defaults to globalThis.console. */ logger?: Logger | undefined; } /** * API Client for interfacing with the Checkout Intents API. */ export declare class CheckoutIntents { #private; apiKey: string; baseURL: string; maxRetries: number; timeout: number; logger: Logger; logLevel: LogLevel | undefined; fetchOptions: MergedRequestInit | undefined; private fetch; protected idempotencyHeader?: string; private _options; /** * API Client for interfacing with the Checkout Intents API. * * @param {string | undefined} [opts.apiKey=process.env['CHECKOUT_INTENTS_API_KEY'] ?? undefined] * @param {Environment} [opts.environment=staging] - Specifies the environment URL to use for the API. * @param {string} [opts.baseURL=process.env['CHECKOUT_INTENTS_BASE_URL'] ?? https://staging.api.rye.com] - Override the default base URL for the API. * @param {number} [opts.timeout=1 minute] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {MergedRequestInit} [opts.fetchOptions] - Additional `RequestInit` options to be passed to `fetch` calls. * @param {Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=2] - The maximum number of times the client will retry a request. * @param {HeadersLike} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Record} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, apiKey, ...opts }?: ClientOptions); /** * Create a new client instance re-using the same options given to the current client with optional overriding. */ withOptions(options: Partial): this; protected defaultQuery(): Record | undefined; protected validateHeaders({ values, nulls }: NullableHeaders): void; protected authHeaders(opts: FinalRequestOptions): Promise; protected stringifyQuery(query: object | Record): string; private getUserAgent; protected defaultIdempotencyKey(): string; protected makeStatusError(status: number, error: Object, message: string | undefined, headers: Headers): Errors.APIError; buildURL(path: string, query: Record | null | undefined, defaultBaseURL?: string | undefined): string; /** * Used as a callback for mutating the given `FinalRequestOptions` object. */ protected prepareOptions(options: FinalRequestOptions): Promise; /** * Used as a callback for mutating the given `RequestInit` object. * * This is useful for cases where you want to add certain headers based off of * the request properties, e.g. `method` or `url`. */ protected prepareRequest(request: RequestInit, { url, options }: { url: string; options: FinalRequestOptions; }): Promise; get(path: string, opts?: PromiseOrValue): APIPromise; post(path: string, opts?: PromiseOrValue): APIPromise; patch(path: string, opts?: PromiseOrValue): APIPromise; put(path: string, opts?: PromiseOrValue): APIPromise; delete(path: string, opts?: PromiseOrValue): APIPromise; private methodRequest; request(options: PromiseOrValue, remainingRetries?: number | null): APIPromise; private makeRequest; getAPIList = Pagination.AbstractPage>(path: string, Page: new (...args: any[]) => PageClass, opts?: PromiseOrValue): Pagination.PagePromise; requestAPIList = Pagination.AbstractPage>(Page: new (...args: ConstructorParameters) => PageClass, options: PromiseOrValue): Pagination.PagePromise; fetchWithTimeout(url: RequestInfo, init: RequestInit | undefined, ms: number, controller: AbortController): Promise; private shouldRetry; private retryRequest; private calculateDefaultRetryTimeoutMillis; buildRequest(inputOptions: FinalRequestOptions, { retryCount }?: { retryCount?: number; }): Promise<{ req: FinalizedRequestInit; url: string; timeout: number; }>; private buildHeaders; private _makeAbort; private buildBody; static CheckoutIntents: typeof CheckoutIntents; static DEFAULT_TIMEOUT: number; static CheckoutIntentsError: typeof Errors.CheckoutIntentsError; static APIError: typeof Errors.APIError; static APIConnectionError: typeof Errors.APIConnectionError; static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError; static APIUserAbortError: typeof Errors.APIUserAbortError; static NotFoundError: typeof Errors.NotFoundError; static ConflictError: typeof Errors.ConflictError; static RateLimitError: typeof Errors.RateLimitError; static BadRequestError: typeof Errors.BadRequestError; static AuthenticationError: typeof Errors.AuthenticationError; static InternalServerError: typeof Errors.InternalServerError; static PermissionDeniedError: typeof Errors.PermissionDeniedError; static UnprocessableEntityError: typeof Errors.UnprocessableEntityError; static toFile: typeof Uploads.toFile; checkoutIntents: API.CheckoutIntentsResource; betas: API.Betas; brands: API.Brands; orders: API.Orders; products: API.Products; shipments: API.Shipments; commissions: API.Commissions; paymentGateways: API.PaymentGateways; billing: API.Billing; events: API.Events; merchantConnectors: API.MerchantConnectors; returns: API.Returns; testHelpers: API.TestHelpers; } export declare namespace CheckoutIntents { export type RequestOptions = Opts.RequestOptions; export import CursorPagination = Pagination.CursorPagination; export { type CursorPaginationParams as CursorPaginationParams, type CursorPaginationResponse as CursorPaginationResponse, }; export { CheckoutIntentsResource as CheckoutIntentsResource, type BaseCheckoutIntent as BaseCheckoutIntent, type Buyer as Buyer, type CheckoutIntent as CheckoutIntent, type Money as Money, type Offer as Offer, type PaymentMethod as PaymentMethod, type VariantSelection as VariantSelection, type CheckoutIntentsCursorPagination as CheckoutIntentsCursorPagination, type CheckoutIntentCreateParams as CheckoutIntentCreateParams, type CheckoutIntentListParams as CheckoutIntentListParams, type CheckoutIntentConfirmParams as CheckoutIntentConfirmParams, type CheckoutIntentPurchaseParams as CheckoutIntentPurchaseParams, }; export { Betas as Betas, type CheckoutSession as CheckoutSession }; export { Brands as Brands, type BrandRetrieveResponse as BrandRetrieveResponse }; export { Orders as Orders, type Cancellation as Cancellation, type Order as Order, type OrdersCursorPagination as OrdersCursorPagination, type OrderListParams as OrderListParams, type OrderCancelParams as OrderCancelParams, }; export { Products as Products, type Product as Product, type ProductAvailability as ProductAvailability, type ProductImage as ProductImage, type ProductVariant as ProductVariant, type VariantDimension as VariantDimension, type ProductLookupParams as ProductLookupParams, }; export { Shipments as Shipments, type Shipment as Shipment, type ShipmentStatus as ShipmentStatus, type ShipmentTracking as ShipmentTracking, type ShipmentsCursorPagination as ShipmentsCursorPagination, type ShipmentListParams as ShipmentListParams, }; export { Commissions as Commissions, type Commission as Commission, type CommissionStatus as CommissionStatus, type CommissionType as CommissionType, type SettlementDirection as SettlementDirection, type CommissionsCursorPagination as CommissionsCursorPagination, type CommissionListParams as CommissionListParams, }; export { PaymentGateways as PaymentGateways, type PaymentGateway as PaymentGateway, type PaymentGatewaySession as PaymentGatewaySession, }; export { Billing as Billing, type BillingCreateTopupInvoiceResponse as BillingCreateTopupInvoiceResponse, type BillingGetBalanceResponse as BillingGetBalanceResponse, type BillingListTransactionsResponse as BillingListTransactionsResponse, type BillingListTransactionsResponsesCursorPagination as BillingListTransactionsResponsesCursorPagination, type BillingCreateTopupInvoiceParams as BillingCreateTopupInvoiceParams, type BillingListTransactionsParams as BillingListTransactionsParams, }; export { Events as Events, type Event as Event, type EventsCursorPagination as EventsCursorPagination, type EventListParams as EventListParams, }; export { MerchantConnectors as MerchantConnectors, type InstallationLink as InstallationLink, type MerchantConnectorCreateInstallationLinkParams as MerchantConnectorCreateInstallationLinkParams, }; export { Returns as Returns, type Return as Return, type ReturnDenial as ReturnDenial, type ReturnFailure as ReturnFailure, type ReturnNextAction as ReturnNextAction, type ReturnReason as ReturnReason, type ReturnRefund as ReturnRefund, type ReturnState as ReturnState, type ReturnTimeline as ReturnTimeline, type ReturnCreateParams as ReturnCreateParams, }; export { TestHelpers as TestHelpers }; } //# sourceMappingURL=client.d.ts.map