trycourier 2.0.0 → 3.0.0.pre.beta1

data/lib/trycourier/audiences/types/audience_member_list_response.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "audience_member"
+require_relative "../../commons/types/paging"
+require "json"
+
+module Courier
+  class Audiences
+    class AudienceMemberListResponse
+      attr_reader :items, :paging, :additional_properties
+
+      # @param items [Array<Audiences::AudienceMember>]
+      # @param paging [Commons::Paging]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Audiences::AudienceMemberListResponse]
+      def initialize(items:, paging:, additional_properties: nil)
+        # @type [Array<Audiences::AudienceMember>]
+        @items = items
+        # @type [Commons::Paging]
+        @paging = paging
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of AudienceMemberListResponse
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::AudienceMemberListResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        items = parsed_json["items"]&.map do |v|
+          v = v.to_json
+          Audiences::AudienceMember.from_json(json_object: v)
+        end
+        if parsed_json["paging"].nil?
+          paging = nil
+        else
+          paging = parsed_json["paging"].to_json
+          paging = Commons::Paging.from_json(json_object: paging)
+        end
+        new(items: items, paging: paging, additional_properties: struct)
+      end
+
+      # Serialize an instance of AudienceMemberListResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "items": @items, "paging": @paging }.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.items.is_a?(Array) != false || raise("Passed value for field obj.items is not the expected type, validation failed.")
+        Commons::Paging.validate_raw(obj: obj.paging)
+      end
+    end
+  end
+end

data/lib/trycourier/audiences/types/audience_update_response.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "audience"
+require "json"
+
+module Courier
+  class Audiences
+    class AudienceUpdateResponse
+      attr_reader :audience, :additional_properties
+
+      # @param audience [Audiences::Audience]
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Audiences::AudienceUpdateResponse]
+      def initialize(audience:, additional_properties: nil)
+        # @type [Audiences::Audience]
+        @audience = audience
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of AudienceUpdateResponse
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::AudienceUpdateResponse]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["audience"].nil?
+          audience = nil
+        else
+          audience = parsed_json["audience"].to_json
+          audience = Audiences::Audience.from_json(json_object: audience)
+        end
+        new(audience: audience, additional_properties: struct)
+      end
+
+      # Serialize an instance of AudienceUpdateResponse to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "audience": @audience }.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:)
+        Audiences::Audience.validate_raw(obj: obj.audience)
+      end
+    end
+  end
+end

data/lib/trycourier/audiences/types/base_filter_config.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "operator"
+require "json"
+
+module Courier
+  class Audiences
+    class BaseFilterConfig
+      attr_reader :operator, :additional_properties
+
+      # @param operator [Audiences::Operator] The operator to use for filtering
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Audiences::BaseFilterConfig]
+      def initialize(operator:, additional_properties: nil)
+        # @type [Audiences::Operator] The operator to use for filtering
+        @operator = operator
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of BaseFilterConfig
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::BaseFilterConfig]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        if parsed_json["operator"].nil?
+          operator = nil
+        else
+          operator = parsed_json["operator"].to_json
+          operator = Audiences::Operator.from_json(json_object: operator)
+        end
+        new(operator: operator, additional_properties: struct)
+      end
+
+      # Serialize an instance of BaseFilterConfig to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "operator": @operator }.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:)
+        Audiences::Operator.validate_raw(obj: obj.operator)
+      end
+    end
+  end
+end

data/lib/trycourier/audiences/types/comparison_operator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Courier
+  class Audiences
+    class ComparisonOperator
+      ENDS_WITH = "ENDS_WITH"
+      EQ = "EQ"
+      EXISTS = "EXISTS"
+      GT = "GT"
+      GTE = "GTE"
+      INCLUDES = "INCLUDES"
+      IS_AFTER = "IS_AFTER"
+      IS_BEFORE = "IS_BEFORE"
+      LT = "LT"
+      LTE = "LTE"
+      NEQ = "NEQ"
+      OMIT = "OMIT"
+      STARTS_WITH = "STARTS_WITH"
+    end
+  end
+end

