sunshine-conversations-client 9.4.2 → 9.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 463c25c67746b75baefe183a32530d85ef991c88
-  data.tar.gz: 32fecd9b161c683ee3cf36fd1294c9b23c6fde4d
+  metadata.gz: 1c6cc5f338295d13d7496d5b23fcec4c8f5e0e8e
+  data.tar.gz: ce3b9098dff3d29888cf2c80380af255f7a7404c
 SHA512:
-  metadata.gz: be3ba62af2d66e56390d97f85a60aa03d062b7dbc0c816e581c26b5e85e8a51fbed4a9dbc04a449e51bbfdef9c1d68e8ddf73642b7a8758d4baac2a4e17adba7
-  data.tar.gz: 6eaf438da768e80bc3035eb7cbb711bb37e8d96a4313cec78e6afe71994be91cb0e0245a104db7d4460928e261f62803930557ec8e3d0deb10ab48788ecdfbe5
+  metadata.gz: fc09ba67d954e804859453b84e425fa35388d3d94785a97ae66612716155cc2072da67aefb036c0bcce9b853dddd9c422449f18695864df0751a6188cbcec6be
+  data.tar.gz: 60fd2bed3a41ec866c377b7aa1c7fd230e3d9a39972a30cdb674f4bfc8a38cac22f77cd2076495d9fd8aa245a26018fc32d46d22f1fd36cfcfaf25c3c516f4b4

data/CHANGELOG_RB.md

@@ -1,11 +1,18 @@
 # Changelog
 
+## [9.4.3] - 2021-02-16
+
+### Fixed
+
+- Fixed: query `Page1` instead of `Page` being used in the v2 List Messages API
+- Fixed: property `displayName` should not be `nullable` in v2 App Key API
+
 ## [9.4.2] - 2021-01-06
 
 ### Added
 
-- Added `phoneNumber` to the `integration` whatsapp response.
-- Added a message type `template` in the Post Message API.
+- Added `phoneNumber` to the `integration` whatsapp response
+- Added a message type `template` in the Post Message API
 
 ### Changed
 
@@ -25,13 +32,13 @@
 
 ### Added
 
-- Added a new user profile field `locale`.
+- Added a new user profile field `locale`
 
 ## [9.3.0] - 2020-11-18
 
 ### Added
 
