@augno/sdk 0.16.1 → 0.18.0

package/resources/core/jobs.d.mts

@@ -1,4 +1,7 @@
 import { APIResource } from "../../core/resource.mjs";
+import * as CoreAPI from "./core.mjs";
+import * as RequestLogsAPI from "./request-logs.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";
 /**
@@ -10,27 +13,32 @@ export declare 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>;
+    retrieve(id: string, query?: JobRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Job>;
     /**
      * 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.
      *
+     * 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>;
+    cancel(id: string, params?: JobCancelParams | null | undefined, options?: RequestOptions): APIPromise<Job>;
 }
 /**
  * Records a piece of work the API accepted and carries out asynchronously.
@@ -55,30 +63,16 @@ 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.
+     * Reference to an actor — the user, API key, agent, or group identity associated
+     * with an action.
      */
-    created_by_id: string | null;
+    created_by: RequestLogsAPI.Actor | 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`.
+     * 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.
      */
@@ -93,24 +87,33 @@ 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`.
+     * 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: Array<JobResult>;
+    results: ListJobResult | null;
     /**
      * 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`.
+     * 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.
      */
@@ -121,35 +124,77 @@ 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.
-     */
-    id: string;
-    /**
-     * Whether the resource was created or updated.
+     * 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.
      */
-    action: 'created' | 'updated';
+    error: ResponseError | null;
     /**
      * 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.
+     * Resource type identifier.
+     */
+    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>;
+    /**
+     * Resource type identifier.
+     */
+    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.
      */
