trycourier 3.1.3 → 3.4.0.pre.alpha0

data/lib/trycourier/users/preferences/client.rb

@@ -1,171 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../requests"
-require_relative "types/user_preferences_list_response"
-require_relative "types/user_preferences_get_response"
-require_relative "../../commons/types/preference_status"
-require_relative "../../commons/types/channel_classification"
-require_relative "types/user_preferences_update_response"
-require "async"
-
-module Courier
-  module Users
-    class PreferencesClient
-      attr_reader :request_client
-
-      # @param request_client [RequestClient]
-      # @return [Users::PreferencesClient]
-      def initialize(request_client:)
-        # @type [RequestClient]
-        @request_client = request_client
-      end
-
-      # Fetch all user preferences.
-      #
-      # @param user_id [String] A unique identifier associated with the user whose preferences you wish to retrieve.
-      # @param request_options [RequestOptions]
-      # @return [Users::Preferences::UserPreferencesListResponse]
-      def list(user_id:, request_options: nil)
-        response = @request_client.conn.get("/users/#{user_id}/preferences") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-        end
-        Users::Preferences::UserPreferencesListResponse.from_json(json_object: response.body)
-      end
-
-      # Fetch user preferences for a specific subscription topic.
-      #
-      # @param user_id [String] A unique identifier associated with the user whose preferences you wish to retrieve.
-      # @param topic_id [String] A unique identifier associated with a subscription topic.
-      # @param request_options [RequestOptions]
-      # @return [Users::Preferences::UserPreferencesGetResponse]
-      def get(user_id:, topic_id:, request_options: nil)
-        response = @request_client.conn.get("/users/#{user_id}/preferences/#{topic_id}") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-        end
-        Users::Preferences::UserPreferencesGetResponse.from_json(json_object: response.body)
-      end
-
-      # Update or Create user preferences for a specific subscription topic.
-      #
-      # @param user_id [String] A unique identifier associated with the user whose preferences you wish to retrieve.
-      # @param topic_id [String] A unique identifier associated with a subscription topic.
-      # @param status [Commons::PreferenceStatus]
-      # @param custom_routing [Array<Commons::ChannelClassification>] The Channels a user has chosen to receive notifications through for this topic
-      # @param default_status [Commons::PreferenceStatus]
-      # @param has_custom_routing [Boolean]
-      # @param request_options [RequestOptions]
-      # @return [Users::Preferences::UserPreferencesUpdateResponse]
-      def update(user_id:, topic_id:, status:, default_status:, custom_routing: nil, has_custom_routing: nil,
-                 request_options: nil)
-        response = @request_client.conn.put("/users/#{user_id}/preferences/#{topic_id}") do |req|
-          req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-          unless request_options&.authorization_token.nil?
-            req.headers["Authorization"] =
-              request_options.authorization_token
-          end
-          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          req.body = {
-            **(request_options&.additional_body_parameters || {}),
-            status: status,
-            custom_routing: custom_routing,
-            default_status: default_status,
-            has_custom_routing: has_custom_routing
-          }.compact
-        end
-        Users::Preferences::UserPreferencesUpdateResponse.from_json(json_object: response.body)
-      end
-    end
-
-    class AsyncPreferencesClient
-      attr_reader :request_client
-
-      # @param request_client [AsyncRequestClient]
-      # @return [Users::AsyncPreferencesClient]
-      def initialize(request_client:)
-        # @type [AsyncRequestClient]
-        @request_client = request_client
-      end
-
-      # Fetch all user preferences.
-      #
-      # @param user_id [String] A unique identifier associated with the user whose preferences you wish to retrieve.
-      # @param request_options [RequestOptions]
-      # @return [Users::Preferences::UserPreferencesListResponse]
-      def list(user_id:, request_options: nil)
-        Async do
-          response = @request_client.conn.get("/users/#{user_id}/preferences") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          end
-          Users::Preferences::UserPreferencesListResponse.from_json(json_object: response.body)
-        end
-      end
-
-      # Fetch user preferences for a specific subscription topic.
-      #
-      # @param user_id [String] A unique identifier associated with the user whose preferences you wish to retrieve.
-      # @param topic_id [String] A unique identifier associated with a subscription topic.
-      # @param request_options [RequestOptions]
-      # @return [Users::Preferences::UserPreferencesGetResponse]
-      def get(user_id:, topic_id:, request_options: nil)
-        Async do
-          response = @request_client.conn.get("/users/#{user_id}/preferences/#{topic_id}") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-          end
-          Users::Preferences::UserPreferencesGetResponse.from_json(json_object: response.body)
-        end
-      end
-
-      # Update or Create user preferences for a specific subscription topic.
-      #
-      # @param user_id [String] A unique identifier associated with the user whose preferences you wish to retrieve.
-      # @param topic_id [String] A unique identifier associated with a subscription topic.
-      # @param status [Commons::PreferenceStatus]
-      # @param custom_routing [Array<Commons::ChannelClassification>] The Channels a user has chosen to receive notifications through for this topic
-      # @param default_status [Commons::PreferenceStatus]
-      # @param has_custom_routing [Boolean]
-      # @param request_options [RequestOptions]
-      # @return [Users::Preferences::UserPreferencesUpdateResponse]
-      def update(user_id:, topic_id:, status:, default_status:, custom_routing: nil, has_custom_routing: nil,
-                 request_options: nil)
-        Async do
-          response = @request_client.conn.put("/users/#{user_id}/preferences/#{topic_id}") do |req|
-            req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
-            unless request_options&.authorization_token.nil?
-              req.headers["Authorization"] =
-                request_options.authorization_token
-            end
-            req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
-            req.body = {
-              **(request_options&.additional_body_parameters || {}),
-              status: status,
-              custom_routing: custom_routing,
-              default_status: default_status,
-              has_custom_routing: has_custom_routing
-            }.compact
-          end
-          Users::Preferences::UserPreferencesUpdateResponse.from_json(json_object: response.body)
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/users/preferences/types/topic_preference.rb

