@etohq/types 1.0.0

package/dist/address/common.d.ts

@@ -0,0 +1,16 @@
+export type AddressDTO = {
+    id?: string;
+    address_1: string;
+    address_2?: string | null;
+    company?: string | null;
+    country_code: string;
+    city?: string | null;
+    phone?: string | null;
+    postal_code?: string | null;
+    province?: string | null;
+    metadata?: Record<string, unknown> | null;
+    created_at?: string | Date;
+    updated_at?: string | Date;
+    deleted_at?: string | Date | null;
+};
+//# sourceMappingURL=common.d.ts.map

package/dist/address/common.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"common.d.ts","sourceRoot":"","sources":["../../src/address/common.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,UAAU,GAAG;IACvB,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,EAAE,MAAM,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACzB,OAAO,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACvB,YAAY,EAAE,MAAM,CAAA;IACpB,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACrB,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC3B,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,IAAI,CAAA;IACzC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAC1B,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAA;CAClC,CAAA"}

package/dist/address/common.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=common.js.map

package/dist/address/common.js.map

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

package/dist/address/index.d.ts

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

package/dist/address/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/address/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA"}

package/dist/address/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+//# sourceMappingURL=index.js.map

package/dist/address/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/address/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB"}

package/dist/admin/extensions.d.ts

@@ -0,0 +1,28 @@
+/**
+ * The props for detail widgets. All widgets that are rendered in a detail view,
+ * e.g. the product detail view, should implement this interface.
+ *
+ * The type of the data prop should be the same as the data that is passed to the widget.
+ * If the widget is rendered in the product detail view, the data prop should be of
+ * type AdminProduct.
+ *
+ * @example
+ * ```tsx
+ * import type { DetailWidgetProps, AdminProduct } from "@etohq/types"
+ * import { defineWidgetConfig } from "@etohq/admin-sdk"
+ *
+ * const ProductWidget = ({ data }: DetailWidgetProps<AdminProduct>) => {
+ *  return <div>{data.title}</div>
+ * }
+ *
+ * export const config = defineWidgetConfig({
+ *  zone: "product.details.after",
+ * })
+ *
+ * export default ProductWidget
+ * ```
+ */
+export interface DetailWidgetProps<TData> {
+    data: TData;
+}
+//# sourceMappingURL=extensions.d.ts.map

package/dist/admin/extensions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"extensions.d.ts","sourceRoot":"","sources":["../../src/admin/extensions.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AACH,MAAM,WAAW,iBAAiB,CAAC,KAAK;IACtC,IAAI,EAAE,KAAK,CAAA;CACZ"}

package/dist/admin/extensions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=extensions.js.map

package/dist/admin/extensions.js.map

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

package/dist/admin/index.d.ts

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

package/dist/admin/index.d.ts.map

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

package/dist/admin/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./extensions"), exports);
+//# sourceMappingURL=index.js.map

package/dist/admin/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/admin/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,+CAA4B"}

package/dist/api-key/common/api-key.d.ts

@@ -0,0 +1,87 @@
+import { BaseFilterable, OperatorMap } from "../../dal";
+/**
+ * An API key's type.
+ */
+export type ApiKeyType = "secret" | "publishable";
+/**
+ * The API key details.
+ */
+export interface ApiKeyDTO {
+    /**
+     * The ID of the API key.
+     */
+    id: string;
+    /**
+     * The token of the API key.
+     */
+    token: string;
+    /**
+     * The redacted form of the API key's token. This is useful
+     * when showing portion of the token. For example `sk_...123`.
+     */
+    redacted: string;
+    /**
+     * The title of the API key.
+     */
+    title: string;
+    /**
+     * The type of the API key.
+     */
+    type: ApiKeyType;
+    /**
+     * The date the API key was last used.
+     */
+    last_used_at: Date | null;
+    /**
+     * Who created the API key.
+     */
+    created_by: string;
+    /**
+     * The date the API key was created.
+     */
+    created_at: Date;
+    /**
+     * The date the API key was updated.
+     */
+    updated_at: Date;
+    /**
+     * The date the API key was deleted.
+     */
+    deleted_at: Date | null;
+    /**
+     * Who revoked the API key. For example,
+     * the ID of the user that revoked it.
+     */
+    revoked_by: string | null;
+    /**
+     * The date the API key was revoked.
+     */
+    revoked_at: Date | null;
+}
+/**
+ * The filters to apply on the retrieved API keys.
+ */
+export interface FilterableApiKeyProps extends BaseFilterable<FilterableApiKeyProps> {
+    /**
+     * Search through the api key names and redacted keys using this search term.
+     */
+    q?: string;
+    /**
+     * The IDs to filter the API keys by.
+     */
+    id?: string | string[];
+    /**
+     * The tokens to filter the API keys by.
+     */
+    token?: string | string[];
+    /**
+     * The titles to filter the API keys by.
+     */
+    title?: string | string[];
+    /**
+     * Filter the API keys by their type.
+     */
+    type?: ApiKeyType;
+    revoked_at?: OperatorMap<Date | null>;
+}
+//# sourceMappingURL=api-key.d.ts.map