-    sub_resource_ids?: Array<string>;
+    page_info: APIKeysAPI.PageInfo;
 }
 /**
  * QuotaInfo provides machine-readable details about a plan-imposed resource limit.
@@ -213,24 +258,21 @@ 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 {
-    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, };
+    export { 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 JobRetrieveParams as JobRetrieveParams, type JobCancelParams as JobCancelParams, };
 }
 //# sourceMappingURL=jobs.d.mts.map

package/resources/core/jobs.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"jobs.d.mts","sourceRoot":"","sources":["../../src/resources/core/jobs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/D;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;CAG9D;AAED;;;;GAIG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAErE;;OAEG;IACH,IAAI,EAAE,YAAY,GAAG,YAAY,GAAG,QAAQ,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EACA,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,0BAA0B,GAC1B,kBAAkB,GAClB,4BAA4B,GAC5B,mBAAmB,GACnB,eAAe,GACf,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,yBAAyB,GACzB,gBAAgB,GAChB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,qBAAqB,GACrB,wBAAwB,GACxB,SAAS,GACT,kBAAkB,GAClB,iBAAiB,GACjB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,qBAAqB,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,mBAAmB,GAAG,uBAAuB,CAAC;CACnE;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,GAAG,IAAI,GAAG,EACf,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,QAAQ,IAAI,QAAQ,GAC1B,CAAC;CACH"}
+{"version":3,"file":"jobs.d.mts","sourceRoot":"","sources":["../../src/resources/core/jobs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,cAAc;OACnB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,GAAG,CAAC;IAIlB;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,GAAG,CAAC;CAInB;AAED;;;;GAIG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;;;OAMG;IACH,aAAa,EACT,SAAS,GACT,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,oBAAoB,GACpB,yBAAyB,GACzB,qBAAqB,GACrB,eAAe,GACf,MAAM,GACN,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,eAAe,GACf,MAAM,GACN,SAAS,GACT,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,oBAAoB,GACpB,MAAM,GACN,MAAM,GACN,qBAAqB,GACrB,kBAAkB,GAClB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,cAAc,GACd,cAAc,GACd,2BAA2B,GAC3B,0BAA0B,GAC1B,6BAA6B,GAC7B,cAAc,GACd,cAAc,GACd,cAAc,GACd,0BAA0B,GAC1B,aAAa,GACb,cAAc,GACd,qCAAqC,GACrC,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,GAChB,YAAY,GACZ,OAAO,GACP,cAAc,GACd,eAAe,GACf,UAAU,GACV,eAAe,GACf,eAAe,GACf,sBAAsB,GACtB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,YAAY,GACZ,qBAAqB,GACrB,eAAe,GACf,cAAc,GACd,eAAe,GACf,WAAW,GACX,MAAM,GACN,mCAAmC,GACnC,cAAc,GACd,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,qBAAqB,GACrB,gBAAgB,GAChB,UAAU,GACV,SAAS,GACT,eAAe,GACf,MAAM,GACN,kBAAkB,GAClB,gBAAgB,GAChB,SAAS,GACT,OAAO,GACP,iBAAiB,GACjB,sBAAsB,GACtB,oBAAoB,GACpB,+BAA+B,GAC/B,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,gBAAgB,GAChB,wBAAwB,GACxB,iBAAiB,GACjB,sBAAsB,GACtB,yBAAyB,GACzB,6BAA6B,GAC7B,wCAAwC,GACxC,qBAAqB,GACrB,0BAA0B,GAC1B,+BAA+B,GAC/B,kCAAkC,GAClC,8BAA8B,GAC9B,sCAAsC,GACtC,kCAAkC,GAClC,4BAA4B,GAC5B,uCAAuC,GACvC,sBAAsB,GACtB,yBAAyB,GACzB,0BAA0B,GAC1B,oBAAoB,GACpB,yBAAyB,GACzB,8BAA8B,GAC9B,oBAAoB,GACpB,yBAAyB,GACzB,wBAAwB,GACxB,qCAAqC,GACrC,kCAAkC,GAClC,0CAA0C,GAC1C,iCAAiC,GACjC,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,aAAa,GACb,8BAA8B,GAC9B,UAAU,GACV,4BAA4B,GAC5B,UAAU,GACV,UAAU,GACV,eAAe,GACf,aAAa,GACb,UAAU,GACV,eAAe,GACf,KAAK,GACL,WAAW,GACX,cAAc,GACd,aAAa,GACb,eAAe,GACf,YAAY,GACZ,sBAAsB,GACtB,SAAS,GACT,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,eAAe,GACf,yBAAyB,GACzB,YAAY,GACZ,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,0BAA0B,GAC1B,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,wBAAwB,GACxB,YAAY,GACZ,wBAAwB,GACxB,mBAAmB,GACnB,iCAAiC,GACjC,sBAAsB,GACtB,kCAAkC,GAClC,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,wBAAwB,GACxB,mBAAmB,GACnB,YAAY,GACZ,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,0BAA0B,GAC1B,gBAAgB,GAChB,uBAAuB,GACvB,wBAAwB,GACxB,eAAe,GACf,aAAa,GACb,yBAAyB,GACzB,gBAAgB,GAChB,uBAAuB,GACvB,8BAA8B,GAC9B,mBAAmB,GACnB,oBAAoB,GACpB,mCAAmC,GACnC,8BAA8B,GAC9B,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,UAAU,GACV,mBAAmB,GACnB,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,MAAM,GACN,WAAW,GACX,cAAc,GACd,YAAY,GACZ,iBAAiB,GACjB,KAAK,GACL,gBAAgB,GAChB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,sBAAsB,GACtB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,sBAAsB,GACtB,6BAA6B,GAC7B,gCAAgC,GAChC,sCAAsC,GACtC,mCAAmC,GACnC,gCAAgC,GAChC,kCAAkC,GAClC,sBAAsB,GACtB,4BAA4B,GAC5B,sCAAsC,GACtC,sBAAsB,GACtB,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,iCAAiC,GACjC,+BAA+B,GAC/B,cAAc,GACd,mBAAmB,GACnB,oBAAoB,GACpB,WAAW,GACX,SAAS,GACT,kBAAkB,GAClB,sBAAsB,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,OAAO,GACP,YAAY,GACZ,SAAS,GACT,6BAA6B,GAC7B,0BAA0B,GAC1B,gBAAgB,GAChB,WAAW,GACX,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,yBAAyB,GACzB,8BAA8B,GAC9B,0BAA0B,GAC1B,qBAAqB,GACrB,sBAAsB,GACtB,yBAAyB,GACzB,2BAA2B,GAC3B,8BAA8B,GAC9B,kBAAkB,GAClB,qBAAqB,GACrB,wBAAwB,GACxB,2BAA2B,GAC3B,qBAAqB,GACrB,eAAe,GACf,aAAa,GACb,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,gBAAgB,GAChB,6BAA6B,GAC7B,kCAAkC,GAClC,WAAW,GACX,iBAAiB,GACjB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,GAChB,KAAK,GACL,YAAY,GACZ,YAAY,GACZ,mCAAmC,GACnC,0BAA0B,GAC1B,0BAA0B,GAC1B,eAAe,GACf,mBAAmB,GACnB,mCAAmC,GACnC,yBAAyB,GACzB,yBAAyB,GACzB,IAAI,CAAC;IAET;;;OAGG;IACH,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAErE;;OAEG;IACH,IAAI,EAAE,aAAa,GAAG,aAAa,GAAG,QAAQ,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;;OAMG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EACA,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,0BAA0B,GAC1B,kBAAkB,GAClB,4BAA4B,GAC5B,mBAAmB,GACnB,eAAe,GACf,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,yBAAyB,GACzB,gBAAgB,GAChB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,qBAAqB,GACrB,wBAAwB,GACxB,SAAS,GACT,kBAAkB,GAClB,iBAAiB,GACjB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,qBAAqB,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,mBAAmB,GAAG,uBAAuB,CAAC;CACnE;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,iBAAiB,CAAC,CAAC;CACnD;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,iBAAiB,CAAC,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,GAAG,IAAI,GAAG,EACf,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/core/jobs.d.ts

@@ -1,4 +1,7 @@
 import { APIResource } from "../../core/resource.js";
+import * as CoreAPI from "./core.js";
+import * as RequestLogsAPI from "./request-logs.js";
+import * as APIKeysAPI from "../auth/api-keys/api-keys.js";
 import { APIPromise } from "../../core/api-promise.js";
 import { RequestOptions } from "../../internal/request-options.js";
 /**
@@ -10,27 +13,32 @@ export declare 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>;
+    retrieve(id: string, query?: JobRetrieveParams | null | undefined, options?: RequestOptions): APIPromise<Job>;
     /**
      * 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.
      *
+     * 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>;
+    cancel(id: string, params?: JobCancelParams | null | undefined, options?: RequestOptions): APIPromise<Job>;
 }
 /**
  * Records a piece of work the API accepted and carries out asynchronously.
@@ -55,30 +63,16 @@ 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.
+     * Reference to an actor — the user, API key, agent, or group identity associated
+     * with an action.
      */