data/lib/trycourier/audiences/types/filter.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "single_filter_config"
+require_relative "nested_filter_config"
+
+module Courier
+  class Audiences
+    class Filter
+      # Deserialize a JSON object to an instance of Filter
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::Filter]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Audiences::SingleFilterConfig.validate_raw(obj: struct)
+          return Audiences::SingleFilterConfig.from_json(json_object: json_object)
+        rescue StandardError
+          # noop
+        end
+        begin
+          Audiences::NestedFilterConfig.validate_raw(obj: struct)
+          return Audiences::NestedFilterConfig.from_json(json_object: json_object)
+        rescue StandardError
+          # noop
+        end
+        struct
+      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:)
+        begin
+          return Audiences::SingleFilterConfig.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Audiences::NestedFilterConfig.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/audiences/types/filter_config.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "json"
+require_relative "single_filter_config"
+require_relative "nested_filter_config"
+
+module Courier
+  class Audiences
+    class FilterConfig
+      # Deserialize a JSON object to an instance of FilterConfig
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::FilterConfig]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          Audiences::SingleFilterConfig.validate_raw(obj: struct)
+          return Audiences::SingleFilterConfig.from_json(json_object: json_object)
+        rescue StandardError
+          # noop
+        end
+        begin
+          Audiences::NestedFilterConfig.validate_raw(obj: struct)
+          return Audiences::NestedFilterConfig.from_json(json_object: json_object)
+        rescue StandardError
+          # noop
+        end
+        struct
+      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:)
+        begin
+          return Audiences::SingleFilterConfig.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        begin
+          return Audiences::NestedFilterConfig.validate_raw(obj: obj)
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/audiences/types/logical_operator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Courier
+  class Audiences
+    class LogicalOperator
+      AND = "AND"
+      OR = "OR"
+    end
+  end
+end

data/lib/trycourier/audiences/types/nested_filter_config.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require_relative "filter_config"
+require_relative "operator"
+require "json"
+
+module Courier
+  class Audiences
+    # The operator to use for filtering
+    class NestedFilterConfig
+      attr_reader :rules, :operator, :additional_properties
+
+      # @param rules [Array<Audiences::FilterConfig>]
+      # @param operator [Audiences::Operator] The operator to use for filtering
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Audiences::NestedFilterConfig]
+      def initialize(rules:, operator:, additional_properties: nil)
+        # @type [Array<Audiences::FilterConfig>]
+        @rules = rules
+        # @type [Audiences::Operator] The operator to use for filtering
+        @operator = operator
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of NestedFilterConfig
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::NestedFilterConfig]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        rules = parsed_json["rules"]&.map do |v|
+          v = v.to_json
+          Audiences::FilterConfig.from_json(json_object: v)
+        end
+        if parsed_json["operator"].nil?
+          operator = nil
+        else
+          operator = parsed_json["operator"].to_json
+          operator = Audiences::Operator.from_json(json_object: operator)
+        end
+        new(rules: rules, operator: operator, additional_properties: struct)
+      end
+
+      # Serialize an instance of NestedFilterConfig to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "rules": @rules, "operator": @operator }.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.rules.is_a?(Array) != false || raise("Passed value for field obj.rules is not the expected type, validation failed.")
+        Audiences::Operator.validate_raw(obj: obj.operator)
+      end
+    end
+  end
+end

data/lib/trycourier/audiences/types/operator.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "json"
+
+module Courier
+  class Audiences
+    class Operator
+      # Deserialize a JSON object to an instance of Operator
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::Operator]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        begin
+          struct.is_a?(Audiences::ComparisonOperator) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          return json_object
+        rescue StandardError
+          # noop
+        end
+        begin
+          struct.is_a?(Audiences::LogicalOperator) != false || raise("Passed value for field struct is not the expected type, validation failed.")
+          return json_object
+        rescue StandardError
+          # noop
+        end
+        struct
+      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:)
+        begin
+          return obj.is_a?(Audiences::ComparisonOperator) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        begin
+          return obj.is_a?(Audiences::LogicalOperator) != false || raise("Passed value for field obj is not the expected type, validation failed.")
+        rescue StandardError
+          # noop
+        end
+        raise("Passed value matched no type within the union, validation failed.")
+      end
+    end
+  end
+end

