@augno/sdk 0.1.9 → 0.7.1

package/resources/sales/addresses.d.ts

@@ -7,20 +7,23 @@ import { RequestOptions } from "../../internal/request-options.js";
  */
 export declare class Addresses extends APIResource {
     /**
-     * Creates an address for the targeted account.
+     * Returns a paginated list of addresses.
+     *
+     * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const address = await client.sales.addresses.create({
-     *   country: 'US',
-     *   name: 'Headquarters',
-     * });
+     * const listAddress = await client.sales.addresses.list();
      * ```
      */
-    create(body: AddressCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Address>;
+    list(query?: AddressListParams | null | undefined, options?: RequestOptions): APIPromise<ListAddress>;
     /**
      * 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(
@@ -30,28 +33,50 @@ export declare class Addresses extends APIResource {
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<APIKeysAPI.Address>;
     /**
-     * Partially updates an address.
+     * Creates an address.
+     *
+     * This endpoint requires the permissions: `addresses:create`, `customers:update`,
+     * `suppliers:update`.
      *
      * @example
      * ```ts
-     * const address = await client.sales.addresses.update(
-     *   'ad_012100950cfaa34aa0e0ad7258',
-     * );
+     * const address = await client.sales.addresses.create({
+     *   country: 'US',
+     *   name: 'Headquarters',
+     *   locality: 'Springfield',
+     *   postal_code: '62701',
+     *   state: 'IL',
+     *   street_line_1: '123 Main St',
+     * });
      * ```
      */
-    update(id: string, body?: AddressUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Address>;
+    create(body: AddressCreateParams, options?: RequestOptions): APIPromise<APIKeysAPI.Address>;
     /**
-     * Returns a paginated list of addresses.
+     * Partially updates an address.
+     *
+     * 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 listAddress = await client.sales.addresses.list();
+     * const address = await client.sales.addresses.update(
+     *   'ad_012100950cfaa34aa0e0ad7258',
+     *   { name: 'Warehouse' },
+     * );
      * ```
      */
-    list(query?: AddressListParams | null | undefined, options?: RequestOptions): APIPromise<ListAddress>;
+    update(id: string, body?: AddressUpdateParams | null | undefined, options?: RequestOptions): APIPromise<APIKeysAPI.Address>;
     /**
-     * Deletes an address. 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.
+     * Deletes an address.
+     *
+     * 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
@@ -63,7 +88,8 @@ export declare class Addresses extends APIResource {
     delete(id: string, options?: RequestOptions): APIPromise<AddressDeleteResponse>;
 }
 /**
- * Request to create an address.
+ * Address details used to create an address, either directly or inline on another
+ * resource.
  */
 export interface AddressInput {
     /**
@@ -103,7 +129,11 @@ export interface AddressInput {
      */
     street_line_2?: string;
     /**
-     * Address type.
+     * How the address is used.
+     *
+     * - `standard`: a normal shipping or billing address.
+     * - `drop_ship`: an address an order is shipped to directly, typically a third
+     *   party or end customer rather than the account itself.
      */
     type?: 'standard' | 'drop_ship';
 }
@@ -126,6 +156,8 @@ export interface ListAddress {
 }
 /**
  * Request to partially update an address.
+ *
+ * Omitted fields are left unchanged.
  */
 export interface UpdateAddressRequest {
     /**
@@ -134,6 +166,8 @@ export interface UpdateAddressRequest {
     country?: string;
     /**
      * Email address associated with the address.
+     *
+     * Send `null` to clear.
      */
     email?: string | null;
     /**
@@ -146,6 +180,8 @@ export interface UpdateAddressRequest {
     name?: string;
     /**
      * Phone number associated with the address.
+     *
+     * Send `null` to clear.
      */
     phone?: string | null;
     /**
@@ -162,15 +198,45 @@ export interface UpdateAddressRequest {
     street_line_1?: string;
     /**
      * Second line of the street address.
+     *
+     * Send `null` to clear.
      */
     street_line_2?: string | null;
     /**
-     * Address type.
+     * How the address is used.
+     *
+     * - `standard`: a normal shipping or billing address.
+     * - `drop_ship`: an address an order is shipped to directly, typically a third
+     *   party or end customer rather than the account itself.
      */
     type?: 'standard' | 'drop_ship';
 }
 export interface AddressDeleteResponse {
 }
+export interface AddressListParams {
+    /**
+     * Opaque cursor token identifying where the page of results starts.
+     *
+     * Use the `cursor` value embedded in a previous response's `next_page_url` or
+     * `previous_page_url` to fetch the adjacent page. Omit to start from the first
+     * page.
+     */
+    cursor?: string;
+    /**
+     * Maximum number of results to return in a single page.
+     */
+    limit?: number;
+    /**
+     * Free-text search term used to filter results.
+     *
+     * Which fields are matched against the term varies by endpoint.
+     */
+    q?: string;
+    /**
+     * Filter results to a single address type.
+     */
+    type?: 'standard' | 'drop_ship';
+}
 export interface AddressCreateParams {
     /**
      * Two-letter country code.
@@ -209,7 +275,11 @@ export interface AddressCreateParams {
      */
     street_line_2?: string;
     /**
-     * Address type.
+     * How the address is used.
+     *
+     * - `standard`: a normal shipping or billing address.
+     * - `drop_ship`: an address an order is shipped to directly, typically a third
+     *   party or end customer rather than the account itself.
      */
     type?: 'standard' | 'drop_ship';
 }
@@ -220,6 +290,8 @@ export interface AddressUpdateParams {
     country?: string;
     /**
      * Email address associated with the address.
+     *
+     * Send `null` to clear.
      */
     email?: string | null;
     /**
@@ -232,6 +304,8 @@ export interface AddressUpdateParams {
     name?: string;
     /**
      * Phone number associated with the address.
+     *
+     * Send `null` to clear.
      */
     phone?: string | null;
     /**
@@ -248,32 +322,20 @@ export interface AddressUpdateParams {
     street_line_1?: string;
     /**
      * Second line of the street address.
+     *
+     * Send `null` to clear.
      */
     street_line_2?: string | null;
     /**
-     * Address type.
-     */
-    type?: 'standard' | 'drop_ship';
-}
-export interface AddressListParams {
-    /**
-     * Cursor token used to retrieve the next or previous page of results.
-     */
-    cursor?: string;
-    /**
-     * Maximum number of results per page (default: 100, max: 1000).
-     */
-    limit?: number;
-    /**
-     * Search query used to filter results.
-     */
-    q?: string;
-    /**
-     * Filter by address type.
+     * How the address is used.
+     *
+     * - `standard`: a normal shipping or billing address.
+     * - `drop_ship`: an address an order is shipped to directly, typically a third
+     *   party or end customer rather than the account itself.
      */
     type?: 'standard' | 'drop_ship';
 }
 export declare namespace Addresses {
-    export { type AddressInput as AddressInput, type ListAddress as ListAddress, type UpdateAddressRequest as UpdateAddressRequest, type AddressDeleteResponse as AddressDeleteResponse, type AddressCreateParams as AddressCreateParams, type AddressUpdateParams as AddressUpdateParams, type AddressListParams as AddressListParams, };
+    export { type AddressInput as AddressInput, type ListAddress as ListAddress, type UpdateAddressRequest as UpdateAddressRequest, type AddressDeleteResponse as AddressDeleteResponse, type AddressListParams as AddressListParams, type AddressCreateParams as AddressCreateParams, type AddressUpdateParams as AddressUpdateParams, };
 }
 //# sourceMappingURL=addresses.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"addresses.d.ts","sourceRoot":"","sources":["../../src/resources/sales/addresses.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,+BAA4B;AAClD,OAAO,KAAK,UAAU,qCAAkC;AACxD,OAAO,EAAE,UAAU,EAAE,kCAA+B;AACpD,OAAO,EAAE,cAAc,EAAE,0CAAuC;AAGhE;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;IAI3F;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;IAI9E;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;IAIjC;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIzG;;;;;;;;;;OAUG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
+{"version":3,"file":"addresses.d.ts","sourceRoot":"","sources":["../../src/resources/sales/addresses.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;IACH,IAAI,CAAC,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,WAAW,CAAC;IAIzG;;;;;;;;;;;;OAYG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;IAI9E;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;IAI3F;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,mBAAmB,GAAG,IAAI,GAAG,SAAc,EACjD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,UAAU,CAAC,OAAO,CAAC;IAIjC;;;;;;;;;;;;;;;OAeG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;CAGhF;AAED;;;GAGG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;IAEhC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,qBAAqB;CAAG;AAEzC,MAAM,WAAW,iBAAiB;IAChC;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,CAAC,CAAC,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;OAIG;IACH,aAAa,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE9B;;;;;;OAMG;IACH,IAAI,CAAC,EAAE,UAAU,GAAG,WAAW,CAAC;CACjC;AAED,MAAM,CAAC,OAAO,WAAW,SAAS,CAAC;IACjC,OAAO,EACL,KAAK,YAAY,IAAI,YAAY,EACjC,KAAK,WAAW,IAAI,WAAW,EAC/B,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}

package/resources/sales/addresses.js

@@ -9,22 +9,25 @@ const path_1 = require("../../internal/utils/path.js");
  */
 class Addresses extends resource_1.APIResource {
     /**
-     * Creates an address for the targeted account.
+     * Returns a paginated list of addresses.
+     *
+     * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const address = await client.sales.addresses.create({
-     *   country: 'US',
-     *   name: 'Headquarters',
-     * });
+     * const listAddress = await client.sales.addresses.list();
      * ```
      */
-    create(body, options) {
-        return this._client.post('/v1/sales/addresses', { body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/sales/addresses', { query, ...options });
     }
     /**
      * 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(
@@ -36,32 +39,54 @@ class Addresses extends resource_1.APIResource {
         return this._client.get((0, path_1.path) `/v1/sales/addresses/${id}`, options);
     }
     /**
-     * Partially updates an address.
+     * Creates an address.
+     *
+     * This endpoint requires the permissions: `addresses:create`, `customers:update`,
+     * `suppliers:update`.
      *
      * @example
      * ```ts
-     * const address = await client.sales.addresses.update(
-     *   'ad_012100950cfaa34aa0e0ad7258',
-     * );
+     * const address = await client.sales.addresses.create({
+     *   country: 'US',
+     *   name: 'Headquarters',
+     *   locality: 'Springfield',
+     *   postal_code: '62701',
+     *   state: 'IL',
+     *   street_line_1: '123 Main St',
+     * });
      * ```
      */
-    update(id, body = {}, options) {
-        return this._client.patch((0, path_1.path) `/v1/sales/addresses/${id}`, { body, ...options });
+    create(body, options) {
+        return this._client.post('/v1/sales/addresses', { body, ...options });
     }
     /**
-     * Returns a paginated list of addresses.
+     * Partially updates an address.
+     *
+     * 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 listAddress = await client.sales.addresses.list();
+     * const address = await client.sales.addresses.update(
+     *   'ad_012100950cfaa34aa0e0ad7258',
+     *   { name: 'Warehouse' },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/sales/addresses', { query, ...options });
+    update(id, body = {}, options) {
+        return this._client.patch((0, path_1.path) `/v1/sales/addresses/${id}`, { body, ...options });
     }
     /**
-     * Deletes an address. 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.
+     * Deletes an address.
+     *
+     * 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

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;;;;;;;;;;OAUG;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;;;;;;;;;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;;;;;;;;;OASG;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;;;;;;;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;;;;;;;;;;OAUG;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;AA1ED,8BA0EC"}
+{"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;;;;;;;;;;;;;;;;;OAiBG;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;;;;;;;;;;;;;;;;OAgBG;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;AAnGD,8BAmGC"}

package/resources/sales/addresses.mjs

@@ -6,22 +6,25 @@ import { path } from "../../internal/utils/path.mjs";
  */
 export class Addresses extends APIResource {
     /**
-     * Creates an address for the targeted account.
+     * Returns a paginated list of addresses.
+     *
+     * This endpoint requires the permissions: `addresses:read`, `customers:read`,
+     * `suppliers:read`.
      *
      * @example
      * ```ts
-     * const address = await client.sales.addresses.create({
-     *   country: 'US',
-     *   name: 'Headquarters',
-     * });
+     * const listAddress = await client.sales.addresses.list();
      * ```
      */
-    create(body, options) {
-        return this._client.post('/v1/sales/addresses', { body, ...options });
+    list(query = {}, options) {
+        return this._client.get('/v1/sales/addresses', { query, ...options });
     }
     /**
      * 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(
@@ -33,32 +36,54 @@ export class Addresses extends APIResource {
         return this._client.get(path `/v1/sales/addresses/${id}`, options);
     }
     /**
-     * Partially updates an address.
+     * Creates an address.
+     *
+     * This endpoint requires the permissions: `addresses:create`, `customers:update`,
+     * `suppliers:update`.
      *
      * @example
      * ```ts
-     * const address = await client.sales.addresses.update(
-     *   'ad_012100950cfaa34aa0e0ad7258',
-     * );
+     * const address = await client.sales.addresses.create({
+     *   country: 'US',
+     *   name: 'Headquarters',
+     *   locality: 'Springfield',
+     *   postal_code: '62701',
+     *   state: 'IL',
+     *   street_line_1: '123 Main St',
+     * });
      * ```
      */
-    update(id, body = {}, options) {
-        return this._client.patch(path `/v1/sales/addresses/${id}`, { body, ...options });
+    create(body, options) {
+        return this._client.post('/v1/sales/addresses', { body, ...options });
     }
     /**
-     * Returns a paginated list of addresses.
+     * Partially updates an address.
+     *
+     * 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 listAddress = await client.sales.addresses.list();
+     * const address = await client.sales.addresses.update(
+     *   'ad_012100950cfaa34aa0e0ad7258',
+     *   { name: 'Warehouse' },
+     * );
      * ```
      */
-    list(query = {}, options) {
-        return this._client.get('/v1/sales/addresses', { query, ...options });
+    update(id, body = {}, options) {
+        return this._client.patch(path `/v1/sales/addresses/${id}`, { body, ...options });
     }
     /**
-     * Deletes an address. 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.
+     * Deletes an address.
+     *
+     * 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

package/resources/sales/addresses.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"addresses.mjs","sourceRoot":"","sources":["../../src/resources/sales/addresses.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,gCAA4B;AAIlD,OAAO,EAAE,IAAI,EAAE,sCAAkC;AAEjD;;GAEG;AACH,MAAM,OAAO,SAAU,SAAQ,WAAW;IACxC;;;;;;;;;;OAUG;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;;;;;;;;;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;;;;;;;;;OASG;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;;;;;;;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;;;;;;;;;;OAUG;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;;;;;;;;;;;;;;;;;OAiBG;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;;;;;;;;;;;;;;;;OAgBG;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"}