-    created_by_id: string | null;
+    created_by: RequestLogsAPI.Actor | 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`.
+     * 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.
      */
@@ -93,24 +87,33 @@ 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`.
+     * 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: Array<JobResult>;
+    results: ListJobResult | null;
     /**
      * 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`.
+     * 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.
      */
@@ -121,35 +124,77 @@ 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.
-     */
-    id: string;
-    /**
-     * Whether the resource was created or updated.
+     * 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.
      */
-    action: 'created' | 'updated';
+    error: ResponseError | null;
     /**
      * 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.
+     * Resource type identifier.
+     */
+    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>;
+    /**
+     * Resource type identifier.
+     */
+    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.
      */
-    sub_resource_ids?: Array<string>;
+    page_info: APIKeysAPI.PageInfo;
 }
 /**
  * QuotaInfo provides machine-readable details about a plan-imposed resource limit.
@@ -213,24 +258,21 @@ 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 {
-    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, };
+    export { 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 JobRetrieveParams as JobRetrieveParams, type JobCancelParams as JobCancelParams, };
 }
 //# sourceMappingURL=jobs.d.ts.map

package/resources/core/jobs.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../src/resources/core/jobs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;IAI/D;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,GAAG,CAAC;CAG9D;AAED;;;;GAIG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,QAAQ,CAAC,CAAC;IAExB;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;OAIG;IACH,OAAO,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAE1B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;OAGG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAErE;;OAEG;IACH,IAAI,EAAE,YAAY,GAAG,YAAY,GAAG,QAAQ,CAAC;IAE7C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,CAAC;IAE9B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CAClC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EACA,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,0BAA0B,GAC1B,kBAAkB,GAClB,4BAA4B,GAC5B,mBAAmB,GACnB,eAAe,GACf,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,yBAAyB,GACzB,gBAAgB,GAChB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,qBAAqB,GACrB,wBAAwB,GACxB,SAAS,GACT,kBAAkB,GAClB,iBAAiB,GACjB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,qBAAqB,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,mBAAmB,GAAG,uBAAuB,CAAC;CACnE;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACvB;;;;OAIG;IACH,KAAK,EAAE,aAAa,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,GAAG,IAAI,GAAG,EACf,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,QAAQ,IAAI,QAAQ,GAC1B,CAAC;CACH"}
+{"version":3,"file":"jobs.d.ts","sourceRoot":"","sources":["../../src/resources/core/jobs.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,OAAO;OACZ,KAAK,cAAc;OACnB,KAAK,UAAU;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB;;GAEG;AACH,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;OAcG;IACH,QAAQ,CACN,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,iBAAiB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,GAAG,CAAC;IAIlB;;;;;;;;;;;;;OAaG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,MAAM,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,GAAG,CAAC;CAInB;AAED;;;;GAIG;AACH,MAAM,WAAW,GAAG;IAClB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,UAAU,EAAE,cAAc,CAAC,KAAK,GAAG,IAAI,CAAC;IAExC;;;;OAIG;IACH,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,MAAM,EAAE,SAAS,GAAG,IAAI,CAAC;IAEzB;;;OAGG;IACH,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAEzB;;OAEG;IACH,MAAM,EAAE,KAAK,CAAC;IAEd;;;;;;OAMG;IACH,aAAa,EACT,SAAS,GACT,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,oBAAoB,GACpB,yBAAyB,GACzB,qBAAqB,GACrB,eAAe,GACf,MAAM,GACN,SAAS,GACT,SAAS,GACT,iBAAiB,GACjB,eAAe,GACf,MAAM,GACN,SAAS,GACT,sBAAsB,GACtB,cAAc,GACd,cAAc,GACd,aAAa,GACb,oBAAoB,GACpB,aAAa,GACb,aAAa,GACb,oBAAoB,GACpB,MAAM,GACN,MAAM,GACN,qBAAqB,GACrB,kBAAkB,GAClB,gBAAgB,GAChB,uBAAuB,GACvB,sBAAsB,GACtB,WAAW,GACX,cAAc,GACd,gBAAgB,GAChB,mBAAmB,GACnB,cAAc,GACd,cAAc,GACd,2BAA2B,GAC3B,0BAA0B,GAC1B,6BAA6B,GAC7B,cAAc,GACd,cAAc,GACd,cAAc,GACd,0BAA0B,GAC1B,aAAa,GACb,cAAc,GACd,qCAAqC,GACrC,iBAAiB,GACjB,yBAAyB,GACzB,oBAAoB,GACpB,0BAA0B,GAC1B,mBAAmB,GACnB,mBAAmB,GACnB,gBAAgB,GAChB,YAAY,GACZ,OAAO,GACP,cAAc,GACd,eAAe,GACf,UAAU,GACV,eAAe,GACf,eAAe,GACf,sBAAsB,GACtB,gBAAgB,GAChB,aAAa,GACb,cAAc,GACd,YAAY,GACZ,qBAAqB,GACrB,eAAe,GACf,cAAc,GACd,eAAe,GACf,WAAW,GACX,MAAM,GACN,mCAAmC,GACnC,cAAc,GACd,iBAAiB,GACjB,kBAAkB,GAClB,gBAAgB,GAChB,kBAAkB,GAClB,qBAAqB,GACrB,gBAAgB,GAChB,UAAU,GACV,SAAS,GACT,eAAe,GACf,MAAM,GACN,kBAAkB,GAClB,gBAAgB,GAChB,SAAS,GACT,OAAO,GACP,iBAAiB,GACjB,sBAAsB,GACtB,oBAAoB,GACpB,+BAA+B,GAC/B,kBAAkB,GAClB,iBAAiB,GACjB,gBAAgB,GAChB,SAAS,GACT,gBAAgB,GAChB,wBAAwB,GACxB,iBAAiB,GACjB,sBAAsB,GACtB,yBAAyB,GACzB,6BAA6B,GAC7B,wCAAwC,GACxC,qBAAqB,GACrB,0BAA0B,GAC1B,+BAA+B,GAC/B,kCAAkC,GAClC,8BAA8B,GAC9B,sCAAsC,GACtC,kCAAkC,GAClC,4BAA4B,GAC5B,uCAAuC,GACvC,sBAAsB,GACtB,yBAAyB,GACzB,0BAA0B,GAC1B,oBAAoB,GACpB,yBAAyB,GACzB,8BAA8B,GAC9B,oBAAoB,GACpB,yBAAyB,GACzB,wBAAwB,GACxB,qCAAqC,GACrC,kCAAkC,GAClC,0CAA0C,GAC1C,iCAAiC,GACjC,eAAe,GACf,YAAY,GACZ,iBAAiB,GACjB,aAAa,GACb,8BAA8B,GAC9B,UAAU,GACV,4BAA4B,GAC5B,UAAU,GACV,UAAU,GACV,eAAe,GACf,aAAa,GACb,UAAU,GACV,eAAe,GACf,KAAK,GACL,WAAW,GACX,cAAc,GACd,aAAa,GACb,eAAe,GACf,YAAY,GACZ,sBAAsB,GACtB,SAAS,GACT,iBAAiB,GACjB,cAAc,GACd,oBAAoB,GACpB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,eAAe,GACf,eAAe,GACf,yBAAyB,GACzB,YAAY,GACZ,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,0BAA0B,GAC1B,aAAa,GACb,qBAAqB,GACrB,oBAAoB,GACpB,kBAAkB,GAClB,wBAAwB,GACxB,YAAY,GACZ,wBAAwB,GACxB,mBAAmB,GACnB,iCAAiC,GACjC,sBAAsB,GACtB,kCAAkC,GAClC,uBAAuB,GACvB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,oBAAoB,GACpB,wBAAwB,GACxB,mBAAmB,GACnB,YAAY,GACZ,uBAAuB,GACvB,uBAAuB,GACvB,wBAAwB,GACxB,0BAA0B,GAC1B,gBAAgB,GAChB,uBAAuB,GACvB,wBAAwB,GACxB,eAAe,GACf,aAAa,GACb,yBAAyB,GACzB,gBAAgB,GAChB,uBAAuB,GACvB,8BAA8B,GAC9B,mBAAmB,GACnB,oBAAoB,GACpB,mCAAmC,GACnC,8BAA8B,GAC9B,gBAAgB,GAChB,kBAAkB,GAClB,kBAAkB,GAClB,oBAAoB,GACpB,UAAU,GACV,mBAAmB,GACnB,MAAM,GACN,kBAAkB,GAClB,YAAY,GACZ,MAAM,GACN,WAAW,GACX,cAAc,GACd,YAAY,GACZ,iBAAiB,GACjB,KAAK,GACL,gBAAgB,GAChB,qBAAqB,GACrB,UAAU,GACV,kBAAkB,GAClB,kBAAkB,GAClB,iBAAiB,GACjB,sBAAsB,GACtB,eAAe,GACf,kBAAkB,GAClB,mBAAmB,GACnB,iBAAiB,GACjB,sBAAsB,GACtB,6BAA6B,GAC7B,gCAAgC,GAChC,sCAAsC,GACtC,mCAAmC,GACnC,gCAAgC,GAChC,kCAAkC,GAClC,sBAAsB,GACtB,4BAA4B,GAC5B,sCAAsC,GACtC,sBAAsB,GACtB,kBAAkB,GAClB,iBAAiB,GACjB,kBAAkB,GAClB,mBAAmB,GACnB,aAAa,GACb,SAAS,GACT,gBAAgB,GAChB,iCAAiC,GACjC,+BAA+B,GAC/B,cAAc,GACd,mBAAmB,GACnB,oBAAoB,GACpB,WAAW,GACX,SAAS,GACT,kBAAkB,GAClB,sBAAsB,GACtB,kBAAkB,GAClB,kBAAkB,GAClB,OAAO,GACP,YAAY,GACZ,SAAS,GACT,6BAA6B,GAC7B,0BAA0B,GAC1B,gBAAgB,GAChB,WAAW,GACX,wBAAwB,GACxB,kBAAkB,GAClB,oBAAoB,GACpB,yBAAyB,GACzB,8BAA8B,GAC9B,0BAA0B,GAC1B,qBAAqB,GACrB,sBAAsB,GACtB,yBAAyB,GACzB,2BAA2B,GAC3B,8BAA8B,GAC9B,kBAAkB,GAClB,qBAAqB,GACrB,wBAAwB,GACxB,2BAA2B,GAC3B,qBAAqB,GACrB,eAAe,GACf,aAAa,GACb,mBAAmB,GACnB,iBAAiB,GACjB,wBAAwB,GACxB,gBAAgB,GAChB,6BAA6B,GAC7B,kCAAkC,GAClC,WAAW,GACX,iBAAiB,GACjB,qBAAqB,GACrB,sBAAsB,GACtB,gBAAgB,GAChB,KAAK,GACL,YAAY,GACZ,YAAY,GACZ,mCAAmC,GACnC,0BAA0B,GAC1B,0BAA0B,GAC1B,eAAe,GACf,mBAAmB,GACnB,mCAAmC,GACnC,yBAAyB,GACzB,yBAAyB,GACzB,IAAI,CAAC;IAET;;;OAGG;IACH,OAAO,EAAE,aAAa,GAAG,IAAI,CAAC;IAE9B;;OAEG;IACH,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;;;;OAKG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,GAAG,WAAW,CAAC;IAErE;;OAEG;IACH,IAAI,EAAE,aAAa,GAAG,aAAa,GAAG,QAAQ,CAAC;IAE/C;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;;;OAIG;IACH,GAAG,EAAE,MAAM,CAAC;CACb;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;;;OAIG;IACH,KAAK,EAAE,aAAa,GAAG,IAAI,CAAC;IAE5B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,YAAY,CAAC;IAErB;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC;IAEhC;;;;;;OAMG;IACH,MAAM,EAAE,SAAS,GAAG,SAAS,GAAG,QAAQ,CAAC;IAEzC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAEvB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;OAQG;IACH,SAAS,EAAE,UAAU,CAAC,QAAQ,CAAC;CAChC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAExB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EACA,eAAe,GACf,iBAAiB,GACjB,iBAAiB,GACjB,qBAAqB,GACrB,0BAA0B,GAC1B,kBAAkB,GAClB,4BAA4B,GAC5B,mBAAmB,GACnB,eAAe,GACf,gBAAgB,GAChB,oBAAoB,GACpB,oBAAoB,GACpB,iBAAiB,GACjB,mBAAmB,GACnB,eAAe,GACf,yBAAyB,GACzB,gBAAgB,GAChB,qBAAqB,GACrB,qBAAqB,GACrB,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,sBAAsB,GACtB,gBAAgB,GAChB,qBAAqB,GACrB,wBAAwB,GACxB,SAAS,GACT,kBAAkB,GAClB,iBAAiB,GACjB,uBAAuB,GACvB,sBAAsB,GACtB,qBAAqB,GACrB,qBAAqB,CAAC;IAE1B;;OAEG;IACH,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;;;OAIG;IACH,KAAK,EAAE,SAAS,GAAG,IAAI,CAAC;IAExB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,IAAI,EAAE,WAAW,GAAG,mBAAmB,GAAG,uBAAuB,CAAC;CACnE;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,iBAAiB,CAAC,CAAC;CACnD;AAED,MAAM,WAAW,eAAe;IAC9B;;;OAGG;IACH,OAAO,CAAC,EAAE,KAAK,CAAC,YAAY,GAAG,iBAAiB,CAAC,CAAC;CACnD;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,GAAG,IAAI,GAAG,EACf,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,SAAS,IAAI,SAAS,EAC3B,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,GACxC,CAAC;CACH"}

package/resources/core/jobs.js

@@ -13,30 +13,36 @@ class Jobs extends resource_1.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, options) {
-        return this._client.get((0, path_1.path) `/v1/core/jobs/${id}`, options);
+    retrieve(id, query = {}, options) {
+        return this._client.get((0, path_1.path) `/v1/core/jobs/${id}`, { query, ...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.
      *
+     * This endpoint requires the permission: `jobs:delete`.
+     *
      * @example
      * ```ts
      * const job = await client.core.jobs.cancel(
-     *   'jb_01k0a5smf9ekb8rqg1',
+     *   'jb_grz7cdpnz8jr',
      * );
      * ```
      */
-    cancel(id, options) {
-        return this._client.post((0, path_1.path) `/v1/core/jobs/${id}/cancel`, options);
+    cancel(id, params = {}, options) {
+        const { include } = params ?? {};
+        return this._client.post((0, path_1.path) `/v1/core/jobs/${id}/cancel`, { query: { include }, ...options });
     }
 }
 exports.Jobs = Jobs;