@@ -1,86 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../commons/types/channel_classification"
-require_relative "../../../commons/types/preference_status"
-require "json"
-
-module Courier
-  module Users
-    class Preferences
-      class TopicPreference
-        attr_reader :custom_routing, :default_status, :has_custom_routing, :status, :topic_id, :topic_name,
-                    :additional_properties
-
-        # @param custom_routing [Array<Commons::ChannelClassification>] The Channels a user has chosen to receive notifications through for this topic
-        # @param default_status [Commons::PreferenceStatus]
-        # @param has_custom_routing [Boolean]
-        # @param status [Commons::PreferenceStatus]
-        # @param topic_id [String]
-        # @param topic_name [String]
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Users::Preferences::TopicPreference]
-        def initialize(default_status:, status:, topic_id:, topic_name:, custom_routing: nil, has_custom_routing: nil,
-                       additional_properties: nil)
-          # @type [Array<Commons::ChannelClassification>] The Channels a user has chosen to receive notifications through for this topic
-          @custom_routing = custom_routing
-          # @type [Commons::PreferenceStatus]
-          @default_status = default_status
-          # @type [Boolean]
-          @has_custom_routing = has_custom_routing
-          # @type [Commons::PreferenceStatus]
-          @status = status
-          # @type [String]
-          @topic_id = topic_id
-          # @type [String]
-          @topic_name = topic_name
-          # @type [OpenStruct] Additional properties unmapped to the current class definition
-          @additional_properties = additional_properties
-        end
-
-        # Deserialize a JSON object to an instance of TopicPreference
-        #
-        # @param json_object [JSON]
-        # @return [Users::Preferences::TopicPreference]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          JSON.parse(json_object)
-          custom_routing = struct.custom_routing
-          default_status = struct.default_status
-          has_custom_routing = struct.has_custom_routing
-          status = struct.status
-          topic_id = struct.topic_id
-          topic_name = struct.topic_name
-          new(custom_routing: custom_routing, default_status: default_status, has_custom_routing: has_custom_routing,
-              status: status, topic_id: topic_id, topic_name: topic_name, additional_properties: struct)
-        end
-
-        # Serialize an instance of TopicPreference to a JSON object
-        #
-        # @return [JSON]
-        def to_json(*_args)
-          {
-            "custom_routing": @custom_routing,
-            "default_status": @default_status,
-            "has_custom_routing": @has_custom_routing,
-            "status": @status,
-            "topic_id": @topic_id,
-            "topic_name": @topic_name
-          }.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.custom_routing&.is_a?(Array) != false || raise("Passed value for field obj.custom_routing is not the expected type, validation failed.")
-          obj.default_status.is_a?(Commons::PreferenceStatus) != false || raise("Passed value for field obj.default_status is not the expected type, validation failed.")
-          obj.has_custom_routing&.is_a?(Boolean) != false || raise("Passed value for field obj.has_custom_routing is not the expected type, validation failed.")
-          obj.status.is_a?(Commons::PreferenceStatus) != false || raise("Passed value for field obj.status is not the expected type, validation failed.")
-          obj.topic_id.is_a?(String) != false || raise("Passed value for field obj.topic_id is not the expected type, validation failed.")
-          obj.topic_name.is_a?(String) != false || raise("Passed value for field obj.topic_name is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/users/preferences/types/user_preferences_get_response.rb

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "topic_preference"
-require "json"
-
-module Courier
-  module Users
-    class Preferences
-      class UserPreferencesGetResponse
-        attr_reader :topic, :additional_properties
-
-        # @param topic [Users::Preferences::TopicPreference]
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Users::Preferences::UserPreferencesGetResponse]
-        def initialize(topic:, additional_properties: nil)
-          # @type [Users::Preferences::TopicPreference]
-          @topic = topic
-          # @type [OpenStruct] Additional properties unmapped to the current class definition
-          @additional_properties = additional_properties
-        end
-
-        # Deserialize a JSON object to an instance of UserPreferencesGetResponse
-        #
-        # @param json_object [JSON]
-        # @return [Users::Preferences::UserPreferencesGetResponse]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          if parsed_json["topic"].nil?
-            topic = nil
-          else
-            topic = parsed_json["topic"].to_json
-            topic = Users::Preferences::TopicPreference.from_json(json_object: topic)
-          end
-          new(topic: topic, additional_properties: struct)
-        end
-
-        # Serialize an instance of UserPreferencesGetResponse to a JSON object
-        #
-        # @return [JSON]
-        def to_json(*_args)
-          { "topic": @topic }.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          Users::Preferences::TopicPreference.validate_raw(obj: obj.topic)
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/users/preferences/types/user_preferences_list_response.rb

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../commons/types/paging"
-require_relative "topic_preference"
-require "json"
-
-module Courier
-  module Users
-    class Preferences
-      class UserPreferencesListResponse
-        attr_reader :paging, :items, :additional_properties
-
-        # @param paging [Commons::Paging]
-        # @param items [Array<Users::Preferences::TopicPreference>] The Preferences associated with the user_id.
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Users::Preferences::UserPreferencesListResponse]
-        def initialize(paging:, items:, additional_properties: nil)
-          # @type [Commons::Paging]
-          @paging = paging
-          # @type [Array<Users::Preferences::TopicPreference>] The Preferences associated with the user_id.
-          @items = items
-          # @type [OpenStruct] Additional properties unmapped to the current class definition
-          @additional_properties = additional_properties
-        end
-
-        # Deserialize a JSON object to an instance of UserPreferencesListResponse
-        #
-        # @param json_object [JSON]
-        # @return [Users::Preferences::UserPreferencesListResponse]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          parsed_json = JSON.parse(json_object)
-          if parsed_json["paging"].nil?
-            paging = nil
-          else
-            paging = parsed_json["paging"].to_json
-            paging = Commons::Paging.from_json(json_object: paging)
-          end
-          items = parsed_json["items"]&.map do |v|
-            v = v.to_json
-            Users::Preferences::TopicPreference.from_json(json_object: v)
-          end
-          new(paging: paging, items: items, additional_properties: struct)
-        end
-
-        # Serialize an instance of UserPreferencesListResponse to a JSON object
-        #
-        # @return [JSON]
-        def to_json(*_args)
-          { "paging": @paging, "items": @items }.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          Commons::Paging.validate_raw(obj: obj.paging)
-          obj.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end

