local-protocol 0.1.0

package/src/resources/deliveries.ts

@@ -0,0 +1,149 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Accept quotes and manage delivery lifecycle state.
+ */
+export class Deliveries extends APIResource {
+  /**
+   * Accept a quote and create a delivery. The `nonce` field provides idempotency.
+   */
+  create(body: DeliveryCreateParams, options?: RequestOptions): APIPromise<Delivery> {
+    return this._client.post('/deliveries', { body, ...options });
+  }
+
+  /**
+   * Returns a single delivery by ID.
+   */
+  retrieve(deliveryID: string, options?: RequestOptions): APIPromise<Delivery> {
+    return this._client.get(path`/deliveries/${deliveryID}`, options);
+  }
+
+  /**
+   * Returns all deliveries.
+   */
+  list(options?: RequestOptions): APIPromise<DeliveryListResponse> {
+    return this._client.get('/deliveries', options);
+  }
+
+  /**
+   * Transition a delivery to a new event state. If a webhook URL was registered, the
+   * server pushes an event notification in the background.
+   */
+  updateEvent(
+    deliveryID: string,
+    body: DeliveryUpdateEventParams,
+    options?: RequestOptions,
+  ): APIPromise<Delivery> {
+    return this._client.patch(path`/deliveries/${deliveryID}/event`, { body, ...options });
+  }
+}
+
+/**
+ * A delivery resource.
+ */
+export interface Delivery {
+  /**
+   * Unique delivery identifier.
+   */
+  id: string;
+
+  /**
+   * Creation timestamp (RFC 3339).
+   */
+  created_at: string;
+
+  /**
+   * Current event identifier.
+   */
+  event: string;
+
+  /**
+   * Human-readable description of the current event.
+   */
+  event_description: string;
+
+  /**
+   * Event vocabulary standard in use.
+   */
+  event_vocabulary: string;
+
+  /**
+   * Reference to the payment instrument used to create this delivery.
+   */
+  payment_instrument_id: string;
+
+  /**
+   * Reference to the accepted quote.
+   */
+  quote_id: string;
+
+  /**
+   * Reference to the delivery request.
+   */
+  request_id: string;
+
+  /**
+   * Last update timestamp (RFC 3339).
+   */
+  updated_at: string;
+
+  /**
+   * Registered webhook URL, if any.
+   */
+  webhook_url?: string | null;
+}
+
+export type DeliveryListResponse = Array<Delivery>;
+
+export interface DeliveryCreateParams {
+  /**
+   * Client-generated idempotency key.
+   */
+  nonce: string;
+
+  /**
+   * The accepted quote.
+   */
+  quote_id: string;
+
+  /**
+   * The delivery request to fulfill.
+   */
+  request_id: string;
+
+  /**
+   * Event vocabulary standard to use.
+   */
+  event_vocabulary?: string;
+
+  /**
+   * Optional URL to receive delivery event webhook notifications.
+   */
+  webhook_url?: string | null;
+}
+
+export interface DeliveryUpdateEventParams {
+  /**
+   * Event identifier from the delivery's event vocabulary.
+   */
+  event: string;
+
+  /**
+   * Human-readable event description.
+   */
+  event_description: string;
+}
+
+export declare namespace Deliveries {
+  export {
+    type Delivery as Delivery,
+    type DeliveryListResponse as DeliveryListResponse,
+    type DeliveryCreateParams as DeliveryCreateParams,
+    type DeliveryUpdateEventParams as DeliveryUpdateEventParams,
+  };
+}

package/src/resources/event-vocabularies.ts

@@ -0,0 +1,74 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+/**
+ * Retrieve event vocabulary definitions by name.
+ */
+export class EventVocabularies extends APIResource {
+  /**
+   * Returns a delivery event vocabulary by name.
+   */
+  retrieve(name: string, options?: RequestOptions): APIPromise<EventVocabularyRetrieveResponse> {
+    return this._client.get(path`/event-vocabularies/${name}`, options);
+  }
+}
+
+/**
+ * Schema for delivery event vocabularies.
+ */
+export interface EventVocabularyRetrieveResponse {
+  /**
+   * Map of event IDs to event definitions.
+   */
+  events: { [key: string]: EventVocabularyRetrieveResponse.Events };
+
+  /**
+   * Standard identifier in reverse-domain notation.
+   */
+  name: string;
+
+  /**
+   * Human-readable title.
+   */
+  title: string;
+
+  /**
+   * Version in YYYY-MM-DD format.
+   */
+  version: string;
+
+  /**
+   * Human-readable description.
+   */
+  description?: string;
+
+  /**
+   * Parent standard this extends (optional, max one).
+   */
+  extends?: Array<string>;
+
+  /**
+   * URL to specification document.
+   */
+  spec?: string;
+}
+
+export namespace EventVocabularyRetrieveResponse {
+  /**
+   * A single delivery event definition.
+   */
+  export interface Events {
+    /**
+     * Human-readable description of the event.
+     */
+    description: string;
+  }
+}
+
+export declare namespace EventVocabularies {
+  export { type EventVocabularyRetrieveResponse as EventVocabularyRetrieveResponse };
+}

package/src/resources/healthz.ts

@@ -0,0 +1,28 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+
+/**
+ * Check whether the server is currently healthy.
+ */
+export class Healthz extends APIResource {
+  /**
+   * Returns server health status.
+   */
+  check(options?: RequestOptions): APIPromise<HealthzCheckResponse> {
+    return this._client.get('/healthz', options);
+  }
+}
+
+/**
+ * Health check response.
+ */
+export interface HealthzCheckResponse {
+  status: 'ok';
+}
+
+export declare namespace Healthz {
+  export { type HealthzCheckResponse as HealthzCheckResponse };
+}

package/src/resources/index.ts

@@ -0,0 +1,43 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export {
+  Deliveries,
+  type Delivery,
+  type DeliveryListResponse,
+  type DeliveryCreateParams,
+  type DeliveryUpdateEventParams,
+} from './deliveries';
+export { EventVocabularies, type EventVocabularyRetrieveResponse } from './event-vocabularies';
+export { Healthz, type HealthzCheckResponse } from './healthz';
+export {
+  Merchants,
+  type Availability,
+  type CatalogCategory,
+  type ModifierGroup,
+  type ModifierOption,
+  type MerchantRetrieveResponse,
+} from './merchants';
+export { Orders, type Order, type OrderCreateParams } from './orders/orders';
+export {
+  PaymentInstruments,
+  type Amount,
+  type EvmAmount,
+  type EvmAuthCaptureEscrowInstrument,
+  type EvmAuthCaptureEscrowInstrumentDetails,
+  type EvmCurrency,
+  type Payment,
+  type PaymentInstrument,
+  type SelectedPaymentInstrument,
+  type SelectedPaymentInstrumentSelectionState,
+  type PaymentInstrumentRegisterParams,
+} from './payment-instruments';
+export {
+  Requests,
+  type Coordinates,
+  type DeliveryRequest,
+  type Location,
+  type PostalAddress,
+  type RequestListResponse,
+  type RequestCreateParams,
+} from './requests/requests';
+export { WellKnown, type WellKnownRetrieveResponse } from './well-known';