onesignal 5.11.2 → 5.12.0

data/lib/onesignal/models/update_journey_request.rb

@@ -0,0 +1,337 @@
+=begin
+#OneSignal
+
+#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
+
+Contact: devrel@onesignal.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module OneSignal
+  # Partial update applied with JSON Merge Patch (RFC 7396). Send only the fields you want to change. A null value clears a nullable field. Arrays such as nodes are replaced wholesale.
+  class UpdateJourneyRequest
+    # Journey name.
+    attr_accessor :name
+
+    # Journey description. Send null to clear it.
+    attr_accessor :description
+
+    attr_accessor :audience
+
+    attr_accessor :early_exit
+
+    attr_accessor :reentry_rules
+
+    attr_accessor :schedule
+
+    # Full ordered list of nodes, which replaces the existing graph wholesale. Preserve each node's server-assigned id from a prior fetch to keep in-flight users on that node; omit id to add a new node.
+    attr_accessor :nodes
+
+    # Target state. Set active to activate a draft journey, or scheduled together with a future schedule.start_at to activate it later. Set archived to stop a running journey; archiving is permanent. Only scheduled and processing journeys can return to draft.
+    attr_accessor :state
+
+    # Optional optimistic-concurrency token. Pass the concurrency_key from a prior fetch to reject the update with 409 if the journey changed. Omit to skip the check.
+    attr_accessor :concurrency_key
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'name' => :'name',
+        :'description' => :'description',
+        :'audience' => :'audience',
+        :'early_exit' => :'early_exit',
+        :'reentry_rules' => :'reentry_rules',
+        :'schedule' => :'schedule',
+        :'nodes' => :'nodes',
+        :'state' => :'state',
+        :'concurrency_key' => :'concurrency_key'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'name' => :'String',
+        :'description' => :'String',
+        :'audience' => :'JourneyAudience',
+        :'early_exit' => :'JourneyEarlyExit',
+        :'reentry_rules' => :'JourneyReentryRules',
+        :'schedule' => :'JourneySchedule',
+        :'nodes' => :'Array<JourneyNode>',
+        :'state' => :'String',
+        :'concurrency_key' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'description',
+        :'early_exit',
+        :'reentry_rules',
+        :'schedule',
+        :'concurrency_key'
+      ])
+    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 `OneSignal::UpdateJourneyRequest` 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 `OneSignal::UpdateJourneyRequest`. 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?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'description')
+        self.description = attributes[:'description']
+      end
+
+      if attributes.key?(:'audience')
+        self.audience = attributes[:'audience']
+      end
+
+      if attributes.key?(:'early_exit')
+        self.early_exit = attributes[:'early_exit']
+      end
+
+      if attributes.key?(:'reentry_rules')
+        self.reentry_rules = attributes[:'reentry_rules']
+      end
+
+      if attributes.key?(:'schedule')
+        self.schedule = attributes[:'schedule']
+      end
+
+      if attributes.key?(:'nodes')
+        if (value = attributes[:'nodes']).is_a?(Array)
+          self.nodes = value
+        end
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      end
+
+      if attributes.key?(:'concurrency_key')
+        self.concurrency_key = attributes[:'concurrency_key']
+      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?
+      state_validator = EnumAttributeValidator.new('String', ["draft", "scheduled", "active", "archived"])
+      return false unless state_validator.valid?(@state)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["draft", "scheduled", "active", "archived"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    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 &&
+          name == o.name &&
+          description == o.description &&
+          audience == o.audience &&
+          early_exit == o.early_exit &&
+          reentry_rules == o.reentry_rules &&
+          schedule == o.schedule &&
+          nodes == o.nodes &&
+          state == o.state &&
+          concurrency_key == o.concurrency_key
+    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
+      [name, description, audience, early_exit, reentry_rules, schedule, nodes, state, concurrency_key].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = OneSignal.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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/onesignal/version.rb

@@ -10,5 +10,5 @@ OpenAPI Generator version: 6.0.0-SNAPSHOT
 =end
 
 module OneSignal
-  VERSION = '5.11.2'
+  VERSION = '5.12.0'
 end

data/lib/onesignal.rb

@@ -31,6 +31,7 @@ require 'onesignal/models/button'
 require 'onesignal/models/copy_template_request'
 require 'onesignal/models/create_api_key_request'
 require 'onesignal/models/create_api_key_response'
+require 'onesignal/models/create_journey_request'
 require 'onesignal/models/create_notification_success_response'
 require 'onesignal/models/create_segment_conflict_response'
 require 'onesignal/models/create_segment_success_response'
@@ -51,6 +52,28 @@ require 'onesignal/models/generic_success_bool_response'
 require 'onesignal/models/get_notification_history_request_body'
 require 'onesignal/models/get_segment_success_response'
 require 'onesignal/models/get_segments_success_response'
+require 'onesignal/models/journey'
+require 'onesignal/models/journey_audience'
+require 'onesignal/models/journey_branch'
+require 'onesignal/models/journey_branch_stats'
+require 'onesignal/models/journey_condition'
+require 'onesignal/models/journey_early_exit'
+require 'onesignal/models/journey_early_exit_rules'
+require 'onesignal/models/journey_early_exit_rules_on_event'
+require 'onesignal/models/journey_early_exit_rules_on_segment'
+require 'onesignal/models/journey_event_attribute'
+require 'onesignal/models/journey_list_audience'
+require 'onesignal/models/journey_list_item'
+require 'onesignal/models/journey_list_response'
+require 'onesignal/models/journey_message_stats'
+require 'onesignal/models/journey_node'
+require 'onesignal/models/journey_node_stats'
+require 'onesignal/models/journey_reentry_rules'
+require 'onesignal/models/journey_schedule'
+require 'onesignal/models/journey_stats'
+require 'onesignal/models/journey_time_point'
+require 'onesignal/models/journey_time_window'
+require 'onesignal/models/journey_wait_until_expiration'
 require 'onesignal/models/language_string_map'
 require 'onesignal/models/list_audit_logs_success_response'
 require 'onesignal/models/notification'
@@ -84,6 +107,8 @@ require 'onesignal/models/template_resource'
 require 'onesignal/models/templates_list_response'
 require 'onesignal/models/transfer_subscription_request_body'
 require 'onesignal/models/update_api_key_request'
+require 'onesignal/models/update_journey_node_request'
+require 'onesignal/models/update_journey_request'
 require 'onesignal/models/update_live_activity_request'
 require 'onesignal/models/update_live_activity_success_response'
 require 'onesignal/models/update_segment_request'

data/spec/api/default_api_spec.rb

@@ -123,6 +123,19 @@ describe 'DefaultApi' do
     end
   end
 
+  # unit tests for create_journey
+  # Create journey
+  # The Journeys API is in beta. Endpoints and response fields can still change. Create a new journey with an audience and a node graph. Journeys are always created in the draft state. The authenticated App API key must have permission to create journeys.
+  # @param app_id Your OneSignal App ID in UUID v4 format.
+  # @param create_journey_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Journey]
+  describe 'create_journey test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for create_notification
   # Create notification
   # Sends notifications to your users.  **Target by External ID (push example):** set `include_aliases` to `{ \"external_id\": [\"your-user-id\"] }` and set `target_channel` to `push` (or `email` / `sms` for those channels). Alias object keys must match API labels exactly (for example `external_id`, not camelCase).  **Do not confuse** the notification-level `external_id` field with External ID targeting: top-level `external_id` / `idempotency_key` are for idempotent notification requests only, not for selecting recipients.  **Targeting compatibility:** `include_aliases` must not be combined with other targeting modes (segments, filters, subscription IDs, legacy player IDs, etc.). Clients should send only one targeting strategy per request. 
@@ -213,6 +226,19 @@ describe 'DefaultApi' do
     end
   end
 
+  # unit tests for delete_journey
+  # Delete journey
+  # The Journeys API is in beta. Endpoints and response fields can still change. Permanently delete a journey by its UUID. Returns { \"success\": true } on success. The authenticated App API key must have permission to delete journeys. Deleting a journey stops any in-flight users and cannot be undone. Archive a running journey instead if you need to keep its data.
+  # @param app_id Your OneSignal App ID in UUID v4 format.
+  # @param journey_id UUID of the journey to delete.
+  # @param [Hash] opts the optional parameters
+  # @return [GenericSuccessBoolResponse]
+  describe 'delete_journey test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for delete_segment
   # Delete Segment
   # Delete a segment (not user devices) - Required: OneSignal Paid Plan You can delete a segment under your app by calling this API. You must provide an API key in the Authorization header that has admin access on the app. The segment_id can be found in the URL of the segment when viewing it in the dashboard. 
@@ -542,6 +568,35 @@ describe 'DefaultApi' do
     end
   end
 
+  # unit tests for update_journey
+  # Update journey
+  # The Journeys API is in beta. Endpoints and response fields can still change. Apply a partial update to a journey using JSON Merge Patch (RFC 7396). Send only the fields you want to change; omitted fields are left unchanged. A null value clears a nullable field, and arrays such as nodes are replaced wholesale. Set state to active to activate a draft journey.
+  # @param app_id Your OneSignal App ID in UUID v4 format.
+  # @param journey_id UUID of the journey to update.
+  # @param update_journey_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Journey]
+  describe 'update_journey test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for update_journey_node
+  # Update journey node
+  # The Journeys API is in beta. Endpoints and response fields can still change. Apply a partial update to a single node, located by its server-assigned id, using JSON Merge Patch (RFC 7396). Send only the node fields you want to change; the rest of the node and the rest of the journey graph are left untouched. Returns the full updated journey.
+  # @param app_id Your OneSignal App ID in UUID v4 format.
+  # @param journey_id UUID of the journey that owns the node.
+  # @param node_id Server-assigned UUID of the node to update, from a prior View journey fetch.
+  # @param update_journey_node_request 
+  # @param [Hash] opts the optional parameters
+  # @return [Journey]
+  describe 'update_journey_node test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for update_live_activity
   # Update a Live Activity via Push
   # Updates a specified live activity.
@@ -638,6 +693,46 @@ describe 'DefaultApi' do
     end
   end
 
+  # unit tests for view_journey
+  # View journey
+  # The Journeys API is in beta. Endpoints and response fields can still change. Retrieve the full configuration of a single journey by its UUID, including its audience and node graph.
+  # @param app_id Your OneSignal App ID in UUID v4 format.
+  # @param journey_id UUID of the journey to retrieve.
+  # @param [Hash] opts the optional parameters
+  # @return [Journey]
+  describe 'view_journey test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for view_journey_stats
+  # View journey stats
+  # The Journeys API is in beta. Endpoints and response fields can still change. Retrieve performance stats for a single journey: journey-level entry and exit counts, per-node counts keyed by node id, per-branch counts keyed by branch id, and channel delivery stats for message-sending nodes. The response carries no definition detail, so join it by id against the journey from View journey.
+  # @param app_id Your OneSignal App ID in UUID v4 format.
+  # @param journey_id UUID of the journey to retrieve stats for.
+  # @param [Hash] opts the optional parameters
+  # @return [JourneyStats]
+  describe 'view_journey_stats test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  # unit tests for view_journeys
+  # View journeys
+  # The Journeys API is in beta. Endpoints and response fields can still change. Retrieve a paginated list of journeys for an app. Returns a summary representation of each journey; use View journey for the full configuration. Uses forward-only cursor-based pagination.
+  # @param app_id Your OneSignal App ID in UUID v4 format.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :cursor Opaque pagination token from a previous response's next_cursor. Omit for the first page.
+  # @option opts [Integer] :limit Maximum journeys to return per page. Minimum 1, maximum 50.
+  # @return [JourneyListResponse]
+  describe 'view_journeys test' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
   # unit tests for view_template
   # View template
   # Fetch a single template by id.

data/spec/models/create_journey_request_spec.rb

@@ -0,0 +1,69 @@
+=begin
+#OneSignal
+
+#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
+
+Contact: devrel@onesignal.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OneSignal::CreateJourneyRequest
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OneSignal::CreateJourneyRequest do
+  let(:instance) { OneSignal::CreateJourneyRequest.new }
+
+  describe 'test an instance of CreateJourneyRequest' do
+    it 'should create an instance of CreateJourneyRequest' do
+      expect(instance).to be_instance_of(OneSignal::CreateJourneyRequest)
+    end
+  end
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "description"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "audience"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "early_exit"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "reentry_rules"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "schedule"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "nodes"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end

data/spec/models/journey_audience_spec.rb

@@ -0,0 +1,67 @@
+=begin
+#OneSignal
+
+#A powerful way to send personalized messages at scale and build effective customer engagement strategies. Learn more at onesignal.com
+
+Contact: devrel@onesignal.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.0-SNAPSHOT
+
+=end
+
+require 'spec_helper'
+require 'json'
+require 'date'
+
+# Unit tests for OneSignal::JourneyAudience
+# Automatically generated by openapi-generator (https://openapi-generator.tech)
+# Please update as you see appropriate
+describe OneSignal::JourneyAudience do
+  let(:instance) { OneSignal::JourneyAudience.new }
+
+  describe 'test an instance of JourneyAudience' do
+    it 'should create an instance of JourneyAudience' do
+      expect(instance).to be_instance_of(OneSignal::JourneyAudience)
+    end
+  end
+  describe 'test attribute "kind"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+      # validator = Petstore::EnumTest::EnumAttributeValidator.new('String', ["segment", "event_trigger"])
+      # validator.allowable_values.each do |value|
+      #   expect { instance.kind = value }.not_to raise_error
+      # end
+    end
+  end
+
+  describe 'test attribute "included_segment_ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "excluded_segment_ids"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "future_additions_only"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "name"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+  describe 'test attribute "attributes"' do
+    it 'should work' do
+      # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
+    end
+  end
+
+end