local-protocol 0.1.0

package/src/resources/orders/requests/requests.ts

@@ -0,0 +1,96 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../../core/resource';
+import * as QuotesAPI from './quotes';
+import { OrderQuote, QuoteListResponse, QuoteRetrieveParams, Quotes } from './quotes';
+import { APIPromise } from '../../../core/api-promise';
+import { RequestOptions } from '../../../internal/request-options';
+
+/**
+ * Create order requests that can be quoted.
+ */
+export class Requests extends APIResource {
+  quotes: QuotesAPI.Quotes = new QuotesAPI.Quotes(this._client);
+
+  /**
+   * Submit a new order request with a cart. The `nonce` field provides idempotency.
+   */
+  create(body: RequestCreateParams, options?: RequestOptions): APIPromise<RequestCreateResponse> {
+    return this._client.post('/orders/requests', { body, ...options });
+  }
+}
+
+/**
+ * An order request.
+ */
+export interface RequestCreateResponse {
+  /**
+   * Unique request identifier.
+   */
+  id: string;
+
+  /**
+   * Shared intent identifier for tracing Request -> Quote -> Order.
+   */
+  intent_id: string;
+
+  /**
+   * Client-generated idempotency key.
+   */
+  nonce: string;
+}
+
+export interface RequestCreateParams {
+  /**
+   * Unique cart identifier.
+   */
+  id: string;
+
+  /**
+   * Shared intent identifier for tracing Request -> Quote -> Order.
+   */
+  intent_id: string;
+
+  /**
+   * Items in the cart.
+   */
+  items: Array<RequestCreateParams.Item>;
+
+  /**
+   * Client-generated idempotency key.
+   */
+  nonce: string;
+}
+
+export namespace RequestCreateParams {
+  /**
+   * An item in a cart.
+   */
+  export interface Item {
+    /**
+     * Item identifier.
+     */
+    id: string;
+
+    /**
+     * Quantity requested.
+     */
+    quantity: number;
+  }
+}
+
+Requests.Quotes = Quotes;
+
+export declare namespace Requests {
+  export {
+    type RequestCreateResponse as RequestCreateResponse,
+    type RequestCreateParams as RequestCreateParams,
+  };
+
+  export {
+    Quotes as Quotes,
+    type OrderQuote as OrderQuote,
+    type QuoteListResponse as QuoteListResponse,
+    type QuoteRetrieveParams as QuoteRetrieveParams,
+  };
+}

package/src/resources/orders/requests.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './requests/index';

package/src/resources/orders.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './orders/index';

package/src/resources/payment-instruments.ts

