ultracart_api 4.1.105 → 4.1.109

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99d889cd177dc8e0a96e68da4a19732c8c89a77116223ce7b2e5e0767050e60a
-  data.tar.gz: 87da67a5c30f8f96347967721d57896331a06a9675e7fe7e2d5b5eeba83dd53d
+  metadata.gz: 071a2350e3bd48bb2f14f0199f4dc7bf0ae3733e506d89a252eeaae422c2cc44
+  data.tar.gz: 1490837ec8c94afddc7a0a084a9a5a5d851fef6d77b0452430d4f91235b435f6
 SHA512:
-  metadata.gz: 350e2d6687f64530bda6bc13a388a59ae80dc4a89b29d47073f05ac39ff86a11db218d41fb371242e32401cd6374280c43459ed474ff5e4aa9a88d7544662b73
-  data.tar.gz: 58115e72c24cfd8d78791281c4557333f11032cbade89170a598c085da3bdcd0bc4ece179035083a32629d810e70ade716dc0e65d5b022ee57b6cdcd8b39754f
+  metadata.gz: bd8c96724564468c45f276ce2ff6b1ee07047c4fc34d989f3ec398b3fb520666ce8ac6acda0f6a059d6dc0f7967d6245da8472b697d97ed96701522ce17e8c7e
+  data.tar.gz: 0a769e3a330a708d6af9027e569d9cc23507a91e4535b9ce37c040769545701fd6ef8a02dc285f4153f3c60176bfbffd93d7a34ac8e3eaa47eac1955374ce2f4

data/README.md

@@ -7,7 +7,7 @@ Note: Every method has a sample for every language.  See https://github.com/Ultr
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.1.105
+- Package version: 4.1.109
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
 gemfile:
 
 ```shell
-gem 'ultracart_api', '4.1.105'
+gem 'ultracart_api', '4.1.109'
 ```
 
 install:
