@interfere/attio 0.1.2

package/dist/commonjs/lib/security.js

@@ -0,0 +1,144 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SecurityError = exports.SecurityErrorCode = void 0;
+exports.resolveSecurity = resolveSecurity;
+exports.resolveGlobalSecurity = resolveGlobalSecurity;
+exports.extractSecurity = extractSecurity;
+const env_js_1 = require("./env.js");
+var SecurityErrorCode;
+(function (SecurityErrorCode) {
+    SecurityErrorCode["Incomplete"] = "incomplete";
+    SecurityErrorCode["UnrecognisedSecurityType"] = "unrecognized_security_type";
+})(SecurityErrorCode || (exports.SecurityErrorCode = SecurityErrorCode = {}));
+class SecurityError extends Error {
+    constructor(code, message) {
+        super(message);
+        this.code = code;
+        this.name = "SecurityError";
+    }
+    static incomplete() {
+        return new SecurityError(SecurityErrorCode.Incomplete, "Security requirements not met in order to perform the operation");
+    }
+    static unrecognizedType(type) {
+        return new SecurityError(SecurityErrorCode.UnrecognisedSecurityType, `Unrecognised security type: ${type}`);
+    }
+}
+exports.SecurityError = SecurityError;
+function resolveSecurity(...options) {
+    const state = {
+        basic: {},
+        headers: {},
+        queryParams: {},
+        cookies: {},
+        oauth2: { type: "none" },
+    };
+    const option = options.find((opts) => {
+        return opts.every((o) => {
+            if (o.value == null) {
+                return false;
+            }
+            else if (o.type === "http:basic") {
+                return o.value.username != null || o.value.password != null;
+            }
+            else if (o.type === "http:custom") {
+                return null;
+            }
+            else if (o.type === "oauth2:password") {
+                return (typeof o.value === "string" && !!o.value);
+            }
+            else if (o.type === "oauth2:client_credentials") {
+                if (typeof o.value == "string") {
+                    return !!o.value;
+                }
+                return o.value.clientID != null || o.value.clientSecret != null;
+            }
+            else if (typeof o.value === "string") {
+                return !!o.value;
+            }
+            else {
+                throw new Error(`Unrecognized security type: ${o.type} (value type: ${typeof o
+                    .value})`);
+            }
+        });
+    });
+    if (option == null) {
+        return null;
+    }
+    option.forEach((spec) => {
+        if (spec.value == null) {
+            return;
+        }
+        const { type } = spec;
+        switch (type) {
+            case "apiKey:header":
+                state.headers[spec.fieldName] = spec.value;
+                break;
+            case "apiKey:query":
+                state.queryParams[spec.fieldName] = spec.value;
+                break;
+            case "apiKey:cookie":
+                state.cookies[spec.fieldName] = spec.value;
+                break;
+            case "http:basic":
+                applyBasic(state, spec);
+                break;
+            case "http:custom":
+                break;
+            case "http:bearer":
+                applyBearer(state, spec);
+                break;
+            case "oauth2":
+                applyBearer(state, spec);
+                break;
+            case "oauth2:password":
+                applyBearer(state, spec);
+                break;
+            case "oauth2:client_credentials":
+                break;
+            case "openIdConnect":
+                applyBearer(state, spec);
+                break;
+            default:
+                spec;
+                throw SecurityError.unrecognizedType(type);
+        }
+    });
+    return state;
+}
+function applyBasic(state, spec) {
+    if (spec.value == null) {
+        return;
+    }
+    state.basic = spec.value;
+}
+function applyBearer(state, spec) {
+    if (typeof spec.value !== "string" || !spec.value) {
+        return;
+    }
+    let value = spec.value;
+    if (value.slice(0, 7).toLowerCase() !== "bearer ") {
+        value = `Bearer ${value}`;
+    }
+    if (spec.fieldName !== undefined) {
+        state.headers[spec.fieldName] = value;
+    }
+}
+function resolveGlobalSecurity(security) {
+    return resolveSecurity([
+        {
+            fieldName: "Authorization",
+            type: "oauth2",
+            value: security?.oauth2 ?? (0, env_js_1.env)().ATTIO_OAUTH2,
+        },
+    ]);
+}
+async function extractSecurity(sec) {
+    if (sec == null) {
+        return;
+    }
+    return typeof sec === "function" ? sec() : sec;
+}
+//# sourceMappingURL=security.js.map