-- Added a new optional field `altText` to the [message schema](https://docs.smooch.io/rest/#operation/postMessage) when sending an image or a file.
+- Added a new optional field `altText` to the [message schema](https://docs.smooch.io/rest/#operation/postMessage) when sending an image or a file
 
 ## [9.2.0] - 2020-11-16
 

data/README.md

@@ -4,8 +4,8 @@ SunshineConversationsClient - the Ruby gem for the Sunshine Conversations API
 
 This SDK is automatically generated by the [OpenAPI Generator Codegen](https://github.com/OpenAPITools/openapi-generator) project using the [Sunshine Conversations API spec](https://github.com/zendesk/sunshine-conversations-api-spec).
 
-- API version: 9.4.2
-- Package version: 9.4.2
+- API version: 9.4.3
+- Package version: 9.4.3
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
 ## Sunshine Conversations API Version
@@ -32,16 +32,16 @@ gem build sunshine-conversations-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./sunshine-conversations-client-9.4.2.gem
+gem install ./sunshine-conversations-client-9.4.3.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-9.4.2.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-9.4.3.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 'sunshine-conversations-client', '~> 9.4.2'
+    gem 'sunshine-conversations-client', '~> 9.4.3'
 
 ### Install from Git
 
@@ -364,7 +364,6 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::Meta](docs/Meta.md)
  - [SunshineConversationsClient::OfferControlBody](docs/OfferControlBody.md)
  - [SunshineConversationsClient::Page](docs/Page.md)
- - [SunshineConversationsClient::Page1](docs/Page1.md)
  - [SunshineConversationsClient::Participant](docs/Participant.md)
  - [SunshineConversationsClient::ParticipantJoinBody](docs/ParticipantJoinBody.md)
  - [SunshineConversationsClient::ParticipantLeaveBody](docs/ParticipantLeaveBody.md)

data/docs/ClientsApi.md

@@ -16,7 +16,7 @@ Method | HTTP request | Description
 
 Create Client
 
-Create a client and link it to a channel specified by the matchCriteria.type.
+Create a client and link it to a channel specified by the `matchCriteria.type`. Note that the client is initially created with a `pending` status. The status of the linking request can be tracked by listening to the `link:match`, `link:success` and `link:failure` webhooks (only available in v1). For more information, see [link-events](https://docs.smooch.io/rest/v1/#link-events).
 
 ### Example
 

data/docs/Ios.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | To configure an ios integration, call the create integration endpoint with a base64 encoded Apple Push Notification certificate from the [Apple Developer Portal](https://developer.apple.com/).  | [optional] [default to 'ios']
-**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
+**certificate** | **String** | The binary of your APN certificate base64 encoded. To base64 encode your certificate you can use this command in the terminal: `openssl base64 -in YOUR_CERTIFICATE.p12 | tr -d '\\n'`  | [optional] 
 **password** | **String** | The password for your APN certificate. | [optional] 
 **production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 
 **auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional] 

data/docs/IosAllOf.md

@@ -5,7 +5,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **type** | **String** | To configure an ios integration, call the create integration endpoint with a base64 encoded Apple Push Notification certificate from the [Apple Developer Portal](https://developer.apple.com/).  | [optional] [default to 'ios']
-**certificate** | **String** | The binary of your APN certificate base64 encoded. | [optional] 
+**certificate** | **String** | The binary of your APN certificate base64 encoded. To base64 encode your certificate you can use this command in the terminal: `openssl base64 -in YOUR_CERTIFICATE.p12 | tr -d '\\n'`  | [optional] 
 **password** | **String** | The password for your APN certificate. | [optional] 
 **production** | **Boolean** | The APN environment to connect to (Production, if true, or Sandbox). Defaults to value inferred from certificate if not specified. | [optional] 
 **auto_update_badge** | **Boolean** | Use the unread count of the conversation as the application badge. | [optional] 

data/docs/MessagePost.md

@@ -9,7 +9,7 @@ Name | Type | Description | Notes
 **destination** | [**Destination**](Destination.md) |  | [optional] 
 **metadata** | [**Object**](.md) | Flat object containing custom properties. Strings, numbers and booleans  are the only supported format that can be passed to metadata. The metadata is limited to 4KB in size.  | [optional] 
 **override** | [**MessageOverride**](MessageOverride.md) |  | [optional] 
-**schema** | **String** | When the `schema` is set to `whatsapp`, the message is automatically converted to the Sunshine Conversations schema to be stored in the conversation record. The Sunshine Conversations message schema is also used in the API response. Go to [Post Message API](https://docs.smooch.io/guide/whatsapp/#post-message-api) to view an example.  | [optional] 
+**schema** | **String** | When `schema` is set to `\"whatsapp\"`, the `content` key is expected to conform to the [native WhatsApp schema](https://developers.facebook.com/docs/whatsapp/api/messages/message-templates) for sending message templates. For more details, consult the documentation for [sending message templates on WhatsApp](https://docs.smooch.io/guide/whatsapp/#sending-message-templates).  | [optional] 
 
 ## Code Sample
 

data/docs/MessagesApi.md

@@ -162,7 +162,7 @@ app_id = '5d8cff3cd55b040010928b5b' # String | Identifies the app.
 conversation_id = '029c31f25a21b47effd7be90' # String | Identifies the conversation.
 # Be sure to add the required body parameters
 opts = {
-  page: SunshineConversationsClient::Page1.new # Page1 | Contains parameters for applying cursor pagination.
+  page: SunshineConversationsClient::Page.new # Page | Contains parameters for applying cursor pagination.
 }
 
 begin
@@ -181,7 +181,7 @@ Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
  **app_id** | **String**| Identifies the app. | 
  **conversation_id** | **String**| Identifies the conversation. | 
- **page** | [**Page1**](.md)| Contains parameters for applying cursor pagination. | [optional] 
+ **page** | [**Page**](.md)| Contains parameters for applying cursor pagination. | [optional] 
 
 ### Return type
 

data/docs/Page.md

@@ -6,7 +6,7 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **after** | **String** | A record id. Results will only contain the records that come after the specified record.  Only one of `after` or `before` can be provided, not both.  | [optional] 
 **before** | **String** | A record id. Results will only contain the records that come before the specified record. Only one of `after` or `before` can be provided, not both.  | [optional] 
-**size** | **Integer** | The number of records to return. | [optional] [default to 25]
+**size** | **Integer** | The number of records to return. Does not apply to the `listMessages` endpoint. | [optional] [default to 25]
 
 ## Code Sample
 

data/docs/TemplateMessage.md

@@ -4,7 +4,7 @@
 
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**type** | **String** | The type of message. | [optional] [default to 'template']
+**type** | **String** | The type of message. | [default to 'template']
 **template** | [**Object**](.md) | The whatsapp template message to send. For more information, consult the [guide](https://docs.smooch.io/guide/whatsapp#sending-message-templates). `schema` must be set to `whatsapp`. | 
 
 ## Code Sample

data/lib/sunshine-conversations-client.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -191,7 +191,6 @@ require 'sunshine-conversations-client/models/messenger_update'
 require 'sunshine-conversations-client/models/meta'
 require 'sunshine-conversations-client/models/offer_control_body'
 require 'sunshine-conversations-client/models/page'
-require 'sunshine-conversations-client/models/page1'
 require 'sunshine-conversations-client/models/participant'
 require 'sunshine-conversations-client/models/participant_join_body'
 require 'sunshine-conversations-client/models/participant_leave_body'

data/lib/sunshine-conversations-client/api/activities_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/app_keys_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/apps_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/attachments_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/clients_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -17,7 +17,7 @@ module SunshineConversationsClient
       @api_client = api_client
     end
     # Create Client
-    # Create a client and link it to a channel specified by the matchCriteria.type.
+    # Create a client and link it to a channel specified by the `matchCriteria.type`. Note that the client is initially created with a `pending` status. The status of the linking request can be tracked by listening to the `link:match`, `link:success` and `link:failure` webhooks (only available in v1). For more information, see [link-events](https://docs.smooch.io/rest/v1/#link-events).
     # @param app_id [String] Identifies the app.
     # @param user_id_or_external_id [String] The user's id or externalId.
     # @param client_create [ClientCreate] 
@@ -29,7 +29,7 @@ module SunshineConversationsClient
     end
 
     # Create Client
-    # Create a client and link it to a channel specified by the matchCriteria.type.
+    # Create a client and link it to a channel specified by the `matchCriteria.type`. Note that the client is initially created with a `pending` status. The status of the linking request can be tracked by listening to the `link:match`, `link:success` and `link:failure` webhooks (only available in v1). For more information, see [link-events](https://docs.smooch.io/rest/v1/#link-events).
     # @param app_id [String] Identifies the app.
     # @param user_id_or_external_id [String] The user's id or externalId.
     # @param client_create [ClientCreate] 

data/lib/sunshine-conversations-client/api/conversations_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/custom_integration_api_keys_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/integrations_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/messages_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1
@@ -163,7 +163,7 @@ module SunshineConversationsClient
     # @param app_id [String] Identifies the app.
     # @param conversation_id [String] Identifies the conversation.
     # @param [Hash] opts the optional parameters
-    # @option opts [Page1] :page Contains parameters for applying cursor pagination.
+    # @option opts [Page] :page Contains parameters for applying cursor pagination.
     # @return [MessageListResponse]
     def list_messages(app_id, conversation_id, opts = {})
       data, _status_code, _headers = list_messages_with_http_info(app_id, conversation_id, opts)
@@ -175,7 +175,7 @@ module SunshineConversationsClient
     # @param app_id [String] Identifies the app.
     # @param conversation_id [String] Identifies the conversation.
     # @param [Hash] opts the optional parameters
-    # @option opts [Page1] :page Contains parameters for applying cursor pagination.
+    # @option opts [Page] :page Contains parameters for applying cursor pagination.
     # @return [Array<(MessageListResponse, Integer, Hash)>] MessageListResponse data, response status code and response headers
     def list_messages_with_http_info(app_id, conversation_id, opts = {})
       if @api_client.config.debugging

data/lib/sunshine-conversations-client/api/o_auth_endpoints_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/participants_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/switchboard_actions_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/switchboard_integrations_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/switchboards_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/users_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api/webhooks_api.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api_client.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/api_error.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/configuration.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/models/accept_control_body.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/models/action.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1

data/lib/sunshine-conversations-client/models/action_subset.rb

@@ -1,7 +1,7 @@
 =begin
 #Sunshine Conversations API
 
-The version of the OpenAPI document: 9.4.2
+The version of the OpenAPI document: 9.4.3
 
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 4.3.1