@@ -0,0 +1,409 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import * as RequestsAPI from './requests/requests';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Register payment instruments and related payment models.
+ */
+export class PaymentInstruments extends APIResource {
+  /**
+   * Register a payment instrument for use in order creation.
+   */
+  register(
+    body: PaymentInstrumentRegisterParams,
+    options?: RequestOptions,
+  ): APIPromise<EvmAuthCaptureEscrowInstrument> {
+    return this._client.post('/payment-instruments', { body, ...options });
+  }
+}
+
+/**
+ * Amount with explicit currency. Value is always in minor units (e.g., cents for
+ * USD).
+ */
+export interface Amount {
+  /**
+   * Currency descriptor (fiat or EVM token).
+   */
+  currency: Amount.FiatCurrency | EvmCurrency;
+
+  /**
+   * Value in minor currency units as an integer string.
+   */
+  value: string;
+}
+
+export namespace Amount {
+  /**
+   * Fiat currency descriptor.
+   */
+  export interface FiatCurrency {
+    /**
+     * ISO 4217 currency code (e.g., 'USD', 'EUR', 'JPY').
+     */
+    symbol: string;
+  }
+}
+
+/**
+ * Amount denominated in an EVM token. Value is in atomic token units.
+ */
+export interface EvmAmount {
+  /**
+   * EVM token currency descriptor.
+   */
+  currency: EvmCurrency;
+
+  /**
+   * Value in atomic token units as an integer string.
+   */
+  value: string;
+}
+
+/**
+ * Payment instrument for auth/capture escrow on EVM chains.
+ */
+export interface EvmAuthCaptureEscrowInstrument
+  extends PaymentInstrument,
+    EvmAuthCaptureEscrowInstrumentDetails {
+  type: 'evm_auth_capture_escrow';
+}
+
+export interface EvmAuthCaptureEscrowInstrumentDetails {
+  /**
+   * EVM token identifier used for auth/capture settlement.
+   */
+  token: EvmAuthCaptureEscrowInstrumentDetails.Token;
+
+  /**
+   * Amount in atomic units. Currency chain_id MUST match the instrument chain_id;
+   * currency address and decimals MUST match token address and decimals.
+   */
+  amount: EvmAmount;
+
+  /**
+   * Authorization expiration (RFC 3339).
+   */
+  authorization_expires_at: string;
+
+  /**
+   * EVM chain id.
+   */
+  chain_id: number;
+
+  /**
+   * Escrow contract address.
+   */
+  contract: string;
+
+  /**
+   * Maximum amount that can be authorized (atomic units). Currency chain_id MUST
+   * match the instrument chain_id; currency address and decimals MUST match token
+   * address and decimals.
+   */
+  max_amount: EvmAmount;
+
+  /**
+   * Unique nonce for payment info hash computation.
+   */
+  nonce: string;
+
+  /**
+   * Operator address.
+   */
+  operator: string;
+
+  /**
+   * Payer address.
+   */
+  payer: string;
+
+  /**
+   * Hash identifying the on-chain payment authorization.
+   */
+  payment_info_hash: string;
+
+  /**
+   * Pre-approval expiration (RFC 3339).
+   */
+  preapproval_expires_at: string;
+
+  /**
+   * Receiver address for captures.
+   */
+  receiver: string;
+
+  /**
+   * Refund expiration (RFC 3339).
+   */
+  refund_expires_at: string;
+
+  [k: string]: unknown;
+}
+
+export namespace EvmAuthCaptureEscrowInstrumentDetails {
+  /**
+   * EVM token identifier used for auth/capture settlement.
+   */
+  export interface Token {
+    /**
+     * Token decimals.
+     */
+    decimals: number;
+
+    /**
+     * Token symbol (e.g., USDC).
+     */
+    symbol: string;
+
+    /**
+     * ERC-20 contract address. Omit for native gas tokens.
+     */
+    address?: string;
+  }
+}
+
+/**
+ * EVM token currency descriptor.
+ */
+export interface EvmCurrency {
+  /**
+   * Token contract address.
+   */
+  address: string;
+
+  /**
+   * EVM chain id.
+   */
+  chain_id: number;
+
+  /**
+   * Decimal places for the token.
+   */
+  decimals: number;
+}
+
+/**
+ * Payment configuration containing instruments.
+ */
+export interface Payment {
+  /**
+   * Payment instruments available. Each instrument is associated with a handler via
+   * handler_id.
+   */
+  instruments?: Array<SelectedPaymentInstrument>;
+}
+
+/**
+ * Base definition for any payment instrument.
+ */
+export interface PaymentInstrument {
+  /**
+   * Unique instrument identifier.
+   */
+  id: string;
+
+  /**
+   * Handler instance identifier.
+   */
+  handler_id: string;
+
+  /**
+   * Instrument category (e.g., 'card', 'tokenized_card').
+   */
+  type: string;
+
+  /**
+   * Billing address.
+   */
+  billing_address?: RequestsAPI.PostalAddress;
+
+  /**
+   * Base definition for any payment credential.
+   */
+  credential?: PaymentInstrument.Credential;
+
+  /**
+   * Display information for the instrument. Each payment instrument schema defines
+   * its specific display properties, as outlined by the payment handler.
+   */
+  display?: { [key: string]: unknown };
+}
+
+export namespace PaymentInstrument {
+  /**
+   * Base definition for any payment credential.
+   */
+  export interface Credential {
+    /**
+     * Credential type discriminator.
+     */
+    type: string;
+
+    [k: string]: unknown;
+  }
+}
+
+/**
+ * A payment instrument with selection state.
+ */
+export interface SelectedPaymentInstrument
+  extends PaymentInstrument,
+    SelectedPaymentInstrumentSelectionState {}
+
+export interface SelectedPaymentInstrumentSelectionState {
+  /**
+   * Whether this instrument is selected by the user.
+   */
+  selected?: boolean;
+}
+
+export interface PaymentInstrumentRegisterParams {
+  /**
+   * Unique instrument identifier.
+   */
+  id: string;
+
+  /**
+   * EVM token identifier used for auth/capture settlement.
+   */
+  token: PaymentInstrumentRegisterParams.Token;
+
+  /**
+   * Amount in atomic units. Currency chain_id MUST match the instrument chain_id;
+   * currency address and decimals MUST match token address and decimals.
+   */
+  amount: EvmAmount;
+
+  /**
+   * Authorization expiration (RFC 3339).
+   */
+  authorization_expires_at: string;
+
+  /**
+   * EVM chain id.
+   */
+  chain_id: number;
+
+  /**
+   * Escrow contract address.
+   */
+  contract: string;
+
+  /**
+   * Handler instance identifier.
+   */
+  handler_id: string;
+
+  /**
+   * Maximum amount that can be authorized (atomic units). Currency chain_id MUST
+   * match the instrument chain_id; currency address and decimals MUST match token
+   * address and decimals.
+   */
+  max_amount: EvmAmount;
+
+  /**
+   * Unique nonce for payment info hash computation.
+   */
+  nonce: string;
+
+  /**
+   * Operator address.
+   */
+  operator: string;
+
+  /**
+   * Payer address.
+   */
+  payer: string;
+
+  /**
+   * Hash identifying the on-chain payment authorization.
+   */
+  payment_info_hash: string;
+
+  /**
+   * Pre-approval expiration (RFC 3339).
+   */
+  preapproval_expires_at: string;
+
+  /**
+   * Receiver address for captures.
+   */
+  receiver: string;
+
+  /**
+   * Refund expiration (RFC 3339).
+   */
+  refund_expires_at: string;
+
+  type: 'evm_auth_capture_escrow';
+
+  /**
+   * Billing address.
+   */
+  billing_address?: RequestsAPI.PostalAddress;
+
+  /**
+   * Base definition for any payment credential.
+   */
+  credential?: PaymentInstrumentRegisterParams.Credential;
+
+  /**
+   * Display information for the instrument. Each payment instrument schema defines
+   * its specific display properties, as outlined by the payment handler.
+   */
+  display?: { [key: string]: unknown };
+}
+
+export namespace PaymentInstrumentRegisterParams {
+  /**
+   * EVM token identifier used for auth/capture settlement.
+   */
+  export interface Token {
+    /**
+     * Token decimals.
+     */
+    decimals: number;
+
+    /**
+     * Token symbol (e.g., USDC).
+     */
+    symbol: string;
+
+    /**
+     * ERC-20 contract address. Omit for native gas tokens.
+     */
+    address?: string;
+  }
+
+  /**
+   * Base definition for any payment credential.
+   */
+  export interface Credential {
+    /**
+     * Credential type discriminator.
+     */
+    type: string;
+
+    [k: string]: unknown;
+  }
+}
+
+export declare namespace PaymentInstruments {
+  export {
+    type Amount as Amount,
+    type EvmAmount as EvmAmount,
+    type EvmAuthCaptureEscrowInstrument as EvmAuthCaptureEscrowInstrument,
+    type EvmAuthCaptureEscrowInstrumentDetails as EvmAuthCaptureEscrowInstrumentDetails,
+    type EvmCurrency as EvmCurrency,
+    type Payment as Payment,
+    type PaymentInstrument as PaymentInstrument,
+    type SelectedPaymentInstrument as SelectedPaymentInstrument,
+    type SelectedPaymentInstrumentSelectionState as SelectedPaymentInstrumentSelectionState,
+    type PaymentInstrumentRegisterParams as PaymentInstrumentRegisterParams,
+  };
+}

