sunshine-conversations-client 12.8.0 → 13.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c3ae702f83f7eec72a2c00c415c6cae61d420df4
-  data.tar.gz: f618a247c16ac18c4d2125fa0cbbe1d3f9a0afa2
+SHA256:
+  metadata.gz: ecb6691f2ea9c64d17dbf2c306f2b16f6fe5657660b30e37085b5c2cc5962c08
+  data.tar.gz: 13faa2262096f42b890fc7cc5df992ad942a0b6c5bdf90163389217170f88138
 SHA512:
-  metadata.gz: b1c7fb40279b34e4e343cdf57d6cf8d6abcec7035c214f553b96754cf3a6a10f70794ced2396c3954d1605ecaf69e031c95003099314ca737aaaf30e8b924b6e
-  data.tar.gz: 1eda2a4f60049d85773ddcb009e9048dde0748c847ec83563d541d5aaa8e661a6c90dfeaf210cdc1044c14469f04b4110c38e4d6db478ca5cc190a4f30c8a1c5
+  metadata.gz: 7a618c43f6a9d27387c3a6e4dbd7127e4f9293fcbd9c3c88924824255b64a27f33c788ff6dda3f6c5f66e655b65e2eff176a23be065b8e78daee3061471da35b
+  data.tar.gz: 0534b757978258bd9bf8970ece88e534c218157ed4951e70b91a3ced498184000059ef4780b6564719834c0035c5a205776ecfc3ed5ef1cbf3e6e34f20500dc0

data/CHANGELOG_RB.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [13.0.0] - 2024-09-17
+
+### Added
+
+- List devices response changed from clients to devices
+
 ## [12.8.0] - 2024-09-12
 
 ### Added
@@ -10,7 +16,7 @@
 
 ### Added
 
-- Added new `attachmentId` property on the `file` and `image` message content of the Messages  API endpoints.
+- Added new `attachmentId` property on the `file` and `image` message content of the Messages API endpoints.
 
 ## [12.6.0] - 2024-06-12
 

data/README.md

@@ -5,7 +5,7 @@ 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: 12.8.0
-- Package version: 12.8.0
+- Package version: 13.0.0
 - 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-12.8.0.gem
+gem install ./sunshine-conversations-client-13.0.0.gem
 ```
 
-(for development, run `gem install --dev ./sunshine-conversations-client-12.8.0.gem` to install the development dependencies)
+(for development, run `gem install --dev ./sunshine-conversations-client-13.0.0.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', '~> 12.8.0'
+    gem 'sunshine-conversations-client', '~> 13.0.0'
 
 ### Install from Git
 
@@ -311,6 +311,7 @@ Class | Method | HTTP request | Description
  - [SunshineConversationsClient::DefaultResponderId](docs/DefaultResponderId.md)
  - [SunshineConversationsClient::Destination](docs/Destination.md)
  - [SunshineConversationsClient::Device](docs/Device.md)
+ - [SunshineConversationsClient::DeviceListResponse](docs/DeviceListResponse.md)
  - [SunshineConversationsClient::DeviceResponse](docs/DeviceResponse.md)
  - [SunshineConversationsClient::EventSubSchema](docs/EventSubSchema.md)
  - [SunshineConversationsClient::ExtraChannelOptions](docs/ExtraChannelOptions.md)

data/docs/DeviceListResponse.md

@@ -0,0 +1,17 @@
+# SunshineConversationsClient::DeviceListResponse
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**devices** | [**Array<Device>**](Device.md) | List of returned devices. | [optional] 
+
+## Code Sample
+
+```ruby
+require 'SunshineConversationsClient'
+
+instance = SunshineConversationsClient::DeviceListResponse.new(devices: null)
+```
+
+

data/docs/DevicesApi.md

@@ -73,7 +73,7 @@ Name | Type | Description  | Notes
 
 ## list_devices
 
-> ClientListResponse list_devices(app_id, user_id_or_external_id)
+> DeviceListResponse list_devices(app_id, user_id_or_external_id)
 
 List Devices
 