data/lib/trycourier/audiences/types/single_filter_config.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "operator"
+require "json"
+
+module Courier
+  class Audiences
+    # A single filter to use for filtering
+    class SingleFilterConfig
+      attr_reader :value, :path, :operator, :additional_properties
+
+      # @param value [String] The value to use for filtering
+      # @param path [String] The attribe name from profile whose value will be operated against the filter value
+      # @param operator [Audiences::Operator] The operator to use for filtering
+      # @param additional_properties [OpenStruct] Additional properties unmapped to the current class definition
+      # @return [Audiences::SingleFilterConfig]
+      def initialize(value:, path:, operator:, additional_properties: nil)
+        # @type [String] The value to use for filtering
+        @value = value
+        # @type [String] The attribe name from profile whose value will be operated against the filter value
+        @path = path
+        # @type [Audiences::Operator] The operator to use for filtering
+        @operator = operator
+        # @type [OpenStruct] Additional properties unmapped to the current class definition
+        @additional_properties = additional_properties
+      end
+
+      # Deserialize a JSON object to an instance of SingleFilterConfig
+      #
+      # @param json_object [JSON]
+      # @return [Audiences::SingleFilterConfig]
+      def self.from_json(json_object:)
+        struct = JSON.parse(json_object, object_class: OpenStruct)
+        parsed_json = JSON.parse(json_object)
+        value = struct.value
+        path = struct.path
+        if parsed_json["operator"].nil?
+          operator = nil
+        else
+          operator = parsed_json["operator"].to_json
+          operator = Audiences::Operator.from_json(json_object: operator)
+        end
+        new(value: value, path: path, operator: operator, additional_properties: struct)
+      end
+
+      # Serialize an instance of SingleFilterConfig to a JSON object
+      #
+      # @return [JSON]
+      def to_json(*_args)
+        { "value": @value, "path": @path, "operator": @operator }.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.value.is_a?(String) != false || raise("Passed value for field obj.value is not the expected type, validation failed.")
+        obj.path.is_a?(String) != false || raise("Passed value for field obj.path is not the expected type, validation failed.")
+        Audiences::Operator.validate_raw(obj: obj.operator)
+      end
+    end
+  end
+end

data/lib/trycourier/audit_events/client.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require_relative "../../requests"
+require_relative "types/list_audit_events_response"
+require_relative "types/audit_event"
+require "async"
+
+module Courier
+  class AuditEventsClient
+    attr_reader :request_client
+
+    # @param request_client [RequestClient]
+    # @return [AuditEventsClient]
+    def initialize(request_client:)
+      # @type [RequestClient]
+      @request_client = request_client
+    end
+
+    # Fetch the list of audit events
+    #
+    # @param cursor [String] A unique identifier that allows for fetching the next set of audit events.
+    # @param request_options [RequestOptions]
+    # @return [AuditEvents::ListAuditEventsResponse]
+    def list(cursor: nil, request_options: nil)
+      response = @request_client.conn.get("/audit-events") 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
+      AuditEvents::ListAuditEventsResponse.from_json(json_object: response.body)
+    end
+
+    # Fetch a specific audit event by ID.
+    #
+    # @param audit_event_id [String] A unique identifier associated with the audit event you wish to retrieve
+    # @param request_options [RequestOptions]
+    # @return [AuditEvents::AuditEvent]
+    def get(audit_event_id:, request_options: nil)
+      response = @request_client.conn.get("/audit-events/#{audit_event_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
+      AuditEvents::AuditEvent.from_json(json_object: response.body)
+    end
+  end
+
+  class AsyncAuditEventsClient
+    attr_reader :request_client
+
+    # @param request_client [AsyncRequestClient]
+    # @return [AsyncAuditEventsClient]
+    def initialize(request_client:)
+      # @type [AsyncRequestClient]
+      @request_client = request_client
+    end
+
+    # Fetch the list of audit events
+    #
+    # @param cursor [String] A unique identifier that allows for fetching the next set of audit events.
+    # @param request_options [RequestOptions]
+    # @return [AuditEvents::ListAuditEventsResponse]
+    def list(cursor: nil, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/audit-events") 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
+        AuditEvents::ListAuditEventsResponse.from_json(json_object: response.body)
+      end
+    end
+
+    # Fetch a specific audit event by ID.
+    #
+    # @param audit_event_id [String] A unique identifier associated with the audit event you wish to retrieve
+    # @param request_options [RequestOptions]
+    # @return [AuditEvents::AuditEvent]
+    def get(audit_event_id:, request_options: nil)
+      Async do
+        response = @request_client.conn.get("/audit-events/#{audit_event_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
+        AuditEvents::AuditEvent.from_json(json_object: response.body)
+      end
+    end
+  end
+end

data/lib/trycourier/audit_events/types/actor.rb

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