package/src/resources/requests/index.ts

@@ -0,0 +1,18 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Quotes,
+  type DeliveryQuote,
+  type QuoteListResponse,
+  type QuoteCreateParams,
+  type QuoteRetrieveParams,
+} from './quotes';
+export {
+  Requests,
+  type Coordinates,
+  type DeliveryRequest,
+  type Location,
+  type PostalAddress,
+  type RequestListResponse,
+  type RequestCreateParams,
+} from './requests';

package/src/resources/requests/quotes.ts

@@ -0,0 +1,168 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as PaymentInstrumentsAPI from '../payment-instruments';
+import * as RequestsAPI from './requests';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Create and read delivery quotes for a request.
+ */
+export class Quotes extends APIResource {
+  /**
+   * Submit a quote for a delivery request. The `nonce` field provides idempotency.
+   */
+  create(requestID: string, body: QuoteCreateParams, options?: RequestOptions): APIPromise<DeliveryQuote> {
+    return this._client.post(path`/requests/${requestID}/quotes`, { body, ...options });
+  }
+
+  /**
+   * Returns a single quote by ID.
+   */
+  retrieve(
+    quoteID: string,
+    params: QuoteRetrieveParams,
+    options?: RequestOptions,
+  ): APIPromise<DeliveryQuote> {
+    const { request_id } = params;
+    return this._client.get(path`/requests/${request_id}/quotes/${quoteID}`, options);
+  }
+
+  /**
+   * Returns all quotes for a delivery request.
+   */
+  list(requestID: string, options?: RequestOptions): APIPromise<QuoteListResponse> {
+    return this._client.get(path`/requests/${requestID}/quotes`, options);
+  }
+}
+
+/**
+ * A delivery quote.
+ */
+export interface DeliveryQuote {
+  /**
+   * Unique quote identifier.
+   */
+  id: string;
+
+  /**
+   * ISO 4217 currency code.
+   */
+  currency: string;
+
+  /**
+   * Estimated dropoff time (RFC 3339).
+   */
+  dropoff_estimate: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  dropoff_location: RequestsAPI.Location;
+
+  /**
+   * Client-generated idempotency key.
+   */
+  nonce: string;
+
+  /**
+   * Payment handlers available for accepting this quote.
+   */
+  payment: PaymentInstrumentsAPI.Payment;
+
+  /**
+   * Estimated pickup time (RFC 3339).
+   */
+  pickup_estimate: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  pickup_location: RequestsAPI.Location;
+
+  /**
+   * Price in minor currency units.
+   */
+  price: number;
+
+  /**
+   * Time when the quote expires (RFC 3339).
+   */
+  expires_at?: string;
+}
+
+export type QuoteListResponse = Array<DeliveryQuote>;
+
+export interface QuoteCreateParams {
+  /**
+   * Unique quote identifier.
+   */
+  id: string;
+
+  /**
+   * ISO 4217 currency code.
+   */
+  currency: string;
+
+  /**
+   * Estimated dropoff time (RFC 3339).
+   */
+  dropoff_estimate: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  dropoff_location: RequestsAPI.Location;
+
+  /**
+   * Client-generated idempotency key.
+   */
+  nonce: string;
+
+  /**
+   * Payment handlers available for accepting this quote.
+   */
+  payment: PaymentInstrumentsAPI.Payment;
+
+  /**
+   * Estimated pickup time (RFC 3339).
+   */
+  pickup_estimate: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  pickup_location: RequestsAPI.Location;
+
+  /**
+   * Price in minor currency units.
+   */
+  price: number;
+
+  /**
+   * Time when the quote expires (RFC 3339).
+   */
+  expires_at?: string;
+}
+
+export interface QuoteRetrieveParams {
+  /**
+   * Delivery request identifier.
+   */
+  request_id: string;
+}
+
+export declare namespace Quotes {
+  export {
+    type DeliveryQuote as DeliveryQuote,
+    type QuoteListResponse as QuoteListResponse,
+    type QuoteCreateParams as QuoteCreateParams,
+    type QuoteRetrieveParams as QuoteRetrieveParams,
+  };
+}