@@ -119,7 +119,7 @@ Name | Type | Description  | Notes
 
 ### Return type
 
-[**ClientListResponse**](ClientListResponse.md)
+[**DeviceListResponse**](DeviceListResponse.md)
 
 ### Authorization
 

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

@@ -95,7 +95,7 @@ module SunshineConversationsClient
     # @param app_id [String] Identifies the app.
     # @param user_id_or_external_id [String] The user's id or externalId.
     # @param [Hash] opts the optional parameters
-    # @return [ClientListResponse]
+    # @return [DeviceListResponse]
     def list_devices(app_id, user_id_or_external_id, opts = {})
       data, _status_code, _headers = list_devices_with_http_info(app_id, user_id_or_external_id, opts)
       data
@@ -106,7 +106,7 @@ module SunshineConversationsClient
     # @param app_id [String] Identifies the app.
     # @param user_id_or_external_id [String] The user's id or externalId.
     # @param [Hash] opts the optional parameters
-    # @return [Array<(ClientListResponse, Integer, Hash)>] ClientListResponse data, response status code and response headers
+    # @return [Array<(DeviceListResponse, Integer, Hash)>] DeviceListResponse data, response status code and response headers
     def list_devices_with_http_info(app_id, user_id_or_external_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: DevicesApi.list_devices ...'
@@ -137,7 +137,7 @@ module SunshineConversationsClient
       post_body = opts[:body] 
 
       # return_type
-      return_type = opts[:return_type] || 'ClientListResponse' 
+      return_type = opts[:return_type] || 'DeviceListResponse' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['basicAuth', 'bearerAuth']

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

@@ -0,0 +1,203 @@
+=begin
+#Sunshine Conversations API
+
+The version of the OpenAPI document: 12.8.0
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+=end
+
+require 'date'
+
+module SunshineConversationsClient
+  class DeviceListResponse
+    # List of returned devices.
+    attr_accessor :devices
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'devices' => :'devices'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'devices' => :'Array<Device>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::DeviceListResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::DeviceListResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'devices')
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          devices == o.devices
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [devices].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        SunshineConversationsClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end

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

@@ -8,5 +8,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module SunshineConversationsClient
-  VERSION = '12.8.0'
+  VERSION = '13.0.0'
 end

data/lib/sunshine-conversations-client.rb

@@ -135,6 +135,7 @@ require 'sunshine-conversations-client/models/default_responder_default_responde
 require 'sunshine-conversations-client/models/default_responder_id'
 require 'sunshine-conversations-client/models/destination'
 require 'sunshine-conversations-client/models/device'
+require 'sunshine-conversations-client/models/device_list_response'
 require 'sunshine-conversations-client/models/device_response'
 require 'sunshine-conversations-client/models/event_sub_schema'
 require 'sunshine-conversations-client/models/extra_channel_options'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sunshine-conversations-client
 version: !ruby/object:Gem::Version
-  version: 12.8.0
+  version: 13.0.0
 platform: ruby
 authors:
 - Sunshine Conversations
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-12 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -200,6 +200,7 @@ files:
 - docs/DefaultResponderId.md
 - docs/Destination.md
 - docs/Device.md
+- docs/DeviceListResponse.md
 - docs/DeviceResponse.md
 - docs/DevicesApi.md
 - docs/EventSubSchema.md
@@ -521,6 +522,7 @@ files:
 - lib/sunshine-conversations-client/models/default_responder_id.rb
 - lib/sunshine-conversations-client/models/destination.rb
 - lib/sunshine-conversations-client/models/device.rb
+- lib/sunshine-conversations-client/models/device_list_response.rb
 - lib/sunshine-conversations-client/models/device_response.rb
 - lib/sunshine-conversations-client/models/event_sub_schema.rb
 - lib/sunshine-conversations-client/models/extra_channel_options.rb
@@ -724,8 +726,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.3.27
 signing_key: 
 specification_version: 4
 summary: Sunshine Conversations API Ruby Gem