@augno/sdk 0.13.4 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +3 -3
- package/package.json +1 -1
- package/resources/catalog/catalog.d.mts +10 -10
- package/resources/catalog/catalog.d.mts.map +1 -1
- package/resources/catalog/catalog.d.ts +10 -10
- package/resources/catalog/catalog.d.ts.map +1 -1
- package/resources/catalog/catalog.js +10 -10
- package/resources/catalog/catalog.js.map +1 -1
- package/resources/catalog/catalog.mjs +10 -10
- package/resources/catalog/catalog.mjs.map +1 -1
- package/resources/catalog/index.d.mts +5 -5
- package/resources/catalog/index.d.ts +5 -5
- package/resources/catalog/index.js +14 -14
- package/resources/catalog/index.js.map +1 -1
- package/resources/catalog/index.mjs +5 -5
- package/resources/catalog/item-categories/actions.d.mts +93 -0
- package/resources/catalog/item-categories/actions.d.mts.map +1 -0
- package/resources/catalog/item-categories/actions.d.ts +93 -0
- package/resources/catalog/item-categories/actions.d.ts.map +1 -0
- package/resources/catalog/item-categories/actions.js +35 -0
- package/resources/catalog/item-categories/actions.js.map +1 -0
- package/resources/catalog/item-categories/actions.mjs +31 -0
- package/resources/catalog/item-categories/actions.mjs.map +1 -0
- package/resources/catalog/item-categories/index.d.mts +1 -0
- package/resources/catalog/item-categories/index.d.mts.map +1 -1
- package/resources/catalog/item-categories/index.d.ts +1 -0
- package/resources/catalog/item-categories/index.d.ts.map +1 -1
- package/resources/catalog/item-categories/index.js +3 -1
- package/resources/catalog/item-categories/index.js.map +1 -1
- package/resources/catalog/item-categories/index.mjs +1 -0
- package/resources/catalog/item-categories/index.mjs.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.mts +4 -0
- package/resources/catalog/item-categories/item-categories.d.mts.map +1 -1
- package/resources/catalog/item-categories/item-categories.d.ts +4 -0
- package/resources/catalog/item-categories/item-categories.d.ts.map +1 -1
- package/resources/catalog/item-categories/item-categories.js +4 -0
- package/resources/catalog/item-categories/item-categories.js.map +1 -1
- package/resources/catalog/item-categories/item-categories.mjs +4 -0
- package/resources/catalog/item-categories/item-categories.mjs.map +1 -1
- package/resources/catalog/items/items.d.mts +1 -1
- package/resources/catalog/items/items.d.mts.map +1 -1
- package/resources/catalog/items/items.d.ts +1 -1
- package/resources/catalog/items/items.d.ts.map +1 -1
- package/resources/catalog/items/items.js.map +1 -1
- package/resources/catalog/items/items.mjs.map +1 -1
- package/resources/catalog/materials/actions.d.mts +118 -0
- package/resources/catalog/materials/actions.d.mts.map +1 -0
- package/resources/catalog/materials/actions.d.ts +118 -0
- package/resources/catalog/materials/actions.d.ts.map +1 -0
- package/resources/catalog/materials/actions.js +33 -0
- package/resources/catalog/materials/actions.js.map +1 -0
- package/resources/catalog/materials/actions.mjs +29 -0
- package/resources/catalog/materials/actions.mjs.map +1 -0
- package/resources/catalog/materials/index.d.mts +3 -0
- package/resources/catalog/materials/index.d.mts.map +1 -0
- package/resources/catalog/materials/index.d.ts +3 -0
- package/resources/catalog/materials/index.d.ts.map +1 -0
- package/resources/catalog/materials/index.js +9 -0
- package/resources/catalog/materials/index.js.map +1 -0
- package/resources/catalog/materials/index.mjs +4 -0
- package/resources/catalog/materials/index.mjs.map +1 -0
- package/resources/catalog/materials/materials.d.mts +483 -0
- package/resources/catalog/materials/materials.d.mts.map +1 -0
- package/resources/catalog/materials/materials.d.ts +483 -0
- package/resources/catalog/materials/materials.d.ts.map +1 -0
- package/resources/catalog/materials/materials.js +159 -0
- package/resources/catalog/materials/materials.js.map +1 -0
- package/resources/catalog/materials/materials.mjs +154 -0
- package/resources/catalog/materials/materials.mjs.map +1 -0
- package/resources/catalog/materials.d.mts +1 -478
- package/resources/catalog/materials.d.mts.map +1 -1
- package/resources/catalog/materials.d.ts +1 -478
- package/resources/catalog/materials.d.ts.map +1 -1
- package/resources/catalog/materials.js +2 -147
- package/resources/catalog/materials.js.map +1 -1
- package/resources/catalog/materials.mjs +1 -145
- package/resources/catalog/materials.mjs.map +1 -1
- package/resources/catalog/parts/actions.d.mts +108 -0
- package/resources/catalog/parts/actions.d.mts.map +1 -0
- package/resources/catalog/parts/actions.d.ts +108 -0
- package/resources/catalog/parts/actions.d.ts.map +1 -0
- package/resources/catalog/parts/actions.js +32 -0
- package/resources/catalog/parts/actions.js.map +1 -0
- package/resources/catalog/parts/actions.mjs +28 -0
- package/resources/catalog/parts/actions.mjs.map +1 -0
- package/resources/catalog/parts/index.d.mts +3 -0
- package/resources/catalog/parts/index.d.mts.map +1 -0
- package/resources/catalog/parts/index.d.ts +3 -0
- package/resources/catalog/parts/index.d.ts.map +1 -0
- package/resources/catalog/parts/index.js +9 -0
- package/resources/catalog/parts/index.js.map +1 -0
- package/resources/catalog/parts/index.mjs +4 -0
- package/resources/catalog/parts/index.mjs.map +1 -0
- package/resources/catalog/parts/parts.d.mts +362 -0
- package/resources/catalog/parts/parts.d.mts.map +1 -0
- package/resources/catalog/parts/parts.d.ts +362 -0
- package/resources/catalog/parts/parts.d.ts.map +1 -0
- package/resources/catalog/parts/parts.js +138 -0
- package/resources/catalog/parts/parts.js.map +1 -0
- package/resources/catalog/parts/parts.mjs +133 -0
- package/resources/catalog/parts/parts.mjs.map +1 -0
- package/resources/catalog/parts.d.mts +1 -357
- package/resources/catalog/parts.d.mts.map +1 -1
- package/resources/catalog/parts.d.ts +1 -357
- package/resources/catalog/parts.d.ts.map +1 -1
- package/resources/catalog/parts.js +2 -126
- package/resources/catalog/parts.js.map +1 -1
- package/resources/catalog/parts.mjs +1 -124
- package/resources/catalog/parts.mjs.map +1 -1
- package/resources/catalog/product-lines/actions.d.mts +82 -0
- package/resources/catalog/product-lines/actions.d.mts.map +1 -0
- package/resources/catalog/product-lines/actions.d.ts +82 -0
- package/resources/catalog/product-lines/actions.d.ts.map +1 -0
- package/resources/catalog/product-lines/actions.js +34 -0
- package/resources/catalog/product-lines/actions.js.map +1 -0
- package/resources/catalog/product-lines/actions.mjs +30 -0
- package/resources/catalog/product-lines/actions.mjs.map +1 -0
- package/resources/catalog/product-lines/index.d.mts +3 -0
- package/resources/catalog/product-lines/index.d.mts.map +1 -0
- package/resources/catalog/product-lines/index.d.ts +3 -0
- package/resources/catalog/product-lines/index.d.ts.map +1 -0
- package/resources/catalog/product-lines/index.js +9 -0
- package/resources/catalog/product-lines/index.js.map +1 -0
- package/resources/catalog/product-lines/index.mjs +4 -0
- package/resources/catalog/product-lines/index.mjs.map +1 -0
- package/resources/catalog/product-lines/product-lines.d.mts +448 -0
- package/resources/catalog/product-lines/product-lines.d.mts.map +1 -0
- package/resources/catalog/product-lines/product-lines.d.ts +448 -0
- package/resources/catalog/product-lines/product-lines.d.ts.map +1 -0
- package/resources/catalog/product-lines/product-lines.js +136 -0
- package/resources/catalog/product-lines/product-lines.js.map +1 -0
- package/resources/catalog/product-lines/product-lines.mjs +131 -0
- package/resources/catalog/product-lines/product-lines.mjs.map +1 -0
- package/resources/catalog/product-lines.d.mts +1 -443
- package/resources/catalog/product-lines.d.mts.map +1 -1
- package/resources/catalog/product-lines.d.ts +1 -443
- package/resources/catalog/product-lines.d.ts.map +1 -1
- package/resources/catalog/product-lines.js +2 -124
- package/resources/catalog/product-lines.js.map +1 -1
- package/resources/catalog/product-lines.mjs +1 -122
- package/resources/catalog/product-lines.mjs.map +1 -1
- package/resources/catalog/products/actions.d.mts +124 -0
- package/resources/catalog/products/actions.d.mts.map +1 -0
- package/resources/catalog/products/actions.d.ts +124 -0
- package/resources/catalog/products/actions.d.ts.map +1 -0
- package/resources/catalog/products/actions.js +33 -0
- package/resources/catalog/products/actions.js.map +1 -0
- package/resources/catalog/products/actions.mjs +29 -0
- package/resources/catalog/products/actions.mjs.map +1 -0
- package/resources/catalog/products/index.d.mts +3 -0
- package/resources/catalog/products/index.d.mts.map +1 -0
- package/resources/catalog/products/index.d.ts +3 -0
- package/resources/catalog/products/index.d.ts.map +1 -0
- package/resources/catalog/products/index.js +9 -0
- package/resources/catalog/products/index.js.map +1 -0
- package/resources/catalog/products/index.mjs +4 -0
- package/resources/catalog/products/index.mjs.map +1 -0
- package/resources/catalog/products/products.d.mts +585 -0
- package/resources/catalog/products/products.d.mts.map +1 -0
- package/resources/catalog/products/products.d.ts +585 -0
- package/resources/catalog/products/products.d.ts.map +1 -0
- package/resources/catalog/products/products.js +185 -0
- package/resources/catalog/products/products.js.map +1 -0
- package/resources/catalog/products/products.mjs +180 -0
- package/resources/catalog/products/products.mjs.map +1 -0
- package/resources/catalog/products.d.mts +1 -580
- package/resources/catalog/products.d.mts.map +1 -1
- package/resources/catalog/products.d.ts +1 -580
- package/resources/catalog/products.d.ts.map +1 -1
- package/resources/catalog/products.js +2 -173
- package/resources/catalog/products.js.map +1 -1
- package/resources/catalog/products.mjs +1 -171
- package/resources/catalog/products.mjs.map +1 -1
- package/resources/catalog/properties/actions.d.mts +86 -0
- package/resources/catalog/properties/actions.d.mts.map +1 -0
- package/resources/catalog/properties/actions.d.ts +86 -0
- package/resources/catalog/properties/actions.d.ts.map +1 -0
- package/resources/catalog/properties/actions.js +33 -0
- package/resources/catalog/properties/actions.js.map +1 -0
- package/resources/catalog/properties/actions.mjs +29 -0
- package/resources/catalog/properties/actions.mjs.map +1 -0
- package/resources/catalog/properties/index.d.mts +1 -0
- package/resources/catalog/properties/index.d.mts.map +1 -1
- package/resources/catalog/properties/index.d.ts +1 -0
- package/resources/catalog/properties/index.d.ts.map +1 -1
- package/resources/catalog/properties/index.js +3 -1
- package/resources/catalog/properties/index.js.map +1 -1
- package/resources/catalog/properties/index.mjs +1 -0
- package/resources/catalog/properties/index.mjs.map +1 -1
- package/resources/catalog/properties/properties.d.mts +4 -0
- package/resources/catalog/properties/properties.d.mts.map +1 -1
- package/resources/catalog/properties/properties.d.ts +4 -0
- package/resources/catalog/properties/properties.d.ts.map +1 -1
- package/resources/catalog/properties/properties.js +4 -0
- package/resources/catalog/properties/properties.js.map +1 -1
- package/resources/catalog/properties/properties.mjs +4 -0
- package/resources/catalog/properties/properties.mjs.map +1 -1
- package/resources/catalog/unit-groups/actions.d.mts +116 -0
- package/resources/catalog/unit-groups/actions.d.mts.map +1 -0
- package/resources/catalog/unit-groups/actions.d.ts +116 -0
- package/resources/catalog/unit-groups/actions.d.ts.map +1 -0
- package/resources/catalog/unit-groups/actions.js +39 -0
- package/resources/catalog/unit-groups/actions.js.map +1 -0
- package/resources/catalog/unit-groups/actions.mjs +35 -0
- package/resources/catalog/unit-groups/actions.mjs.map +1 -0
- package/resources/catalog/unit-groups/index.d.mts +1 -0
- package/resources/catalog/unit-groups/index.d.mts.map +1 -1
- package/resources/catalog/unit-groups/index.d.ts +1 -0
- package/resources/catalog/unit-groups/index.d.ts.map +1 -1
- package/resources/catalog/unit-groups/index.js +3 -1
- package/resources/catalog/unit-groups/index.js.map +1 -1
- package/resources/catalog/unit-groups/index.mjs +1 -0
- package/resources/catalog/unit-groups/index.mjs.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.mts +9 -5
- package/resources/catalog/unit-groups/unit-groups.d.mts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.d.ts +9 -5
- package/resources/catalog/unit-groups/unit-groups.d.ts.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.js +6 -2
- package/resources/catalog/unit-groups/unit-groups.js.map +1 -1
- package/resources/catalog/unit-groups/unit-groups.mjs +6 -2
- package/resources/catalog/unit-groups/unit-groups.mjs.map +1 -1
- package/resources/catalog/units/actions.d.mts +91 -0
- package/resources/catalog/units/actions.d.mts.map +1 -0
- package/resources/catalog/units/actions.d.ts +91 -0
- package/resources/catalog/units/actions.d.ts.map +1 -0
- package/resources/catalog/units/actions.js +37 -0
- package/resources/catalog/units/actions.js.map +1 -0
- package/resources/catalog/units/actions.mjs +33 -0
- package/resources/catalog/units/actions.mjs.map +1 -0
- package/resources/catalog/units/index.d.mts +3 -0
- package/resources/catalog/units/index.d.mts.map +1 -0
- package/resources/catalog/units/index.d.ts +3 -0
- package/resources/catalog/units/index.d.ts.map +1 -0
- package/resources/catalog/units/index.js +9 -0
- package/resources/catalog/units/index.js.map +1 -0
- package/resources/catalog/units/index.mjs +4 -0
- package/resources/catalog/units/index.mjs.map +1 -0
- package/resources/catalog/units/units.d.mts +449 -0
- package/resources/catalog/units/units.d.mts.map +1 -0
- package/resources/catalog/units/units.d.ts +449 -0
- package/resources/catalog/units/units.d.ts.map +1 -0
- package/resources/catalog/units/units.js +122 -0
- package/resources/catalog/units/units.js.map +1 -0
- package/resources/catalog/units/units.mjs +117 -0
- package/resources/catalog/units/units.mjs.map +1 -0
- package/resources/catalog/units.d.mts +1 -444
- package/resources/catalog/units.d.mts.map +1 -1
- package/resources/catalog/units.d.ts +1 -444
- package/resources/catalog/units.d.ts.map +1 -1
- package/resources/catalog/units.js +2 -110
- package/resources/catalog/units.js.map +1 -1
- package/resources/catalog/units.mjs +1 -108
- package/resources/catalog/units.mjs.map +1 -1
- package/resources/core/audit-events.d.mts +6 -6
- package/resources/core/audit-events.d.mts.map +1 -1
- package/resources/core/audit-events.d.ts +6 -6
- package/resources/core/audit-events.d.ts.map +1 -1
- package/resources/core/core.d.mts +6 -2
- package/resources/core/core.d.mts.map +1 -1
- package/resources/core/core.d.ts +6 -2
- package/resources/core/core.d.ts.map +1 -1
- package/resources/core/core.js +4 -0
- package/resources/core/core.js.map +1 -1
- package/resources/core/core.mjs +4 -0
- package/resources/core/core.mjs.map +1 -1
- package/resources/core/index.d.mts +1 -0
- package/resources/core/index.d.mts.map +1 -1
- package/resources/core/index.d.ts +1 -0
- package/resources/core/index.d.ts.map +1 -1
- package/resources/core/index.js +3 -1
- package/resources/core/index.js.map +1 -1
- package/resources/core/index.mjs +1 -0
- package/resources/core/index.mjs.map +1 -1
- package/resources/core/jobs.d.mts +236 -0
- package/resources/core/jobs.d.mts.map +1 -0
- package/resources/core/jobs.d.ts +236 -0
- package/resources/core/jobs.d.ts.map +1 -0
- package/resources/core/jobs.js +43 -0
- package/resources/core/jobs.js.map +1 -0
- package/resources/core/jobs.mjs +39 -0
- package/resources/core/jobs.mjs.map +1 -0
- package/resources/messaging/conversations/conversations.d.mts +3 -3
- package/resources/messaging/conversations/conversations.d.mts.map +1 -1
- package/resources/messaging/conversations/conversations.d.ts +3 -3
- package/resources/messaging/conversations/conversations.d.ts.map +1 -1
- package/resources/messaging/conversations/conversations.js.map +1 -1
- package/resources/messaging/conversations/conversations.mjs.map +1 -1
- package/resources/messaging/conversations/links.d.mts +2 -2
- package/resources/messaging/conversations/links.d.mts.map +1 -1
- package/resources/messaging/conversations/links.d.ts +2 -2
- package/resources/messaging/conversations/links.d.ts.map +1 -1
- package/resources/messaging/conversations/messages.d.mts +2 -2
- package/resources/messaging/conversations/messages.d.mts.map +1 -1
- package/resources/messaging/conversations/messages.d.ts +2 -2
- package/resources/messaging/conversations/messages.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.d.mts +2 -2
- package/resources/messaging/notifications/notifications.d.mts.map +1 -1
- package/resources/messaging/notifications/notifications.d.ts +2 -2
- package/resources/messaging/notifications/notifications.d.ts.map +1 -1
- package/resources/messaging/notifications/notifications.js.map +1 -1
- package/resources/messaging/notifications/notifications.mjs.map +1 -1
- package/resources/operations/demand-overrides.d.mts +1 -1
- package/resources/operations/demand-overrides.d.mts.map +1 -1
- package/resources/operations/demand-overrides.d.ts +1 -1
- package/resources/operations/demand-overrides.d.ts.map +1 -1
- package/resources/operations/index.d.mts +1 -1
- package/resources/operations/index.d.ts +1 -1
- package/resources/operations/index.js +8 -8
- package/resources/operations/index.js.map +1 -1
- package/resources/operations/index.mjs +1 -1
- package/resources/operations/locations/actions.d.mts +67 -0
- package/resources/operations/locations/actions.d.mts.map +1 -0
- package/resources/operations/locations/actions.d.ts +67 -0
- package/resources/operations/locations/actions.d.ts.map +1 -0
- package/resources/operations/locations/actions.js +27 -0
- package/resources/operations/locations/actions.js.map +1 -0
- package/resources/operations/locations/actions.mjs +23 -0
- package/resources/operations/locations/actions.mjs.map +1 -0
- package/resources/operations/locations/index.d.mts +3 -0
- package/resources/operations/locations/index.d.mts.map +1 -0
- package/resources/operations/locations/index.d.ts +3 -0
- package/resources/operations/locations/index.d.ts.map +1 -0
- package/resources/operations/locations/index.js +9 -0
- package/resources/operations/locations/index.js.map +1 -0
- package/resources/operations/locations/index.mjs +4 -0
- package/resources/operations/locations/index.mjs.map +1 -0
- package/resources/operations/locations/locations.d.mts +273 -0
- package/resources/operations/locations/locations.d.mts.map +1 -0
- package/resources/operations/locations/locations.d.ts +273 -0
- package/resources/operations/locations/locations.d.ts.map +1 -0
- package/resources/operations/locations/locations.js +113 -0
- package/resources/operations/locations/locations.js.map +1 -0
- package/resources/operations/locations/locations.mjs +108 -0
- package/resources/operations/locations/locations.mjs.map +1 -0
- package/resources/operations/locations.d.mts +1 -268
- package/resources/operations/locations.d.mts.map +1 -1
- package/resources/operations/locations.d.ts +1 -268
- package/resources/operations/locations.d.ts.map +1 -1
- package/resources/operations/locations.js +2 -101
- package/resources/operations/locations.js.map +1 -1
- package/resources/operations/locations.mjs +1 -99
- package/resources/operations/locations.mjs.map +1 -1
- package/resources/operations/operations.d.mts +2 -2
- package/resources/operations/operations.d.mts.map +1 -1
- package/resources/operations/operations.d.ts +2 -2
- package/resources/operations/operations.d.ts.map +1 -1
- package/resources/operations/operations.js +2 -2
- package/resources/operations/operations.js.map +1 -1
- package/resources/operations/operations.mjs +2 -2
- package/resources/operations/operations.mjs.map +1 -1
- package/resources/operations/scanning-stations.d.mts +12 -4
- package/resources/operations/scanning-stations.d.mts.map +1 -1
- package/resources/operations/scanning-stations.d.ts +12 -4
- package/resources/operations/scanning-stations.d.ts.map +1 -1
- package/resources/operations/shipping-terms.d.mts +1 -1
- package/resources/operations/shipping-terms.d.mts.map +1 -1
- package/resources/operations/shipping-terms.d.ts +1 -1
- package/resources/operations/shipping-terms.d.ts.map +1 -1
- package/resources/sales/customers/customers.d.mts +1 -1
- package/resources/sales/customers/customers.d.mts.map +1 -1
- package/resources/sales/customers/customers.d.ts +1 -1
- package/resources/sales/customers/customers.d.ts.map +1 -1
- package/resources/sales/sales-orders/lines/lines.d.mts +2 -2
- package/resources/sales/sales-orders/lines/lines.d.ts +2 -2
- package/resources/sales/sales-orders/sales-orders.d.mts +4 -4
- package/resources/sales/sales-orders/sales-orders.d.mts.map +1 -1
- package/resources/sales/sales-orders/sales-orders.d.ts +4 -4
- package/resources/sales/sales-orders/sales-orders.d.ts.map +1 -1
- package/src/resources/catalog/catalog.ts +51 -51
- package/src/resources/catalog/index.ts +5 -5
- package/src/resources/catalog/item-categories/actions.ts +112 -0
- package/src/resources/catalog/item-categories/index.ts +7 -0
- package/src/resources/catalog/item-categories/item-categories.ts +18 -0
- package/src/resources/catalog/items/items.ts +1 -1
- package/src/resources/catalog/materials/actions.ts +141 -0
- package/src/resources/catalog/materials/index.ts +22 -0
- package/src/resources/catalog/materials/materials.ts +633 -0
- package/src/resources/catalog/materials.ts +1 -611
- package/src/resources/catalog/parts/actions.ts +129 -0
- package/src/resources/catalog/parts/index.ts +20 -0
- package/src/resources/catalog/parts/parts.ts +476 -0
- package/src/resources/catalog/parts.ts +1 -454
- package/src/resources/catalog/product-lines/actions.ts +97 -0
- package/src/resources/catalog/product-lines/index.ts +21 -0
- package/src/resources/catalog/product-lines/product-lines.ts +552 -0
- package/src/resources/catalog/product-lines.ts +1 -532
- package/src/resources/catalog/products/actions.ts +148 -0
- package/src/resources/catalog/products/index.ts +22 -0
- package/src/resources/catalog/products/products.ts +816 -0
- package/src/resources/catalog/products.ts +1 -794
- package/src/resources/catalog/properties/actions.ts +102 -0
- package/src/resources/catalog/properties/index.ts +7 -0
- package/src/resources/catalog/properties/properties.ts +18 -0
- package/src/resources/catalog/unit-groups/actions.ts +139 -0
- package/src/resources/catalog/unit-groups/index.ts +8 -0
- package/src/resources/catalog/unit-groups/unit-groups.ts +25 -5
- package/src/resources/catalog/units/actions.ts +110 -0
- package/src/resources/catalog/units/index.ts +20 -0
- package/src/resources/catalog/units/units.ts +547 -0
- package/src/resources/catalog/units.ts +1 -532
- package/src/resources/core/audit-events.ts +8 -4
- package/src/resources/core/core.ts +17 -1
- package/src/resources/core/index.ts +9 -0
- package/src/resources/core/jobs.ts +321 -0
- package/src/resources/messaging/conversations/conversations.ts +6 -3
- package/src/resources/messaging/conversations/links.ts +4 -2
- package/src/resources/messaging/conversations/messages.ts +4 -2
- package/src/resources/messaging/notifications/notifications.ts +4 -2
- package/src/resources/operations/demand-overrides.ts +1 -1
- package/src/resources/operations/index.ts +1 -1
- package/src/resources/operations/locations/actions.ts +82 -0
- package/src/resources/operations/locations/index.ts +18 -0
- package/src/resources/operations/locations/locations.ts +344 -0
- package/src/resources/operations/locations.ts +1 -329
- package/src/resources/operations/operations.ts +11 -11
- package/src/resources/operations/scanning-stations.ts +12 -4
- package/src/resources/operations/shipping-terms.ts +1 -1
- package/src/resources/sales/customers/customers.ts +1 -1
- package/src/resources/sales/sales-orders/lines/lines.ts +2 -2
- package/src/resources/sales/sales-orders/sales-orders.ts +4 -4
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.mjs";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* View the jobs that track asynchronous work. Endpoints that answer 202 Accepted raise one and point at it with a Location header.
|
|
6
|
+
*/
|
|
7
|
+
export declare class Jobs extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Returns a job by ID — poll the job named in a `202 Accepted` response's
|
|
10
|
+
* `Location` to observe its outcome. A completed export carries the link to its
|
|
11
|
+
* file on `export.url`.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const job = await client.core.jobs.retrieve(
|
|
16
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Job>;
|
|
21
|
+
/**
|
|
22
|
+
* Cancels a job and returns it carrying its `cancelled` status. Work in flight is
|
|
23
|
+
* not interrupted but can no longer settle, and a finished job cannot be
|
|
24
|
+
* cancelled.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const job = await client.core.jobs.cancel(
|
|
29
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
30
|
+
* );
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
cancel(id: string, options?: RequestOptions): APIPromise<Job>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Records a piece of work the API accepted and carries out asynchronously.
|
|
37
|
+
* Endpoints answering `202 Accepted` point at one with a `Location` header; poll
|
|
38
|
+
* it for the outcome.
|
|
39
|
+
*/
|
|
40
|
+
export interface Job {
|
|
41
|
+
/**
|
|
42
|
+
* Job ID.
|
|
43
|
+
*/
|
|
44
|
+
id: string;
|
|
45
|
+
/**
|
|
46
|
+
* When the job was cancelled.
|
|
47
|
+
*/
|
|
48
|
+
cancelled_at: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* When the job finished processing, whether or not every row succeeded.
|
|
51
|
+
*/
|
|
52
|
+
completed_at: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* When the job was created.
|
|
55
|
+
*/
|
|
56
|
+
created_at: string;
|
|
57
|
+
/**
|
|
58
|
+
* Email of the account user who requested the work.
|
|
59
|
+
*/
|
|
60
|
+
created_by_email: string | null;
|
|
61
|
+
/**
|
|
62
|
+
* The ID of the account user who requested the work.
|
|
63
|
+
*/
|
|
64
|
+
created_by_id: string | null;
|
|
65
|
+
/**
|
|
66
|
+
* Name of the account user who requested the work.
|
|
67
|
+
*/
|
|
68
|
+
created_by_name: string | null;
|
|
69
|
+
/**
|
|
70
|
+
* Username of the account user who requested the work.
|
|
71
|
+
*/
|
|
72
|
+
created_by_username: string | null;
|
|
73
|
+
/**
|
|
74
|
+
* A one-line reason the last attempt failed.
|
|
75
|
+
*/
|
|
76
|
+
error_summary: string | null;
|
|
77
|
+
/**
|
|
78
|
+
* One entry per failure, so a `completed` job can still carry failed rows. A
|
|
79
|
+
* whole-job failure records a single entry with no `index`.
|
|
80
|
+
*/
|
|
81
|
+
errors: Array<RowError>;
|
|
82
|
+
/**
|
|
83
|
+
* Points a completed export job at the file it produced.
|
|
84
|
+
*/
|
|
85
|
+
export: JobExport | null;
|
|
86
|
+
/**
|
|
87
|
+
* When the most recent attempt failed. A retry that succeeds leaves this alongside
|
|
88
|
+
* `completed_at`.
|
|
89
|
+
*/
|
|
90
|
+
failed_at: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Resource type identifier.
|
|
93
|
+
*/
|
|
94
|
+
object: 'job';
|
|
95
|
+
/**
|
|
96
|
+
* One entry per request row that produced a resource. A bulk create records these
|
|
97
|
+
* when it accepts the request, so they stay provisional until `status` is
|
|
98
|
+
* `completed`.
|
|
99
|
+
*/
|
|
100
|
+
results: Array<JobResult>;
|
|
101
|
+
/**
|
|
102
|
+
* When the job began executing.
|
|
103
|
+
*/
|
|
104
|
+
started_at: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* How far the job has got. `completed` means the work was processed, not that
|
|
107
|
+
* every row succeeded — read `errors`.
|
|
108
|
+
*/
|
|
109
|
+
status: 'created' | 'started' | 'completed' | 'failed' | 'cancelled';
|
|
110
|
+
/**
|
|
111
|
+
* The kind of work the job carries out.
|
|
112
|
+
*/
|
|
113
|
+
type: 'bulkcreate' | 'bulkupsert' | 'export';
|
|
114
|
+
/**
|
|
115
|
+
* When the job was last updated.
|
|
116
|
+
*/
|
|
117
|
+
updated_at: string;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Points a completed export job at the file it produced.
|
|
121
|
+
*/
|
|
122
|
+
export interface JobExport {
|
|
123
|
+
/**
|
|
124
|
+
* Presigned link to the file, valid for five minutes — read the job again for a
|
|
125
|
+
* fresh one. It carries its own authorization, so treat it as a credential: do not
|
|
126
|
+
* log it, store it, or pass it on.
|
|
127
|
+
*/
|
|
128
|
+
url: string;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Accounts for one request row that produced a resource. With `errors`, also
|
|
132
|
+
* row-indexed, every submitted row lands in exactly one of the two once the job
|
|
133
|
+
* completes.
|
|
134
|
+
*/
|
|
135
|
+
export interface JobResult {
|
|
136
|
+
/**
|
|
137
|
+
* ID of the resource this row produced.
|
|
138
|
+
*/
|
|
139
|
+
id: string;
|
|
140
|
+
/**
|
|
141
|
+
* Whether the resource was created or updated.
|
|
142
|
+
*/
|
|
143
|
+
action: 'created' | 'updated';
|
|
144
|
+
/**
|
|
145
|
+
* Zero-based row of the request this result names.
|
|
146
|
+
*/
|
|
147
|
+
index: number;
|
|
148
|
+
/**
|
|
149
|
+
* Resources created alongside this row's own resource — for a bulk production run
|
|
150
|
+
* create, the ids of its batches. Omitted for operations that produce none.
|
|
151
|
+
*/
|
|
152
|
+
sub_resource_ids?: Array<string>;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* QuotaInfo provides machine-readable details about a plan-imposed resource limit.
|
|
156
|
+
* Included in limit_exceeded errors so clients can display upgrade prompts, usage
|
|
157
|
+
* bars, or implement programmatic retry/backoff logic.
|
|
158
|
+
*/
|
|
159
|
+
export interface QuotaInfo {
|
|
160
|
+
/**
|
|
161
|
+
* Limit is the maximum number of resources allowed by the current plan.
|
|
162
|
+
*/
|
|
163
|
+
limit: number;
|
|
164
|
+
/**
|
|
165
|
+
* ResetAt is the time when the quota resets, if applicable. Nil for static
|
|
166
|
+
* (non-metered) limits.
|
|
167
|
+
*/
|
|
168
|
+
reset_at: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Used is the number of resources currently consumed.
|
|
171
|
+
*/
|
|
172
|
+
used: number;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* ResponseError is the JSON-serializable error body returned to API clients. It
|
|
176
|
+
* contains only public information. This struct is used by the OpenAPI schema
|
|
177
|
+
* generator to produce documentation.
|
|
178
|
+
*/
|
|
179
|
+
export interface ResponseError {
|
|
180
|
+
/**
|
|
181
|
+
* A machine-readable code for the error.
|
|
182
|
+
*/
|
|
183
|
+
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';
|
|
184
|
+
/**
|
|
185
|
+
* A URL to documentation about the error.
|
|
186
|
+
*/
|
|
187
|
+
doc_url: string | null;
|
|
188
|
+
/**
|
|
189
|
+
* Whether this error is transient and the request can be retried.
|
|
190
|
+
*/
|
|
191
|
+
is_transient: boolean;
|
|
192
|
+
/**
|
|
193
|
+
* A human-readable message providing more details about the error.
|
|
194
|
+
*/
|
|
195
|
+
message: string;
|
|
196
|
+
/**
|
|
197
|
+
* The parameter that caused the error, if applicable.
|
|
198
|
+
*/
|
|
199
|
+
param: string | null;
|
|
200
|
+
/**
|
|
201
|
+
* QuotaInfo provides machine-readable details about a plan-imposed resource limit.
|
|
202
|
+
* Included in limit_exceeded errors so clients can display upgrade prompts, usage
|
|
203
|
+
* bars, or implement programmatic retry/backoff logic.
|
|
204
|
+
*/
|
|
205
|
+
quota: QuotaInfo | null;
|
|
206
|
+
/**
|
|
207
|
+
* RequestLogURL is a link to the dashboard page for this request's log entry. Nil
|
|
208
|
+
* when no request log is available.
|
|
209
|
+
*/
|
|
210
|
+
request_log_url: string | null;
|
|
211
|
+
/**
|
|
212
|
+
* The type of error.
|
|
213
|
+
*/
|
|
214
|
+
type: 'api_error' | 'idempotency_error' | 'invalid_request_error';
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* pairs one row of a bulk request with the failure it produced; a failure of the
|
|
218
|
+
* request as a whole carries no index
|
|
219
|
+
*/
|
|
220
|
+
export interface RowError {
|
|
221
|
+
/**
|
|
222
|
+
* ResponseError is the JSON-serializable error body returned to API clients. It
|
|
223
|
+
* contains only public information. This struct is used by the OpenAPI schema
|
|
224
|
+
* generator to produce documentation.
|
|
225
|
+
*/
|
|
226
|
+
error: ResponseError;
|
|
227
|
+
/**
|
|
228
|
+
* Zero-based row of the request this failure names. Absent for a failure of the
|
|
229
|
+
* whole request.
|
|
230
|
+
*/
|
|
231
|
+
index?: number;
|
|
232
|
+
}
|
|
233
|
+
export declare namespace Jobs {
|
|
234
|
+
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, };
|
|
235
|
+
}
|
|
236
|
+
//# sourceMappingURL=jobs.d.mts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,236 @@
|
|
|
1
|
+
import { APIResource } from "../../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../../internal/request-options.js";
|
|
4
|
+
/**
|
|
5
|
+
* View the jobs that track asynchronous work. Endpoints that answer 202 Accepted raise one and point at it with a Location header.
|
|
6
|
+
*/
|
|
7
|
+
export declare class Jobs extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Returns a job by ID — poll the job named in a `202 Accepted` response's
|
|
10
|
+
* `Location` to observe its outcome. A completed export carries the link to its
|
|
11
|
+
* file on `export.url`.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const job = await client.core.jobs.retrieve(
|
|
16
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<Job>;
|
|
21
|
+
/**
|
|
22
|
+
* Cancels a job and returns it carrying its `cancelled` status. Work in flight is
|
|
23
|
+
* not interrupted but can no longer settle, and a finished job cannot be
|
|
24
|
+
* cancelled.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const job = await client.core.jobs.cancel(
|
|
29
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
30
|
+
* );
|
|
31
|
+
* ```
|
|
32
|
+
*/
|
|
33
|
+
cancel(id: string, options?: RequestOptions): APIPromise<Job>;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* Records a piece of work the API accepted and carries out asynchronously.
|
|
37
|
+
* Endpoints answering `202 Accepted` point at one with a `Location` header; poll
|
|
38
|
+
* it for the outcome.
|
|
39
|
+
*/
|
|
40
|
+
export interface Job {
|
|
41
|
+
/**
|
|
42
|
+
* Job ID.
|
|
43
|
+
*/
|
|
44
|
+
id: string;
|
|
45
|
+
/**
|
|
46
|
+
* When the job was cancelled.
|
|
47
|
+
*/
|
|
48
|
+
cancelled_at: string | null;
|
|
49
|
+
/**
|
|
50
|
+
* When the job finished processing, whether or not every row succeeded.
|
|
51
|
+
*/
|
|
52
|
+
completed_at: string | null;
|
|
53
|
+
/**
|
|
54
|
+
* When the job was created.
|
|
55
|
+
*/
|
|
56
|
+
created_at: string;
|
|
57
|
+
/**
|
|
58
|
+
* Email of the account user who requested the work.
|
|
59
|
+
*/
|
|
60
|
+
created_by_email: string | null;
|
|
61
|
+
/**
|
|
62
|
+
* The ID of the account user who requested the work.
|
|
63
|
+
*/
|
|
64
|
+
created_by_id: string | null;
|
|
65
|
+
/**
|
|
66
|
+
* Name of the account user who requested the work.
|
|
67
|
+
*/
|
|
68
|
+
created_by_name: string | null;
|
|
69
|
+
/**
|
|
70
|
+
* Username of the account user who requested the work.
|
|
71
|
+
*/
|
|
72
|
+
created_by_username: string | null;
|
|
73
|
+
/**
|
|
74
|
+
* A one-line reason the last attempt failed.
|
|
75
|
+
*/
|
|
76
|
+
error_summary: string | null;
|
|
77
|
+
/**
|
|
78
|
+
* One entry per failure, so a `completed` job can still carry failed rows. A
|
|
79
|
+
* whole-job failure records a single entry with no `index`.
|
|
80
|
+
*/
|
|
81
|
+
errors: Array<RowError>;
|
|
82
|
+
/**
|
|
83
|
+
* Points a completed export job at the file it produced.
|
|
84
|
+
*/
|
|
85
|
+
export: JobExport | null;
|
|
86
|
+
/**
|
|
87
|
+
* When the most recent attempt failed. A retry that succeeds leaves this alongside
|
|
88
|
+
* `completed_at`.
|
|
89
|
+
*/
|
|
90
|
+
failed_at: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Resource type identifier.
|
|
93
|
+
*/
|
|
94
|
+
object: 'job';
|
|
95
|
+
/**
|
|
96
|
+
* One entry per request row that produced a resource. A bulk create records these
|
|
97
|
+
* when it accepts the request, so they stay provisional until `status` is
|
|
98
|
+
* `completed`.
|
|
99
|
+
*/
|
|
100
|
+
results: Array<JobResult>;
|
|
101
|
+
/**
|
|
102
|
+
* When the job began executing.
|
|
103
|
+
*/
|
|
104
|
+
started_at: string | null;
|
|
105
|
+
/**
|
|
106
|
+
* How far the job has got. `completed` means the work was processed, not that
|
|
107
|
+
* every row succeeded — read `errors`.
|
|
108
|
+
*/
|
|
109
|
+
status: 'created' | 'started' | 'completed' | 'failed' | 'cancelled';
|
|
110
|
+
/**
|
|
111
|
+
* The kind of work the job carries out.
|
|
112
|
+
*/
|
|
113
|
+
type: 'bulkcreate' | 'bulkupsert' | 'export';
|
|
114
|
+
/**
|
|
115
|
+
* When the job was last updated.
|
|
116
|
+
*/
|
|
117
|
+
updated_at: string;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Points a completed export job at the file it produced.
|
|
121
|
+
*/
|
|
122
|
+
export interface JobExport {
|
|
123
|
+
/**
|
|
124
|
+
* Presigned link to the file, valid for five minutes — read the job again for a
|
|
125
|
+
* fresh one. It carries its own authorization, so treat it as a credential: do not
|
|
126
|
+
* log it, store it, or pass it on.
|
|
127
|
+
*/
|
|
128
|
+
url: string;
|
|
129
|
+
}
|
|
130
|
+
/**
|
|
131
|
+
* Accounts for one request row that produced a resource. With `errors`, also
|
|
132
|
+
* row-indexed, every submitted row lands in exactly one of the two once the job
|
|
133
|
+
* completes.
|
|
134
|
+
*/
|
|
135
|
+
export interface JobResult {
|
|
136
|
+
/**
|
|
137
|
+
* ID of the resource this row produced.
|
|
138
|
+
*/
|
|
139
|
+
id: string;
|
|
140
|
+
/**
|
|
141
|
+
* Whether the resource was created or updated.
|
|
142
|
+
*/
|
|
143
|
+
action: 'created' | 'updated';
|
|
144
|
+
/**
|
|
145
|
+
* Zero-based row of the request this result names.
|
|
146
|
+
*/
|
|
147
|
+
index: number;
|
|
148
|
+
/**
|
|
149
|
+
* Resources created alongside this row's own resource — for a bulk production run
|
|
150
|
+
* create, the ids of its batches. Omitted for operations that produce none.
|
|
151
|
+
*/
|
|
152
|
+
sub_resource_ids?: Array<string>;
|
|
153
|
+
}
|
|
154
|
+
/**
|
|
155
|
+
* QuotaInfo provides machine-readable details about a plan-imposed resource limit.
|
|
156
|
+
* Included in limit_exceeded errors so clients can display upgrade prompts, usage
|
|
157
|
+
* bars, or implement programmatic retry/backoff logic.
|
|
158
|
+
*/
|
|
159
|
+
export interface QuotaInfo {
|
|
160
|
+
/**
|
|
161
|
+
* Limit is the maximum number of resources allowed by the current plan.
|
|
162
|
+
*/
|
|
163
|
+
limit: number;
|
|
164
|
+
/**
|
|
165
|
+
* ResetAt is the time when the quota resets, if applicable. Nil for static
|
|
166
|
+
* (non-metered) limits.
|
|
167
|
+
*/
|
|
168
|
+
reset_at: string | null;
|
|
169
|
+
/**
|
|
170
|
+
* Used is the number of resources currently consumed.
|
|
171
|
+
*/
|
|
172
|
+
used: number;
|
|
173
|
+
}
|
|
174
|
+
/**
|
|
175
|
+
* ResponseError is the JSON-serializable error body returned to API clients. It
|
|
176
|
+
* contains only public information. This struct is used by the OpenAPI schema
|
|
177
|
+
* generator to produce documentation.
|
|
178
|
+
*/
|
|
179
|
+
export interface ResponseError {
|
|
180
|
+
/**
|
|
181
|
+
* A machine-readable code for the error.
|
|
182
|
+
*/
|
|
183
|
+
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';
|
|
184
|
+
/**
|
|
185
|
+
* A URL to documentation about the error.
|
|
186
|
+
*/
|
|
187
|
+
doc_url: string | null;
|
|
188
|
+
/**
|
|
189
|
+
* Whether this error is transient and the request can be retried.
|
|
190
|
+
*/
|
|
191
|
+
is_transient: boolean;
|
|
192
|
+
/**
|
|
193
|
+
* A human-readable message providing more details about the error.
|
|
194
|
+
*/
|
|
195
|
+
message: string;
|
|
196
|
+
/**
|
|
197
|
+
* The parameter that caused the error, if applicable.
|
|
198
|
+
*/
|
|
199
|
+
param: string | null;
|
|
200
|
+
/**
|
|
201
|
+
* QuotaInfo provides machine-readable details about a plan-imposed resource limit.
|
|
202
|
+
* Included in limit_exceeded errors so clients can display upgrade prompts, usage
|
|
203
|
+
* bars, or implement programmatic retry/backoff logic.
|
|
204
|
+
*/
|
|
205
|
+
quota: QuotaInfo | null;
|
|
206
|
+
/**
|
|
207
|
+
* RequestLogURL is a link to the dashboard page for this request's log entry. Nil
|
|
208
|
+
* when no request log is available.
|
|
209
|
+
*/
|
|
210
|
+
request_log_url: string | null;
|
|
211
|
+
/**
|
|
212
|
+
* The type of error.
|
|
213
|
+
*/
|
|
214
|
+
type: 'api_error' | 'idempotency_error' | 'invalid_request_error';
|
|
215
|
+
}
|
|
216
|
+
/**
|
|
217
|
+
* pairs one row of a bulk request with the failure it produced; a failure of the
|
|
218
|
+
* request as a whole carries no index
|
|
219
|
+
*/
|
|
220
|
+
export interface RowError {
|
|
221
|
+
/**
|
|
222
|
+
* ResponseError is the JSON-serializable error body returned to API clients. It
|
|
223
|
+
* contains only public information. This struct is used by the OpenAPI schema
|
|
224
|
+
* generator to produce documentation.
|
|
225
|
+
*/
|
|
226
|
+
error: ResponseError;
|
|
227
|
+
/**
|
|
228
|
+
* Zero-based row of the request this failure names. Absent for a failure of the
|
|
229
|
+
* whole request.
|
|
230
|
+
*/
|
|
231
|
+
index?: number;
|
|
232
|
+
}
|
|
233
|
+
export declare namespace Jobs {
|
|
234
|
+
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, };
|
|
235
|
+
}
|
|
236
|
+
//# sourceMappingURL=jobs.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Jobs = void 0;
|
|
5
|
+
const resource_1 = require("../../core/resource.js");
|
|
6
|
+
const path_1 = require("../../internal/utils/path.js");
|
|
7
|
+
/**
|
|
8
|
+
* View the jobs that track asynchronous work. Endpoints that answer 202 Accepted raise one and point at it with a Location header.
|
|
9
|
+
*/
|
|
10
|
+
class Jobs extends resource_1.APIResource {
|
|
11
|
+
/**
|
|
12
|
+
* Returns a job by ID — poll the job named in a `202 Accepted` response's
|
|
13
|
+
* `Location` to observe its outcome. A completed export carries the link to its
|
|
14
|
+
* file on `export.url`.
|
|
15
|
+
*
|
|
16
|
+
* @example
|
|
17
|
+
* ```ts
|
|
18
|
+
* const job = await client.core.jobs.retrieve(
|
|
19
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
20
|
+
* );
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
retrieve(id, options) {
|
|
24
|
+
return this._client.get((0, path_1.path) `/v1/core/jobs/${id}`, options);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Cancels a job and returns it carrying its `cancelled` status. Work in flight is
|
|
28
|
+
* not interrupted but can no longer settle, and a finished job cannot be
|
|
29
|
+
* cancelled.
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* const job = await client.core.jobs.cancel(
|
|
34
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
35
|
+
* );
|
|
36
|
+
* ```
|
|
37
|
+
*/
|
|
38
|
+
cancel(id, options) {
|
|
39
|
+
return this._client.post((0, path_1.path) `/v1/core/jobs/${id}/cancel`, options);
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
exports.Jobs = Jobs;
|
|
43
|
+
//# sourceMappingURL=jobs.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../src/resources/core/jobs.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAGlD,uDAAiD;AAEjD;;GAEG;AACH,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAA,WAAI,EAAA,iBAAiB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF;AAhCD,oBAgCC"}
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../../core/resource.mjs";
|
|
3
|
+
import { path } from "../../internal/utils/path.mjs";
|
|
4
|
+
/**
|
|
5
|
+
* View the jobs that track asynchronous work. Endpoints that answer 202 Accepted raise one and point at it with a Location header.
|
|
6
|
+
*/
|
|
7
|
+
export class Jobs extends APIResource {
|
|
8
|
+
/**
|
|
9
|
+
* Returns a job by ID — poll the job named in a `202 Accepted` response's
|
|
10
|
+
* `Location` to observe its outcome. A completed export carries the link to its
|
|
11
|
+
* file on `export.url`.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const job = await client.core.jobs.retrieve(
|
|
16
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
17
|
+
* );
|
|
18
|
+
* ```
|
|
19
|
+
*/
|
|
20
|
+
retrieve(id, options) {
|
|
21
|
+
return this._client.get(path `/v1/core/jobs/${id}`, options);
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Cancels a job and returns it carrying its `cancelled` status. Work in flight is
|
|
25
|
+
* not interrupted but can no longer settle, and a finished job cannot be
|
|
26
|
+
* cancelled.
|
|
27
|
+
*
|
|
28
|
+
* @example
|
|
29
|
+
* ```ts
|
|
30
|
+
* const job = await client.core.jobs.cancel(
|
|
31
|
+
* 'jb_01k0a5smf9ekb8rqg1',
|
|
32
|
+
* );
|
|
33
|
+
* ```
|
|
34
|
+
*/
|
|
35
|
+
cancel(id, options) {
|
|
36
|
+
return this._client.post(path `/v1/core/jobs/${id}/cancel`, options);
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
//# sourceMappingURL=jobs.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"jobs.mjs","sourceRoot":"","sources":["../../src/resources/core/jobs.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,IAAI,EAAE;AAEf;;GAEG;AACH,MAAM,OAAO,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;OAWG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,iBAAiB,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,iBAAiB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;CACF"}
|