local-protocol 0.1.0

package/src/resources/requests/requests.ts

@@ -0,0 +1,225 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as QuotesAPI from './quotes';
+import { DeliveryQuote, QuoteCreateParams, QuoteListResponse, QuoteRetrieveParams, Quotes } from './quotes';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * Create and manage delivery requests.
+ */
+export class Requests extends APIResource {
+  quotes: QuotesAPI.Quotes = new QuotesAPI.Quotes(this._client);
+
+  /**
+   * Submit a new delivery request. The `nonce` field provides idempotency.
+   */
+  create(body: RequestCreateParams, options?: RequestOptions): APIPromise<DeliveryRequest> {
+    return this._client.post('/requests', { body, ...options });
+  }
+
+  /**
+   * Returns a single delivery request by ID.
+   */
+  retrieve(requestID: string, options?: RequestOptions): APIPromise<DeliveryRequest> {
+    return this._client.get(path`/requests/${requestID}`, options);
+  }
+
+  /**
+   * Returns all delivery requests.
+   */
+  list(options?: RequestOptions): APIPromise<RequestListResponse> {
+    return this._client.get('/requests', options);
+  }
+}
+
+/**
+ * Geographic coordinates.
+ */
+export interface Coordinates {
+  /**
+   * Latitude in decimal degrees.
+   */
+  latitude: number;
+
+  /**
+   * Longitude in decimal degrees.
+   */
+  longitude: number;
+}
+
+/**
+ * A delivery request.
+ */
+export interface DeliveryRequest {
+  /**
+   * Unique request identifier.
+   */
+  id: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  dropoff_location: Location;
+
+  /**
+   * Requested dropoff time (RFC 3339).
+   */
+  dropoff_time: string;
+
+  /**
+   * Client-generated idempotency key.
+   */
+  nonce: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  pickup_location: Location;
+
+  /**
+   * Requested pickup time (RFC 3339).
+   */
+  pickup_time: string;
+
+  /**
+   * Dropoff directions, access codes, or delivery notes.
+   */
+  dropoff_instructions?: string;
+
+  /**
+   * Pickup directions, access codes, or handling notes.
+   */
+  pickup_instructions?: string;
+}
+
+/**
+ * A location specified by coordinates and/or postal address. At least one must be
+ * provided.
+ */
+export interface Location {
+  /**
+   * Geographic coordinates.
+   */
+  coordinates?: Coordinates;
+
+  postal_address?: PostalAddress;
+}
+
+export interface PostalAddress {
+  /**
+   * Country (ISO 3166-1 alpha-2 recommended).
+   */
+  address_country?: string;
+
+  /**
+   * City or locality.
+   */
+  address_locality?: string;
+
+  /**
+   * State, province, or region.
+   */
+  address_region?: string;
+
+  /**
+   * Address extension (apartment number, C/O, etc.).
+   */
+  extended_address?: string;
+
+  /**
+   * Contact first name.
+   */
+  first_name?: string;
+
+  /**
+   * Contact last name.
+   */
+  last_name?: string;
+
+  /**
+   * Contact phone number.
+   */
+  phone_number?: string;
+
+  /**
+   * Postal code.
+   */
+  postal_code?: string;
+
+  /**
+   * The street address.
+   */
+  street_address?: string;
+}
+
+export type RequestListResponse = Array<DeliveryRequest>;
+
+export interface RequestCreateParams {
+  /**
+   * Unique request identifier.
+   */
+  id: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  dropoff_location: Location;
+
+  /**
+   * Requested dropoff time (RFC 3339).
+   */
+  dropoff_time: string;
+
+  /**
+   * Client-generated idempotency key.
+   */
+  nonce: string;
+
+  /**
+   * A location specified by coordinates and/or postal address. At least one must be
+   * provided.
+   */
+  pickup_location: Location;
+
+  /**
+   * Requested pickup time (RFC 3339).
+   */
+  pickup_time: string;
+
+  /**
+   * Dropoff directions, access codes, or delivery notes.
+   */
+  dropoff_instructions?: string;
+
+  /**
+   * Pickup directions, access codes, or handling notes.
+   */
+  pickup_instructions?: string;
+}
+
+Requests.Quotes = Quotes;
+
+export declare namespace Requests {
+  export {
+    type Coordinates as Coordinates,
+    type DeliveryRequest as DeliveryRequest,
+    type Location as Location,
+    type PostalAddress as PostalAddress,
+    type RequestListResponse as RequestListResponse,
+    type RequestCreateParams as RequestCreateParams,
+  };
+
+  export {
+    Quotes as Quotes,
+    type DeliveryQuote as DeliveryQuote,
+    type QuoteListResponse as QuoteListResponse,
+    type QuoteCreateParams as QuoteCreateParams,
+    type QuoteRetrieveParams as QuoteRetrieveParams,
+  };
+}

