ultracart_api 4.0.37.rc → 4.0.40.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e48b47e3d743b9314c562b3ea981b605cee052fc7c3b62fa4f7da74fdf4b5f47
-  data.tar.gz: 924dcfa7461c242d2a003693373f4392b9e5ab7c30b70991579d19ff7b87f3f0
+  metadata.gz: 76013e5a63e089f1e40ed70b618beb58c0ecfb27836590c30970a63081b50541
+  data.tar.gz: b976780adb3bb8a80f81f0d5a73d07532edd764997e66b944488ea56c0ca6cf3
 SHA512:
-  metadata.gz: 9d99937360395a25c786acd38a43836b12ee8b1fb1b98f21baee01105883b62ee9e045e6d8da6c77acefa6055afb4db52b89f985e523aeb6943c957de4bcbfb2
-  data.tar.gz: 4f945414957aed966fe9fb356befaf49b9ee2691139834afb5990edc3ed43e5c9389eedd09997ba05ce48beffad263185f6c9d9e0f870cdc6b991fd78bc3987c
+  metadata.gz: 19040f00897b6b9b015f78a3ae05f5894367f688cb2f1ab38c4a388edd46959c2172a494c254ef2fc5008999b523fe7f8dffe90a9fa92c8fd262529634dd536c
+  data.tar.gz: 1c694c816b9df21260ca6b9267b81d0bf2f3b39311025ac3cf89a56212e7345bead4799eabcbc465b505f8d1e0163c13cc64dd365740f7fa57b1f2b3e19b5532

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.37.rc
+- Package version: 4.0.40.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.37.rc.gem
+gem install ./ultracart_api-4.0.40.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.37.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.40.rc.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.37.rc'
+    gem 'ultracart_api', '~> 4.0.40.rc'
 
 ### Install from Git
 
@@ -472,6 +472,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::AutoOrderItemOption](docs/AutoOrderItemOption.md)
  - [UltracartClient::AutoOrderItemSimpleSchedule](docs/AutoOrderItemSimpleSchedule.md)
  - [UltracartClient::AutoOrderLog](docs/AutoOrderLog.md)
+ - [UltracartClient::AutoOrderManagement](docs/AutoOrderManagement.md)
  - [UltracartClient::AutoOrderQuery](docs/AutoOrderQuery.md)
  - [UltracartClient::AutoOrderQueryBatch](docs/AutoOrderQueryBatch.md)
  - [UltracartClient::AutoOrderResponse](docs/AutoOrderResponse.md)