package/dist/commonjs/lib/security.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"security.js","sourceRoot":"","sources":["../../../src/lib/security.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAuHH,0CAqFC;AAmCD,sDAYC;AAED,0CAQC;AAlQD,qCAA+B;AAU/B,IAAY,iBAGX;AAHD,WAAY,iBAAiB;IAC3B,8CAAyB,CAAA;IACzB,4EAAuD,CAAA;AACzD,CAAC,EAHW,iBAAiB,iCAAjB,iBAAiB,QAG5B;AAED,MAAa,aAAc,SAAQ,KAAK;IACtC,YACS,IAAuB,EAC9B,OAAe;QAEf,KAAK,CAAC,OAAO,CAAC,CAAC;QAHR,SAAI,GAAJ,IAAI,CAAmB;QAI9B,IAAI,CAAC,IAAI,GAAG,eAAe,CAAC;IAC9B,CAAC;IAED,MAAM,CAAC,UAAU;QACf,OAAO,IAAI,aAAa,CACtB,iBAAiB,CAAC,UAAU,EAC5B,iEAAiE,CAClE,CAAC;IACJ,CAAC;IACD,MAAM,CAAC,gBAAgB,CAAC,IAAY;QAClC,OAAO,IAAI,aAAa,CACtB,iBAAiB,CAAC,wBAAwB,EAC1C,+BAA+B,IAAI,EAAE,CACtC,CAAC;IACJ,CAAC;CACF;AArBD,sCAqBC;AAgFD,SAAgB,eAAe,CAC7B,GAAG,OAA0B;IAE7B,MAAM,KAAK,GAAkB;QAC3B,KAAK,EAAE,EAAE;QACT,OAAO,EAAE,EAAE;QACX,WAAW,EAAE,EAAE;QACf,OAAO,EAAE,EAAE;QACX,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;KACzB,CAAC;IAEF,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE;QACnC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;YACtB,IAAI,CAAC,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;gBACpB,OAAO,KAAK,CAAC;YACf,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;gBACnC,OAAO,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,CAAC;YAC9D,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;gBACpC,OAAO,IAAI,CAAC;YACd,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,iBAAiB,EAAE,CAAC;gBACxC,OAAO,CACL,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,CACzC,CAAC;YACJ,CAAC;iBAAM,IAAI,CAAC,CAAC,IAAI,KAAK,2BAA2B,EAAE,CAAC;gBAClD,IAAI,OAAO,CAAC,CAAC,KAAK,IAAI,QAAQ,EAAE,CAAC;oBAC/B,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;gBACnB,CAAC;gBACD,OAAO,CAAC,CAAC,KAAK,CAAC,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC,KAAK,CAAC,YAAY,IAAI,IAAI,CAAC;YAClE,CAAC;iBAAM,IAAI,OAAO,CAAC,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;gBACvC,OAAO,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,KAAK,CACb,+BAA+B,CAAC,CAAC,IAAI,iBAAiB,OAAO,CAAC;qBAC3D,KAAK,GAAG,CACZ,CAAC;YACJ,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IACH,IAAI,MAAM,IAAI,IAAI,EAAE,CAAC;QACnB,OAAO,IAAI,CAAC;IACd,CAAC;IAED,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,EAAE,EAAE;QACtB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;YACvB,OAAO;QACT,CAAC;QAED,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;QAEtB,QAAQ,IAAI,EAAE,CAAC;YACb,KAAK,eAAe;gBAClB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC3C,MAAM;YACR,KAAK,cAAc;gBACjB,KAAK,CAAC,WAAW,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC/C,MAAM;YACR,KAAK,eAAe;gBAClB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC;gBAC3C,MAAM;YACR,KAAK,YAAY;gBACf,UAAU,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACxB,MAAM;YACR,KAAK,aAAa;gBAChB,MAAM;YACR,KAAK,aAAa;gBAChB,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACzB,MAAM;YACR,KAAK,QAAQ;gBACX,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACzB,MAAM;YACR,KAAK,iBAAiB;gBACpB,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACzB,MAAM;YACR,KAAK,2BAA2B;gBAC9B,MAAM;YACR,KAAK,eAAe;gBAClB,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;gBACzB,MAAM;YACR;gBACE,IAAoB,CAAC;gBACrB,MAAM,aAAa,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,UAAU,CACjB,KAAoB,EACpB,IAAwB;IAExB,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;QACvB,OAAO;IACT,CAAC;IAED,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;AAC3B,CAAC;AAED,SAAS,WAAW,CAClB,KAAoB,EACpB,IAI0C;IAE1C,IAAI,OAAO,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;QAClD,OAAO;IACT,CAAC;IAED,IAAI,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACvB,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,EAAE,KAAK,SAAS,EAAE,CAAC;QAClD,KAAK,GAAG,UAAU,KAAK,EAAE,CAAC;IAC5B,CAAC;IAED,IAAI,IAAI,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;QACjC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,KAAK,CAAC;IACxC,CAAC;AACH,CAAC;AAED,SAAgB,qBAAqB,CACnC,QAAqD;IAErD,OAAO,eAAe,CACpB;QACE;YACE,SAAS,EAAE,eAAe;YAC1B,IAAI,EAAE,QAAQ;YACd,KAAK,EAAE,QAAQ,EAAE,MAAM,IAAI,IAAA,YAAG,GAAE,CAAC,YAAY;SAC9C;KACF,CACF,CAAC;AACJ,CAAC;AAEM,KAAK,UAAU,eAAe,CAEnC,GAAuC;IACvC,IAAI,GAAG,IAAI,IAAI,EAAE,CAAC;QAChB,OAAO;IACT,CAAC;IAED,OAAO,OAAO,GAAG,KAAK,UAAU,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC;AACjD,CAAC"}

