RubyGems - purecloudplatformclientv2 - Versions diffs - 53.0.0 → 54.0.0 - Mend

purecloudplatformclientv2 53.0.0 → 54.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (425) hide show

data/docs/UpdateShiftTradeRequest.md DELETED

@@ -1,16 +0,0 @@
----
-title: UpdateShiftTradeRequest
----
-## PureCloud::UpdateShiftTradeRequest
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **receiving_user_id** | **String** | Update the ID of the receiving user to direct the request at a specific user, or set to null to open up a trade to be matched by any user | [optional] |
-| **expiration** | **DateTime** | Update the expiration time for this shift trade. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ | [optional] |
-| **acceptable_intervals** | [**Array&lt;ShiftTradeResponseAcceptableIntervals&gt;**](ShiftTradeResponseAcceptableIntervals.html) |  | [optional] |
-| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata | |
-{: class="table table-striped"}

data/docs/UpdateShiftTradeStateRequest.md DELETED

@@ -1,14 +0,0 @@
----
-title: UpdateShiftTradeStateRequest
----
-## PureCloud::UpdateShiftTradeStateRequest
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **state** | **String** | The new state for this shift trade | |
-| **metadata** | [**WfmVersionedEntityMetadata**](WfmVersionedEntityMetadata.html) | Version metadata for the shift trade | |
-{: class="table table-striped"}

data/docs/UrlCondition.md DELETED

@@ -1,14 +0,0 @@
----
-title: UrlCondition
----
-## PureCloud::UrlCondition
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **values** | **Array&lt;String&gt;** | The URL condition value. | |
-| **operator** | **String** | The comparison operator. | |
-{: class="table table-striped"}

data/docs/WebActionEvent.md DELETED

@@ -1,26 +0,0 @@
----
-title: WebActionEvent
----
-## PureCloud::WebActionEvent
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **action** | [**EventAction**](EventAction.html) | The action that triggered the event. | |
-| **action_map** | [**ActionMap**](ActionMap.html) | The action map that triggered the action. | [optional] |
-| **action_target** | [**ActionTarget**](ActionTarget.html) | The target for engagement actions. | [optional] |
-| **time_to_disposition** | **Integer** | Milliseconds elapsed until the action is disposed. | [optional] |
-| **error_code** | **String** | Code of the error returned when the action fails. | [optional] |
-| **error_message** | **String** | Message of the error returned when the action fails. | [optional] |
-| **user_agent_string** | **String** | HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15). | [optional] |
-| **browser** | [**Browser**](Browser.html) | Customer&#39;s browser. | [optional] |
-| **device** | [**Device**](Device.html) | Customer&#39;s device. | [optional] |
-| **geolocation** | [**JourneyGeolocation**](JourneyGeolocation.html) | Customer&#39;s geolocation. | [optional] |
-| **ip_address** | **String** | Visitor&#39;s IP address. | [optional] |
-| **ip_organization** | **String** | Visitor&#39;s IP-based organization or ISP name. | [optional] |
-| **mkt_campaign** | [**JourneyCampaign**](JourneyCampaign.html) | Marketing / traffic source information. | [optional] |
-| **visit_referrer** | [**Referrer**](Referrer.html) | Visit&#39;s referrer. | [optional] |
-{: class="table table-striped"}

data/docs/WebEvent.md DELETED