@@ -562,13 +563,18 @@ Class | Method | HTTP request | Description
  - [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
  - [UltracartClient::CityStateZip](docs/CityStateZip.md)
  - [UltracartClient::Conversation](docs/Conversation.md)
+ - [UltracartClient::ConversationAgentAuth](docs/ConversationAgentAuth.md)
  - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
  - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
  - [UltracartClient::ConversationMessageTransportStatus](docs/ConversationMessageTransportStatus.md)
+ - [UltracartClient::ConversationMultimediaUploadUrl](docs/ConversationMultimediaUploadUrl.md)
+ - [UltracartClient::ConversationMultimediaUploadUrlResponse](docs/ConversationMultimediaUploadUrlResponse.md)
  - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
+ - [UltracartClient::ConversationResponse](docs/ConversationResponse.md)
  - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
  - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
  - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
+ - [UltracartClient::ConversationWebsocketMessage](docs/ConversationWebsocketMessage.md)
  - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
  - [UltracartClient::Country](docs/Country.md)
@@ -1160,6 +1166,9 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.40-RC | 07/25/2022 | conversations - add a websocket message model |
+| 4.0.39-RC | 07/21/2022 | conversation response types improvements |
+| 4.0.38-RC | 07/21/2022 | conversation bugfix for poor response objects |
 | 4.0.37-RC | 07/20/2022 | conversation participant name added |
 | 4.0.36-RC | 07/18/2022 | twilio dev |
 | 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |

data/docs/AutoOrder.md

@@ -19,6 +19,7 @@
 | **failure_reason** | **String** | The reason this auto order failed during the last rebill attempt | [optional] |
 | **items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | The items that are setup to rebill | [optional] |
 | **logs** | [**Array<AutoOrderLog>**](AutoOrderLog.md) | Logs associated with this auto order | [optional] |
+| **management** | [**AutoOrderManagement**](AutoOrderManagement.md) |  | [optional] |
 | **next_attempt** | **String** | The next time that the auto order will be attempted for processing | [optional] |
 | **original_order** | [**Order**](Order.md) |  | [optional] |
 | **original_order_id** | **String** | The original order id that this auto order is associated with. | [optional] |
@@ -48,6 +49,7 @@ instance = UltracartClient::AutoOrder.new(
   failure_reason: null,
   items: null,
   logs: null,
+  management: null,
   next_attempt: null,
   original_order: null,
   original_order_id: null,

data/docs/AutoOrderManagement.md

@@ -0,0 +1,18 @@
+# UltracartClient::AutoOrderManagement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **update_billing_url** | **String** | URL where the customer can go to update their billing information. | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::AutoOrderManagement.new(
+  update_billing_url: null
+)
+```
+

data/docs/ConversationAgentAuth.md

@@ -0,0 +1,28 @@
+# UltracartClient::ConversationAgentAuth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_participant_arn** | **String** |  | [optional] |
+| **conversation_participant_name** | **String** |  | [optional] |
+| **jwt** | **String** |  | [optional] |
+| **merchant_id** | **String** |  | [optional] |
+| **twilio_phone_numbers** | **Array<String>** |  | [optional] |
+| **websocket_url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationAgentAuth.new(
+  conversation_participant_arn: null,
+  conversation_participant_name: null,
+  jwt: null,
+  merchant_id: null,
+  twilio_phone_numbers: null,
+  websocket_url: null
+)
+```
+

data/docs/ConversationAgentAuthResponse.md

@@ -4,12 +4,11 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **conversation_participant_arn** | **String** |  | [optional] |
-| **conversation_participant_name** | **String** |  | [optional] |
-| **jwt** | **String** |  | [optional] |
-| **merchant_id** | **String** |  | [optional] |
-| **twilio_phone_numbers** | **Array<String>** |  | [optional] |
-| **websocket_url** | **String** |  | [optional] |
+| **agent_auth** | [**ConversationAgentAuth**](ConversationAgentAuth.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
 
@@ -17,12 +16,11 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationAgentAuthResponse.new(
-  conversation_participant_arn: null,
-  conversation_participant_name: null,
-  jwt: null,
-  merchant_id: null,
-  twilio_phone_numbers: null,
-  websocket_url: null
+  agent_auth: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
 )
 ```
 

data/docs/ConversationApi.md

@@ -83,7 +83,7 @@ This endpoint does not need any parameter.
 
 ## get_conversation
 
-> <Conversation> get_conversation(conversation_uuid)
+> <ConversationResponse> get_conversation(conversation_uuid)
 
 Retrieve a conversation
 
@@ -118,7 +118,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<Conversation>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
+> <Array(<ConversationResponse>, Integer, Hash)> get_conversation_with_http_info(conversation_uuid)
 
 ```ruby
 begin
@@ -126,7 +126,7 @@ begin
   data, status_code, headers = api_instance.get_conversation_with_http_info(conversation_uuid)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <Conversation>
+  p data # => <ConversationResponse>
 rescue UltracartClient::ApiError => e
   puts "Error when calling ConversationApi->get_conversation_with_http_info: #{e}"
 end
@@ -140,7 +140,7 @@ end
 
 ### Return type
 
-[**Conversation**](Conversation.md)
+[**ConversationResponse**](ConversationResponse.md)
 
 ### Authorization
 
@@ -154,7 +154,7 @@ end
 
 ## get_conversation_multimedia_upload_url
 
-> get_conversation_multimedia_upload_url(extension)
+> <ConversationMultimediaUploadUrlResponse> get_conversation_multimedia_upload_url(extension)
 
 Get a presigned conersation multimedia upload URL
 
@@ -178,7 +178,8 @@ extension = 'extension_example' # String |
 
 begin
   # Get a presigned conersation multimedia upload URL
-  api_instance.get_conversation_multimedia_upload_url(extension)
+  result = api_instance.get_conversation_multimedia_upload_url(extension)
+  p result
 rescue UltracartClient::ApiError => e
   puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url: #{e}"
 end
@@ -186,9 +187,9 @@ end
 
 #### Using the get_conversation_multimedia_upload_url_with_http_info variant
 
-This returns an Array which contains the response data (`nil` in this case), status code and headers.
+This returns an Array which contains the response data, status code and headers.
 
-> <Array(nil, Integer, Hash)> get_conversation_multimedia_upload_url_with_http_info(extension)
+> <Array(<ConversationMultimediaUploadUrlResponse>, Integer, Hash)> get_conversation_multimedia_upload_url_with_http_info(extension)
 
 ```ruby
 begin
@@ -196,7 +197,7 @@ begin
   data, status_code, headers = api_instance.get_conversation_multimedia_upload_url_with_http_info(extension)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => nil
+  p data # => <ConversationMultimediaUploadUrlResponse>
 rescue UltracartClient::ApiError => e
   puts "Error when calling ConversationApi->get_conversation_multimedia_upload_url_with_http_info: #{e}"
 end
@@ -210,7 +211,7 @@ end
 
 ### Return type
 
-nil (empty response body)
+[**ConversationMultimediaUploadUrlResponse**](ConversationMultimediaUploadUrlResponse.md)
 
 ### Authorization
 

data/docs/ConversationMultimediaUploadUrl.md

@@ -0,0 +1,20 @@
+# UltracartClient::ConversationMultimediaUploadUrl
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** |  | [optional] |
+| **url** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationMultimediaUploadUrl.new(
+  key: null,
+  url: null
+)
+```
+

data/docs/ConversationMultimediaUploadUrlResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationMultimediaUploadUrlResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_multimedia_upload_url** | [**ConversationMultimediaUploadUrl**](ConversationMultimediaUploadUrl.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::ConversationMultimediaUploadUrlResponse.new(
+  conversation_multimedia_upload_url: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::ConversationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation** | [**Conversation**](Conversation.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::ConversationResponse.new(
+  conversation: null,
+  error: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/ConversationStartRequest.md

@@ -6,6 +6,7 @@
 | ---- | ---- | ----------- | ----- |
 | **add_conversation_participant_arns** | **Array<String>** |  | [optional] |
 | **conversation_arn** | **String** |  | [optional] |
+| **conversation_webchat_queue_uuid** | **String** |  | [optional] |
 
 ## Example
 
@@ -14,7 +15,8 @@ require 'ultracart_api'
 
 instance = UltracartClient::ConversationStartRequest.new(
   add_conversation_participant_arns: null,
-  conversation_arn: null
+  conversation_arn: null,
+  conversation_webchat_queue_uuid: null
 )
 ```
 

data/docs/ConversationStartResponse.md

@@ -4,8 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **conversation_arn** | **String** |  | [optional] |
-| **conversation_uuid** | **String** |  | [optional] |
+| **conversation** | [**Conversation**](Conversation.md) |  | [optional] |
 
 ## Example
 
@@ -13,8 +12,7 @@
 require 'ultracart_api'
 
 instance = UltracartClient::ConversationStartResponse.new(
-  conversation_arn: null,
-  conversation_uuid: null
+  conversation: null
 )
 ```
 

data/docs/ConversationWebsocketMessage.md

@@ -0,0 +1,34 @@
+# UltracartClient::ConversationWebsocketMessage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **conversation_uuid** | **String** | Conversation UUID if the websocket message is tied to a specific conversation | [optional] |
+| **event_conversation_closed** | [**Conversation**](Conversation.md) |  | [optional] |
+| **event_new_conversation** | [**Conversation**](Conversation.md) |  | [optional] |
+| **event_new_message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] |
+| **event_queue_position** | **Object** |  | [optional] |
+| **event_type** | **String** | Type of event | [optional] |
+| **event_updated_message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] |
+| **message** | [**ConversationMessage**](ConversationMessage.md) |  | [optional] |
+| **type** | **String** | Type of message | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::ConversationWebsocketMessage.new(
+  conversation_uuid: null,
+  event_conversation_closed: null,
+  event_new_conversation: null,
+  event_new_message: null,
+  event_queue_position: null,
+  event_type: null,
+  event_updated_message: null,
+  message: null,
+  type: null
+)
+```
+

data/lib/ultracart_api/api/conversation_api.rb

@@ -94,7 +94,7 @@ module UltracartClient
     # Retrieve a conversation including the participants and messages 
     # @param conversation_uuid [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Conversation]
+    # @return [ConversationResponse]
     def get_conversation(conversation_uuid, opts = {})
       data, _status_code, _headers = get_conversation_with_http_info(conversation_uuid, opts)
       data
@@ -104,7 +104,7 @@ module UltracartClient
     # Retrieve a conversation including the participants and messages 
     # @param conversation_uuid [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Conversation, Integer, Hash)>] Conversation data, response status code and response headers
+    # @return [Array<(ConversationResponse, Integer, Hash)>] ConversationResponse data, response status code and response headers
     def get_conversation_with_http_info(conversation_uuid, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation ...'
@@ -132,7 +132,7 @@ module UltracartClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Conversation'
+      return_type = opts[:debug_return_type] || 'ConversationResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
@@ -158,17 +158,17 @@ module UltracartClient
     # Get a presigned conersation multimedia upload URL 
     # @param extension [String] 
     # @param [Hash] opts the optional parameters
-    # @return [nil]
+    # @return [ConversationMultimediaUploadUrlResponse]
     def get_conversation_multimedia_upload_url(extension, opts = {})
-      get_conversation_multimedia_upload_url_with_http_info(extension, opts)
-      nil
+      data, _status_code, _headers = get_conversation_multimedia_upload_url_with_http_info(extension, opts)
+      data
     end
 
     # Get a presigned conersation multimedia upload URL
     # Get a presigned conersation multimedia upload URL 
     # @param extension [String] 
     # @param [Hash] opts the optional parameters
-    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    # @return [Array<(ConversationMultimediaUploadUrlResponse, Integer, Hash)>] ConversationMultimediaUploadUrlResponse data, response status code and response headers
     def get_conversation_multimedia_upload_url_with_http_info(extension, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: ConversationApi.get_conversation_multimedia_upload_url ...'
@@ -196,7 +196,7 @@ module UltracartClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'ConversationMultimediaUploadUrlResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

data/lib/ultracart_api/models/auto_order.rb

@@ -60,6 +60,8 @@ module UltracartClient
     # Logs associated with this auto order
     attr_accessor :logs
 
+    attr_accessor :management
+
     # The next time that the auto order will be attempted for processing
     attr_accessor :next_attempt
 
@@ -120,6 +122,7 @@ module UltracartClient
         :'failure_reason' => :'failure_reason',
         :'items' => :'items',
         :'logs' => :'logs',
+        :'management' => :'management',
         :'next_attempt' => :'next_attempt',
         :'original_order' => :'original_order',
         :'original_order_id' => :'original_order_id',
@@ -153,6 +156,7 @@ module UltracartClient
         :'failure_reason' => :'String',
         :'items' => :'Array<AutoOrderItem>',
         :'logs' => :'Array<AutoOrderLog>',
+        :'management' => :'AutoOrderManagement',
         :'next_attempt' => :'String',
         :'original_order' => :'Order',
         :'original_order_id' => :'String',
@@ -248,6 +252,10 @@ module UltracartClient
         end
       end
 
+      if attributes.key?(:'management')
+        self.management = attributes[:'management']
+      end
+
       if attributes.key?(:'next_attempt')
         self.next_attempt = attributes[:'next_attempt']
       end
@@ -324,6 +332,7 @@ module UltracartClient
           failure_reason == o.failure_reason &&
           items == o.items &&
           logs == o.logs &&
+          management == o.management &&
           next_attempt == o.next_attempt &&
           original_order == o.original_order &&
           original_order_id == o.original_order_id &&
@@ -342,7 +351,7 @@ module UltracartClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
+      [auto_order_code, auto_order_oid, cancel_after_next_x_orders, cancel_downgrade, cancel_reason, cancel_upgrade, canceled_by_user, canceled_dts, completed, credit_card_attempt, disabled_dts, enabled, failure_reason, items, logs, management, next_attempt, original_order, original_order_id, override_affiliate_id, rebill_orders, rotating_transaction_gateway_code, status].hash
     end
 
     # Builds the object from hash