package/dist/commonjs/lib/url.d.ts

@@ -0,0 +1,5 @@
+export type Params = Partial<Record<string, string | number>>;
+export declare function pathToFunc(pathPattern: string, options?: {
+    charEncoding?: "percent" | "none";
+}): (params?: Params) => string;
+//# sourceMappingURL=url.d.ts.map

package/dist/commonjs/lib/url.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.d.ts","sourceRoot":"","sources":["../../../src/lib/url.ts"],"names":[],"mappings":"AAMA,MAAM,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC,CAAC,CAAC;AAE9D,wBAAgB,UAAU,CACxB,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE;IAAE,YAAY,CAAC,EAAE,SAAS,GAAG,MAAM,CAAA;CAAE,GAC9C,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,MAAM,CAqB7B"}

package/dist/commonjs/lib/url.js

@@ -0,0 +1,25 @@
+"use strict";
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.pathToFunc = pathToFunc;
+const hasOwn = Object.prototype.hasOwnProperty;
+function pathToFunc(pathPattern, options) {
+    const paramRE = /\{([a-zA-Z0-9_][a-zA-Z0-9_-]*?)\}/g;
+    return function buildURLPath(params = {}) {
+        return pathPattern.replace(paramRE, function (_, placeholder) {
+            if (!hasOwn.call(params, placeholder)) {
+                throw new Error(`Parameter '${placeholder}' is required`);
+            }
+            const value = params[placeholder];
+            if (typeof value !== "string" && typeof value !== "number") {
+                throw new Error(`Parameter '${placeholder}' must be a string or number`);
+            }
+            return options?.charEncoding === "percent"
+                ? encodeURIComponent(`${value}`)
+                : `${value}`;
+        });
+    };
+}
+//# sourceMappingURL=url.js.map