@@ -1,25 +0,0 @@
----
-title: WebEvent
----
-## PureCloud::WebEvent
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **event_name** | **String** | Represents the action the customer performed. A good event name is typically an object followed by the action performed in past tense (e.g. page_viewed, order_completed, user_registered). | |
-| **total_event_count** | **Integer** | The total count of events performed by the customer across all sessions. | [optional] |
-| **total_pageview_count** | **Integer** | The total count of pageviews performed by the customer across all sessions. | [optional] |
-| **page** | [**JourneyPage**](JourneyPage.html) | The webpage where the user interaction occurred. | [optional] |
-| **user_agent_string** | **String** | HTTP User-Agent string (see https://tools.ietf.org/html/rfc1945#section-10.15). | [optional] |
-| **browser** | [**Browser**](Browser.html) | Customer&#39;s browser. | [optional] |
-| **device** | [**Device**](Device.html) | Customer&#39;s device. | [optional] |
-| **geolocation** | [**JourneyGeolocation**](JourneyGeolocation.html) | Customer&#39;s geolocation. | [optional] |
-| **ip_address** | **String** | Customer&#39;s IP address. May be null if the business configures the tracker to not collect IP addresses. | [optional] |
-| **ip_organization** | **String** | Customer&#39;s IP-based organization or ISP name. | [optional] |
-| **mkt_campaign** | [**JourneyCampaign**](JourneyCampaign.html) | Marketing / traffic source information. | [optional] |
-| **referrer** | [**Referrer**](Referrer.html) | Identifies the page URL that originally generated the request for the current page being viewed. | [optional] |
-| **attributes** | [**Hash&lt;String, CustomEventAttribute&gt;**](CustomEventAttribute.html) | User-defined attributes associated with a particular event. | [optional] |
-{: class="table table-striped"}

data/docs/WeekShiftTradeListResponse.md DELETED

@@ -1,13 +0,0 @@
----
-title: WeekShiftTradeListResponse
----
-## PureCloud::WeekShiftTradeListResponse
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **entities** | [**Array&lt;WeekShiftTradeResponse&gt;**](WeekShiftTradeResponse.html) |  | [optional] |
-{: class="table table-striped"}

data/docs/WeekShiftTradeResponse.md DELETED

@@ -1,14 +0,0 @@
----
-title: WeekShiftTradeResponse
----
-## PureCloud::WeekShiftTradeResponse
-## Properties
-|Name | Type | Description | Notes|
-|------------ | ------------- | ------------- | -------------|
-| **trade** | [**ShiftTradeResponse**](ShiftTradeResponse.html) | The shift trade details | [optional] |
-| **match_review** | [**ShiftTradeMatchReviewResponse**](ShiftTradeMatchReviewResponse.html) | A preview of what the schedule would look like if the shift trade is approved plus any violations | [optional] |
-{: class="table table-striped"}

data/lib/purecloudplatformclientv2/api/journey_api.rb DELETED

@@ -1,119 +0,0 @@
-=begin
-PureCloud Platform API
-With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
-OpenAPI spec version: v2
-Contact: DeveloperEvangelists@genesys.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-License: UNLICENSED
-https://help.mypurecloud.com/articles/terms-and-conditions/
-Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
-=end
-require "uri"
-module PureCloud
-  class JourneyApi
-    attr_accessor :api_client
-    def initialize(api_client = ApiClient.default)
-      @api_client = api_client
-    end
-    # Retrieve all events for a given session.
-    #
-    # @param session_id System-generated UUID that represents the session the event is a part of.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :before The cursor that points to the start of the set of entities that has been returned.
-    # @option opts [String] :after The cursor that points to the end of the set of entities that has been returned.
-    # @option opts [String] :limit Number of entities to return. Maximum of 200.
-    # @return [EventListing]
-    def get_journey_session_events(session_id, opts = {})
-      data, _status_code, _headers = get_journey_session_events_with_http_info(session_id, opts)
-      return data
-    end
-    # Retrieve all events for a given session.
-    #
-    # @param session_id System-generated UUID that represents the session the event is a part of.
-    # @param [Hash] opts the optional parameters
-    # @option opts [String] :before The cursor that points to the start of the set of entities that has been returned.
-    # @option opts [String] :after The cursor that points to the end of the set of entities that has been returned.
-    # @option opts [String] :limit Number of entities to return. Maximum of 200.
-    # @return [Array<(EventListing, Fixnum, Hash)>] EventListing data, response status code and response headers
-    def get_journey_session_events_with_http_info(session_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: JourneyApi.get_journey_session_events ..."
-      end
-      # verify the required parameter 'session_id' is set
-      fail ArgumentError, "Missing the required parameter 'session_id' when calling JourneyApi.get_journey_session_events" if session_id.nil?
-      # resource path
-      local_var_path = "/api/v2/journey/sessions/{sessionId}/events".sub('{format}','json').sub('{' + 'sessionId' + '}', session_id.to_s)
-      # query parameters
-      query_params = {}
-      query_params[:'before'] = opts[:'before'] if opts[:'before']
-      query_params[:'after'] = opts[:'after'] if opts[:'after']
-      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
-      # header parameters
-      header_params = {}
-      # HTTP header 'Accept' (if needed)
-      local_header_accept = ['application/json']
-      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
-      # HTTP header 'Content-Type'
-      local_header_content_type = ['application/json']
-      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
-      # form parameters
-      form_params = {}
-      # http body (model)
-      post_body = nil
-      auth_names = ['PureCloud OAuth']
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
-        :header_params => header_params,
-        :query_params => query_params,
-        :form_params => form_params,
-        :body => post_body,
-        :auth_names => auth_names,
-        :return_type => 'EventListing')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: JourneyApi#get_journey_session_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-  end
-end

data/lib/purecloudplatformclientv2/models/action_map.rb DELETED

@@ -1,666 +0,0 @@
-=begin
-PureCloud Platform API
-With the PureCloud Platform API, you can control all aspects of your PureCloud environment. With the APIs you can access the system configuration, manage conversations and more.
-OpenAPI spec version: v2
-Contact: DeveloperEvangelists@genesys.com
-Generated by: https://github.com/swagger-api/swagger-codegen.git
-License: UNLICENSED
-https://help.mypurecloud.com/articles/terms-and-conditions/
-Terms of Service: https://help.mypurecloud.com/articles/terms-and-conditions/
-=end
-require 'date'
-module PureCloud
-  class ActionMap
-    # The globally unique identifier for the object.
-    attr_accessor :id
-    attr_accessor :name
-    # The version of the action map.
-    attr_accessor :version
-    # Whether the action map is active.
-    attr_accessor :is_active
-    # Display name of the action map.
-    attr_accessor :display_name
-    # Trigger action map if any segment in the list is assigned to a given customer.
-    attr_accessor :trigger_with_segments
-    # List of event conditions that must be satisfied to trigger the action map.
-    attr_accessor :trigger_with_event_conditions
-    # Probability conditions for outcomes that must be satisfied to trigger the action map.
-    attr_accessor :trigger_with_outcome_probability_conditions
-    # URL conditions that a page must match for web actions to be displayable.
-    attr_accessor :page_url_conditions
-    # Type of activation.
-    attr_accessor :activation
-    # Weight of the action map with higher number denoting higher weight.
-    attr_accessor :weight
-    # The action that will be executed if this action map is triggered.
-    attr_accessor :action
-    # The estimated wait time limit above which actions will not be offered.
-    attr_accessor :estimated_wait_time_limit
-    # The URI for this object
-    attr_accessor :self_uri
-    # Timestamp indicating when the action map was created. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :created_date
-    # Timestamp indicating when the action map was last updated. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :modified_date
-    # Timestamp at which the action map is scheduled to start firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :start_date
-    # Timestamp at which the action map is scheduled to stop firing. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
-    attr_accessor :end_date
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'id' => :'id',
-        :'name' => :'name',
-        :'version' => :'version',
-        :'is_active' => :'isActive',
-        :'display_name' => :'displayName',
-        :'trigger_with_segments' => :'triggerWithSegments',
-        :'trigger_with_event_conditions' => :'triggerWithEventConditions',
-        :'trigger_with_outcome_probability_conditions' => :'triggerWithOutcomeProbabilityConditions',
-        :'page_url_conditions' => :'pageUrlConditions',
-        :'activation' => :'activation',
-        :'weight' => :'weight',
-        :'action' => :'action',
-        :'estimated_wait_time_limit' => :'estimatedWaitTimeLimit',
-        :'self_uri' => :'selfUri',
-        :'created_date' => :'createdDate',
-        :'modified_date' => :'modifiedDate',
-        :'start_date' => :'startDate',
-        :'end_date' => :'endDate'
-      }
-    end
-    # Attribute type mapping.
-    def self.swagger_types
-      {
-        :'id' => :'String',
-        :'name' => :'String',
-        :'version' => :'Integer',
-        :'is_active' => :'BOOLEAN',
-        :'display_name' => :'String',
-        :'trigger_with_segments' => :'Array<String>',
-        :'trigger_with_event_conditions' => :'Array<EventCondition>',
-        :'trigger_with_outcome_probability_conditions' => :'Array<OutcomeProbabilityCondition>',
-        :'page_url_conditions' => :'Array<UrlCondition>',
-        :'activation' => :'Activation',
-        :'weight' => :'Integer',
-        :'action' => :'ActionMapAction',
-        :'estimated_wait_time_limit' => :'Integer',
-        :'self_uri' => :'String',
-        :'created_date' => :'DateTime',
-        :'modified_date' => :'DateTime',
-        :'start_date' => :'DateTime',
-        :'end_date' => :'DateTime'
-      }
-    end
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      return unless attributes.is_a?(Hash)
-      # convert string to symbol for hash key
-      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
-      if attributes.has_key?(:'id')
-        self.id = attributes[:'id']
-      end
-      if attributes.has_key?(:'name')
-        self.name = attributes[:'name']
-      end
-      if attributes.has_key?(:'version')
-        self.version = attributes[:'version']
-      end
-      if attributes.has_key?(:'isActive')
-        self.is_active = attributes[:'isActive']
-      end
-      if attributes.has_key?(:'displayName')
-        self.display_name = attributes[:'displayName']
-      end
-      if attributes.has_key?(:'triggerWithSegments')
-        if (value = attributes[:'triggerWithSegments']).is_a?(Array)
-          self.trigger_with_segments = value
-        end
-      end
-      if attributes.has_key?(:'triggerWithEventConditions')
-        if (value = attributes[:'triggerWithEventConditions']).is_a?(Array)
-          self.trigger_with_event_conditions = value
-        end
-      end
-      if attributes.has_key?(:'triggerWithOutcomeProbabilityConditions')
-        if (value = attributes[:'triggerWithOutcomeProbabilityConditions']).is_a?(Array)
-          self.trigger_with_outcome_probability_conditions = value
-        end
-      end
-      if attributes.has_key?(:'pageUrlConditions')
-        if (value = attributes[:'pageUrlConditions']).is_a?(Array)
-          self.page_url_conditions = value
-        end
-      end
-      if attributes.has_key?(:'activation')
-        self.activation = attributes[:'activation']
-      end
-      if attributes.has_key?(:'weight')
-        self.weight = attributes[:'weight']
-      end
-      if attributes.has_key?(:'action')
-        self.action = attributes[:'action']
-      end
-      if attributes.has_key?(:'estimatedWaitTimeLimit')
-        self.estimated_wait_time_limit = attributes[:'estimatedWaitTimeLimit']
-      end
-      if attributes.has_key?(:'selfUri')
-        self.self_uri = attributes[:'selfUri']
-      end
-      if attributes.has_key?(:'createdDate')
-        self.created_date = attributes[:'createdDate']
-      end
-      if attributes.has_key?(:'modifiedDate')
-        self.modified_date = attributes[:'modifiedDate']
-      end
-      if attributes.has_key?(:'startDate')
-        self.start_date = attributes[:'startDate']
-      end
-      if attributes.has_key?(:'endDate')
-        self.end_date = attributes[:'endDate']
-      end
-    end
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
-    def list_invalid_properties
-      invalid_properties = Array.new
-      return 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?
-      if @display_name.nil?
-        return false
-      end
-      if @trigger_with_segments.nil?
-        return false
-      end
-      if @page_url_conditions.nil?
-        return false
-      end
-    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 &&
-          id == o.id &&
-          name == o.name &&
-          version == o.version &&
-          is_active == o.is_active &&
-          display_name == o.display_name &&
-          trigger_with_segments == o.trigger_with_segments &&
-          trigger_with_event_conditions == o.trigger_with_event_conditions &&
-          trigger_with_outcome_probability_conditions == o.trigger_with_outcome_probability_conditions &&
-          page_url_conditions == o.page_url_conditions &&
-          activation == o.activation &&
-          weight == o.weight &&
-          action == o.action &&
-          estimated_wait_time_limit == o.estimated_wait_time_limit &&
-          self_uri == o.self_uri &&
-          created_date == o.created_date &&
-          modified_date == o.modified_date &&
-          start_date == o.start_date &&
-          end_date == o.end_date
-    end
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-    # Calculates hash code according to all attributes.
-    # @return [Fixnum] Hash code
-    def hash
-      [id, name, version, is_active, display_name, trigger_with_segments, trigger_with_event_conditions, trigger_with_outcome_probability_conditions, page_url_conditions, activation, weight, action, estimated_wait_time_limit, self_uri, created_date, modified_date, start_date, end_date].hash
-    end
-    # build the object from hash
-    def build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      self.class.swagger_types.each_pair do |key, type|
-        if type =~ /^Array<(.*)>/i
-          if attributes[self.class.attribute_map[key]].is_a?(Array)
-            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
-          else
-            #TODO show warning in debug mode
-          end
-        elsif !attributes[self.class.attribute_map[key]].nil?
-          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
-      end
-      self
-    end
-    def _deserialize(type, value)
-      case type.to_sym
-      when :DateTime
-        DateTime.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 =~ /^(true|t|yes|y|1)$/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
-        _model = Object.const_get("PureCloud").const_get(type).new
-        _model.build_from_hash(value)
-      end
-    end
-    def to_s
-      to_hash.to_s
-    end
-    # to_body is an alias to to_body (backward compatibility))
-    def to_body
-      to_hash
-    end
-    # return the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        next if value.nil?
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-    # Method to output non-array value in the form of hash
-    # For object, use to_hash. Otherwise, just return the value
-    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