api-sdk-rb 1.11.66 → 1.11.133

data/docs/UploadsApi.md

@@ -4,20 +4,20 @@ All URIs are relative to *https://api.widgetic.com/v1*
 
 | Method | HTTP request | Description |
 | ------ | ------------ | ----------- |
-| [**uploads_get_0**](UploadsApi.md#uploads_get_0) | **GET** /uploads | List the account's uploads |
-| [**uploads_id_delete_0**](UploadsApi.md#uploads_id_delete_0) | **DELETE** /uploads/{id} | Delete an upload |
-| [**uploads_id_get_0**](UploadsApi.md#uploads_id_get_0) | **GET** /uploads/{id} | Get an upload by id |
-| [**uploads_limits_get_0**](UploadsApi.md#uploads_limits_get_0) | **GET** /uploads/limits | Upload size limits and accepted file types |
-| [**uploads_post_0**](UploadsApi.md#uploads_post_0) | **POST** /uploads | Upload a file |
+| [**delete_upload**](UploadsApi.md#delete_upload) | **DELETE** /uploads/{id} | Delete an upload |
+| [**get_upload**](UploadsApi.md#get_upload) | **GET** /uploads/{id} | Get an upload by id |
+| [**get_upload_limits**](UploadsApi.md#get_upload_limits) | **GET** /uploads/limits | Upload size limits and accepted file types |
+| [**list_uploads**](UploadsApi.md#list_uploads) | **GET** /uploads | List the account's uploads |
+| [**upload_file**](UploadsApi.md#upload_file) | **POST** /uploads | Upload a file |
 
 
-## uploads_get_0
+## delete_upload
 
-> <UploadsGet200Response> uploads_get_0(opts)
+> <DeleteUpload200Response> delete_upload(id)
 
-List the account's uploads
+Delete an upload
 
-The files the account has uploaded, newest first. Deleted files are not listed. Returns at most `limit` files and has no further pages: a client that needs more narrows the list instead, for example to one managed user's files with `managedUserId` or `managedUserExternalId`. The files that visitors sent through a widget's upload adapter (`source` is `widget-visitor-upload`) are not part of this list, so that a popular widget does not push the account's own files out of it; naming one widget with `widgetId` lists what visitors sent to that widget as well. 
+Removes the stored file and the upload row. A file in Widgetic's own storage gives back the space it took from your storage allowance; a file in your own bucket is removed from your bucket. Deleting an upload that is already gone succeeds the same way as the first delete. An upload that belongs to another account is not found. If the storage cannot be reached the call fails and nothing is marked deleted, so it can be repeated. 
 
 ### Examples
 
@@ -31,36 +31,32 @@ ApiSdkRb.configure do |config|
 end
 
 api_instance = ApiSdkRb::UploadsApi.new
-opts = {
-  limit: 56, # Integer | Maximum number of files to return
-  managed_user_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | List only the files uploaded for this managed user (Widgetic's id for the user). Send this or `managedUserExternalId`, not both.
-  managed_user_external_id: 'managed_user_external_id_example' # String | List only the files uploaded for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
-}
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
 
 begin
-  # List the account's uploads
-  result = api_instance.uploads_get_0(opts)
+  # Delete an upload
+  result = api_instance.delete_upload(id)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_get_0: #{e}"
+  puts "Error when calling UploadsApi->delete_upload: #{e}"
 end
 ```
 
-#### Using the uploads_get_0_with_http_info variant
+#### Using the delete_upload_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UploadsGet200Response>, Integer, Hash)> uploads_get_0_with_http_info(opts)
+> <Array(<DeleteUpload200Response>, Integer, Hash)> delete_upload_with_http_info(id)
 
 ```ruby
 begin
-  # List the account's uploads
-  data, status_code, headers = api_instance.uploads_get_0_with_http_info(opts)
+  # Delete an upload
+  data, status_code, headers = api_instance.delete_upload_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <UploadsGet200Response>
+  p data # => <DeleteUpload200Response>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_get_0_with_http_info: #{e}"
+  puts "Error when calling UploadsApi->delete_upload_with_http_info: #{e}"
 end
 ```
 
@@ -68,13 +64,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **limit** | **Integer** | Maximum number of files to return | [optional][default to 50] |
-| **managed_user_id** | **String** | List only the files uploaded for this managed user (Widgetic&#39;s id for the user). Send this or &#x60;managedUserExternalId&#x60;, not both. | [optional] |
-| **managed_user_external_id** | **String** | List only the files uploaded for the managed user you registered with this &#x60;externalId&#x60; (your own identifier for the user). Send this or &#x60;managedUserId&#x60;, not both. | [optional] |
+| **id** | **String** |  |  |
 
 ### Return type
 
-[**UploadsGet200Response**](UploadsGet200Response.md)
+[**DeleteUpload200Response**](DeleteUpload200Response.md)
 
 ### Authorization
 
@@ -86,13 +80,13 @@ end
 - **Accept**: application/json
 
 
-## uploads_id_delete_0
+## get_upload
 
-> <UploadsIdDelete200Response> uploads_id_delete_0(id)
+> <UploadResponse> get_upload(id)
 
-Delete an upload
+Get an upload by id
 
-Removes the stored file and the upload row. A file in Widgetic's own storage gives back the space it took from your storage allowance; a file in your own bucket is removed from your bucket. Deleting an upload that is already gone succeeds the same way as the first delete. An upload that belongs to another account is not found. If the storage cannot be reached the call fails and nothing is marked deleted, so it can be repeated. 
+The details of one of the account's uploads. An upload that belongs to another account is not found.
 
 ### Examples
 
@@ -106,32 +100,32 @@ ApiSdkRb.configure do |config|
 end
 
 api_instance = ApiSdkRb::UploadsApi.new
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The upload to read
 
 begin
-  # Delete an upload
-  result = api_instance.uploads_id_delete_0(id)
+  # Get an upload by id
+  result = api_instance.get_upload(id)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_id_delete_0: #{e}"
+  puts "Error when calling UploadsApi->get_upload: #{e}"
 end
 ```
 
-#### Using the uploads_id_delete_0_with_http_info variant
+#### Using the get_upload_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UploadsIdDelete200Response>, Integer, Hash)> uploads_id_delete_0_with_http_info(id)
+> <Array(<UploadResponse>, Integer, Hash)> get_upload_with_http_info(id)
 
 ```ruby
 begin
-  # Delete an upload
-  data, status_code, headers = api_instance.uploads_id_delete_0_with_http_info(id)
+  # Get an upload by id
+  data, status_code, headers = api_instance.get_upload_with_http_info(id)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <UploadsIdDelete200Response>
+  p data # => <UploadResponse>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_id_delete_0_with_http_info: #{e}"
+  puts "Error when calling UploadsApi->get_upload_with_http_info: #{e}"
 end
 ```
 
@@ -139,11 +133,11 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **id** | **String** |  |  |
+| **id** | **String** | The upload to read |  |
 
 ### Return type
 
-[**UploadsIdDelete200Response**](UploadsIdDelete200Response.md)
+[**UploadResponse**](UploadResponse.md)
 
 ### Authorization
 
@@ -155,13 +149,13 @@ end
 - **Accept**: application/json
 
 
-## uploads_id_get_0
+## get_upload_limits
 
-> <UploadResponse> uploads_id_get_0(id)
+> <UploadLimitsResponse> get_upload_limits
 
-Get an upload by id
+Upload size limits and accepted file types
 
-The details of one of the account's uploads. An upload that belongs to another account is not found.
+The size limit and the accepted file types of the upload endpoints. Read them from here rather than hard-coding thresholds: they are configuration and can change. The limits are the same for every account, whatever its plan: `multipart_max_bytes` for a file sent in one request (10 MB) and `tus_max_bytes` for a resumable upload (250 MB). 
 
 ### Examples
 
@@ -175,44 +169,41 @@ ApiSdkRb.configure do |config|
 end
 
 api_instance = ApiSdkRb::UploadsApi.new
-id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The upload to read
 
 begin
-  # Get an upload by id
-  result = api_instance.uploads_id_get_0(id)
+  # Upload size limits and accepted file types
+  result = api_instance.get_upload_limits
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_id_get_0: #{e}"
+  puts "Error when calling UploadsApi->get_upload_limits: #{e}"
 end
 ```
 
-#### Using the uploads_id_get_0_with_http_info variant
+#### Using the get_upload_limits_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UploadResponse>, Integer, Hash)> uploads_id_get_0_with_http_info(id)
+> <Array(<UploadLimitsResponse>, Integer, Hash)> get_upload_limits_with_http_info
 
 ```ruby
 begin
-  # Get an upload by id
-  data, status_code, headers = api_instance.uploads_id_get_0_with_http_info(id)
+  # Upload size limits and accepted file types
+  data, status_code, headers = api_instance.get_upload_limits_with_http_info
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <UploadResponse>
+  p data # => <UploadLimitsResponse>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_id_get_0_with_http_info: #{e}"
+  puts "Error when calling UploadsApi->get_upload_limits_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-| Name | Type | Description | Notes |
-| ---- | ---- | ----------- | ----- |
-| **id** | **String** | The upload to read |  |
+This endpoint does not need any parameter.
 
 ### Return type
 
-[**UploadResponse**](UploadResponse.md)
+[**UploadLimitsResponse**](UploadLimitsResponse.md)
 
 ### Authorization
 
@@ -224,13 +215,13 @@ end
 - **Accept**: application/json
 
 
-## uploads_limits_get_0
+## list_uploads
 
-> <UploadLimitsResponse> uploads_limits_get_0
+> <ListUploads200Response> list_uploads(opts)
 
-Upload size limits and accepted file types
+List the account's uploads
 
-The size limit and the accepted file types of the upload endpoints. Read them from here rather than hard-coding thresholds: they are configuration and can change. The limits are the same for every account, whatever its plan: `multipart_max_bytes` for a file sent in one request (10 MB) and `tus_max_bytes` for a resumable upload (250 MB). 
+The files the account has uploaded, newest first. Deleted files are not listed. Returns at most `limit` files and has no further pages: a client that needs more narrows the list instead, for example to one managed user's files with `managedUserId` or `managedUserExternalId`. The files that visitors sent through a widget's upload adapter (`source` is `widget-visitor-upload`) are not part of this list, so that a popular widget does not push the account's own files out of it; naming one widget with `widgetId` lists what visitors sent to that widget as well. 
 
 ### Examples
 
@@ -244,41 +235,50 @@ ApiSdkRb.configure do |config|
 end
 
 api_instance = ApiSdkRb::UploadsApi.new
+opts = {
+  limit: 56, # Integer | Maximum number of files to return
+  managed_user_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | List only the files uploaded for this managed user (Widgetic's id for the user). Send this or `managedUserExternalId`, not both.
+  managed_user_external_id: 'managed_user_external_id_example' # String | List only the files uploaded for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
+}
 
 begin
-  # Upload size limits and accepted file types
-  result = api_instance.uploads_limits_get_0
+  # List the account's uploads
+  result = api_instance.list_uploads(opts)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_limits_get_0: #{e}"
+  puts "Error when calling UploadsApi->list_uploads: #{e}"
 end
 ```
 
-#### Using the uploads_limits_get_0_with_http_info variant
+#### Using the list_uploads_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UploadLimitsResponse>, Integer, Hash)> uploads_limits_get_0_with_http_info
+> <Array(<ListUploads200Response>, Integer, Hash)> list_uploads_with_http_info(opts)
 
 ```ruby
 begin
-  # Upload size limits and accepted file types
-  data, status_code, headers = api_instance.uploads_limits_get_0_with_http_info
+  # List the account's uploads
+  data, status_code, headers = api_instance.list_uploads_with_http_info(opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <UploadLimitsResponse>
+  p data # => <ListUploads200Response>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_limits_get_0_with_http_info: #{e}"
+  puts "Error when calling UploadsApi->list_uploads_with_http_info: #{e}"
 end
 ```
 
 ### Parameters
 
-This endpoint does not need any parameter.
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Integer** | Maximum number of files to return | [optional][default to 50] |
+| **managed_user_id** | **String** | List only the files uploaded for this managed user (Widgetic&#39;s id for the user). Send this or &#x60;managedUserExternalId&#x60;, not both. | [optional] |
+| **managed_user_external_id** | **String** | List only the files uploaded for the managed user you registered with this &#x60;externalId&#x60; (your own identifier for the user). Send this or &#x60;managedUserId&#x60;, not both. | [optional] |
 
 ### Return type
 
-[**UploadLimitsResponse**](UploadLimitsResponse.md)
+[**ListUploads200Response**](ListUploads200Response.md)
 
 ### Authorization
 
@@ -290,13 +290,13 @@ This endpoint does not need any parameter.
 - **Accept**: application/json
 
 
-## uploads_post_0
+## upload_file
 
-> <UploadResponse> uploads_post_0(file, opts)
+> <UploadResponse> upload_file(file, opts)
 
 Upload a file
 
-Stores one file for the account and returns its public address. This is how a user's own images, video and PDFs reach a widget's content.  Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team's shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store's session, always work in that team's shared storage. A personal API key or an SDK token always uses the account's own allowance. The two never add up and one never lends room to the other. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `uploadsLimitsGet` lists the size limit and the accepted types.  A file is judged by what is in it, not by the type it is sent as. A file that is not the type it claims (a web page sent as `image/png`) is refused with 415 and `UPLOAD_UNSUPPORTED_TYPE`, and a picture sent under the wrong picture type is stored under the type it really is, which `mime_type` in the answer says. An SVG is rewritten as it is stored: script, `foreignObject`, animation and references to other addresses are taken out, it must be UTF-8 and at most 2 MB, and the stored file can be larger or smaller than the one sent. Anything that is not an image, audio or video (a PDF, for example) is served as a download rather than shown in a page.  When the full storage is a Shopify store's team's, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person's own workspace, get the shorter message.  To upload the file for one of your managed users, send `managedUserId` (Widgetic's id for the user) or `managedUserExternalId` (your own identifier for the user), not both. The file stays in your account and counts against its allowance; the tag lets you list one user's files with `uploadsGet`. The managed user must be yours and active: one that is not yours, or does not exist, is refused with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`, before the file is stored. The tag is set here and does not change afterwards.  Called with an editor session (`createManagedUserEditorSession`), the file is always filed for the session's own managed user and is always media for widget content: naming another managed user is refused with 403 and `MANAGED_USER_SESSION_MISMATCH`, and `contextType`, `source`, `widgetId` and `conversationId` are ignored. A full storage allowance is refused with the same 413 and `QUOTA_STORAGE_EXCEEDED`, but the message only says that it is not available right now (not how much is stored: that is the partner's business) and `error.details.limit` is `storage`.  An account that administers a partner with a storage destination (`setPartnerStorageDestination`) has its files stored in the partner's own bucket instead. Such a file takes none of the allowance, its `url` is served from the partner's public address, and its `storage_key` is the key in the partner's bucket. The file is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 and `STORAGE_DESTINATION_UNAVAILABLE`, and when the partner's storage rejects the file with 502 and `STORAGE_DESTINATION_WRITE_FAILED`.  Partner storage is not optional, and it does not depend on how the file arrives. A partner's own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) and the uploads of its customers' editor sessions are kept in the partner's own storage or not at all, so a partner with no destination (or one that removed it after the session was made) has them refused with 409 and `PARTNER_STORAGE_REQUIRED`; they are never stored with Widgetic. An editor session's browser is only told that the feature is not available right now. 
+Stores one file for the account and returns its public address. This is how a user's own images, video and PDFs reach a widget's content.  Send a `multipart/form-data` request with the file in the field named `file`. The file counts against the storage of the workspace it is uploaded in, and a full workspace is refused with 413 and `QUOTA_STORAGE_EXCEEDED`. For a person signed in on widgetic.com that is the workspace they are currently working in: inside a team, the team's shared storage; inside their own workspace, their own allowance. An organization API key, and a Shopify store's session, always work in that team's shared storage. A personal API key or an SDK token always uses the account's own allowance. The two never add up and one never lends room to the other. A file over the size limit is refused with 413 and `UPLOAD_TOO_LARGE`, and a type that is not accepted with 415 and `UPLOAD_UNSUPPORTED_TYPE`; `getUploadLimits` lists the size limit and the accepted types.  A file is judged by what is in it, not by the type it is sent as. A file that is not the type it claims (a web page sent as `image/png`) is refused with 415 and `UPLOAD_UNSUPPORTED_TYPE`, and a picture sent under the wrong picture type is stored under the type it really is, which `mime_type` in the answer says. An SVG is rewritten as it is stored: script, `foreignObject`, animation and references to other addresses are taken out, it must be UTF-8 and at most 2 MB, and the stored file can be larger or smaller than the one sent. Anything that is not an image, audio or video (a PDF, for example) is served as a download rather than shown in a page.  When the full storage is a Shopify store's team's, extra storage cannot be added through Shopify yet, so the message ends by saying so and what to do instead: delete files, or contact support. On a Solo plan it names the Teams plan (which holds more) and `error.details.planPageUrl` is the address of the plan page on Shopify. `error.suggestedAction` says the same in a few words, instead of the usual \"upgrade your storage plan\". Any other team, and a person's own workspace, get the shorter message.  To upload the file for one of your managed users, send `managedUserId` (Widgetic's id for the user) or `managedUserExternalId` (your own identifier for the user), not both. The file stays in your account and counts against its allowance; the tag lets you list one user's files with `listUploads`. The managed user must be yours and active: one that is not yours, or does not exist, is refused with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`, before the file is stored. The tag is set here and does not change afterwards.  Called with an editor session (`createManagedUserEditorSession`), the file is always filed for the session's own managed user and is always media for widget content: naming another managed user is refused with 403 and `MANAGED_USER_SESSION_MISMATCH`, and `contextType`, `source`, `widgetId` and `conversationId` are ignored. A full storage allowance is refused with the same 413 and `QUOTA_STORAGE_EXCEEDED`, but the message only says that it is not available right now (not how much is stored: that is the partner's business) and `error.details.limit` is `storage`.  An account that administers a partner with a storage destination (`setPartnerStorageDestination`) has its files stored in the partner's own bucket instead. Such a file takes none of the allowance, its `url` is served from the partner's public address, and its `storage_key` is the key in the partner's bucket. The file is never stored with Widgetic instead: when the destination cannot be used the upload is refused with 503 and `STORAGE_DESTINATION_UNAVAILABLE`, and when the partner's storage rejects the file with 502 and `STORAGE_DESTINATION_WRITE_FAILED`.  Partner storage is not optional, and it does not depend on how the file arrives. A partner's own uploads (with its API key, an SDK token, or from the Widgetic website, the resumable route and the media library alike) and the uploads of its customers' editor sessions are kept in the partner's own storage or not at all, so a partner with no destination (or one that removed it after the session was made) has them refused with 409 and `PARTNER_STORAGE_REQUIRED`; they are never stored with Widgetic. An editor session's browser is only told that the feature is not available right now. 
 
 ### Examples
 
@@ -321,28 +321,28 @@ opts = {
 
 begin
   # Upload a file
-  result = api_instance.uploads_post_0(file, opts)
+  result = api_instance.upload_file(file, opts)
   p result
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_post_0: #{e}"
+  puts "Error when calling UploadsApi->upload_file: #{e}"
 end
 ```
 
-#### Using the uploads_post_0_with_http_info variant
+#### Using the upload_file_with_http_info variant
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<UploadResponse>, Integer, Hash)> uploads_post_0_with_http_info(file, opts)
+> <Array(<UploadResponse>, Integer, Hash)> upload_file_with_http_info(file, opts)
 
 ```ruby
 begin
   # Upload a file
-  data, status_code, headers = api_instance.uploads_post_0_with_http_info(file, opts)
+  data, status_code, headers = api_instance.upload_file_with_http_info(file, opts)
   p status_code # => 2xx
   p headers # => { ... }
   p data # => <UploadResponse>
 rescue ApiSdkRb::ApiError => e
-  puts "Error when calling UploadsApi->uploads_post_0_with_http_info: #{e}"
+  puts "Error when calling UploadsApi->upload_file_with_http_info: #{e}"
 end
 ```