ultracart_rest_api_v2_typescript 4.1.106 → 4.1.109

package/.openapi-generator/FILES

@@ -4,6 +4,7 @@ README.md
 package.json
 src/apis/AffiliateApi.ts
 src/apis/AutoOrderApi.ts
+src/apis/BulkApi.ts
 src/apis/ChannelPartnerApi.ts
 src/apis/CheckoutApi.ts
 src/apis/ConversationApi.ts
@@ -85,6 +86,13 @@ src/models/Browser.ts
 src/models/BrowserDevice.ts
 src/models/BrowserOS.ts
 src/models/BrowserUserAgent.ts
+src/models/BulkJob.ts
+src/models/BulkJobRequest.ts
+src/models/BulkJobResponse.ts
+src/models/BulkJobsResponse.ts
+src/models/BulkRecord.ts
+src/models/BulkRecordsResponse.ts
+src/models/BulkUploadUrlResponse.ts
 src/models/Cart.ts
 src/models/CartAffiliate.ts
 src/models/CartAffirmCheckoutResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.106
+## ultracart_rest_api_v2_typescript@4.1.109
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.106 --save
+npm install ultracart_rest_api_v2_typescript@4.1.109 --save
 ```
 
 ```typescript
@@ -85,6 +85,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.109 | 07/03/2026 | bulk import endpoints (alpha) |
+| 4.1.108 | 07/03/2026 | bulk import endpoints (alpha) |
+| 4.1.107 | 07/03/2026 | bulk import endpoints (alpha) |
 | 4.1.106 | 07/03/2026 | bulk import endpoints (alpha) |
 | 4.1.105 | 07/01/2026 | conversation - updatePbxCall support additional zoho desk values |
 | 4.1.104 | 06/30/2026 | conversations - customer snapshot zoho desk tickets included |

package/dist/apis/BulkApi.d.ts