package/dist/commonjs/lib/url.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"url.js","sourceRoot":"","sources":["../../../src/lib/url.ts"],"names":[],"mappings":";AAAA;;GAEG;;AAMH,gCAwBC;AA5BD,MAAM,MAAM,GAAG,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC;AAI/C,SAAgB,UAAU,CACxB,WAAmB,EACnB,OAA+C;IAE/C,MAAM,OAAO,GAAG,oCAAoC,CAAC;IAErD,OAAO,SAAS,YAAY,CAAC,SAAkC,EAAE;QAC/D,OAAO,WAAW,CAAC,OAAO,CAAC,OAAO,EAAE,UAAU,CAAC,EAAE,WAAW;YAC1D,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,EAAE,CAAC;gBACtC,MAAM,IAAI,KAAK,CAAC,cAAc,WAAW,eAAe,CAAC,CAAC;YAC5D,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,WAAW,CAAC,CAAC;YAClC,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;gBAC3D,MAAM,IAAI,KAAK,CACb,cAAc,WAAW,8BAA8B,CACxD,CAAC;YACJ,CAAC;YAED,OAAO,OAAO,EAAE,YAAY,KAAK,SAAS;gBACxC,CAAC,CAAC,kBAAkB,CAAC,GAAG,KAAK,EAAE,CAAC;gBAChC,CAAC,CAAC,GAAG,KAAK,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;AACJ,CAAC"}

package/dist/commonjs/models/attribute.d.ts

