@augno/sdk 0.1.6 → 0.1.9

package/src/resources/identity/account-users/account-users.ts

@@ -22,10 +22,6 @@ export class AccountUsers extends APIResource {
    * ```ts
    * const accountUser =
    *   await client.identity.accountUsers.create({
-   *     email: 'jdoe@augno.com',
-   *     name: 'John Doe',
-   *     password: 'QgS7Z8Hhj3&1',
-   *     username: 'jdoe',
    *     preferences: [
    *       {
    *         notification_type: 'order_acknowledgement',
@@ -35,8 +31,11 @@ export class AccountUsers extends APIResource {
    *   });
    * ```
    */
-  create(params: AccountUserCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.AccountUser> {
-    const { include, ...body } = params;
+  create(
+    params: AccountUserCreateParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<CustomersAPI.AccountUser> {
+    const { include, ...body } = params ?? {};
     return this._client.post('/v1/identity/account-users', { query: { include }, body, ...options });
   }
 
@@ -67,7 +66,6 @@ export class AccountUsers extends APIResource {
    * const accountUser =
    *   await client.identity.accountUsers.update(
    *     'acus_01ea9983ddb41dacc44ecf997c',
-   *     { name: 'John Doe' },
    *   );
    * ```
    */
@@ -105,31 +103,26 @@ export class AccountUsers extends APIResource {
  * Request to create an account user.
  */
 export interface CreateAccountUserRequest {
+  /**
+   * Department assigned to the user.
+   */
+  department_id?: string;
+
   /**
    * User email address.
    */
-  email: string | null;
+  email?: string;
 
   /**
    * User display name.
    */
-  name: string | null;
+  name?: string;
 
   /**
    * Password. Only used for scanner-role users (scanning stations). Must be 8–72
    * chars and include upper, lower, number, and special character.
    */
-  password: string | null;
-
-  /**
-   * Unique username (3–255 chars; letters, numbers, underscores, hyphens).
-   */
-  username: string | null;
-
-  /**
-   * Department assigned to the user.
-   */
-  department_id?: string | null;
+  password?: string;
 
   /**
    * Notification preferences for the user (external targets only).
@@ -139,7 +132,12 @@ export interface CreateAccountUserRequest {
   /**
    * Role assigned to the user.
    */
-  role_id?: string | null;
+  role_id?: string;
+
+  /**
+   * Unique username (3–255 chars; letters, numbers, underscores, hyphens).
+   */
+  username?: string;
 }
 
 /**
@@ -214,37 +212,31 @@ export interface UpdateAccountUserRequest {
 
 export interface AccountUserCreateParams {
   /**
-   * Body param: User email address.
-   */
-  email: string | null;
-
-  /**
-   * Body param: User display name.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  name: string | null;
+  include?: Array<'role' | 'department'>;
 
   /**
-   * Body param: Password. Only used for scanner-role users (scanning stations). Must
-   * be 8–72 chars and include upper, lower, number, and special character.
+   * Body param: Department assigned to the user.
    */
-  password: string | null;
+  department_id?: string;
 
   /**
-   * Body param: Unique username (3–255 chars; letters, numbers, underscores,
-   * hyphens).
+   * Body param: User email address.
    */
-  username: string | null;
+  email?: string;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Body param: User display name.
    */
-  include?: Array<'role' | 'department'>;
+  name?: string;
 
   /**
-   * Body param: Department assigned to the user.
+   * Body param: Password. Only used for scanner-role users (scanning stations). Must
+   * be 8–72 chars and include upper, lower, number, and special character.
    */
-  department_id?: string | null;
+  password?: string;
 
   /**
    * Body param: Notification preferences for the user (external targets only).
@@ -254,7 +246,13 @@ export interface AccountUserCreateParams {
   /**
    * Body param: Role assigned to the user.
    */
-  role_id?: string | null;
+  role_id?: string;
+
+  /**
+   * Body param: Unique username (3–255 chars; letters, numbers, underscores,
+   * hyphens).
+   */
+  username?: string;
 }
 
 export interface AccountUserRetrieveParams {

package/src/resources/identity/roles.ts

@@ -57,10 +57,6 @@ export class Roles extends APIResource {
    * ```ts
    * const role = await client.identity.roles.update(
    *   'rl_01c16d2eb637c0d1f3a372937c',
-   *   {
-   *     name: 'Updated Manager',
-   *     permissions: ['customers:read', 'customers:update'],
-   *   },
    * );
    * ```
    */

package/src/resources/operations/carriers/carriers.ts

@@ -33,10 +33,7 @@ export class Carriers extends APIResource {
    * @example
    * ```ts
    * const carrier = await client.operations.carriers.create({
-   *   account_number: '1234567890',
-   *   code: 'fedex',
    *   name: 'FedEx',
-   *   customer_portal_visibility: 'visible',
    * });
    * ```
    */
@@ -70,7 +67,6 @@ export class Carriers extends APIResource {
    * ```ts
    * const carrier = await client.operations.carriers.update(
    *   'cr_01784fd54c9ba197bb4e42f0e6',
-   *   { name: 'FedEx Express' },
    * );
    * ```
    */
@@ -116,23 +112,26 @@ export class Carriers extends APIResource {
  */
 export interface CreateCarrierRequest {
   /**
-   * Carrier account number. Required for UPS and USPS carriers.
+   * Display name.
    */
-  account_number: string | null;
+  name: string;
 
   /**
-   * Carrier code.
+   * Carrier account number. Required for UPS and USPS carriers.
    */
-  code: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect' | null;
+  account_number?: string;
 
   /**
-   * Display name.
+   * Carrier code.
    */
-  name: string;
+  code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
 
   /**
-   * Whether this carrier will be available for customers to select in the customer
-   * portal.
+   * Carrier visibility in the customer portal.
+   *
+   * If `visible`, this carrier will be available for your customers to utilize when
+   * they go to checkout. If `hidden`, this carrier will not be an option on
+   * checkout.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 }
@@ -162,8 +161,11 @@ export interface ListCarrier {
  */
 export interface UpdateCarrierRequest {
   /**
-   * Whether this carrier will be available for customers to select in the customer
-   * portal.
+   * Carrier visibility in the customer portal.
+   *
+   * If `visible`, this carrier will be available for your customers to utilize when
+   * they go to checkout. If `hidden`, this carrier will not be an option on
+   * checkout.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 
@@ -177,29 +179,32 @@ export interface CarrierDeleteResponse {}
 
 export interface CarrierCreateParams {
   /**
-   * Body param: Carrier account number. Required for UPS and USPS carriers.
+   * Body param: Display name.
    */
-  account_number: string | null;
+  name: string;
 
   /**
-   * Body param: Carrier code.
+   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
+   * are returned as `null`.
    */
-  code: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect' | null;
+  include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 
   /**
-   * Body param: Display name.
+   * Body param: Carrier account number. Required for UPS and USPS carriers.
    */
-  name: string;
+  account_number?: string;
 
   /**
-   * Query param: Sub-objects to expand in the response. When omitted, sub-objects
-   * are returned as `null`.
+   * Body param: Carrier code.
    */
-  include?: Array<'owner' | 'owner.account' | 'service_levels'>;
+  code?: 'fedex' | 'ups' | 'usps' | 'will_call' | 'delivery' | 'ltl' | 'ltl1' | 'freight_collect';
 
   /**
-   * Body param: Whether this carrier will be available for customers to select in
-   * the customer portal.
+   * Body param: Carrier visibility in the customer portal.
+   *
+   * If `visible`, this carrier will be available for your customers to utilize when
+   * they go to checkout. If `hidden`, this carrier will not be an option on
+   * checkout.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 }
@@ -220,8 +225,11 @@ export interface CarrierUpdateParams {
   include?: Array<'owner' | 'owner.account' | 'service_levels'>;
 
   /**
-   * Body param: Whether this carrier will be available for customers to select in
-   * the customer portal.
+   * Body param: Carrier visibility in the customer portal.
+   *
+   * If `visible`, this carrier will be available for your customers to utilize when
+   * they go to checkout. If `hidden`, this carrier will not be an option on
+   * checkout.
    */
   customer_portal_visibility?: 'visible' | 'hidden';
 

package/src/resources/operations/carriers/service-levels.ts

@@ -71,10 +71,7 @@ export class ServiceLevels extends APIResource {
    * const serviceLevel =
    *   await client.operations.carriers.serviceLevels.update(
    *     'crop_01cfaf03f104e90ef9680e2a30',
-   *     {
-   *       carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6',
-   *       name: 'Express Shipping',
-   *     },
+   *     { carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6' },
    *   );
    * ```
    */

package/src/resources/operations/locations.ts

@@ -51,7 +51,6 @@ export class Locations extends APIResource {
    * ```ts
    * const location = await client.operations.locations.update(
    *   'lc_014d187d99b31926f0c74af9d8',
-   *   { name: 'Warehouse B' },
    * );
    * ```
    */
@@ -112,12 +111,12 @@ export interface CreateLocationRequest {
   /**
    * IDs of child locations to attach.
    */
-  child_ids?: Array<string> | null;
+  child_ids?: Array<string>;
 
   /**
    * Parent location ID. Null for top-level locations.
    */
-  parent_id?: string | null;
+  parent_id?: string;
 }
 
 /**
@@ -168,12 +167,12 @@ export interface LocationCreateParams {
   /**
    * Body param: IDs of child locations to attach.
    */
-  child_ids?: Array<string> | null;
+  child_ids?: Array<string>;
 
   /**
    * Body param: Parent location ID. Null for top-level locations.
    */
-  parent_id?: string | null;
+  parent_id?: string;
 }
 
 export interface LocationRetrieveParams {

package/src/resources/operations/scanning-stations.ts

@@ -21,8 +21,6 @@ export class ScanningStations extends APIResource {
    *     name: 'Packaging Line 1',
    *     operator_requirement: 'none',
    *     type: 'init_batch',
-   *     label_size: '1x1',
-   *     label_type: 'tag',
    *   });
    * ```
    */
@@ -61,7 +59,6 @@ export class ScanningStations extends APIResource {
    * const scanningStation =
    *   await client.operations.scanningStations.update(
    *     'scst_0129335dd6286056a97024fcc1',
-   *     { name: 'Station B' },
    *   );
    * ```
    */

package/src/resources/operations/shipping-terms.ts

@@ -57,7 +57,6 @@ export class ShippingTerms extends APIResource {
    * const shippingTerm =
    *   await client.operations.shippingTerms.update(
    *     'shtm_014341ab4bb5bf94d5b6936f86',
-   *     { name: 'Collect' },
    *   );
    * ```
    */
@@ -126,7 +125,7 @@ export interface CreateShippingTermRequest {
    * QuantityInput represents a value with an associated unit for create/update
    * requests.
    */
-  flat_rate?: CustomersAPI.QuantityInput | null;
+  flat_rate?: CustomersAPI.QuantityInput;
 
   /**
    * Service level IDs that qualify for free shipping.
@@ -137,7 +136,7 @@ export interface CreateShippingTermRequest {
    * QuantityInput represents a value with an associated unit for create/update
    * requests.
    */
-  minimum_order_value?: CustomersAPI.QuantityInput | null;
+  minimum_order_value?: CustomersAPI.QuantityInput;
 }
 
 /**
@@ -220,7 +219,7 @@ export interface ShippingTermCreateParams {
    * Body param: QuantityInput represents a value with an associated unit for
    * create/update requests.
    */
-  flat_rate?: CustomersAPI.QuantityInput | null;
+  flat_rate?: CustomersAPI.QuantityInput;
 
   /**
    * Body param: Service level IDs that qualify for free shipping.
@@ -231,7 +230,7 @@ export interface ShippingTermCreateParams {
    * Body param: QuantityInput represents a value with an associated unit for
    * create/update requests.
    */
-  minimum_order_value?: CustomersAPI.QuantityInput | null;
+  minimum_order_value?: CustomersAPI.QuantityInput;
 }
 
 export interface ShippingTermRetrieveParams {

package/src/resources/sales/account-groups.ts

@@ -49,7 +49,6 @@ export class AccountGroups extends APIResource {
    * const accountGroup =
    *   await client.sales.accountGroups.update(
    *     'acgp_018e88072d1320808dc979cfac',
-   *     { name: 'Updated Wholesale Customers' },
    *   );
    * ```
    */
@@ -105,6 +104,10 @@ export interface AccountGroup {
 
   /**
    * Commission policy.
+   *
+   * - `commission_exempt`: no commission applies.
+   * - `commission_applied`: commission applies; if the account group is within a
+   *   sales rep's territory, it will be assigned to that rep unless overridden.
    */
   commission_policy: 'commission_applied' | 'commission_exempt';
 
@@ -120,6 +123,10 @@ export interface AccountGroup {
 
   /**
    * Freight policy.
+   *
+   * - `free_freight`: customers within this group will not have to pay for freight.
+   * - `billed_freight`: freight will be applied to any order within this account
+   *   group, unless overridden elsewhere.
    */
   freight_policy: 'free_freight' | 'billed_freight';
 
@@ -136,11 +143,10 @@ export interface AccountGroup {
   /**
    * Account group type.
    *
-   * The type `pricing_group` indicates this account group is utilized for pricing
-   * rules. For example, you may have a 'Preferred' price group that receives a
-   * special discount rate. The type `type_group` indicates the account group is
-   * utilized to categorize a set of accounts. For example, you may have a group of
-   * accounts that are 'Consumers' or 'Distributors'.
+   * - `pricing_group`: used for pricing rules, such as a "Preferred" group that
+   *   receives a special discount.
+   * - `type_group`: used to categorize accounts, such as "Consumers" or
+   *   "Distributors".
    */
   type: 'pricing_group' | 'type_group';
 
@@ -161,11 +167,22 @@ export interface CreateAccountGroupRequest {
 
   /**
    * Account group type.
+   *
+   * Cannot be changed after creation.
+   *
+   * - `pricing_group`: used for pricing rules, such as a "Preferred" group that
+   *   receives a special discount.
+   * - `type_group`: used to categorize accounts, such as "Consumers" or
+   *   "Distributors".
    */
   type: 'pricing_group' | 'type_group';
 
   /**
-   * Commission policy.
+   * Commission policy. Defaults to `commission_exempt`.
+   *
+   * - `commission_exempt`: no commission applies.
+   * - `commission_applied`: commission applies; if the account group is within a
+   *   sales rep's territory, it will be assigned to that rep unless overridden.
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
@@ -175,7 +192,11 @@ export interface CreateAccountGroupRequest {
   description?: string;
 
   /**
-   * Freight policy.
+   * Freight policy. Defaults to `billed_freight`.
+   *
+   * - `free_freight`: customers within this group will not have to pay for freight.
+   * - `billed_freight`: freight will be applied to any order within this account
+   *   group, unless overridden elsewhere.
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 }
@@ -206,6 +227,10 @@ export interface ListAccountGroup {
 export interface UpdateAccountGroupRequest {
   /**
    * Commission policy.
+   *
+   * - `commission_exempt`: no commission applies.
+   * - `commission_applied`: commission applies; if the account group is within a
+   *   sales rep's territory, it will be assigned to that rep unless overridden.
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
@@ -216,6 +241,10 @@ export interface UpdateAccountGroupRequest {
 
   /**
    * Freight policy.
+   *
+   * - `free_freight`: customers within this group will not have to pay for freight.
+   * - `billed_freight`: freight will be applied to any order within this account
+   *   group, unless overridden elsewhere.
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 
@@ -235,11 +264,22 @@ export interface AccountGroupCreateParams {
 
   /**
    * Account group type.
+   *
+   * Cannot be changed after creation.
+   *
+   * - `pricing_group`: used for pricing rules, such as a "Preferred" group that
+   *   receives a special discount.
+   * - `type_group`: used to categorize accounts, such as "Consumers" or
+   *   "Distributors".
    */
   type: 'pricing_group' | 'type_group';
 
   /**
-   * Commission policy.
+   * Commission policy. Defaults to `commission_exempt`.
+   *
+   * - `commission_exempt`: no commission applies.
+   * - `commission_applied`: commission applies; if the account group is within a
+   *   sales rep's territory, it will be assigned to that rep unless overridden.
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
@@ -249,7 +289,11 @@ export interface AccountGroupCreateParams {
   description?: string;
 
   /**
-   * Freight policy.
+   * Freight policy. Defaults to `billed_freight`.
+   *
+   * - `free_freight`: customers within this group will not have to pay for freight.
+   * - `billed_freight`: freight will be applied to any order within this account
+   *   group, unless overridden elsewhere.
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 }
@@ -257,6 +301,10 @@ export interface AccountGroupCreateParams {
 export interface AccountGroupUpdateParams {
   /**
    * Commission policy.
+   *
+   * - `commission_exempt`: no commission applies.
+   * - `commission_applied`: commission applies; if the account group is within a
+   *   sales rep's territory, it will be assigned to that rep unless overridden.
    */
   commission_policy?: 'commission_applied' | 'commission_exempt';
 
@@ -267,6 +315,10 @@ export interface AccountGroupUpdateParams {
 
   /**
    * Freight policy.
+   *
+   * - `free_freight`: customers within this group will not have to pay for freight.
+   * - `billed_freight`: freight will be applied to any order within this account
+   *   group, unless overridden elsewhere.
    */
   freight_policy?: 'free_freight' | 'billed_freight';
 

package/src/resources/sales/addresses.ts

@@ -46,7 +46,6 @@ export class Addresses extends APIResource {
    * ```ts
    * const address = await client.sales.addresses.update(
    *   'ad_012100950cfaa34aa0e0ad7258',
-   *   { name: 'Warehouse' },
    * );
    * ```
    */
@@ -103,37 +102,37 @@ export interface AddressInput {
   /**
    * Email address associated with the address.
    */
-  email?: string | null;
+  email?: string;
 
   /**
    * City or locality.
    */
-  locality?: string | null;
+  locality?: string;
 
   /**
    * Phone number associated with the address.
    */
-  phone?: string | null;
+  phone?: string;
 
   /**
    * Postal or ZIP code.
    */
-  postal_code?: string | null;
+  postal_code?: string;
 
   /**
    * State or administrative area.
    */
-  state?: string | null;
+  state?: string;
 
   /**
    * First line of the street address.
    */
-  street_line_1?: string | null;
+  street_line_1?: string;
 
   /**
    * Second line of the street address.
    */
-  street_line_2?: string | null;
+  street_line_2?: string;
 
   /**
    * Address type.
@@ -232,37 +231,37 @@ export interface AddressCreateParams {
   /**
    * Email address associated with the address.
    */
-  email?: string | null;
+  email?: string;
 
   /**
    * City or locality.
    */
-  locality?: string | null;
+  locality?: string;
 
   /**
    * Phone number associated with the address.
    */
-  phone?: string | null;
+  phone?: string;
 
   /**
    * Postal or ZIP code.
    */
-  postal_code?: string | null;
+  postal_code?: string;
 
   /**
    * State or administrative area.
    */
-  state?: string | null;
+  state?: string;
 
   /**
    * First line of the street address.
    */
-  street_line_1?: string | null;
+  street_line_1?: string;
 
   /**
    * Second line of the street address.
    */
-  street_line_2?: string | null;
+  street_line_2?: string;
 
   /**
    * Address type.

package/src/resources/sales/customers/customers.ts

@@ -34,7 +34,6 @@ export class Customers extends APIResource {
    *     'shtm_014341ab4bb5bf94d5b6936f86',
    *   name: 'Acme Inc.',
    *   ship_to_address: { name: 'Acme Inc.', country: 'US' },
-   *   note: 'Key enterprise account',
    * });
    * ```
    */
@@ -69,11 +68,6 @@ export class Customers extends APIResource {
    * ```ts
    * const customer = await client.sales.customers.update(
    *   'ac_0170df1ac58e4d24c66fc89f5f',
-   *   {
-   *     default_carrier_id: 'cr_01784fd54c9ba197bb4e42f0e6',
-   *     freight_policy: 'billed_freight',
-   *     name: 'Acme Corp Updated',
-   *   },
    * );
    * ```
    */
@@ -176,6 +170,11 @@ export interface AccountUser {
    */
   updated_at: string;
 
+  /**
+   * Underlying user ID.
+   */
+  user_id: string;
+
   /**
    * Username.
    */