package/dist/api-key/common/api-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/common/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,WAAW,EAAE,MAAM,WAAW,CAAA;AAEvD;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,aAAa,CAAA;AAEjD;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,YAAY,EAAE,IAAI,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;IAEvB;;;OAGG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAA;IAEzB;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,IAAI,CAAA;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,qBACf,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC7C;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;IAEzB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB,UAAU,CAAC,EAAE,WAAW,CAAC,IAAI,GAAG,IAAI,CAAC,CAAA;CACtC"}

package/dist/api-key/common/api-key.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-key.js.map

package/dist/api-key/common/api-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../../src/api-key/common/api-key.ts"],"names":[],"mappings":""}

package/dist/api-key/common/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api-key";
+//# sourceMappingURL=index.d.ts.map

package/dist/api-key/common/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api-key/common/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/dist/api-key/common/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-key"), exports);
+//# sourceMappingURL=index.js.map

package/dist/api-key/common/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api-key/common/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB"}

package/dist/api-key/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./common";
+export * from "./mutations";
+export * from "./service";
+//# sourceMappingURL=index.d.ts.map

package/dist/api-key/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/api-key/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,aAAa,CAAA;AAC3B,cAAc,WAAW,CAAA"}

package/dist/api-key/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./common"), exports);
+__exportStar(require("./mutations"), exports);
+__exportStar(require("./service"), exports);
+//# sourceMappingURL=index.js.map

package/dist/api-key/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/api-key/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,2CAAwB;AACxB,8CAA2B;AAC3B,4CAAyB"}

package/dist/api-key/mutations/api-key.d.ts

@@ -0,0 +1,63 @@
+import { ApiKeyType } from "../common";
+/**
+ * The API key to be created.
+ */
+export interface CreateApiKeyDTO {
+    /**
+     * The title of the API key.
+     */
+    title: string;
+    /**
+     * The type of the API key.
+     */
+    type: ApiKeyType;
+    /**
+     * Who created the API key.
+     */
+    created_by: string;
+}
+/**
+ * The attributes in the API key to be created or updated.
+ */
+export interface UpsertApiKeyDTO {
+    /**
+     * The ID of the API key.
+     */
+    id?: string;
+    /**
+     * The title of the API key.
+     */
+    title?: string;
+    /**
+     * The type of the API key. Required only when creating an API key.
+     */
+    type?: ApiKeyType;
+    /**
+     * Who created the API key. It's only
+     * usable and required when creating an API key.
+     */
+    created_by?: string;
+}
+/**
+ * The attributes to update in the API key.
+ */
+export interface UpdateApiKeyDTO {
+    /**
+     * The title of the API key.
+     */
+    title?: string;
+}
+/**
+ * The details of revoking an API key.
+ */
+export interface RevokeApiKeyDTO {
+    /**
+     * Who revoked the API key.
+     */
+    revoked_by: string;
+    /**
+     * When to revoke the API key (time in seconds).
+     */
+    revoke_in?: number;
+}
+//# sourceMappingURL=api-key.d.ts.map

package/dist/api-key/mutations/api-key.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.d.ts","sourceRoot":"","sources":["../../../src/api-key/mutations/api-key.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,WAAW,CAAA;AAEtC;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,EAAE,UAAU,CAAA;IAEhB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;CAEnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB"}

package/dist/api-key/mutations/api-key.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=api-key.js.map

package/dist/api-key/mutations/api-key.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"api-key.js","sourceRoot":"","sources":["../../../src/api-key/mutations/api-key.ts"],"names":[],"mappings":""}

package/dist/api-key/mutations/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api-key";
+//# sourceMappingURL=index.d.ts.map

package/dist/api-key/mutations/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/api-key/mutations/index.ts"],"names":[],"mappings":"AAAA,cAAc,WAAW,CAAA"}

package/dist/api-key/mutations/index.js

@@ -0,0 +1,18 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./api-key"), exports);
+//# sourceMappingURL=index.js.map

package/dist/api-key/mutations/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/api-key/mutations/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,4CAAyB"}