@@ -0,0 +1,303 @@
+import * as z from "zod/v4-mini";
+import * as discriminatedUnionTypes from "../types/discriminated-union.js";
+import { ClosedEnum, OpenEnum } from "../types/enums.js";
+import { Result as SafeParseResult } from "../types/fp.js";
+import { SDKValidationError } from "./errors/sdk-validation-error.js";
+import { OutputValue } from "./output-value.js";
+export type AttributeId = {
+    /**
+     * A UUID representing the workspace this attribute belongs to.
+     */
+    workspaceId: string;
+    /**
+     * A UUID to identify the object or list that this attribute belongs to
+     */
+    objectId: string;
+    /**
+     * A UUID to identify this attribute.
+     */
+    attributeId: string;
+};
+/**
+ * The type of the attribute.
+ */
+export declare const AttributeTypeEnum: {
+    readonly Text: "text";
+    readonly Number: "number";
+    readonly Checkbox: "checkbox";
+    readonly Currency: "currency";
+    readonly Date: "date";
+    readonly Timestamp: "timestamp";
+    readonly Rating: "rating";
+    readonly Status: "status";
+    readonly Select: "select";
+    readonly RecordReference: "record-reference";
+    readonly ActorReference: "actor-reference";
+    readonly Location: "location";
+    readonly Domain: "domain";
+    readonly EmailAddress: "email-address";
+    readonly PhoneNumber: "phone-number";
+    readonly Interaction: "interaction";
+    readonly PersonalName: "personal-name";
+};
+/**
+ * The type of the attribute.
+ */
+export type AttributeTypeEnum = OpenEnum<typeof AttributeTypeEnum>;
+export type DefaultValueStatic = {
+    type: "static";
+    template: Array<OutputValue>;
+};
+/**
+ * For actor reference attributes, you may pass a dynamic value of `"current-user"`. When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry.
+ */
+export declare const Template: {
+    readonly CurrentUser: "current-user";
+};
+/**
+ * For actor reference attributes, you may pass a dynamic value of `"current-user"`. When creating new records or entries, this will cause the actor reference value to be populated with either the workspace member or API token that created the record/entry.
+ */
+export type Template = ClosedEnum<typeof Template>;
+export type DefaultValueDynamic = {
+    type: "dynamic";
+    template: any;
+};
+/**
+ * The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute.
+ */
+export type DefaultValue = DefaultValueDynamic | DefaultValueStatic | discriminatedUnionTypes.Unknown<"type">;
+export type RelationshipId = {
+    /**
+     * A UUID representing the workspace this attribute belongs to.
+     */
+    workspaceId: string;
+    /**
+     * A UUID to identify the object or list that this attribute belongs to
+     */
+    objectId: string;
+    /**
+     * A UUID to identify this attribute.
+     */
+    attributeId: string;
+};
+/**
+ * If this attribute is related to another attribute, this is an object that includes an `id` property that identifies the other attribute. `null` means no relationship exists. See [the help center](https://attio.com/help/reference/managing-your-data/attributes#relationship-attributes) for more details about relationship attributes.
+ */
+export type Relationship = {
+    id: RelationshipId;
+    /**
+     * The slug of the object that the related attribute belongs to.
+     */
+    objectSlug: string;
+    /**
+     * The title of the related attribute.
+     */
+    title: string;
+    /**
+     * The API slug identifying the related attribute.
+     */
+    apiSlug: string;
+    /**
+     * Whether the related attribute supports selecting multiple values. Combined with the parent attribute's `is_multiselect`, this determines the relationship type: both `false` = one-to-one, parent `true` + related `false` = many-to-one, parent `false` + related `true` = one-to-many, both `true` = many-to-many.
+     */
+    isMultiselect: boolean;
+};
+/**
+ * The ISO4217 code representing the currency that values for this attribute should be stored in.
+ */
+export declare const DefaultCurrencyCode: {
+    readonly Ars: "ARS";
+    readonly Aud: "AUD";
+    readonly Brl: "BRL";
+    readonly Bgn: "BGN";
+    readonly Cad: "CAD";
+    readonly Clp: "CLP";
+    readonly Cny: "CNY";
+    readonly Cop: "COP";
+    readonly Czk: "CZK";
+    readonly Dkk: "DKK";
+    readonly Eur: "EUR";
+    readonly Hkd: "HKD";
+    readonly Huf: "HUF";
+    readonly Isk: "ISK";
+    readonly Inr: "INR";
+    readonly Ils: "ILS";
+    readonly Jpy: "JPY";
+    readonly Kes: "KES";
+    readonly Krw: "KRW";
+    readonly Myr: "MYR";
+    readonly Mxn: "MXN";
+    readonly Ntd: "NTD";
+    readonly Nzd: "NZD";
+    readonly Ngn: "NGN";
+    readonly Nok: "NOK";
+    readonly Xpf: "XPF";
+    readonly Pen: "PEN";
+    readonly Php: "PHP";
+    readonly Pln: "PLN";
+    readonly Gbp: "GBP";
+    readonly Rwf: "RWF";
+    readonly Sar: "SAR";
+    readonly Sgd: "SGD";
+    readonly Zar: "ZAR";
+    readonly Sek: "SEK";
+    readonly Chf: "CHF";
+    readonly Thb: "THB";
+    readonly Aed: "AED";
+    readonly Uyu: "UYU";
+    readonly Usd: "USD";
+};
+/**
+ * The ISO4217 code representing the currency that values for this attribute should be stored in.
+ */
+export type DefaultCurrencyCode = OpenEnum<typeof DefaultCurrencyCode>;
+/**
+ * How the currency should be displayed across the app. "code" will display the ISO currency code e.g. "USD", "name" will display the localized currency name e.g. "British pound", "narrowSymbol" will display "$1" instead of "US$1" and "symbol" will display a localized currency symbol such as "$".
+ */
+export declare const DisplayType: {
+    readonly Code: "code";
+    readonly Name: "name";
+    readonly NarrowSymbol: "narrowSymbol";
+    readonly Symbol: "symbol";
+};
+/**
+ * How the currency should be displayed across the app. "code" will display the ISO currency code e.g. "USD", "name" will display the localized currency name e.g. "British pound", "narrowSymbol" will display "$1" instead of "US$1" and "symbol" will display a localized currency symbol such as "$".
+ */
+export type DisplayType = OpenEnum<typeof DisplayType>;
+/**
+ * Configuration available for attributes of type "currency".
+ */
+export type Currency = {
+    /**
+     * The ISO4217 code representing the currency that values for this attribute should be stored in.
+     */
+    defaultCurrencyCode: DefaultCurrencyCode | null;
+    /**
+     * How the currency should be displayed across the app. "code" will display the ISO currency code e.g. "USD", "name" will display the localized currency name e.g. "British pound", "narrowSymbol" will display "$1" instead of "US$1" and "symbol" will display a localized currency symbol such as "$".
+     */
+    displayType: DisplayType | null;
+};
+/**
+ * Configuration available for attributes of type "record-reference".
+ */
+export type RecordReference = {
+    /**
+     * A list of UUIDs to indicate which objects records are allowed to belong to. Leave empty to to allow records from all object types.
+     */
+    allowedObjectIds: Array<string> | null;
+};
+/**
+ * Additional, type-dependent configuration for the attribute.
+ */
+export type Config = {
+    /**
+     * Configuration available for attributes of type "currency".
+     */
+    currency: Currency;
+    /**
+     * Configuration available for attributes of type "record-reference".
+     */
+    recordReference: RecordReference;
+};
+export type Attribute = {
+    id: AttributeId;
+    /**
+     * A title for the attribute, to be displayed across the app.
+     */
+    title: string;
+    /**
+     * A text description of the attribute.
+     */
+    description: string | null;
+    /**
+     * A unique slug for the attribute for use in API responses and URLs. Formatted in snake case.
+     */
+    apiSlug: string;
+    /**
+     * The type of the attribute.
+     */
+    type: AttributeTypeEnum;
+    /**
+     * `true` if this is an Attio system-defined attribute, `false` if defined by a user or non-Attio system.
+     */
+    isSystemAttribute: boolean;
+    /**
+     * Whether or not this attribute can be written to. Can only be false when `is_system_attribute` is `true` (user-defined attributes are always writeable). If `false`, this usually means the attribute is enriched by Attio.
+     */
+    isWritable: boolean;
+    /**
+     * When `is_required` is `true`, new records/entries must have a value for this attribute. If `false`, values may be `null`. This value does not affect existing data and you do not need to backfill `null` values if changing `is_required` from `false` to `true`.
+     */
+    isRequired: boolean;
+    /**
+     * Whether or not new values for this attribute must be unique. Uniqueness restrictions are only applied to new data and do not apply retroactively to previously created data.
+     */
+    isUnique: boolean;
+    /**
+     * Whether or not this attribute can have multiple values. Multiselect is only available on some value types.
+     */
+    isMultiselect: boolean;
+    /**
+     * Whether this attribute has a default value enabled. Must be `true` when `is_required` is `true`.
+     */
+    isDefaultValueEnabled: boolean;
+    /**
+     * Whether this attribute has been archived. Archived attributes are hidden from most UI, but can be restored either over the API or in workspace settings. See the [guide on archiving and deleting](/docs/archiving-vs-deleting)for more information.
+     */
+    isArchived: boolean;
+    /**
+     * The default value for this attribute. Static values are used to directly populate values using their contents. Dynamic values are used to lookup data at the point of creation. For example, you could use a dynamic value to insert a value for the currently logged in user. Which default values are available is dependent on the type of the attribute.
+     */
+    defaultValue: DefaultValueDynamic | DefaultValueStatic | discriminatedUnionTypes.Unknown<"type"> | null;
+    /**
+     * If this attribute is related to another attribute, this is an object that includes an `id` property that identifies the other attribute. `null` means no relationship exists. See [the help center](https://attio.com/help/reference/managing-your-data/attributes#relationship-attributes) for more details about relationship attributes.
+     */
+    relationship: Relationship | null;
+    /**
+     * When this attribute was created.
+     */
+    createdAt: string;
+    /**
+     * Additional, type-dependent configuration for the attribute.
+     */
+    config: Config;
+};
+/** @internal */
+export declare const AttributeId$inboundSchema: z.ZodMiniType<AttributeId, unknown>;
+export declare function attributeIdFromJSON(jsonString: string): SafeParseResult<AttributeId, SDKValidationError>;
+/** @internal */
+export declare const AttributeTypeEnum$inboundSchema: z.ZodMiniType<AttributeTypeEnum, unknown>;
+/** @internal */
+export declare const DefaultValueStatic$inboundSchema: z.ZodMiniType<DefaultValueStatic, unknown>;
+export declare function defaultValueStaticFromJSON(jsonString: string): SafeParseResult<DefaultValueStatic, SDKValidationError>;
+/** @internal */
+export declare const Template$inboundSchema: z.ZodMiniEnum<typeof Template>;
+/** @internal */
+export declare const DefaultValueDynamic$inboundSchema: z.ZodMiniType<DefaultValueDynamic, unknown>;
+export declare function defaultValueDynamicFromJSON(jsonString: string): SafeParseResult<DefaultValueDynamic, SDKValidationError>;
+/** @internal */
+export declare const DefaultValue$inboundSchema: z.ZodMiniType<DefaultValue, unknown>;
+export declare function defaultValueFromJSON(jsonString: string): SafeParseResult<DefaultValue, SDKValidationError>;
+/** @internal */
+export declare const RelationshipId$inboundSchema: z.ZodMiniType<RelationshipId, unknown>;
+export declare function relationshipIdFromJSON(jsonString: string): SafeParseResult<RelationshipId, SDKValidationError>;
+/** @internal */
+export declare const Relationship$inboundSchema: z.ZodMiniType<Relationship, unknown>;
+export declare function relationshipFromJSON(jsonString: string): SafeParseResult<Relationship, SDKValidationError>;
+/** @internal */
+export declare const DefaultCurrencyCode$inboundSchema: z.ZodMiniType<DefaultCurrencyCode, unknown>;
+/** @internal */
+export declare const DisplayType$inboundSchema: z.ZodMiniType<DisplayType, unknown>;
+/** @internal */
+export declare const Currency$inboundSchema: z.ZodMiniType<Currency, unknown>;
+export declare function currencyFromJSON(jsonString: string): SafeParseResult<Currency, SDKValidationError>;
+/** @internal */
+export declare const RecordReference$inboundSchema: z.ZodMiniType<RecordReference, unknown>;
+export declare function recordReferenceFromJSON(jsonString: string): SafeParseResult<RecordReference, SDKValidationError>;
+/** @internal */
+export declare const Config$inboundSchema: z.ZodMiniType<Config, unknown>;
+export declare function configFromJSON(jsonString: string): SafeParseResult<Config, SDKValidationError>;
+/** @internal */
+export declare const Attribute$inboundSchema: z.ZodMiniType<Attribute, unknown>;
+export declare function attributeFromJSON(jsonString: string): SafeParseResult<Attribute, SDKValidationError>;
+//# sourceMappingURL=attribute.d.ts.map

