@augno/sdk 0.13.4 → 0.15.0

package/src/resources/core/jobs.ts

@@ -0,0 +1,321 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { path } from '../../internal/utils/path';
+
+/**
+ * View the jobs that track asynchronous work. Endpoints that answer 202 Accepted raise one and point at it with a Location header.
+ */
+export class Jobs extends APIResource {
+  /**
+   * Returns a job by ID — poll the job named in a `202 Accepted` response's
+   * `Location` to observe its outcome. A completed export carries the link to its
+   * file on `export.url`.
+   *
+   * @example
+   * ```ts
+   * const job = await client.core.jobs.retrieve(
+   *   'jb_01k0a5smf9ekb8rqg1',
+   * );
+   * ```
+   */
+  retrieve(id: string, options?: RequestOptions): APIPromise<Job> {
+    return this._client.get(path`/v1/core/jobs/${id}`, options);
+  }
+
+  /**
+   * Cancels a job and returns it carrying its `cancelled` status. Work in flight is
+   * not interrupted but can no longer settle, and a finished job cannot be
+   * cancelled.
+   *
+   * @example
+   * ```ts
+   * const job = await client.core.jobs.cancel(
+   *   'jb_01k0a5smf9ekb8rqg1',
+   * );
+   * ```
+   */
+  cancel(id: string, options?: RequestOptions): APIPromise<Job> {
+    return this._client.post(path`/v1/core/jobs/${id}/cancel`, options);
+  }
+}
+
+/**
+ * Records a piece of work the API accepted and carries out asynchronously.
+ * Endpoints answering `202 Accepted` point at one with a `Location` header; poll
+ * it for the outcome.
+ */
+export interface Job {
+  /**
+   * Job ID.
+   */
+  id: string;
+
+  /**
+   * When the job was cancelled.
+   */
+  cancelled_at: string | null;
+
+  /**
+   * When the job finished processing, whether or not every row succeeded.
+   */
+  completed_at: string | null;
+
+  /**
+   * When the job was created.
+   */
+  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.
+   */
+  created_by_name: string | 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`.
+   */
+  errors: Array<RowError>;
+
+  /**
+   * Points a completed export job at the file it produced.
+   */
+  export: JobExport | null;
+
+  /**
+   * When the most recent attempt failed. A retry that succeeds leaves this alongside
+   * `completed_at`.
+   */
+  failed_at: string | null;
+
+  /**
+   * Resource type identifier.
+   */
+  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>;
+
+  /**
+   * When the job began executing.
+   */
+  started_at: string | null;
+
+  /**
+   * How far the job has got. `completed` means the work was processed, not that
+   * every row succeeded — read `errors`.
+   */
+  status: 'created' | 'started' | 'completed' | 'failed' | 'cancelled';
+
+  /**
+   * The kind of work the job carries out.
+   */
+  type: 'bulkcreate' | 'bulkupsert' | 'export';
+
+  /**
+   * When the job was last updated.
+   */
+  updated_at: string;
+}
+
+/**
+ * Points a completed export job at the file it produced.
+ */
+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.
+   */
+  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.
+ */
+export interface JobResult {
+  /**
+   * ID of the resource this row produced.
+   */
+  id: string;
+
+  /**
+   * Whether the resource was created or updated.
+   */
+  action: 'created' | 'updated';
+
+  /**
+   * Zero-based row of the request this result names.
+   */
+  index: number;
+
+  /**
+   * 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.
+   */
+  sub_resource_ids?: Array<string>;
+}
+
+/**
+ * QuotaInfo provides machine-readable details about a plan-imposed resource limit.
+ * Included in limit_exceeded errors so clients can display upgrade prompts, usage
+ * bars, or implement programmatic retry/backoff logic.
+ */
+export interface QuotaInfo {
+  /**
+   * Limit is the maximum number of resources allowed by the current plan.
+   */
+  limit: number;
+
+  /**
+   * ResetAt is the time when the quota resets, if applicable. Nil for static
+   * (non-metered) limits.
+   */
+  reset_at: string | null;
+
+  /**
+   * Used is the number of resources currently consumed.
+   */
+  used: number;
+}
+
+/**
+ * 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.
+ */
+export interface ResponseError {
+  /**
+   * A machine-readable code for the error.
+   */
+  code:
+    | 'expired_token'
+    | 'api_key_expired'
+    | 'api_key_revoked'
+    | 'invalid_credentials'
+    | 'insufficient_permissions'
+    | 'payment_required'
+    | 'agent_spending_cap_reached'
+    | 'validation_failed'
+    | 'missing_field'
+    | 'invalid_format'
+    | 'method_not_allowed'
+    | 'resource_not_found'
+    | 'resource_exists'
+    | 'resource_conflict'
+    | 'resource_gone'
+    | 'idempotency_in_progress'
+    | 'limit_exceeded'
+    | 'registration_closed'
+    | 'rate_limit_exceeded'
+    | 'parameter_missing'
+    | 'parameter_invalid'
+    | 'parameter_unknown'
+    | 'parameters_exclusive'
+    | 'internal_error'
+    | 'service_unavailable'
+    | 'external_service_error'
+    | 'timeout'
+    | 'connection_error'
+    | 'request_timeout'
+    | 'client_closed_request'
+    | 'api_version_required'
+    | 'api_version_invalid'
+    | 'api_version_too_old';
+
+  /**
+   * A URL to documentation about the error.
+   */
+  doc_url: string | null;
+
+  /**
+   * Whether this error is transient and the request can be retried.
+   */
+  is_transient: boolean;
+
+  /**
+   * A human-readable message providing more details about the error.
+   */
+  message: string;
+
+  /**
+   * The parameter that caused the error, if applicable.
+   */
+  param: string | null;
+
+  /**
+   * QuotaInfo provides machine-readable details about a plan-imposed resource limit.
+   * Included in limit_exceeded errors so clients can display upgrade prompts, usage
+   * bars, or implement programmatic retry/backoff logic.
+   */
+  quota: QuotaInfo | null;
+
+  /**
+   * RequestLogURL is a link to the dashboard page for this request's log entry. Nil
+   * when no request log is available.
+   */
+  request_log_url: string | null;
+
+  /**
+   * The type of error.
+   */
+  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 {
+  /**
+   * 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.
+   */
+  error: ResponseError;
+
+  /**
+   * Zero-based row of the request this failure names. Absent for a failure of the
+   * whole request.
+   */
+  index?: number;
+}
+
+export declare namespace Jobs {
+  export {
+    type Job as Job,
+    type JobExport as JobExport,
+    type JobResult as JobResult,
+    type QuotaInfo as QuotaInfo,
+    type ResponseError as ResponseError,
+    type RowError as RowError,
+  };
+}

package/src/resources/messaging/conversations/conversations.ts

@@ -574,7 +574,16 @@ export interface CreateConversationRequest {
     | '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'
+    | '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'
@@ -647,6 +656,7 @@ export interface CreateConversationRequest {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -740,7 +750,8 @@ export interface CreateConversationRequest {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 }
 
 /**
@@ -1404,7 +1415,16 @@ export interface ConversationCreateParams {
     | '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'
+    | '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'
@@ -1477,6 +1497,7 @@ export interface ConversationCreateParams {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -1570,7 +1591,8 @@ export interface ConversationCreateParams {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 }
 
 export interface ConversationListParams {
@@ -1763,7 +1785,16 @@ export interface ConversationListParams {
     | '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'
+    | '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'
@@ -1836,6 +1867,7 @@ export interface ConversationListParams {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -1929,7 +1961,8 @@ export interface ConversationListParams {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 
   /**
    * Filter by conversation type.

package/src/resources/messaging/conversations/links.ts

@@ -208,7 +208,16 @@ export interface AddConversationLinkRequest {
     | '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'
+    | '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'
@@ -281,6 +290,7 @@ export interface AddConversationLinkRequest {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -374,7 +384,8 @@ export interface AddConversationLinkRequest {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 }
 
 /**
@@ -561,7 +572,16 @@ export interface LinkCreateParams {
     | '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'
+    | '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'
@@ -634,6 +654,7 @@ export interface LinkCreateParams {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -727,7 +748,8 @@ export interface LinkCreateParams {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 
   /**
    * Query param: Sub-objects to expand in the response. When omitted, sub-objects

package/src/resources/messaging/conversations/messages.ts

@@ -359,7 +359,16 @@ export interface SendMessageRequest {
     | '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'
+    | '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'
@@ -432,6 +441,7 @@ export interface SendMessageRequest {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -525,7 +535,8 @@ export interface SendMessageRequest {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 
   /**
    * Account user ids explicitly @mentioned in the message.
@@ -775,7 +786,16 @@ export interface MessageCreateParams {
     | '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'
+    | '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'
@@ -848,6 +868,7 @@ export interface MessageCreateParams {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -941,7 +962,8 @@ export interface MessageCreateParams {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 
   /**
    * Body param: Account user ids explicitly @mentioned in the message.

package/src/resources/messaging/notifications/notifications.ts

@@ -589,7 +589,16 @@ export interface SendNotificationRequest {
     | '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'
+    | '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'
@@ -662,6 +671,7 @@ export interface SendNotificationRequest {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -755,7 +765,8 @@ export interface SendNotificationRequest {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 
   /**
    * How prominently the notification should be surfaced, from `low` through
@@ -918,7 +929,16 @@ export interface NotificationCreateParams {
     | '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'
+    | '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'
@@ -991,6 +1011,7 @@ export interface NotificationCreateParams {
     | 'customer_contact_info'
     | 'customer_freight_preferences'
     | 'customer_defaults'
+    | 'customer_lead_time'
     | 'customer_notification_preferences'
     | 'order_notification_recipient'
     | 'order_discount'
@@ -1084,7 +1105,8 @@ export interface NotificationCreateParams {
     | 'pack_list_party'
     | 'pack_list_line_item'
     | 'pack_list_back_order'
-    | 'pack_list_case';
+    | 'pack_list_case'
+    | 'job';
 
   /**
    * How prominently the notification should be surfaced, from `low` through

package/src/resources/operations/demand-overrides.ts

@@ -1,10 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
 import { APIResource } from '../../core/resource';
-import * as UnitsAPI from '../catalog/units';
 import * as CoreAPI from '../core/core';
 import * as RequestLogsAPI from '../core/request-logs';
 import * as APIKeysAPI from '../auth/api-keys/api-keys';
+import * as UnitsAPI from '../catalog/units/units';
 import { APIPromise } from '../../core/api-promise';
 import { RequestOptions } from '../../internal/request-options';
 import { path } from '../../internal/utils/path';