trycourier 1.10.0 → 3.0.0.pre.beta1

data/lib/trycourier/lists/client.rb

@@ -0,0 +1,454 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/list_get_all_response"
+require_relative "types/list"
+require_relative "types/list_put_params"
+require_relative "types/list_get_subscriptions_response"
+require_relative "types/put_subscriptions_recipient"
+require_relative "../commons/types/recipient_preferences"
+require "async"
+
+module Courier
+  class ListsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [ListsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Returns all of the lists, with the ability to filter based on a pattern.
+    #
+    # @param cursor [String] A unique identifier that allows for fetching the next page of lists.
+    # @param pattern [String] "A pattern used to filter the list items returned. Pattern types supported: exact match on `list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `**` to signify a wildcard `endsWith` pattern match."
+    # @param request_options [RequestOptions]
+    # @return [Lists::ListGetAllResponse]
+    def list(cursor: nil, pattern: nil, request_options: nil)
+      response = @request_client.conn.get("/lists") 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.params = {
+          **(request_options&.additional_query_parameters || {}),
+          "cursor": cursor,
+          "pattern": pattern
+        }.compact
+      end
+      Lists::ListGetAllResponse.from_json(json_object: response.body)
+    end
+
+    # Returns a list based on the list ID provided.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request_options [RequestOptions]
+    # @return [Lists::List]
+    def get(list_id:, request_options: nil)
+      response = @request_client.conn.get("/lists/#{list_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
+      Lists::List.from_json(json_object: response.body)
+    end
+
+    # Create or replace an existing list with the supplied values.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request [Hash] Request of type Lists::ListPutParams, as a Hash
+    #   * :name (String)
+    #   * :preferences (Hash)
+    #     * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #     * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [RequestOptions]
+    # @return [Lists::List]
+    def update(list_id:, request:, request_options: nil)
+      response = @request_client.conn.put("/lists/#{list_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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+      end
+      Lists::List.from_json(json_object: response.body)
+    end
+
+    # Delete a list by list ID.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def delete(list_id:, request_options: nil)
+      @request_client.conn.delete("/lists/#{list_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
+    end
+
+    # Restore a previously deleted list.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def restore(list_id:, request_options: nil)
+      @request_client.conn.put("/lists/#{list_id}/restore") 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
+    end
+
+    # Get the list's subscriptions.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param cursor [String] A unique identifier that allows for fetching the next set of list subscriptions
+    # @param request_options [RequestOptions]
+    # @return [Lists::ListGetSubscriptionsResponse]
+    def get_subscribers(list_id:, cursor: nil, request_options: nil)
+      response = @request_client.conn.get("/lists/#{list_id}/subscriptions") 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.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
+      end
+      Lists::ListGetSubscriptionsResponse.from_json(json_object: response.body)
+    end
+
+    # Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request [Array<Hash>] Request of type Array<Lists::PutSubscriptionsRecipient>, as a Hash
+    #   * :recipient_id (String)
+    #   * :preferences (Hash)
+    #     * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #     * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def update_subscribers(list_id:, request:, request_options: nil)
+      @request_client.conn.put("/lists/#{list_id}/subscriptions") 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+      end
+    end
+
+    # Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request [Array<Hash>] Request of type Array<Lists::PutSubscriptionsRecipient>, as a Hash
+    #   * :recipient_id (String)
+    #   * :preferences (Hash)
+    #     * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #     * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [IdempotencyRequestOptions]
+    # @return [Void]
+    def add_subscribers(list_id:, request:, request_options: nil)
+      @request_client.conn.post("/lists/#{list_id}/subscriptions") 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["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
+        unless request_options&.idempotency_expiry.nil?
+          req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
+        end
+        req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+        req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+      end
+    end
+
+    # Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param user_id [String] A unique identifier representing the recipient associated with the list
+    # @param preferences [Hash] Request of type Commons::RecipientPreferences, as a Hash
+    #   * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #   * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def subscribe(list_id:, user_id:, preferences: nil, request_options: nil)
+      @request_client.conn.put("/lists/#{list_id}/subscriptions/#{user_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 || {}), preferences: preferences }.compact
+      end
+    end
+
+    # Delete a subscription to a list by list ID and user ID.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param user_id [String] A unique identifier representing the recipient associated with the list
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def unsubscribe(list_id:, user_id:, request_options: nil)
+      @request_client.conn.delete("/lists/#{list_id}/subscriptions/#{user_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
+    end
+  end
+
+  class AsyncListsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncListsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Returns all of the lists, with the ability to filter based on a pattern.
+    #
+    # @param cursor [String] A unique identifier that allows for fetching the next page of lists.
+    # @param pattern [String] "A pattern used to filter the list items returned. Pattern types supported: exact match on `list_id` or a pattern of one or more pattern parts. you may replace a part with either: `*` to match all parts in that position, or `**` to signify a wildcard `endsWith` pattern match."
+    # @param request_options [RequestOptions]
+    # @return [Lists::ListGetAllResponse]
+    def list(cursor: nil, pattern: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/lists") 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.params = {
+            **(request_options&.additional_query_parameters || {}),
+            "cursor": cursor,
+            "pattern": pattern
+          }.compact
+        end
+        Lists::ListGetAllResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Returns a list based on the list ID provided.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request_options [RequestOptions]
+    # @return [Lists::List]
+    def get(list_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/lists/#{list_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
+        Lists::List.from_json(json_object: response.body)
+      end
+    end
+
+    # Create or replace an existing list with the supplied values.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request [Hash] Request of type Lists::ListPutParams, as a Hash
+    #   * :name (String)
+    #   * :preferences (Hash)
+    #     * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #     * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [RequestOptions]
+    # @return [Lists::List]
+    def update(list_id:, request:, request_options: nil)
+      Async do
+        response = @request_client.conn.put("/lists/#{list_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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+        end
+        Lists::List.from_json(json_object: response.body)
+      end
+    end
+
+    # Delete a list by list ID.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def delete(list_id:, request_options: nil)
+      Async do
+        @request_client.conn.delete("/lists/#{list_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
+      end
+    end
+
+    # Restore a previously deleted list.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def restore(list_id:, request_options: nil)
+      Async do
+        @request_client.conn.put("/lists/#{list_id}/restore") 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
+      end
+    end
+
+    # Get the list's subscriptions.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param cursor [String] A unique identifier that allows for fetching the next set of list subscriptions
+    # @param request_options [RequestOptions]
+    # @return [Lists::ListGetSubscriptionsResponse]
+    def get_subscribers(list_id:, cursor: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/lists/#{list_id}/subscriptions") 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.params = { **(request_options&.additional_query_parameters || {}), "cursor": cursor }.compact
+        end
+        Lists::ListGetSubscriptionsResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Subscribes the users to the list, overwriting existing subscriptions. If the list does not exist, it will be automatically created.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request [Array<Hash>] Request of type Array<Lists::PutSubscriptionsRecipient>, as a Hash
+    #   * :recipient_id (String)
+    #   * :preferences (Hash)
+    #     * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #     * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def update_subscribers(list_id:, request:, request_options: nil)
+      Async do
+        @request_client.conn.put("/lists/#{list_id}/subscriptions") 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 || {}), **(request_options&.additional_body_parameters || {}) }.compact
+        end
+      end
+    end
+
+    # Subscribes additional users to the list, without modifying existing subscriptions. If the list does not exist, it will be automatically created.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param request [Array<Hash>] Request of type Array<Lists::PutSubscriptionsRecipient>, as a Hash
+    #   * :recipient_id (String)
+    #   * :preferences (Hash)
+    #     * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #     * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [IdempotencyRequestOptions]
+    # @return [Void]
+    def add_subscribers(list_id:, request:, request_options: nil)
+      Async do
+        @request_client.conn.post("/lists/#{list_id}/subscriptions") 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["Idempotency-Key"] = request_options.idempotency_key unless request_options&.idempotency_key.nil?
+          unless request_options&.idempotency_expiry.nil?
+            req.headers["X-Idempotency-Expiration"] = request_options.idempotency_expiry
+          end
+          req.headers = { **req.headers, **(request_options&.additional_headers || {}) }.compact
+          req.body = { **(request || {}), **(request_options&.additional_body_parameters || {}) }.compact
+        end
+      end
+    end
+
+    # Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param user_id [String] A unique identifier representing the recipient associated with the list
+    # @param preferences [Hash] Request of type Commons::RecipientPreferences, as a Hash
+    #   * :categories (Commons::NOTIFICATION_PREFERENCES)
+    #   * :notifications (Commons::NOTIFICATION_PREFERENCES)
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def subscribe(list_id:, user_id:, preferences: nil, request_options: nil)
+      Async do
+        @request_client.conn.put("/lists/#{list_id}/subscriptions/#{user_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 || {}), preferences: preferences }.compact
+        end
+      end
+    end
+
+    # Delete a subscription to a list by list ID and user ID.
+    #
+    # @param list_id [String] A unique identifier representing the list you wish to retrieve.
+    # @param user_id [String] A unique identifier representing the recipient associated with the list
+    # @param request_options [RequestOptions]
+    # @return [Void]
+    def unsubscribe(list_id:, user_id:, request_options: nil)
+      Async do
+        @request_client.conn.delete("/lists/#{list_id}/subscriptions/#{user_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
+      end
+    end
+  end
+end

data/lib/trycourier/lists/types/list.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Lists
+    class List
+      attr_reader :id, :name, :created, :updated, :additional_properties
+
+      # @param id [String]
+      # @param name [String]
+      # @param created [Integer]
+      # @param updated [Integer]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lists::List]
+      def initialize(id:, name:, created: nil, updated: nil, additional_properties: nil)
+        # @type [String]
+        @id = id
+        # @type [String]
+        @name = name
+        # @type [Integer]
+        @created = created
+        # @type [Integer]
+        @updated = updated
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of List
+      #
+      # @param json_object [JSON]
+      # @return [Lists::List]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        JSON.parse(json_object)
+        id = struct.id
+        name = struct.name
+        created = struct.created
+        updated = struct.updated
+        new(id: id, name: name, created: created, updated: updated, additional_properties: struct)
+      end
+
+      # Serialize an instance of List to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "id": @id, "name": @name, "created": @created, "updated": @updated }.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.id.is_a?(String) != false || raise("Passed value for field obj.id is not the expected type, validation failed.")
+        obj.name.is_a?(String) != false || raise("Passed value for field obj.name is not the expected type, validation failed.")
+        obj.created&.is_a?(Integer) != false || raise("Passed value for field obj.created is not the expected type, validation failed.")
+        obj.updated&.is_a?(Integer) != false || raise("Passed value for field obj.updated is not the expected type, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/lists/types/list_get_all_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/paging"
+require_relative "list"
+require "json"
+
+module Courier
+  class Lists
+    class ListGetAllResponse
+      attr_reader :paging, :items, :additional_properties
+
+      # @param paging [Commons::Paging]
+      # @param items [Array<Lists::List>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lists::ListGetAllResponse]
+      def initialize(paging:, items:, additional_properties: nil)
+        # @type [Commons::Paging]
+        @paging = paging
+        # @type [Array<Lists::List>]
+        @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 ListGetAllResponse
+      #
+      # @param json_object [JSON]
+      # @return [Lists::ListGetAllResponse]
+      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
+          Lists::List.from_json(json_object: v)
+        end
+        new(paging: paging, items: items, additional_properties: struct)
+      end
+
+      # Serialize an instance of ListGetAllResponse 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

data/lib/trycourier/lists/types/list_get_subscriptions_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "../../commons/types/paging"
+require_relative "list_subscription_recipient"
+require "json"
+
+module Courier
+  class Lists
+    class ListGetSubscriptionsResponse
+      attr_reader :paging, :items, :additional_properties
+
+      # @param paging [Commons::Paging]
+      # @param items [Array<Lists::ListSubscriptionRecipient>]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Lists::ListGetSubscriptionsResponse]
+      def initialize(paging:, items:, additional_properties: nil)
+        # @type [Commons::Paging]
+        @paging = paging
+        # @type [Array<Lists::ListSubscriptionRecipient>]
+        @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 ListGetSubscriptionsResponse
+      #
+      # @param json_object [JSON]
+      # @return [Lists::ListGetSubscriptionsResponse]
+      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
+          Lists::ListSubscriptionRecipient.from_json(json_object: v)
+        end
+        new(paging: paging, items: items, additional_properties: struct)
+      end
+
+      # Serialize an instance of ListGetSubscriptionsResponse 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