@augno/sdk 0.7.0 → 0.9.0

package/resources/sales/addresses.js

@@ -11,6 +11,9 @@ class Addresses extends resource_1.APIResource {
     /**
      * Returns a paginated list of addresses.
      *
+     * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+     * `suppliers:read`.
+     *
      * @example
      * ```ts
      * const listAddress = await client.sales.addresses.list();
@@ -22,6 +25,9 @@ class Addresses extends resource_1.APIResource {
     /**
      * Retrieves an address by ID.
      *
+     * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+     * `suppliers:read`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.retrieve(
@@ -35,15 +41,22 @@ class Addresses extends resource_1.APIResource {
     /**
      * Creates an address.
      *
+     * This endpoint requires the permissions: `addresses:create`, `customers:update`,
+     * `suppliers:update`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.create({
      *   country: 'US',
      *   name: 'Headquarters',
+     *   email: 'warehouse@acme.com',
      *   locality: 'Springfield',
+     *   phone: '555-123-4567',
      *   postal_code: '62701',
      *   state: 'IL',
      *   street_line_1: '123 Main St',
+     *   street_line_2: 'Suite 400',
+     *   type: 'standard',
      * });
      * ```
      */
@@ -56,11 +69,25 @@ class Addresses extends resource_1.APIResource {
      * Changing a street, locality, state, postal code, or country field may replace
      * the address's geolocation, so the geolocation `id` in the response can change.
      *
+     * This endpoint requires the permissions: `addresses:update`, `customers:update`,
+     * `suppliers:update`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.update(
      *   'ad_012100950cfaa34aa0e0ad7258',
-     *   { name: 'Warehouse' },
+     *   {
+     *     country: 'US',
+     *     email: 'warehouse@acme.com',
+     *     locality: 'Springfield',
+     *     name: 'Warehouse',
+     *     phone: '555-123-4567',
+     *     postal_code: '62701',
+     *     state: 'IL',
+     *     street_line_1: '123 Main St',
+     *     street_line_2: 'Suite 400',
+     *     type: 'standard',
+     *   },
      * );
      * ```
      */
@@ -73,6 +100,9 @@ class Addresses extends resource_1.APIResource {
      * Deletion fails if the address is in use as a billing or shipping address on a
      * sales order, invoice, or shipment, or as a default account address.
      *
+     * This endpoint requires the permissions: `addresses:delete`, `customers:update`,
+     * `suppliers:update`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.delete(

package/resources/sales/addresses.js.map

@@ -1 +1 @@
-{"version":3,"file":"addresses.js","sourceRoot":"","sources":["../../src/resources/sales/addresses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,uBAAuB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AApFD,8BAoFC"}
+{"version":3,"file":"addresses.js","sourceRoot":"","sources":["../../src/resources/sales/addresses.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,SAAU,SAAQ,sBAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAA,WAAI,EAAA,uBAAuB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF;AAlHD,8BAkHC"}

package/resources/sales/addresses.mjs

@@ -8,6 +8,9 @@ export class Addresses extends APIResource {
     /**
      * Returns a paginated list of addresses.
      *
+     * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+     * `suppliers:read`.
+     *
      * @example
      * ```ts
      * const listAddress = await client.sales.addresses.list();
@@ -19,6 +22,9 @@ export class Addresses extends APIResource {
     /**
      * Retrieves an address by ID.
      *
+     * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+     * `suppliers:read`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.retrieve(
@@ -32,15 +38,22 @@ export class Addresses extends APIResource {
     /**
      * Creates an address.
      *
+     * This endpoint requires the permissions: `addresses:create`, `customers:update`,
+     * `suppliers:update`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.create({
      *   country: 'US',
      *   name: 'Headquarters',
+     *   email: 'warehouse@acme.com',
      *   locality: 'Springfield',
+     *   phone: '555-123-4567',
      *   postal_code: '62701',
      *   state: 'IL',
      *   street_line_1: '123 Main St',
+     *   street_line_2: 'Suite 400',
+     *   type: 'standard',
      * });
      * ```
      */
@@ -53,11 +66,25 @@ export class Addresses extends APIResource {
      * Changing a street, locality, state, postal code, or country field may replace
      * the address's geolocation, so the geolocation `id` in the response can change.
      *
+     * This endpoint requires the permissions: `addresses:update`, `customers:update`,
+     * `suppliers:update`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.update(
      *   'ad_012100950cfaa34aa0e0ad7258',
-     *   { name: 'Warehouse' },
+     *   {
+     *     country: 'US',
+     *     email: 'warehouse@acme.com',
+     *     locality: 'Springfield',
+     *     name: 'Warehouse',
+     *     phone: '555-123-4567',
+     *     postal_code: '62701',
+     *     state: 'IL',
+     *     street_line_1: '123 Main St',
+     *     street_line_2: 'Suite 400',
+     *     type: 'standard',
+     *   },
      * );
      * ```
      */
@@ -70,6 +97,9 @@ export class Addresses extends APIResource {
      * Deletion fails if the address is in use as a billing or shipping address on a
      * sales order, invoice, or shipment, or as a default account address.
      *
+     * This endpoint requires the permissions: `addresses:delete`, `customers:update`,
+     * `suppliers:update`.
+     *
      * @example
      * ```ts
      * const address = await client.sales.addresses.delete(

package/resources/sales/addresses.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"addresses.mjs","sourceRoot":"","sources":["../../src/resources/sales/addresses.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;OAOG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,uBAAuB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}
+{"version":3,"file":"addresses.mjs","sourceRoot":"","sources":["../../src/resources/sales/addresses.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAIf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,QAA8C,EAAE,EAAE,OAAwB;QAC7E,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,qBAAqB,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACpE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,MAAM,CAAC,IAAyB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,MAAM,CACJ,EAAU,EACV,OAA+C,EAAE,EACjD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,uBAAuB,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnF,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,uBAAuB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}

package/resources/sales/contacts/actions.d.mts

@@ -0,0 +1,120 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as BlocksAPI from "../../messaging/blocks.mjs";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.mjs";
+import { APIPromise } from "../../../core/api-promise.mjs";
+import { RequestOptions } from "../../../internal/request-options.mjs";
+/**
+ * Look up the people you do business with.
+ */
+export declare class Actions extends APIResource {
+    /**
+     * Finds the contacts that match an email address.
+     *
+     * Only people on accounts you have a relationship with are returned — your
+     * customers, your suppliers, or your own account. A match's `relationship` says
+     * how you relate to the account it belongs to. Several accounts can share an
+     * email, so this can return more than one match.
+     *
+     * This endpoint requires the permission: `customers:read`.
+     *
+     * @example
+     * ```ts
+     * const listContactMatch =
+     *   await client.sales.contacts.actions.findByEmail({
+     *     email: 'buyer@acme-co.example',
+     *   });
+     * ```
+     */
+    findByEmail(params: ActionFindByEmailParams, options?: RequestOptions): APIPromise<ListContactMatch>;
+}
+/**
+ * A contact found by email on an account you have a relationship with — one of
+ * your customers, your suppliers, or your own account.
+ *
+ * The same email can be a contact on many accounts across the platform; only
+ * accounts you relate to are returned. The matched person is available through
+ * `account_user` (and the shared profile through `account_user.user`), and the
+ * account they belong to through `account`.
+ */
+export interface ContactMatch {
+    /**
+     * Resource ID.
+     *
+     * This is the matched account user's ID, so the same value also appears as
+     * `account_user.id`.
+     */
+    id: string;
+    /**
+     * A customer account, including its branding and customer portal sub-resources.
+     */
+    account: APIKeysAPI.Account | null;
+    /**
+     * A user's membership in an account, carrying the account-specific status, role,
+     * and department.
+     *
+     * Profile fields (name, email, username, image URL) live on the expandable `user`
+     * sub-resource, which is shared across every account the user belongs to.
+     */
+    account_user: BlocksAPI.AccountUser | null;
+    /**
+     * The email address that was matched.
+     */
+    email: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'contact_match';
+    /**
+     * How you relate to the account this contact belongs to.
+     *
+     * - `customer` — the account is one of your customers.
+     * - `supplier` — the account is one of your suppliers.
+     * - `self` — the account is your own.
+     */
+    relationship: 'customer' | 'supplier' | 'self';
+}
+/**
+ * Request to find contacts by email.
+ */
+export interface FindContactByEmailRequest {
+    /**
+     * The email address to look up.
+     */
+    email: string;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListContactMatch {
+    /**
+     * Resources in this page.
+     */
+    data: Array<ContactMatch>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+export interface ActionFindByEmailParams {
+    /**
+     * Body param: The email address to look up.
+     */
+    email: string;
+    /**
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
+     */
+    include?: Array<'account_user' | 'account_user.user' | 'account_user.role' | 'account_user.department' | 'account'>;
+    /**
+     * Query param: Filter to contacts whose relationship to you is one of these.
+     */
+    relationships?: Array<'customer' | 'supplier' | 'self'>;
+}
+export declare namespace Actions {
+    export { type ContactMatch as ContactMatch, type FindContactByEmailRequest as FindContactByEmailRequest, type ListContactMatch as ListContactMatch, type ActionFindByEmailParams as ActionFindByEmailParams, };
+}
+//# sourceMappingURL=actions.d.mts.map

package/resources/sales/contacts/actions.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.mts","sourceRoot":"","sources":["../../../src/resources/sales/contacts/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAQrG;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;IAEnC;;;;;;OAMG;IACH,YAAY,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;;;;;OAMG;IACH,YAAY,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,cAAc,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,yBAAyB,GAAG,SAAS,CACnG,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC,CAAC;CACzD;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/sales/contacts/actions.d.ts

@@ -0,0 +1,120 @@
+import { APIResource } from "../../../core/resource.js";
+import * as BlocksAPI from "../../messaging/blocks.js";
+import * as APIKeysAPI from "../../auth/api-keys/api-keys.js";
+import { APIPromise } from "../../../core/api-promise.js";
+import { RequestOptions } from "../../../internal/request-options.js";
+/**
+ * Look up the people you do business with.
+ */
+export declare class Actions extends APIResource {
+    /**
+     * Finds the contacts that match an email address.
+     *
+     * Only people on accounts you have a relationship with are returned — your
+     * customers, your suppliers, or your own account. A match's `relationship` says
+     * how you relate to the account it belongs to. Several accounts can share an
+     * email, so this can return more than one match.
+     *
+     * This endpoint requires the permission: `customers:read`.
+     *
+     * @example
+     * ```ts
+     * const listContactMatch =
+     *   await client.sales.contacts.actions.findByEmail({
+     *     email: 'buyer@acme-co.example',
+     *   });
+     * ```
+     */
+    findByEmail(params: ActionFindByEmailParams, options?: RequestOptions): APIPromise<ListContactMatch>;
+}
+/**
+ * A contact found by email on an account you have a relationship with — one of
+ * your customers, your suppliers, or your own account.
+ *
+ * The same email can be a contact on many accounts across the platform; only
+ * accounts you relate to are returned. The matched person is available through
+ * `account_user` (and the shared profile through `account_user.user`), and the
+ * account they belong to through `account`.
+ */
+export interface ContactMatch {
+    /**
+     * Resource ID.
+     *
+     * This is the matched account user's ID, so the same value also appears as
+     * `account_user.id`.
+     */
+    id: string;
+    /**
+     * A customer account, including its branding and customer portal sub-resources.
+     */
+    account: APIKeysAPI.Account | null;
+    /**
+     * A user's membership in an account, carrying the account-specific status, role,
+     * and department.
+     *
+     * Profile fields (name, email, username, image URL) live on the expandable `user`
+     * sub-resource, which is shared across every account the user belongs to.
+     */
+    account_user: BlocksAPI.AccountUser | null;
+    /**
+     * The email address that was matched.
+     */
+    email: string;
+    /**
+     * Resource type identifier.
+     */
+    object: 'contact_match';
+    /**
+     * How you relate to the account this contact belongs to.
+     *
+     * - `customer` — the account is one of your customers.
+     * - `supplier` — the account is one of your suppliers.
+     * - `self` — the account is your own.
+     */
+    relationship: 'customer' | 'supplier' | 'self';
+}
+/**
+ * Request to find contacts by email.
+ */
+export interface FindContactByEmailRequest {
+    /**
+     * The email address to look up.
+     */
+    email: string;
+}
+/**
+ * List represents a paginated list of resources.
+ */
+export interface ListContactMatch {
+    /**
+     * Resources in this page.
+     */
+    data: Array<ContactMatch>;
+    /**
+     * Resource type identifier.
+     */
+    object: 'list';
+    /**
+     * PageInfo contains URL-based pagination metadata.
+     */
+    page_info: APIKeysAPI.PageInfo;
+}
+export interface ActionFindByEmailParams {
+    /**
+     * Body param: The email address to look up.
+     */
+    email: string;
+    /**
+     * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+     * are returned as `null`.
+     */
+    include?: Array<'account_user' | 'account_user.user' | 'account_user.role' | 'account_user.department' | 'account'>;
+    /**
+     * Query param: Filter to contacts whose relationship to you is one of these.
+     */
+    relationships?: Array<'customer' | 'supplier' | 'self'>;
+}
+export declare namespace Actions {
+    export { type ContactMatch as ContactMatch, type FindContactByEmailRequest as FindContactByEmailRequest, type ListContactMatch as ListContactMatch, type ActionFindByEmailParams as ActionFindByEmailParams, };
+}
+//# sourceMappingURL=actions.d.ts.map

package/resources/sales/contacts/actions.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/contacts/actions.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,SAAS;OACd,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,MAAM,EAAE,uBAAuB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,gBAAgB,CAAC;CAQrG;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,OAAO,EAAE,UAAU,CAAC,OAAO,GAAG,IAAI,CAAC;IAEnC;;;;;;OAMG;IACH,YAAY,EAAE,SAAS,CAAC,WAAW,GAAG,IAAI,CAAC;IAE3C;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,eAAe,CAAC;IAExB;;;;;;OAMG;IACH,YAAY,EAAE,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC;CAChD;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,CAAC;IAE1B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CACb,cAAc,GAAG,mBAAmB,GAAG,mBAAmB,GAAG,yBAAyB,GAAG,SAAS,CACnG,CAAC;IAEF;;OAEG;IACH,aAAa,CAAC,EAAE,KAAK,CAAC,UAAU,GAAG,UAAU,GAAG,MAAM,CAAC,CAAC;CACzD;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/sales/contacts/actions.js

@@ -0,0 +1,38 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Actions = void 0;
+const resource_1 = require("../../../core/resource.js");
+/**
+ * Look up the people you do business with.
+ */
+class Actions extends resource_1.APIResource {
+    /**
+     * Finds the contacts that match an email address.
+     *
+     * Only people on accounts you have a relationship with are returned — your
+     * customers, your suppliers, or your own account. A match's `relationship` says
+     * how you relate to the account it belongs to. Several accounts can share an
+     * email, so this can return more than one match.
+     *
+     * This endpoint requires the permission: `customers:read`.
+     *
+     * @example
+     * ```ts
+     * const listContactMatch =
+     *   await client.sales.contacts.actions.findByEmail({
+     *     email: 'buyer@acme-co.example',
+     *   });
+     * ```
+     */
+    findByEmail(params, options) {
+        const { include, relationships, ...body } = params;
+        return this._client.post('/v1/sales/contacts/actions/find-by-email', {
+            query: { include, relationships },
+            body,
+            ...options,
+        });
+    }
+}
+exports.Actions = Actions;
+//# sourceMappingURL=actions.js.map

package/resources/sales/contacts/actions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.js","sourceRoot":"","sources":["../../../src/resources/sales/contacts/actions.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wDAAqD;AAMrD;;GAEG;AACH,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,MAA+B,EAAE,OAAwB;QACnE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE;YACnE,KAAK,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE;YACjC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF;AA3BD,0BA2BC"}

package/resources/sales/contacts/actions.mjs

@@ -0,0 +1,34 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+/**
+ * Look up the people you do business with.
+ */
+export class Actions extends APIResource {
+    /**
+     * Finds the contacts that match an email address.
+     *
+     * Only people on accounts you have a relationship with are returned — your
+     * customers, your suppliers, or your own account. A match's `relationship` says
+     * how you relate to the account it belongs to. Several accounts can share an
+     * email, so this can return more than one match.
+     *
+     * This endpoint requires the permission: `customers:read`.
+     *
+     * @example
+     * ```ts
+     * const listContactMatch =
+     *   await client.sales.contacts.actions.findByEmail({
+     *     email: 'buyer@acme-co.example',
+     *   });
+     * ```
+     */
+    findByEmail(params, options) {
+        const { include, relationships, ...body } = params;
+        return this._client.post('/v1/sales/contacts/actions/find-by-email', {
+            query: { include, relationships },
+            body,
+            ...options,
+        });
+    }
+}
+//# sourceMappingURL=actions.mjs.map

package/resources/sales/contacts/actions.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"actions.mjs","sourceRoot":"","sources":["../../../src/resources/sales/contacts/actions.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAMtB;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;;;;;;;;OAiBG;IACH,WAAW,CAAC,MAA+B,EAAE,OAAwB;QACnE,MAAM,EAAE,OAAO,EAAE,aAAa,EAAE,GAAG,IAAI,EAAE,GAAG,MAAM,CAAC;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,0CAA0C,EAAE;YACnE,KAAK,EAAE,EAAE,OAAO,EAAE,aAAa,EAAE;YACjC,IAAI;YACJ,GAAG,OAAO;SACX,CAAC,CAAC;IACL,CAAC;CACF"}

package/resources/sales/contacts/contacts.d.mts

@@ -0,0 +1,10 @@
+import { APIResource } from "../../../core/resource.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { ActionFindByEmailParams, Actions, ContactMatch, FindContactByEmailRequest, ListContactMatch } from "./actions.mjs";
+export declare class Contacts extends APIResource {
+    actions: ActionsAPI.Actions;
+}
+export declare namespace Contacts {
+    export { Actions as Actions, type ContactMatch as ContactMatch, type FindContactByEmailRequest as FindContactByEmailRequest, type ListContactMatch as ListContactMatch, type ActionFindByEmailParams as ActionFindByEmailParams, };
+}
+//# sourceMappingURL=contacts.d.mts.map

package/resources/sales/contacts/contacts.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.d.mts","sourceRoot":"","sources":["../../../src/resources/sales/contacts/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,uBAAuB,EACvB,OAAO,EACP,YAAY,EACZ,yBAAyB,EACzB,gBAAgB,EACjB;AAED,qBAAa,QAAS,SAAQ,WAAW;IACvC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;CACpE;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/sales/contacts/contacts.d.ts

@@ -0,0 +1,10 @@
+import { APIResource } from "../../../core/resource.js";
+import * as ActionsAPI from "./actions.js";
+import { ActionFindByEmailParams, Actions, ContactMatch, FindContactByEmailRequest, ListContactMatch } from "./actions.js";
+export declare class Contacts extends APIResource {
+    actions: ActionsAPI.Actions;
+}
+export declare namespace Contacts {
+    export { Actions as Actions, type ContactMatch as ContactMatch, type FindContactByEmailRequest as FindContactByEmailRequest, type ListContactMatch as ListContactMatch, type ActionFindByEmailParams as ActionFindByEmailParams, };
+}
+//# sourceMappingURL=contacts.d.ts.map

package/resources/sales/contacts/contacts.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/contacts/contacts.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EACL,uBAAuB,EACvB,OAAO,EACP,YAAY,EACZ,yBAAyB,EACzB,gBAAgB,EACjB;AAED,qBAAa,QAAS,SAAQ,WAAW;IACvC,OAAO,EAAE,UAAU,CAAC,OAAO,CAAwC;CACpE;AAID,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,OAAO,IAAI,OAAO,EAClB,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/sales/contacts/contacts.js

@@ -0,0 +1,17 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contacts = void 0;
+const tslib_1 = require("../../../internal/tslib.js");
+const resource_1 = require("../../../core/resource.js");
+const ActionsAPI = tslib_1.__importStar(require("./actions.js"));
+const actions_1 = require("./actions.js");
+class Contacts extends resource_1.APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+}
+exports.Contacts = Contacts;
+Contacts.Actions = actions_1.Actions;
+//# sourceMappingURL=contacts.js.map

package/resources/sales/contacts/contacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../../src/resources/sales/contacts/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;;AAEtF,wDAAqD;AACrD,iEAAwC;AACxC,0CAMmB;AAEnB,MAAa,QAAS,SAAQ,sBAAW;IAAzC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAFD,4BAEC;AAED,QAAQ,CAAC,OAAO,GAAG,iBAAO,CAAC"}

package/resources/sales/contacts/contacts.mjs

@@ -0,0 +1,12 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../../../core/resource.mjs";
+import * as ActionsAPI from "./actions.mjs";
+import { Actions, } from "./actions.mjs";
+export class Contacts extends APIResource {
+    constructor() {
+        super(...arguments);
+        this.actions = new ActionsAPI.Actions(this._client);
+    }
+}
+Contacts.Actions = Actions;
+//# sourceMappingURL=contacts.mjs.map

package/resources/sales/contacts/contacts.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.mjs","sourceRoot":"","sources":["../../../src/resources/sales/contacts/contacts.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAEL,OAAO,GAIR;AAED,MAAM,OAAO,QAAS,SAAQ,WAAW;IAAzC;;QACE,YAAO,GAAuB,IAAI,UAAU,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrE,CAAC;CAAA;AAED,QAAQ,CAAC,OAAO,GAAG,OAAO,CAAC"}

package/resources/sales/contacts/index.d.mts

@@ -0,0 +1,3 @@
+export { Actions, type ContactMatch, type FindContactByEmailRequest, type ListContactMatch, type ActionFindByEmailParams, } from "./actions.mjs";
+export { Contacts } from "./contacts.mjs";
+//# sourceMappingURL=index.d.mts.map

package/resources/sales/contacts/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../../src/resources/sales/contacts/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,GAC7B;OACM,EAAE,QAAQ,EAAE"}

package/resources/sales/contacts/index.d.ts

@@ -0,0 +1,3 @@
+export { Actions, type ContactMatch, type FindContactByEmailRequest, type ListContactMatch, type ActionFindByEmailParams, } from "./actions.js";
+export { Contacts } from "./contacts.js";
+//# sourceMappingURL=index.d.ts.map

package/resources/sales/contacts/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/resources/sales/contacts/index.ts"],"names":[],"mappings":"OAEO,EACL,OAAO,EACP,KAAK,YAAY,EACjB,KAAK,yBAAyB,EAC9B,KAAK,gBAAgB,EACrB,KAAK,uBAAuB,GAC7B;OACM,EAAE,QAAQ,EAAE"}

package/resources/sales/contacts/index.js

@@ -0,0 +1,9 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Contacts = exports.Actions = void 0;
+var actions_1 = require("./actions.js");
+Object.defineProperty(exports, "Actions", { enumerable: true, get: function () { return actions_1.Actions; } });
+var contacts_1 = require("./contacts.js");
+Object.defineProperty(exports, "Contacts", { enumerable: true, get: function () { return contacts_1.Contacts; } });
+//# sourceMappingURL=index.js.map

package/resources/sales/contacts/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/resources/sales/contacts/index.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,wCAMmB;AALjB,kGAAA,OAAO,OAAA;AAMT,0CAAsC;AAA7B,oGAAA,QAAQ,OAAA"}

package/resources/sales/contacts/index.mjs

@@ -0,0 +1,4 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+export { Actions, } from "./actions.mjs";
+export { Contacts } from "./contacts.mjs";
+//# sourceMappingURL=index.mjs.map

package/resources/sales/contacts/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","sourceRoot":"","sources":["../../../src/resources/sales/contacts/index.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EACL,OAAO,GAKR;OACM,EAAE,QAAQ,EAAE"}

package/resources/sales/contacts.d.mts

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

package/resources/sales/contacts.d.mts.map

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

package/resources/sales/contacts.d.ts

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

package/resources/sales/contacts.d.ts.map

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

package/resources/sales/contacts.js

@@ -0,0 +1,6 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("../../internal/tslib.js");
+tslib_1.__exportStar(require("./contacts/index.js"), exports);
+//# sourceMappingURL=contacts.js.map

package/resources/sales/contacts.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contacts.js","sourceRoot":"","sources":["../../src/resources/sales/contacts.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,8DAAiC"}