cirro-ruby-client 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76097208caab26d55fe43bc4ca78e868d65c7fbd0aa0ab172cf76fbe51b769dc
-  data.tar.gz: 4e5db26e12fc65b9a8bb0da9a75ce846d9d8f5a0054f8cca47fe2ded2830a458
+  metadata.gz: cb241151c08978a8fea7a2b594440dd63ea330620c3e2e75c392bf78c4e85a9a
+  data.tar.gz: 32028d6fd708791bb8ef147a6149d3eb8ee54739ee01d384c5929a2c56b6ba11
 SHA512:
-  metadata.gz: c7af16a9900b76331bc9c248f8b22ca38f6e34b8affc1cbf54cf8d60eed55b915315b84e09bf654bc82b0a15ceb79cefbba8d88b3f1901739d87a57a0f000df8
-  data.tar.gz: 2299039507bef30f4bc613faf0107f2dec238c113903b92213f9f248d84ef276c6c4e5b31484c3b3839249de308afdabcb8e9ed8ffbfb173e03bc314aaaa31c8
+  metadata.gz: afd6cc918fda461905fe9ffd2a91492c40fa7feaa7ae82f7fc6c216b8448e04fad95f510bc7da0e4fe33f90ec1bf27b73270d21f6027f02cd2e8154033d41c21
+  data.tar.gz: 53e4c74b781b0d695d9f85d08e9524bca54aa2a4c59c3bf7875e23051468df25320ff271df34c7af0985da9ea755ef180f94ff49deed44745b672c83cef0f490

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cirro-ruby-client (2.0.1)
+    cirro-ruby-client (2.1.0)
       activesupport
       faraday (< 1.2.0)
       faraday_middleware
@@ -110,4 +110,4 @@ DEPENDENCIES
   webmock
 
 BUNDLED WITH
-   2.3.4
+   2.3.20

data/README.md

@@ -111,7 +111,7 @@ preference.id
 preference.locale
 # => 'de'
 