@@ -0,0 +1,199 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime';
+import { BulkJobRequest, BulkJobResponse, BulkJobsResponse, BulkRecordsResponse, BulkUploadUrlResponse } from '../models';
+export interface BulkCancelJobRequest {
+    object: string;
+    jobId: string;
+}
+export interface BulkGenerateUploadUrlRequest {
+    object: string;
+}
+export interface BulkGetJobRequest {
+    object: string;
+    jobId: string;
+}
+export interface BulkGetJobRecordsRequest {
+    object: string;
+    jobId: string;
+    status?: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface BulkListJobsRequest {
+    object: string;
+    status?: string;
+    cursor?: string;
+    limit?: number;
+}
+export interface BulkSubmitJobRequest {
+    object: string;
+    bulkJob: BulkJobRequest;
+}
+/**
+ * BulkApi - interface
+ *
+ * @export
+ * @interface BulkApiInterface
+ */
+export interface BulkApiInterface {
+    /**
+     * Queued jobs cancel immediately (200). In-progress jobs finalize as cancelled between records (202); already-processed records stand.
+     * @summary Request cancellation of a bulk job
+     * @param {string} object Object type
+     * @param {string} jobId The bulk job id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkApiInterface
+     */
+    bulkCancelJobRaw(requestParameters: BulkCancelJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Queued jobs cancel immediately (200). In-progress jobs finalize as cancelled between records (202); already-processed records stand.
+     * Request cancellation of a bulk job
+     */
+    bulkCancelJob(requestParameters: BulkCancelJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns a presigned S3 PUT URL the merchant uploads NDJSON to, plus the s3_key to pass to submit.
+     * @summary Generate a presigned upload URL for a bulk payload
+     * @param {string} object Object type
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkApiInterface
+     */
+    bulkGenerateUploadUrlRaw(requestParameters: BulkGenerateUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkUploadUrlResponse>>;
+    /**
+     * Returns a presigned S3 PUT URL the merchant uploads NDJSON to, plus the s3_key to pass to submit.
+     * Generate a presigned upload URL for a bulk payload
+     */
+    bulkGenerateUploadUrl(requestParameters: BulkGenerateUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkUploadUrlResponse>;
+    /**
+     *
+     * @summary Retrieve a bulk job\'s status and counts
+     * @param {string} object Object type
+     * @param {string} jobId The bulk job id
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkApiInterface
+     */
+    bulkGetJobRaw(requestParameters: BulkGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkJobResponse>>;
+    /**
+     * Retrieve a bulk job\'s status and counts
+     */
+    bulkGetJob(requestParameters: BulkGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkJobResponse>;
+    /**
+     *
+     * @summary Paginate a bulk job\'s per-record results
+     * @param {string} object Object type
+     * @param {string} jobId The bulk job id
+     * @param {string} [status] Filter by per-record result status (success, failed, duplicate)
+     * @param {string} [cursor] Opaque pagination cursor
+     * @param {number} [limit] Page size (default 100, max 1000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkApiInterface
+     */
+    bulkGetJobRecordsRaw(requestParameters: BulkGetJobRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkRecordsResponse>>;
+    /**
+     * Paginate a bulk job\'s per-record results
+     */
+    bulkGetJobRecords(requestParameters: BulkGetJobRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkRecordsResponse>;
+    /**
+     *
+     * @summary List bulk jobs for the calling merchant
+     * @param {string} object Object type
+     * @param {string} [status] Filter by job status
+     * @param {string} [cursor] Opaque pagination cursor
+     * @param {number} [limit] Page size (default 100, max 1000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkApiInterface
+     */
+    bulkListJobsRaw(requestParameters: BulkListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkJobsResponse>>;
+    /**
+     * List bulk jobs for the calling merchant
+     */
+    bulkListJobs(requestParameters: BulkListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkJobsResponse>;
+    /**
+     * Submits a job referencing a previously uploaded NDJSON object. One active job per merchant; additional submissions queue. The bulk surface is write-only (insert / upsert); it has no bulk read or export operation.
+     * @summary Submit a bulk job
+     * @param {string} object Object type
+     * @param {BulkJobRequest} bulkJob Bulk job submission
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkApiInterface
+     */
+    bulkSubmitJobRaw(requestParameters: BulkSubmitJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkJobResponse>>;
+    /**
+     * Submits a job referencing a previously uploaded NDJSON object. One active job per merchant; additional submissions queue. The bulk surface is write-only (insert / upsert); it has no bulk read or export operation.
+     * Submit a bulk job
+     */
+    bulkSubmitJob(requestParameters: BulkSubmitJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkJobResponse>;
+}
+/**
+ *
+ */
+export declare class BulkApi extends runtime.BaseAPI implements BulkApiInterface {
+    /**
+     * Queued jobs cancel immediately (200). In-progress jobs finalize as cancelled between records (202); already-processed records stand.
+     * Request cancellation of a bulk job
+     */
+    bulkCancelJobRaw(requestParameters: BulkCancelJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Queued jobs cancel immediately (200). In-progress jobs finalize as cancelled between records (202); already-processed records stand.
+     * Request cancellation of a bulk job
+     */
+    bulkCancelJob(requestParameters: BulkCancelJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns a presigned S3 PUT URL the merchant uploads NDJSON to, plus the s3_key to pass to submit.
+     * Generate a presigned upload URL for a bulk payload
+     */
+    bulkGenerateUploadUrlRaw(requestParameters: BulkGenerateUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkUploadUrlResponse>>;
+    /**
+     * Returns a presigned S3 PUT URL the merchant uploads NDJSON to, plus the s3_key to pass to submit.
+     * Generate a presigned upload URL for a bulk payload
+     */
+    bulkGenerateUploadUrl(requestParameters: BulkGenerateUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkUploadUrlResponse>;
+    /**
+     * Retrieve a bulk job\'s status and counts
+     */
+    bulkGetJobRaw(requestParameters: BulkGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkJobResponse>>;
+    /**
+     * Retrieve a bulk job\'s status and counts
+     */
+    bulkGetJob(requestParameters: BulkGetJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkJobResponse>;
+    /**
+     * Paginate a bulk job\'s per-record results
+     */
+    bulkGetJobRecordsRaw(requestParameters: BulkGetJobRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkRecordsResponse>>;
+    /**
+     * Paginate a bulk job\'s per-record results
+     */
+    bulkGetJobRecords(requestParameters: BulkGetJobRecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkRecordsResponse>;
+    /**
+     * List bulk jobs for the calling merchant
+     */
+    bulkListJobsRaw(requestParameters: BulkListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkJobsResponse>>;
+    /**
+     * List bulk jobs for the calling merchant
+     */
+    bulkListJobs(requestParameters: BulkListJobsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkJobsResponse>;
+    /**
+     * Submits a job referencing a previously uploaded NDJSON object. One active job per merchant; additional submissions queue. The bulk surface is write-only (insert / upsert); it has no bulk read or export operation.
+     * Submit a bulk job
+     */
+    bulkSubmitJobRaw(requestParameters: BulkSubmitJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BulkJobResponse>>;
+    /**
+     * Submits a job referencing a previously uploaded NDJSON object. One active job per merchant; additional submissions queue. The bulk surface is write-only (insert / upsert); it has no bulk read or export operation.
+     * Submit a bulk job
+     */
+    bulkSubmitJob(requestParameters: BulkSubmitJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BulkJobResponse>;
+}