package/src/resources/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/well-known.ts

@@ -0,0 +1,46 @@
+// 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';
+
+/**
+ * Discover server capabilities, standards, and endpoints.
+ */
+export class WellKnown extends APIResource {
+  /**
+   * Returns server capabilities, supported standards, and endpoint paths.
+   */
+  retrieve(options?: RequestOptions): APIPromise<WellKnownRetrieveResponse> {
+    return this._client.get('/.well-known/local-protocol', options);
+  }
+}
+
+/**
+ * Service discovery metadata.
+ */
+export interface WellKnownRetrieveResponse {
+  /**
+   * Supported capabilities by domain.
+   */
+  capabilities: { [key: string]: { [key: string]: unknown } };
+
+  /**
+   * Endpoint path map.
+   */
+  endpoints: { [key: string]: string };
+
+  /**
+   * Server name.
+   */
+  name: string;
+
+  /**
+   * Protocol version.
+   */
+  version: string;
+}
+
+export declare namespace WellKnown {
+  export { type WellKnownRetrieveResponse as WellKnownRetrieveResponse };
+}

package/src/resources.ts

@@ -0,0 +1 @@
+export * from './resources/index';

package/src/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  // this config is included in the published src directory to prevent TS errors
+  // from appearing when users go to source, and VSCode opens the source .ts file
+  // via declaration maps
+  "include": ["index.ts"],
+  "compilerOptions": {
+    "target": "ES2015",
+    "lib": ["DOM", "DOM.Iterable", "ES2018"],
+    "moduleResolution": "node"
+  }
+}

package/src/uploads.ts

@@ -0,0 +1,2 @@
+/** @deprecated Import from ./core/uploads instead */
+export * from './core/uploads';

package/src/version.ts

@@ -0,0 +1 @@
+export const VERSION = '0.1.0'; // x-release-please-version

package/uploads.d.mts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.d.mts.map

package/uploads.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.mts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.d.ts

@@ -0,0 +1,2 @@
+export * from "./core/uploads.js";
+//# sourceMappingURL=uploads.d.ts.map

package/uploads.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.d.ts","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/uploads.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("./internal/tslib.js");
+/** @deprecated Import from ./core/uploads instead */
+tslib_1.__exportStar(require("./core/uploads.js"), exports);
+//# sourceMappingURL=uploads.js.map

package/uploads.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.js","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":";;;AAAA,qDAAqD;AACrD,4DAA+B"}

package/uploads.mjs

@@ -0,0 +1,2 @@
+export * from "./core/uploads.mjs";
+//# sourceMappingURL=uploads.mjs.map

package/uploads.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"uploads.mjs","sourceRoot":"","sources":["src/uploads.ts"],"names":[],"mappings":""}

package/version.d.mts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.0";
+//# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.d.ts

@@ -0,0 +1,2 @@
+export declare const VERSION = "0.1.0";
+//# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}

package/version.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = '0.1.0'; // x-release-please-version
+//# sourceMappingURL=version.js.map

package/version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -0,0 +1,2 @@
+export const VERSION = '0.1.0'; // x-release-please-version
+//# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}