@augno/sdk 0.16.1 → 0.18.0

package/src/resources/core/jobs.ts

@@ -1,6 +1,9 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
+import * as CoreAPI from './core';
+import * as RequestLogsAPI from './request-logs';
+import * as APIKeysAPI from '../auth/api-keys/api-keys';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -14,15 +17,22 @@ export class Jobs extends APIResource {
    * `Location` to observe its outcome. A completed export carries the link to its
    * file on `export.url`.
    *
+   * This endpoint requires the permissions: `jobs:read`, `customers:read`,
+   * `suppliers:read`.
+   *
    * @example
    * ```ts
    * const job = await client.core.jobs.retrieve(
-   *   'jb_01k0a5smf9ekb8rqg1',
+   *   'jb_grz7cdpnz8jr',
    * );
    * ```
    */
-  retrieve(id: string, options?: RequestOptions): APIPromise<Job> {
-    return this._client.get(path`/v1/core/jobs/${id}`, options);
+  retrieve(
+    id: string,
+    query: JobRetrieveParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Job> {
+    return this._client.get(path`/v1/core/jobs/${id}`, { query, ...options });
   }
 
   /**
@@ -30,15 +40,22 @@ export class Jobs extends APIResource {
    * not interrupted but can no longer settle, and a finished job cannot be
    * cancelled.
    *
+   * This endpoint requires the permission: `jobs:delete`.
+   *
    * @example
    * ```ts
    * const job = await client.core.jobs.cancel(
-   *   'jb_01k0a5smf9ekb8rqg1',
+   *   'jb_grz7cdpnz8jr',
    * );
    * ```
    */
-  cancel(id: string, options?: RequestOptions): APIPromise<Job> {
-    return this._client.post(path`/v1/core/jobs/${id}/cancel`, options);
+  cancel(
+    id: string,
+    params: JobCancelParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<Job> {
+    const { include } = params ?? {};
+    return this._client.post(path`/v1/core/jobs/${id}/cancel`, { query: { include }, ...options });
   }
 }
 
@@ -69,35 +86,17 @@ export interface Job {
   created_at: string;
 
   /**
-   * Email of the account user who requested the work.
-   */
-  created_by_email: string | null;
-
-  /**
-   * The ID of the account user who requested the work.
-   */
-  created_by_id: string | null;
-
-  /**
-   * Name of the account user who requested the work.
+   * Reference to an actor — the user, API key, agent, or group identity associated
+   * with an action.
    */
-  created_by_name: string | null;
+  created_by: RequestLogsAPI.Actor | null;
 
   /**
-   * Username of the account user who requested the work.
-   */
-  created_by_username: string | null;
-
-  /**
-   * A one-line reason the last attempt failed.
-   */
-  error_summary: string | null;
-
-  /**
-   * One entry per failure, so a `completed` job can still carry failed rows. A
-   * whole-job failure records a single entry with no `index`.
+   * ResponseError is the JSON-serializable error body returned to API clients. It
+   * contains only public information. This struct is used by the OpenAPI schema
+   * generator to produce documentation.
    */
-  errors: Array<RowError>;
+  error: ResponseError | null;
 
   /**
    * Points a completed export job at the file it produced.
@@ -116,11 +115,318 @@ export interface Job {
   object: 'job';
 
   /**
-   * One entry per request row that produced a resource. A bulk create records these
-   * when it accepts the request, so they stay provisional until `status` is
-   * `completed`.
-   */
-  results: Array<JobResult>;
+   * The kind of resource the job operates on, as an object-type value (e.g.
+   * `product`).
+   *
+   * `type` names the verb — what the job does — and this names the subject, so a job
+   * that produced no results still says what it was for.
+   */
+  resource_type:
+    | 'account'
+    | 'actor'
+    | 'entity'
+    | 'record'
+    | 'freight'
+    | 'sales_order_totals'
+    | 'sales_order_stage_total'
+    | 'sales_order_related'
+    | 'order_contact'
+    | 'user'
+    | 'address'
+    | 'api_key'
+    | 'created_api_key'
+    | 'refresh_token'
+    | 'list'
+    | 'sandbox'
+    | 'registration_session'
+    | 'pricing_plan'
+    | 'account_plan'
+    | 'plan_change'
+    | 'enterprise_inquiry'
+    | 'request_log'
+    | 'audit_event'
+    | 'audit_field_change'
+    | 'role'
+    | 'unit'
+    | 'account_affiliation'
+    | 'agent_definition'
+    | 'available_tool'
+    | 'agent_definition_tool'
+    | 'agent_account_status'
+    | 'agent_run'
+    | 'agent_action'
+    | 'agent_run_step'
+    | 'agent_token_usage'
+    | 'agent_memory'
+    | 'notification'
+    | 'notification_unread_count'
+    | 'notification_send_result'
+    | 'notification_unread_summary'
+    | 'announcement'
+    | 'conversation'
+    | 'support_case'
+    | 'conversation_participant'
+    | 'read_cursor'
+    | 'chat_message'
+    | 'notification_unread_summary_account'
+    | 'messaging_block'
+    | 'notification_preference'
+    | 'message_attachment'
+    | 'attachment_upload_target'
+    | 'scheduled_message'
+    | 'messaging_contact'
+    | 'message_report'
+    | 'tool_group'
+    | 'model'
+    | 'payment_term'
+    | 'shipping_term'
+    | 'quantity'
+    | 'account_group'
+    | 'support_route'
+    | 'support_availability'
+    | 'account_status'
+    | 'geolocation'
+    | 'account_user'
+    | 'department'
+    | 'account_integration'
+    | 'account_price'
+    | 'product_line'
+    | 'item_category'
+    | 'attribute'
+    | 'rate'
+    | 'account_group_product_line_access'
+    | 'sales_target'
+    | 'adjustment_type'
+    | 'account_branding'
+    | 'account_portal'
+    | 'account_logo_url'
+    | 'account_favicon_url'
+    | 'public_account'
+    | 'property'
+    | 'carrier'
+    | 'service_level'
+    | 'item'
+    | 'item_lot_default'
+    | 'item_inventory'
+    | 'product'
+    | 'batch'
+    | 'batch_flow_node'
+    | 'scanning_consumption'
+    | 'open_batch_summary'
+    | 'scanning_production_step_info'
+    | 'scanning_station'
+    | 'production_step'
+    | 'production_run'
+    | 'machine'
+    | 'machine_status'
+    | 'machine_downtime_event'
+    | 'demand_override'
+    | 'demand_override_type'
+    | 'machine_downtime_reason'
+    | 'production_schedule_preview'
+    | 'production_schedule_regenerate_preview'
+    | 'production_schedule'
+    | 'production_schedule_line'
+    | 'production_schedule_deviation'
+    | 'production_schedule_derived_line'
+    | 'production_schedule_settings'
+    | 'production_schedule_resource_setting'
+    | 'production_schedule_item_setting'
+    | 'fulfillment_recommendation'
+    | 'analyze_delivery_performance_response'
+    | 'delivery_performance'
+    | 'delivery_backlog_bucket'
+    | 'delivery_lateness_bucket'
+    | 'delivery_breakdown'
+    | 'schedule_order_coverage'
+    | 'schedule_order_coverage_line'
+    | 'promise_date_quote'
+    | 'schedule_deviation_type'
+    | 'schedule_at_risk_order'
+    | 'production_schedule_finished_policy'
+    | 'production_schedule_week_release'
+    | 'production_schedule_week_release_preview'
+    | 'production_schedule_item_policy'
+    | 'child_account'
+    | 'unit_group'
+    | 'unit_group_unit'
+    | 'consumption'
+    | 'customer_product_line_access'
+    | 'customer'
+    | 'frequently_ordered_product'
+    | 'priority'
+    | 'delivery'
+    | 'delivery_line'
+    | 'sales_order'
+    | 'location'
+    | 'location_type'
+    | 'lot'
+    | 'email_log'
+    | 'email_domain'
+    | 'email_inbox'
+    | 'portal_domain'
+    | 'dns_record'
+    | 'inventory_change_log'
+    | 'invoice'
+    | 'invoice_summary'
+    | 'invoice_line'
+    | 'invoice_allocation'
+    | 'invoice_for_payment'
+    | 'shipment'
+    | 'shipment_summary'
+    | 'shipment_line'
+    | 'shipping_case'
+    | 'shipping_case_label_url'
+    | 'settlement'
+    | 'settlement_summary'
+    | 'role_permission'
+    | 'registration_flow'
+    | 'registration_flow_option'
+    | 'transaction'
+    | 'transaction_summary'
+    | 'transaction_method'
+    | 'transaction_type'
+    | 'transaction_allocation'
+    | 'usage_item'
+    | 'account_usage_response'
+    | 'subscription_info'
+    | 'billing_portal_session_response'
+    | 'switch_plan_response'
+    | 'ensure_billing_customer_response'
+    | 'spending_cap_response'
+    | 'agent_spend_info'
+    | 'webhook_response'
+    | 'address_suggestion'
+    | 'address_components'
+    | 'address_details_result'
+    | 'validated_address'
+    | 'plan_limit'
+    | 'plan_change_proration'
+    | 'plan_change_line_item'
+    | 'setup_billing_response'
+    | 'confirm_payment_response'
+    | 'oauth_response'
+    | 'oauth_status_response'
+    | 'stripe_publishable_key'
+    | 'stripe_status'
+    | 'healthcheck'
+    | 'agent_definition_config'
+    | 'trigger_config'
+    | 'customer_contact_info'
+    | 'customer_freight_preferences'
+    | 'customer_defaults'
+    | 'customer_lead_time'
+    | 'customer_notification_preferences'
+    | 'order_notification_recipient'
+    | 'order_discount'
+    | 'sales_order_line'
+    | 'sales_order_type'
+    | 'sales_order_status'
+    | 'material'
+    | 'supplier_material'
+    | 'part'
+    | 'permission_group'
+    | 'permission'
+    | 'pick'
+    | 'pick_line'
+    | 'product_type'
+    | 'production'
+    | 'production_flow'
+    | 'map'
+    | 'purchase_order'
+    | 'purchase_order_line'
+    | 'supplier'
+    | 'supplier_summary'
+    | 'receivable_entry'
+    | 'receiving_order'
+    | 'receiving_order_line'
+    | 'email_contact'
+    | 'allocation_entry'
+    | 'open_credit_entry'
+    | 'volume_discount'
+    | 'volume_discount_tier'
+    | 'analyze_deliveries_response'
+    | 'analyze_manufacturing_response'
+    | 'analyze_manufacturing_batch_response'
+    | 'analyze_quarterly_orders_response'
+    | 'analyze_new_customers_response'
+    | 'analyze_demand_forecast_response'
+    | 'analyze_oee_response'
+    | 'analyze_oee_trend_response'
+    | 'analyze_schedule_attainment_response'
+    | 'catalog_product_line'
+    | 'catalog_category'
+    | 'catalog_product'
+    | 'catalog_property'
+    | 'catalog_attribute'
+    | 'dc_location'
+    | 'edi_run'
+    | 'inventory_item'
+    | 'analyze_weeks_of_sales_response'
+    | 'bulk_reconcile_items_response'
+    | 'sys_property'
+    | 'sys_property_type'
+    | 'sys_property_value'
+    | 'territory'
+    | 'tenancy'
+    | 'checkout_session'
+    | 'estimate_rate_result'
+    | 'rate_shop_option'
+    | 'rate_shop_result'
+    | 'owner'
+    | 'created_by'
+    | 'message'
+    | 'account_photo_upload_result'
+    | 'user_photo_upload_result'
+    | 'user_photo_url'
+    | 'batch_lot'
+    | 'check_duplicate_result'
+    | 'item_trend_point'
+    | 'pack_pick_response'
+    | 'pick_shipments_response'
+    | 'tenancy_pending_registration'
+    | 'invoice_allocation_entry'
+    | 'allocation_customer'
+    | 'checkout_sales_order'
+    | 'sales_order_price_quote'
+    | 'sales_order_freight_quote'
+    | 'sales_order_price_quote_line'
+    | 'hubspot_sync_job'
+    | 'hubspot_sync_report'
+    | 'hubspot_company_review'
+    | 'hubspot_company_candidate'
+    | 'hubspot_sync_record'
+    | 'contact_match'
+    | 'reply_draft'
+    | 'conversation_link'
+    | 'messaging_group'
+    | 'messaging_group_member'
+    | 'portal_profile'
+    | 'portal_registration_session'
+    | 'portal_registration_session_data'
+    | 'pack_list'
+    | 'pack_list_party'
+    | 'pack_list_line_item'
+    | 'pack_list_back_order'
+    | 'pack_list_case'
+    | 'job'
+    | 'job_result'
+    | 'job_export'
+    | 'analyze_customer_pricing_response'
+    | 'customer_pricing_finding'
+    | 'customer_pricing_summary'
+    | 'computed_rate'
+    | 'computed_quantity'
+    | 'analyze_realized_margins_response'
+    | 'realized_margin_finding'
+    | 'realized_margin_summary'
+    | null;
+
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  results: ListJobResult | null;
 
   /**
    * When the job began executing.
@@ -128,15 +434,17 @@ export interface Job {
   started_at: string | null;
 
   /**
-   * How far the job has got. `completed` means the work was processed, not that
-   * every row succeeded — read `errors`.
+   * How far the job has got.
+   *
+   * `completed` means the work was processed, not that every row succeeded — read
+   * each entry's own `status` in `results`.
    */
   status: 'created' | 'started' | 'completed' | 'failed' | 'cancelled';
 
   /**
    * The kind of work the job carries out.
    */
-  type: 'bulkcreate' | 'bulkupsert' | 'export';
+  type: 'bulk_create' | 'bulk_upsert' | 'export';
 
   /**
    * When the job was last updated.
@@ -149,39 +457,87 @@ export interface Job {
  */
 export interface JobExport {
   /**
-   * Presigned link to the file, valid for five minutes — read the job again for a
-   * fresh one. It carries its own authorization, so treat it as a credential: do not
-   * log it, store it, or pass it on.
+   * Resource type identifier.
+   */
+  object: 'job_export';
+
+  /**
+   * Presigned link to the file, valid for five minutes.
+   *
+   * If the link has expired, read the job again for a fresh one.
    */
   url: string;
 }
 
 /**
- * Accounts for one request row that produced a resource. With `errors`, also
- * row-indexed, every submitted row lands in exactly one of the two once the job
- * completes.
+ * Accounts for one row of the request: the resource it produced, or the error it
+ * was rejected with. Every submitted row lands in exactly one of these once the
+ * job completes.
  */
 export interface JobResult {
   /**
-   * ID of the resource this row produced.
+   * ResponseError is the JSON-serializable error body returned to API clients. It
+   * contains only public information. This struct is used by the OpenAPI schema
+   * generator to produce documentation.
    */
-  id: string;
+  error: ResponseError | null;
 
   /**
-   * Whether the resource was created or updated.
+   * Zero-based row of the request this result names.
    */
-  action: 'created' | 'updated';
+  index: number;
 
   /**
-   * Zero-based row of the request this result names.
+   * Resource type identifier.
    */
-  index: number;
+  object: 'job_result';
+
+  /**
+   * Entity is a polymorphic reference to any resource in the system.
+   */
+  resource: CoreAPI.Entity | null;
+
+  /**
+   * What became of the row.
+   *
+   * - `created`: the row produced a new resource.
+   * - `updated`: the row updated an existing resource.
+   * - `failed`: the row was rejected and wrote nothing.
+   */
+  status: 'created' | 'updated' | 'failed';
+
+  /**
+   * A single page of resources, together with the metadata needed to page through
+   * the rest of the result set.
+   */
+  sub_resources: CoreAPI.ListEntity | null;
+}
+
+/**
+ * A single page of resources, together with the metadata needed to page through
+ * the rest of the result set.
+ */
+export interface ListJobResult {
+  /**
+   * Resources in this page.
+   */
+  data: Array<JobResult>;
 
   /**
-   * Resources created alongside this row's own resource — for a bulk production run
-   * create, the ids of its batches. Omitted for operations that produce none.
+   * Resource type identifier.
    */
-  sub_resource_ids?: Array<string>;
+  object: 'list';
+
+  /**
+   * PageInfo describes where the current page sits within a paginated result set and
+   * how to move to the adjacent pages.
+   *
+   * Page a list by following the URLs below rather than assembling cursors yourself.
+   * For a top-level list endpoint the URL repeats the original request's query
+   * string with only the cursor swapped, so following it preserves the same filters,
+   * search term, and page size.
+   */
+  page_info: APIKeysAPI.PageInfo;
 }
 
 /**
@@ -290,23 +646,20 @@ export interface ResponseError {
   type: 'api_error' | 'idempotency_error' | 'invalid_request_error';
 }
 
-/**
- * pairs one row of a bulk request with the failure it produced; a failure of the
- * request as a whole carries no index
- */
-export interface RowError {
+export interface JobRetrieveParams {
   /**
-   * ResponseError is the JSON-serializable error body returned to API clients. It
-   * contains only public information. This struct is used by the OpenAPI schema
-   * generator to produce documentation.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  error: ResponseError;
+  include?: Array<'created_by' | 'created_by.role'>;
+}
 
+export interface JobCancelParams {
   /**
-   * Zero-based row of the request this failure names. Absent for a failure of the
-   * whole request.
+   * Sub-objects to expand in the response. When omitted, sub-objects are returned as
+   * `null`.
    */
-  index?: number;
+  include?: Array<'created_by' | 'created_by.role'>;
 }
 
 export declare namespace Jobs {
@@ -314,8 +667,10 @@ export declare namespace Jobs {
     type Job as Job,
     type JobExport as JobExport,
     type JobResult as JobResult,
+    type ListJobResult as ListJobResult,
     type QuotaInfo as QuotaInfo,
     type ResponseError as ResponseError,
-    type RowError as RowError,
+    type JobRetrieveParams as JobRetrieveParams,
+    type JobCancelParams as JobCancelParams,
   };
 }

package/src/resources/finance/payment-terms.ts

@@ -2,7 +2,7 @@
 
 import { APIResource } from '../../core/resource';
 import * as APIKeysAPI from '../auth/api-keys/api-keys';
-import * as CustomersAPI from '../sales/customers/customers';
+import * as AccountPricesAPI from '../sales/account-prices/account-prices';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';
@@ -52,7 +52,7 @@ export class PaymentTerms extends APIResource {
     id: string,
     query: PaymentTermRetrieveParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.PaymentTerm> {
+  ): APIPromise<AccountPricesAPI.PaymentTerm> {
     return this._client.get(path`/v1/finance/payment-terms/${id}`, { query, ...options });
   }
 
@@ -71,7 +71,10 @@ export class PaymentTerms extends APIResource {
    *   });
    * ```
    */
-  create(params: PaymentTermCreateParams, options?: RequestOptions): APIPromise<CustomersAPI.PaymentTerm> {
+  create(
+    params: PaymentTermCreateParams,
+    options?: RequestOptions,
+  ): APIPromise<AccountPricesAPI.PaymentTerm> {
     const { include, ...body } = params;
     return this._client.post('/v1/finance/payment-terms', { query: { include }, body, ...options });
   }
@@ -97,7 +100,7 @@ export class PaymentTerms extends APIResource {
     id: string,
     params: PaymentTermUpdateParams | null | undefined = {},
     options?: RequestOptions,
-  ): APIPromise<CustomersAPI.PaymentTerm> {
+  ): APIPromise<AccountPricesAPI.PaymentTerm> {
     const { include, ...body } = params ?? {};
     return this._client.patch(path`/v1/finance/payment-terms/${id}`, {
       query: { include },
@@ -148,7 +151,7 @@ export interface ListPaymentTerm {
   /**
    * Resources in this page.
    */
-  data: Array<CustomersAPI.PaymentTerm>;
+  data: Array<AccountPricesAPI.PaymentTerm>;
 
   /**
    * Resource type identifier.