-preference.channels
+preference.topics
 # => Array of NotificationTopicPreference objects
 ```
 
@@ -120,7 +120,7 @@ preference.channels
 ```ruby
 client.User.update_notification_preference({
   locale: 'de',
-  channels: [
+  topics: [
     { id: '1', preferences: { email: 'immediately' } },
     { id: '2', preferences: { email: 'digest_daily' } }
   ]
@@ -292,7 +292,7 @@ client.NotificationLayoutTemplate.delete('1')
 ### List all notification topics
 
 ```ruby
-list = client.NotificationTopic
+list = client.NotificationTopic.list
 # => ListObject
 
 list.has_more?
@@ -308,7 +308,7 @@ client.NotificationTopic.list(notification_layout_id: 1)
 client.NotificationTopic.list(limit: 10, after: 10)
 ```
 
-### Create a notification channel
+### Create a notification topic
 
 ```ruby
 client.NotificationTopic.create(
@@ -332,11 +332,11 @@ client.NotificationTopic.create(
 )
 ```
 
-## Notification (Channel) Template
+## Notification (Topic) Template
 ### List all
 
 ```ruby
-list = client.NotificationTemplate
+list = client.NotificationTemplate.list
 # => ListObject
 
 list.has_more?
@@ -345,8 +345,8 @@ list.has_more?
 list.data
 # => Array of NotificationTemplate objects
 
-# filter by channel id
-client.NotificationTemplate.list(notification_channel_id: 1)
+# filter by topic id
+client.NotificationTemplate.list(notification_topic_id: 1)
 
 # filter by configuration id
 client.NotificationTemplate.list(notification_configuration_id: 1)
@@ -370,7 +370,7 @@ client.NotificationTemplate.update(
 ```ruby
 client.NotificationTemplate.delete('1')
 ``` 
-## Notifcation Channel Preference
+## Notifcation Topic Preference
 ### List all
 
 ```ruby
@@ -383,8 +383,8 @@ list.has_more?
 list.data
 # => Array of NotificationTopicPreference objects
 
-# filter by channel id
-client.NotificationTopicPreference.list(notification_channel_id: 1)
+# filter by topic id
+client.NotificationTopicPreference.list(notification_topic_id: 1)
 
 # filter by user id
 client.NotificationTopicPreference.list(user_id: 1)
@@ -405,6 +405,6 @@ client.NotificationBroadcast.create(
   recipients: {
     user_ids: [1, 2, 3]
   },
-  notification_channel_id: 1
+  notification_topic_id: 1
 )
 ```

data/lib/cirro_io/client/notifications_broadcast.rb

@@ -1,7 +1,7 @@
 module CirroIO
   module Client
     class NotificationsBroadcast < Base
-      has_one :channel, class_name: 'NotificationsChannel'
+      has_one :topic, class_name: 'NotificationsTopic'
       has_one :worker_filter
     end
   end

data/lib/cirro_io/client/notifications_template.rb

@@ -1,7 +1,7 @@
 module CirroIO
   module Client
     class NotificationsTemplate < Base
-      has_one :channel, class_name: 'NotificationsChannel'
+      has_one :topic, class_name: 'NotificationsTopic'
     end
   end
 end

data/lib/cirro_io/client/{notifications_channel.rb → notifications_topic.rb}

@@ -1,6 +1,6 @@
 module CirroIO
   module Client
-    class NotificationsChannel < Base
+    class NotificationsTopic < Base
     end
   end
 end

data/lib/cirro_io/client/version.rb

@@ -1,7 +1,7 @@
 # rubocop:disable Style/MutableConstant
 module CirroIO
   module Client
-    VERSION = '2.0.1'
+    VERSION = '2.1.0'
   end
 end
 # rubocop:enable Style/MutableConstant

data/lib/cirro_io/client.rb

@@ -16,7 +16,7 @@ require 'cirro_io/client/gig_time_activity'
 require 'cirro_io/client/gig'
 require 'cirro_io/client/payout'
 require 'cirro_io/client/notifications_broadcast'
-require 'cirro_io/client/notifications_channel'
+require 'cirro_io/client/notifications_topic'
 require 'cirro_io/client/notifications_template'
 
 module CirroIO

data/lib/cirro_io_v2/client.rb

@@ -7,7 +7,7 @@ require 'cirro_io_v2/request_clients/jwt'
 
 require 'cirro_io_v2/resources/base'
 require 'cirro_io_v2/resources/gig'
-require 'cirro_io_v2/resources/gig_ivitation'
+require 'cirro_io_v2/resources/gig_invitation'
 require 'cirro_io_v2/resources/user'
 
 require 'cirro_io_v2/responses/base'
@@ -73,12 +73,12 @@ module CirroIOV2
       Resources::NotificationBroadcast.new(self)
     end
 
-    def NotificationChannelPreference
-      Resources::NotificationChannelPreference.new(self)
+    def NotificationTopicPreference
+      Resources::NotificationTopicPreference.new(self)
     end
 
-    def NotificationChannel
-      Resources::NotificationChannel.new(self)
+    def NotificationTopic
+      Resources::NotificationTopic.new(self)
     end
 
     def NotificationConfiguration
@@ -101,10 +101,6 @@ module CirroIOV2
       Resources::NotificationTopic.new(self)
     end
 
-    def NotificationTopic
-      Resources::NotificationTopic.new(self)
-    end
-
     # rubocop:enable Naming/MethodName
   end
 end

data/lib/cirro_io_v2/request_clients/jwt.rb

@@ -13,6 +13,7 @@ module CirroIOV2
 
         @connection = Faraday.new(url: base_url) do |conn|
           conn.request :json
+          conn.response :raise_error
           conn.response :json
           conn.adapter Faraday.default_adapter # testIO App is on older version of faraday and needs this line
         end

data/lib/cirro_io_v2/resources/notification_broadcast.rb

@@ -1,7 +1,7 @@
 module CirroIOV2
   module Resources
     class NotificationBroadcast < Base
-      ALLOWED_PARAMS = [:payload, :recipients, :notification_channel_id].freeze
+      ALLOWED_PARAMS = [:payload, :recipients, :notification_topic_id].freeze
 
       def create(params)
         params_allowed?(params, ALLOWED_PARAMS)

data/lib/cirro_io_v2/resources/notification_template.rb

@@ -1,7 +1,7 @@
 module CirroIOV2
   module Resources
     class NotificationTemplate < Base
-      LIST_ALLOWED_PARAMS = [:notification_configuration_id, :notification_channel_id, :limit, :before, :after].freeze
+      LIST_ALLOWED_PARAMS = [:notification_configuration_id, :notification_topic_id, :limit, :before, :after].freeze
       UPDATE_ALLOWED_PARAMS = [:subject, :body].freeze
 
       def list(params = nil)

data/lib/cirro_io_v2/resources/notification_topic.rb

@@ -2,15 +2,22 @@ module CirroIOV2
   module Resources
     class NotificationTopic < Base
       ALLOWED_PARAMS = [:name, :notification_layout_id, :preferences, :templates].freeze
+      ALLOWED_LIST_PARAMS = [:notification_layout_id, :limit, :before, :after].freeze
 
       def resource_root
-        'notification_channels'
+        'notification_topics'
+      end
+
+      def list(params = nil)
+        params_allowed?(params, ALLOWED_LIST_PARAMS) if params
+        response = client.request_client.request(:get, resource_root, params: params)
+        Responses::NotificationTopicListResponse.new(response.body)
       end
 
       def create(params)
         params_allowed?(params, ALLOWED_PARAMS)
         response = client.request_client.request(:post, resource_root, body: params)
-        Responses::NotificationChannelResponse.new(response.body)
+        Responses::NotificationTopicResponse.new(response.body)
       end
     end
   end

data/lib/cirro_io_v2/resources/notification_topic_preference.rb

@@ -1,16 +1,16 @@
 module CirroIOV2
   module Resources
     class NotificationTopicPreference < Base
-      ALLOWED_PARAMS = [:user_id, :notification_channel_id, :limit, :before, :after].freeze
+      ALLOWED_PARAMS = [:user_id, :notification_topic_id, :limit, :before, :after].freeze
 
       def resource_root
-        'notification_channel_preferences'
+        'notification_topic_preferences'
       end
 
       def list(params = nil)
         params_allowed?(params, ALLOWED_PARAMS) if params
         response = client.request_client.request(:get, resource_root, params: params)
-        Responses::NotificationChannelPreferenceListResponse.new(response.body)
+        Responses::NotificationTopicPreferenceListResponse.new(response.body)
       end
     end
   end

data/lib/cirro_io_v2/responses/responses.rb

@@ -3,11 +3,11 @@ module CirroIOV2
     LIST_RESPONSES = [
       :GigTaskListResponse,
       :GigInvitationListResponse,
-      :NotificationChannelPreferenceListResponse,
+      :NotificationTopicPreferenceListResponse,
       :NotificationLocaleListResponse,
       :NotificationConfigurationListResponse,
       :NotificationLayoutTemplateListResponse,
-      :NotificationChannelListResponse,
+      :NotificationTopicListResponse,
       :NotificationTemplateListResponse,
     ].freeze
 
@@ -15,8 +15,8 @@ module CirroIOV2
       include Base
     end
 
-    UserNotificationPreferenceResponse = Struct.new(:id, :object, :locale, :channels) do
-      self::NESTED_RESPONSES = { channels: :NotificationChannelListResponse }.freeze
+    UserNotificationPreferenceResponse = Struct.new(:id, :object, :locale, :topics) do
+      self::NESTED_RESPONSES = { topics: :NotificationTopicListResponse }.freeze
       include Base
     end
 
@@ -45,8 +45,8 @@ module CirroIOV2
       include Base
     end
 
-    NotificationChannelPreferenceResponse = Struct.new(:id, :object, :preferences, :notification_channel_id, :user_id) do
-      self::NESTED_RESPONSES = { preferences: :NotificationChannelPreferenceListResponse }.freeze
+    NotificationTopicPreferenceResponse = Struct.new(:id, :object, :preferences, :notification_topic_id, :user_id) do
+      self::NESTED_RESPONSES = { preferences: :NotificationTopicPreferenceListResponse }.freeze
       include Base
     end
 
@@ -72,12 +72,12 @@ module CirroIOV2
       include Base
     end
 
-    NotificationChannelResponse = Struct.new(:id, :object, :name, :notification_layout_id, :preferences, :templates) do
+    NotificationTopicResponse = Struct.new(:id, :object, :name, :notification_layout_id, :preferences, :templates) do
       self::NESTED_RESPONSES = { templates: :NotificationTemplateListResponse }.freeze
       include Base
     end
 
-    NotificationTemplateResponse = Struct.new(:id, :object, :notification_configuration_id, :notification_channel_id, :subject, :body) do
+    NotificationTemplateResponse = Struct.new(:id, :object, :notification_configuration_id, :notification_topic_id, :subject, :body) do
       include Base
     end
 
@@ -85,7 +85,7 @@ module CirroIOV2
       include Base
     end
 
-    NotificationBroadcastResponse = Struct.new(:id, :object, :payload, :recipients, :notification_channel_id) do
+    NotificationBroadcastResponse = Struct.new(:id, :object, :payload, :recipients, :notification_topic_id) do
       include Base
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cirro-ruby-client
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Cirro Dev Team
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-08-17 00:00:00.000000000 Z
+date: 2022-08-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -115,8 +115,8 @@ files:
 - lib/cirro_io/client/gig_time_activity.rb
 - lib/cirro_io/client/jwt_authentication.rb
 - lib/cirro_io/client/notifications_broadcast.rb
-- lib/cirro_io/client/notifications_channel.rb
 - lib/cirro_io/client/notifications_template.rb
+- lib/cirro_io/client/notifications_topic.rb
 - lib/cirro_io/client/payout.rb
 - lib/cirro_io/client/response_debugging_middleware.rb
 - lib/cirro_io/client/version.rb
@@ -128,7 +128,7 @@ files:
 - lib/cirro_io_v2/request_clients/jwt.rb
 - lib/cirro_io_v2/resources/base.rb
 - lib/cirro_io_v2/resources/gig.rb
-- lib/cirro_io_v2/resources/gig_ivitation.rb
+- lib/cirro_io_v2/resources/gig_invitation.rb
 - lib/cirro_io_v2/resources/notification_broadcast.rb
 - lib/cirro_io_v2/resources/notification_configuration.rb
 - lib/cirro_io_v2/resources/notification_layout.rb
@@ -162,7 +162,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
+rubygems_version: 3.1.3
 signing_key: 
 specification_version: 4
 summary: Ruby client library for Cirro API