package/dist/commonjs/models/attribute.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"attribute.d.ts","sourceRoot":"","sources":["../../../src/models/attribute.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,CAAC,MAAM,aAAa,CAAC;AAGjC,OAAO,KAAK,uBAAuB,MAAM,iCAAiC,CAAC;AAG3E,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,MAAM,IAAI,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE3D,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,WAAW,EAA6B,MAAM,mBAAmB,CAAC;AAE3E,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;CAkBpB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,QAAQ,CAAC,OAAO,iBAAiB,CAAC,CAAC;AAEnE,MAAM,MAAM,kBAAkB,GAAG;IAC/B,IAAI,EAAE,QAAQ,CAAC;IACf,QAAQ,EAAE,KAAK,CAAC,WAAW,CAAC,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,QAAQ;;CAEX,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,UAAU,CAAC,OAAO,QAAQ,CAAC,CAAC;AAEnD,MAAM,MAAM,mBAAmB,GAAG;IAChC,IAAI,EAAE,SAAS,CAAC;IAChB,QAAQ,EAAE,GAAG,CAAC;CACf,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GACpB,mBAAmB,GACnB,kBAAkB,GAClB,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;AAE5C,MAAM,MAAM,cAAc,GAAG;IAC3B;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,YAAY,GAAG;IACzB,EAAE,EAAE,cAAc,CAAC;IACnB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IACnB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;CACxB,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAyCtB,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,QAAQ,CAAC,OAAO,mBAAmB,CAAC,CAAC;AAEvE;;GAEG;AACH,eAAO,MAAM,WAAW;;;;;CAKd,CAAC;AACX;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAAC,OAAO,WAAW,CAAC,CAAC;AAEvD;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,mBAAmB,EAAE,mBAAmB,GAAG,IAAI,CAAC;IAChD;;OAEG;IACH,WAAW,EAAE,WAAW,GAAG,IAAI,CAAC;CACjC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,gBAAgB,EAAE,KAAK,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC;CACxC,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,MAAM,GAAG;IACnB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IACnB;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;CAClC,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,EAAE,EAAE,WAAW,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,WAAW,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAC;IACxB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC;IAClB;;OAEG;IACH,aAAa,EAAE,OAAO,CAAC;IACvB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,UAAU,EAAE,OAAO,CAAC;IACpB;;OAEG;IACH,YAAY,EACR,mBAAmB,GACnB,kBAAkB,GAClB,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,GACvC,IAAI,CAAC;IACT;;OAEG;IACH,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAClC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,OAAO,CAcvE,CAAC;AAEJ,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,WAAW,EAAE,kBAAkB,CAAC,CAMlD;AAED,gBAAgB;AAChB,eAAO,MAAM,+BAA+B,EAAE,CAAC,CAAC,WAAW,CACzD,iBAAiB,EACjB,OAAO,CACqC,CAAC;AAE/C,gBAAgB;AAChB,eAAO,MAAM,gCAAgC,EAAE,CAAC,CAAC,WAAW,CAC1D,kBAAkB,EAClB,OAAO,CAIP,CAAC;AAEH,wBAAgB,0BAA0B,CACxC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,kBAAkB,EAAE,kBAAkB,CAAC,CAMzD;AAED,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,WAAW,CAAC,OAAO,QAAQ,CAEjE,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,WAAW,CAC3D,mBAAmB,EACnB,OAAO,CAIP,CAAC;AAEH,wBAAgB,2BAA2B,CACzC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,CAM1D;AAED,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,CAIxE,CAAC;AAEL,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD;AAED,gBAAgB;AAChB,eAAO,MAAM,4BAA4B,EAAE,CAAC,CAAC,WAAW,CACtD,cAAc,EACd,OAAO,CAcR,CAAC;AAEF,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAMrD;AAED,gBAAgB;AAChB,eAAO,MAAM,0BAA0B,EAAE,CAAC,CAAC,WAAW,CAAC,YAAY,EAAE,OAAO,CAgBzE,CAAC;AAEJ,wBAAgB,oBAAoB,CAClC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,YAAY,EAAE,kBAAkB,CAAC,CAMnD;AAED,gBAAgB;AAChB,eAAO,MAAM,iCAAiC,EAAE,CAAC,CAAC,WAAW,CAC3D,mBAAmB,EACnB,OAAO,CACuC,CAAC;AAEjD,gBAAgB;AAChB,eAAO,MAAM,yBAAyB,EAAE,CAAC,CAAC,WAAW,CAAC,WAAW,EAAE,OAAO,CACpC,CAAC;AAEvC,gBAAgB;AAChB,eAAO,MAAM,sBAAsB,EAAE,CAAC,CAAC,WAAW,CAAC,QAAQ,EAAE,OAAO,CAWnE,CAAC;AAEF,wBAAgB,gBAAgB,CAC9B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAM/C;AAED,gBAAgB;AAChB,eAAO,MAAM,6BAA6B,EAAE,CAAC,CAAC,WAAW,CACvD,eAAe,EACf,OAAO,CAUR,CAAC;AAEF,wBAAgB,uBAAuB,CACrC,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,eAAe,EAAE,kBAAkB,CAAC,CAMtD;AAED,gBAAgB;AAChB,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,WAAW,CAAC,MAAM,EAAE,OAAO,CAU/D,CAAC;AAEF,wBAAgB,cAAc,CAC5B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,MAAM,EAAE,kBAAkB,CAAC,CAM7C;AAED,gBAAgB;AAChB,eAAO,MAAM,uBAAuB,EAAE,CAAC,CAAC,WAAW,CAAC,SAAS,EAAE,OAAO,CAuCnE,CAAC;AAEJ,wBAAgB,iBAAiB,CAC/B,UAAU,EAAE,MAAM,GACjB,eAAe,CAAC,SAAS,EAAE,kBAAkB,CAAC,CAMhD"}