data/lib/trycourier/users/preferences/types/user_preferences_update_response.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "json"
-
-module Courier
-  module Users
-    class Preferences
-      class UserPreferencesUpdateResponse
-        attr_reader :message, :additional_properties
-
-        # @param message [String]
-        # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
-        # @return [Users::Preferences::UserPreferencesUpdateResponse]
-        def initialize(message:, additional_properties: nil)
-          # @type [String]
-          @message = message
-          # @type [OpenStruct] Additional properties unmapped to the current class definition
-          @additional_properties = additional_properties
-        end
-
-        # Deserialize a JSON object to an instance of UserPreferencesUpdateResponse
-        #
-        # @param json_object [JSON]
-        # @return [Users::Preferences::UserPreferencesUpdateResponse]
-        def self.from_json(json_object:)
-          struct = JSON.parse(json_object, object_class: OpenStruct)
-          JSON.parse(json_object)
-          message = struct.message
-          new(message: message, additional_properties: struct)
-        end
-
-        # Serialize an instance of UserPreferencesUpdateResponse to a JSON object
-        #
-        # @return [JSON]
-        def to_json(*_args)
-          { "message": @message }.to_json
-        end
-
-        # Leveraged for Union-type generation, validate_raw attempts to parse the given hash and check each fields type against the current object's property definitions.
-        #
-        # @param obj [Object]
-        # @return [Void]
-        def self.validate_raw(obj:)
-          obj.message.is_a?(String) != false || raise("Passed value for field obj.message is not the expected type, validation failed.")
-        end
-      end
-    end
-  end
-end