@@ -106,6 +106,12 @@ Class | Method | HTTP request | Description
 *UltracartClient::AutoOrderApi* | [**update_auto_order_item_properties**](docs/AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties
 *UltracartClient::AutoOrderApi* | [**update_auto_order_properties**](docs/AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties
 *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
+*UltracartClient::BulkApi* | [**bulk_cancel_job**](docs/BulkApi.md#bulk_cancel_job) | **DELETE** /bulk/{object}/{job_id} | Request cancellation of a bulk job
+*UltracartClient::BulkApi* | [**bulk_generate_upload_url**](docs/BulkApi.md#bulk_generate_upload_url) | **POST** /bulk/{object}/upload-url | Generate a presigned upload URL for a bulk payload
+*UltracartClient::BulkApi* | [**bulk_get_job**](docs/BulkApi.md#bulk_get_job) | **GET** /bulk/{object}/{job_id} | Retrieve a bulk job's status and counts
+*UltracartClient::BulkApi* | [**bulk_get_job_records**](docs/BulkApi.md#bulk_get_job_records) | **GET** /bulk/{object}/{job_id}/records | Paginate a bulk job's per-record results
+*UltracartClient::BulkApi* | [**bulk_list_jobs**](docs/BulkApi.md#bulk_list_jobs) | **GET** /bulk/{object} | List bulk jobs for the calling merchant
+*UltracartClient::BulkApi* | [**bulk_submit_job**](docs/BulkApi.md#bulk_submit_job) | **POST** /bulk/{object} | Submit a bulk job
 *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
 *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_ultra_cart_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
 *UltracartClient::ChannelPartnerApi* | [**delete_channel_partner_ship_to_preference**](docs/ChannelPartnerApi.md#delete_channel_partner_ship_to_preference) | **DELETE** /channel_partner/channel_partners/{channel_partner_oid}/ship_to_preferences/{channel_partner_ship_to_preference_oid} | Delete a ship to preference record for the channel partner.
@@ -761,6 +767,13 @@ Class | Method | HTTP request | Description
  - [UltracartClient::BrowserDevice](docs/BrowserDevice.md)
  - [UltracartClient::BrowserOS](docs/BrowserOS.md)
  - [UltracartClient::BrowserUserAgent](docs/BrowserUserAgent.md)
+ - [UltracartClient::BulkJob](docs/BulkJob.md)
+ - [UltracartClient::BulkJobRequest](docs/BulkJobRequest.md)
+ - [UltracartClient::BulkJobResponse](docs/BulkJobResponse.md)
+ - [UltracartClient::BulkJobsResponse](docs/BulkJobsResponse.md)
+ - [UltracartClient::BulkRecord](docs/BulkRecord.md)
+ - [UltracartClient::BulkRecordsResponse](docs/BulkRecordsResponse.md)
+ - [UltracartClient::BulkUploadUrlResponse](docs/BulkUploadUrlResponse.md)
  - [UltracartClient::Cart](docs/Cart.md)
  - [UltracartClient::CartAffiliate](docs/CartAffiliate.md)
  - [UltracartClient::CartAffirmCheckoutResponse](docs/CartAffirmCheckoutResponse.md)
@@ -1793,6 +1806,10 @@ 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 |
 | 4.1.103 | 06/18/2026 | affiliate api alpha |

data/docs/BulkApi.md

@@ -0,0 +1,335 @@
+# UltracartClient::BulkApi
+
+All URIs are relative to *https://secure.ultracart.com/rest/v2*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**bulk_cancel_job**](BulkApi.md#bulk_cancel_job) | **DELETE** /bulk/{object}/{job_id} | Request cancellation of a bulk job |
+| [**bulk_generate_upload_url**](BulkApi.md#bulk_generate_upload_url) | **POST** /bulk/{object}/upload-url | Generate a presigned upload URL for a bulk payload |
+| [**bulk_get_job**](BulkApi.md#bulk_get_job) | **GET** /bulk/{object}/{job_id} | Retrieve a bulk job's status and counts |
+| [**bulk_get_job_records**](BulkApi.md#bulk_get_job_records) | **GET** /bulk/{object}/{job_id}/records | Paginate a bulk job's per-record results |
+| [**bulk_list_jobs**](BulkApi.md#bulk_list_jobs) | **GET** /bulk/{object} | List bulk jobs for the calling merchant |
+| [**bulk_submit_job**](BulkApi.md#bulk_submit_job) | **POST** /bulk/{object} | Submit a bulk job |
+
+
+## bulk_cancel_job
+
+> bulk_cancel_job(object, job_id)
+
+Request cancellation of a bulk job
+
+Queued jobs cancel immediately (200). In-progress jobs finalize as cancelled between records (202); already-processed records stand. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the bulk_cancel_job_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> bulk_cancel_job_with_http_info(object, job_id)
+
+```ruby
+begin
+  # Request cancellation of a bulk job
+  data, status_code, headers = api_instance.bulk_cancel_job_with_http_info(object, job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue UltracartClient::ApiError => e
+  puts "Error when calling BulkApi->bulk_cancel_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | Object type |  |
+| **job_id** | **String** | The bulk job id |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bulk_generate_upload_url
+
+> <BulkUploadUrlResponse> bulk_generate_upload_url(object)
+
+Generate a presigned upload URL for a bulk payload
+
+Returns a presigned S3 PUT URL the merchant uploads NDJSON to, plus the s3_key to pass to submit. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the bulk_generate_upload_url_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkUploadUrlResponse>, Integer, Hash)> bulk_generate_upload_url_with_http_info(object)
+
+```ruby
+begin
+  # Generate a presigned upload URL for a bulk payload
+  data, status_code, headers = api_instance.bulk_generate_upload_url_with_http_info(object)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkUploadUrlResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling BulkApi->bulk_generate_upload_url_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | Object type |  |
+
+### Return type
+
+[**BulkUploadUrlResponse**](BulkUploadUrlResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bulk_get_job
+
+> <BulkJobResponse> bulk_get_job(object, job_id)
+
+Retrieve a bulk job's status and counts
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the bulk_get_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkJobResponse>, Integer, Hash)> bulk_get_job_with_http_info(object, job_id)
+
+```ruby
+begin
+  # Retrieve a bulk job's status and counts
+  data, status_code, headers = api_instance.bulk_get_job_with_http_info(object, job_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkJobResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling BulkApi->bulk_get_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | Object type |  |
+| **job_id** | **String** | The bulk job id |  |
+
+### Return type
+
+[**BulkJobResponse**](BulkJobResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bulk_get_job_records
+
+> <BulkRecordsResponse> bulk_get_job_records(object, job_id, opts)
+
+Paginate a bulk job's per-record results
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the bulk_get_job_records_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkRecordsResponse>, Integer, Hash)> bulk_get_job_records_with_http_info(object, job_id, opts)
+
+```ruby
+begin
+  # Paginate a bulk job's per-record results
+  data, status_code, headers = api_instance.bulk_get_job_records_with_http_info(object, job_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkRecordsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling BulkApi->bulk_get_job_records_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | Object type |  |
+| **job_id** | **String** | The bulk job id |  |
+| **status** | **String** | Filter by per-record result status (success, failed, duplicate) | [optional] |
+| **cursor** | **String** | Opaque pagination cursor | [optional] |
+| **limit** | **Integer** | Page size (default 100, max 1000) | [optional] |
+
+### Return type
+
+[**BulkRecordsResponse**](BulkRecordsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bulk_list_jobs
+
+> <BulkJobsResponse> bulk_list_jobs(object, opts)
+
+List bulk jobs for the calling merchant
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the bulk_list_jobs_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkJobsResponse>, Integer, Hash)> bulk_list_jobs_with_http_info(object, opts)
+
+```ruby
+begin
+  # List bulk jobs for the calling merchant
+  data, status_code, headers = api_instance.bulk_list_jobs_with_http_info(object, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkJobsResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling BulkApi->bulk_list_jobs_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | Object type |  |
+| **status** | **String** | Filter by job status | [optional] |
+| **cursor** | **String** | Opaque pagination cursor | [optional] |
+| **limit** | **Integer** | Page size (default 100, max 1000) | [optional] |
+
+### Return type
+
+[**BulkJobsResponse**](BulkJobsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## bulk_submit_job
+
+> <BulkJobResponse> bulk_submit_job(object, bulk_job)
+
+Submit a bulk job
+
+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. 
+
+
+### Examples
+
+
+(No example for this operation).
+
+
+#### Using the bulk_submit_job_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BulkJobResponse>, Integer, Hash)> bulk_submit_job_with_http_info(object, bulk_job)
+
+```ruby
+begin
+  # Submit a bulk job
+  data, status_code, headers = api_instance.bulk_submit_job_with_http_info(object, bulk_job)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BulkJobResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling BulkApi->bulk_submit_job_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **object** | **String** | Object type |  |
+| **bulk_job** | [**BulkJobRequest**](BulkJobRequest.md) | Bulk job submission |  |
+
+### Return type
+
+[**BulkJobResponse**](BulkJobResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json; charset=UTF-8
+- **Accept**: application/json
+

data/docs/BulkJob.md

@@ -0,0 +1,46 @@
+# UltracartClient::BulkJob
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **completed_at** | **String** | When the job reached a terminal status | [optional] |
+| **duplicate_count** | **Integer** | Records short-circuited as duplicates | [optional] |
+| **error_code** | **String** | Job-level failure code when status is failed | [optional] |
+| **fail_count** | **Integer** | Records that failed | [optional] |
+| **job_id** | **String** | Public-facing job id (uc-bulk-<ulid>) | [optional] |
+| **object** | **String** | Object type this job processes | [optional] |
+| **operation** | **String** | Mutation mode this job runs (the bulk surface is write-only) | [optional] |
+| **processed_records** | **Integer** | Records processed so far | [optional] |
+| **queue_position** | **Integer** | Position behind the merchant's active job (queued jobs only) | [optional] |
+| **results_summary_url** | **String** | Presigned S3 URL to the full per-record results NDJSON (set when finished) | [optional] |
+| **started_at** | **String** | When the worker started the job | [optional] |
+| **status** | **String** | Job status | [optional] |
+| **submitted_at** | **String** | When the job was submitted | [optional] |
+| **success_count** | **Integer** | Records that landed | [optional] |
+| **total_records** | **Integer** | Total records counted on the first pass (null until counted) | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::BulkJob.new(
+  completed_at: null,
+  duplicate_count: null,
+  error_code: null,
+  fail_count: null,
+  job_id: null,
+  object: null,
+  operation: null,
+  processed_records: null,
+  queue_position: null,
+  results_summary_url: null,
+  started_at: null,
+  status: null,
+  submitted_at: null,
+  success_count: null,
+  total_records: null
+)
+```
+

data/docs/BulkJobRequest.md

@@ -0,0 +1,24 @@
+# UltracartClient::BulkJobRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operation** | **String** | Mutation mode - insert (create only) or upsert (create or update). Defaults to insert. This is always a mutation verb — the bulk surface writes only and has no read / query mode. upsert is currently supported for customer only. | [optional] |
+| **s3_key** | **String** | The s3_key returned by the upload-url endpoint | [optional] |
+| **webhook_secret** | **String** | Optional shared secret echoed in the completion POST's Authorization header | [optional] |
+| **webhook_url** | **String** | Optional URL to POST once, on completion | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::BulkJobRequest.new(
+  operation: null,
+  s3_key: null,
+  webhook_secret: null,
+  webhook_url: null
+)
+```
+

data/docs/BulkJobResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::BulkJobResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_job** | [**BulkJob**](BulkJob.md) |  | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::BulkJobResponse.new(
+  bulk_job: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/BulkJobsResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::BulkJobsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bulk_jobs** | [**Array<BulkJob>**](BulkJob.md) | Bulk jobs | [optional] |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **next_cursor** | **String** | Opaque cursor for the next page, null when exhausted | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::BulkJobsResponse.new(
+  bulk_jobs: null,
+  error: null,
+  metadata: null,
+  next_cursor: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/BulkRecord.md

@@ -0,0 +1,30 @@
+# UltracartClient::BulkRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **action** | **String** | On an upsert success, whether the record was inserted or updated | [optional] |
+| **error_code** | **String** | Error code on a failed record | [optional] |
+| **error_message** | **String** | Human-readable detail on a failed record | [optional] |
+| **line_number** | **Integer** | Original NDJSON line number | [optional] |
+| **merchant_record_id** | **String** | The merchant-supplied dedupe key for this record | [optional] |
+| **status** | **String** | Per-record verdict | [optional] |
+| **uc_id** | **String** | UltraCart-side id created on success or matched on duplicate | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::BulkRecord.new(
+  action: null,
+  error_code: null,
+  error_message: null,
+  line_number: null,
+  merchant_record_id: null,
+  status: null,
+  uc_id: null
+)
+```
+

data/docs/BulkRecordsResponse.md

@@ -0,0 +1,28 @@
+# UltracartClient::BulkRecordsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **next_cursor** | **String** | Opaque cursor for the next page, null when exhausted | [optional] |
+| **records** | [**Array<BulkRecord>**](BulkRecord.md) | Per-record results | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::BulkRecordsResponse.new(
+  error: null,
+  metadata: null,
+  next_cursor: null,
+  records: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/BulkUploadUrlResponse.md

@@ -0,0 +1,32 @@
+# UltracartClient::BulkUploadUrlResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **expires_at** | **String** | When the presigned URL expires | [optional] |
+| **max_records** | **Integer** | Per-job record cap | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **s3_key** | **String** | Opaque reference to pass back on POST /rest/v2/bulk/{object} | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **upload_url** | **String** | Presigned S3 PUT URL (short-lived) | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::BulkUploadUrlResponse.new(
+  error: null,
+  expires_at: null,
+  max_records: null,
+  metadata: null,
+  s3_key: null,
+  success: null,
+  upload_url: null,
+  warning: null
+)
+```
+