api-sdk-rb 1.11.111 → 1.11.133

data/lib/api-sdk-rb/models/get_operation_response_data_metadata.rb

@@ -0,0 +1,283 @@
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+require 'date'
+require 'time'
+
+module ApiSdkRb
+  # What the operation tells about its work. A finished composition duplication names the new composition in `newCompositionId`, and lists any problem with its database in `warnings` (absent when there is none). A code generation whose request declared `clientCapabilities` also tells what that client asked to show: `plan` while it builds, `outcome` `needs_answers` with the card in `clarification` when it asked before building, and `nextSteps` once it is done. A key whose part the client did not declare is never present. During code generation, `stage` is a short status line. While the model streams code, `streamTail` holds the last portion of generated source (replaced periodically, cleared when streaming ends). While the model streams reasoning before code, `thinkingTail` holds the last portion of reasoning text (same cadence; cleared when code streaming starts or the run ends). Clients may read `thinkingTail` or `thinking_tail`. 
+  class GetOperationResponseDataMetadata
+    # The plan of a code generation, published when it is made and again each time a step changes (`pending`, `in_progress`, `done`, `failed`). `null` when the build was called off, so the client hides the plan it showed. 
+    attr_accessor :plan
+
+    # `needs_answers` on a code generation that completed by asking questions: nothing was built, the credit was returned, and the card is in `clarification`. Absent on every other outcome. 
+    attr_accessor :outcome
+
+    # The card of questions, present with `outcome` `needs_answers`.
+    attr_accessor :clarification
+
+    # Suggested next improvements of a completed code generation, the recommended one first. Absent when none were made in time or the build was not kept. 
+    attr_accessor :next_steps
+
+    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
+      {
+        :'plan' => :'plan',
+        :'outcome' => :'outcome',
+        :'clarification' => :'clarification',
+        :'next_steps' => :'nextSteps'
+      }
+    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
+      {
+        :'plan' => :'WidgetPlan',
+        :'outcome' => :'String',
+        :'clarification' => :'WidgetClarification',
+        :'next_steps' => :'Array<WidgetNextStep>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'plan',
+      ])
+    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 `ApiSdkRb::GetOperationResponseDataMetadata` 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 `ApiSdkRb::GetOperationResponseDataMetadata`. 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?(:'plan')
+        self.plan = attributes[:'plan']
+      end
+
+      if attributes.key?(:'outcome')
+        self.outcome = attributes[:'outcome']
+      end
+
+      if attributes.key?(:'clarification')
+        self.clarification = attributes[:'clarification']
+      end
+
+      if attributes.key?(:'next_steps')
+        if (value = attributes[:'next_steps']).is_a?(Array)
+          self.next_steps = value
+        end
+      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
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      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?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      outcome_validator = EnumAttributeValidator.new('String', ["needs_answers"])
+      return false unless outcome_validator.valid?(@outcome)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] outcome Object to be assigned
+    def outcome=(outcome)
+      validator = EnumAttributeValidator.new('String', ["needs_answers"])
+      unless validator.valid?(outcome)
+        fail ArgumentError, "invalid value for \"outcome\", must be one of #{validator.allowable_values}."
+      end
+      @outcome = outcome
+    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 &&
+          plan == o.plan &&
+          outcome == o.outcome &&
+          clarification == o.clarification &&
+          next_steps == o.next_steps
+    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
+      [plan, outcome, clarification, next_steps].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)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{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[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def self._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 = ApiSdkRb.const_get(type)
+        klass.respond_to?(:openapi_any_of) || 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/api-sdk-rb/models/{uploads_get200_response.rb → list_uploads200_response.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module ApiSdkRb
-  class UploadsGet200Response
+  class ListUploads200Response
     attr_accessor :success
 
     attr_accessor :data
@@ -54,13 +54,13 @@ module ApiSdkRb
     # @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 `ApiSdkRb::UploadsGet200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ApiSdkRb::ListUploads200Response` 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 `ApiSdkRb::UploadsGet200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::ListUploads200Response`. 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
       }

data/lib/api-sdk-rb/models/{get_managed_user_limits200_response.rb → managed_user_limits_response.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module ApiSdkRb
-  class GetManagedUserLimits200Response
+  class ManagedUserLimitsResponse
     attr_accessor :success
 
     attr_accessor :data
@@ -54,13 +54,13 @@ module ApiSdkRb
     # @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 `ApiSdkRb::GetManagedUserLimits200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ApiSdkRb::ManagedUserLimitsResponse` 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 `ApiSdkRb::GetManagedUserLimits200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::ManagedUserLimitsResponse`. 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
       }

data/lib/api-sdk-rb/models/{uploads_id_delete200_response.rb → managed_user_removal_response.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module ApiSdkRb
-  class UploadsIdDelete200Response
+  class ManagedUserRemovalResponse
     attr_accessor :success
 
     attr_accessor :data
@@ -39,7 +39,7 @@ module ApiSdkRb
     def self.openapi_types
       {
         :'success' => :'Boolean',
-        :'data' => :'UploadsIdDelete200ResponseData',
+        :'data' => :'ManagedUserRemoval',
         :'meta' => :'ResponseMeta'
       }
     end
@@ -54,13 +54,13 @@ module ApiSdkRb
     # @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 `ApiSdkRb::UploadsIdDelete200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ApiSdkRb::ManagedUserRemovalResponse` 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 `ApiSdkRb::UploadsIdDelete200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::ManagedUserRemovalResponse`. 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
       }

data/lib/api-sdk-rb/models/patch_brand_kit_request.rb

@@ -21,6 +21,9 @@ module ApiSdkRb
 
     attr_accessor :fonts
 
+    # The whole list of text styles (it replaces the saved list). An empty list removes them, and the fonts by role apply again. Left out, the saved text styles stay as they are.
+    attr_accessor :text_styles
+
     attr_accessor :spacing
 
     # One corner radius in pixels for the whole kit; the small, medium and large radii are made from it. 0 gives square corners. A radius step sent in `spacing` wins over the one made from this value.
@@ -37,6 +40,7 @@ module ApiSdkRb
       {
         :'colors' => :'colors',
         :'fonts' => :'fonts',
+        :'text_styles' => :'textStyles',
         :'spacing' => :'spacing',
         :'corner_radius' => :'cornerRadius',
         :'instructions' => :'instructions',
@@ -54,6 +58,7 @@ module ApiSdkRb
       {
         :'colors' => :'Array<BrandColor>',
         :'fonts' => :'PatchBrandKitRequestFonts',
+        :'text_styles' => :'Array<BrandTextStyle>',
         :'spacing' => :'PatchBrandKitRequestSpacing',
         :'corner_radius' => :'Integer',
         :'instructions' => :'String',
@@ -92,6 +97,12 @@ module ApiSdkRb
         self.fonts = attributes[:'fonts']
       end
 
+      if attributes.key?(:'text_styles')
+        if (value = attributes[:'text_styles']).is_a?(Array)
+          self.text_styles = value
+        end
+      end
+
       if attributes.key?(:'spacing')
         self.spacing = attributes[:'spacing']
       end
@@ -118,6 +129,10 @@ module ApiSdkRb
         invalid_properties.push('invalid value for "colors", number of items must be less than or equal to 24.')
       end
 
+      if !@text_styles.nil? && @text_styles.length > 12
+        invalid_properties.push('invalid value for "text_styles", number of items must be less than or equal to 12.')
+      end
+
       if !@corner_radius.nil? && @corner_radius > 64
         invalid_properties.push('invalid value for "corner_radius", must be smaller than or equal to 64.')
       end
@@ -138,6 +153,7 @@ module ApiSdkRb
     def valid?
       warn '[DEPRECATED] the `valid?` method is obsolete'
       return false if !@colors.nil? && @colors.length > 24
+      return false if !@text_styles.nil? && @text_styles.length > 12
       return false if !@corner_radius.nil? && @corner_radius > 64
       return false if !@corner_radius.nil? && @corner_radius < 0
       return false if !@instructions.nil? && @instructions.to_s.length > 500
@@ -158,6 +174,20 @@ module ApiSdkRb
       @colors = colors
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] text_styles Value to be assigned
+    def text_styles=(text_styles)
+      if text_styles.nil?
+        fail ArgumentError, 'text_styles cannot be nil'
+      end
+
+      if text_styles.length > 12
+        fail ArgumentError, 'invalid value for "text_styles", number of items must be less than or equal to 12.'
+      end
+
+      @text_styles = text_styles
+    end
+
     # Custom attribute writer method with validation
     # @param [Object] corner_radius Value to be assigned
     def corner_radius=(corner_radius)
@@ -197,6 +227,7 @@ module ApiSdkRb
       self.class == o.class &&
           colors == o.colors &&
           fonts == o.fonts &&
+          text_styles == o.text_styles &&
           spacing == o.spacing &&
           corner_radius == o.corner_radius &&
           instructions == o.instructions &&
@@ -212,7 +243,7 @@ module ApiSdkRb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [colors, fonts, spacing, corner_radius, instructions, expected_version].hash
+      [colors, fonts, text_styles, spacing, corner_radius, instructions, expected_version].hash
     end
 
     # Builds the object from hash

data/lib/api-sdk-rb/models/public_workflow_events_request_events_inner.rb

@@ -24,6 +24,9 @@ module ApiSdkRb
     # How many times (1 when not given).
     attr_accessor :c
 
+    # Only on an `f` event: why moving the visitor on failed. `t` the composition did not appear in time, `e` the widget in it reported an error, `b` the composition could not be built, `o` another reason (a step was already on its way, or the page was going away). Left out by an embed that does not say why; a letter this server does not know is read as left out, and the failure is still counted. On an `n` or an `e` event it is ignored. Never a message: one letter, so that nothing a visitor typed can ride on it. 
+    attr_accessor :r
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -51,7 +54,8 @@ module ApiSdkRb
       {
         :'k' => :'k',
         :'id' => :'id',
-        :'c' => :'c'
+        :'c' => :'c',
+        :'r' => :'r'
       }
     end
 
@@ -65,7 +69,8 @@ module ApiSdkRb
       {
         :'k' => :'String',
         :'id' => :'String',
-        :'c' => :'Integer'
+        :'c' => :'Integer',
+        :'r' => :'String'
       }
     end
 
@@ -105,6 +110,10 @@ module ApiSdkRb
       if attributes.key?(:'c')
         self.c = attributes[:'c']
       end
+
+      if attributes.key?(:'r')
+        self.r = attributes[:'r']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -147,6 +156,8 @@ module ApiSdkRb
       return false if @id !~ Regexp.new(/^[A-Za-z0-9_-]{1,64}$/)
       return false if !@c.nil? && @c > 50
       return false if !@c.nil? && @c < 1
+      r_validator = EnumAttributeValidator.new('String', ["t", "e", "b", "o"])
+      return false unless r_validator.valid?(@r)
       true
     end
 
@@ -193,6 +204,16 @@ module ApiSdkRb
       @c = c
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] r Object to be assigned
+    def r=(r)
+      validator = EnumAttributeValidator.new('String', ["t", "e", "b", "o"])
+      unless validator.valid?(r)
+        fail ArgumentError, "invalid value for \"r\", must be one of #{validator.allowable_values}."
+      end
+      @r = r
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -200,7 +221,8 @@ module ApiSdkRb
       self.class == o.class &&
           k == o.k &&
           id == o.id &&
-          c == o.c
+          c == o.c &&
+          r == o.r
     end
 
     # @see the `==` method
@@ -212,7 +234,7 @@ module ApiSdkRb
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [k, id, c].hash
+      [k, id, c, r].hash
     end
 
     # Builds the object from hash

data/lib/api-sdk-rb/models/{get_public_workflow200_response.rb → public_workflow_response.rb}

@@ -14,7 +14,7 @@ require 'date'
 require 'time'
 
 module ApiSdkRb
-  class GetPublicWorkflow200Response
+  class PublicWorkflowResponse
     attr_accessor :success
 
     attr_accessor :data
@@ -54,13 +54,13 @@ module ApiSdkRb
     # @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 `ApiSdkRb::GetPublicWorkflow200Response` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `ApiSdkRb::PublicWorkflowResponse` 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 `ApiSdkRb::GetPublicWorkflow200Response`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `ApiSdkRb::PublicWorkflowResponse`. 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
       }

data/lib/api-sdk-rb/models/upload.rb

@@ -48,7 +48,7 @@ module ApiSdkRb
 
     attr_accessor :conversation_id
 
-    # The managed user the file was uploaded for, or null when it is the account's own. List one managed user's files with the `managed_user_id` or `managed_user_external_id` query parameter of `uploadsGet`.
+    # The managed user the file was uploaded for, or null when it is the account's own. List one managed user's files with the `managed_user_id` or `managed_user_external_id` query parameter of `listUploads`.
     attr_accessor :managed_user_id
 
     # Where in the product the partner uses the file, or null when unknown

data/lib/api-sdk-rb/models/upload_limits.rb

@@ -16,13 +16,13 @@ require 'time'
 module ApiSdkRb
   # What the upload endpoints accept. Read it rather than hard-coding the numbers.
   class UploadLimits
-    # The largest file `uploadsPost` takes in one request, in bytes. The same for every account.
+    # The largest file `uploadFile` takes in one request, in bytes. The same for every account.
     attr_accessor :multipart_max_bytes
 
-    # The file types `uploadsPost` takes for media (`content-property` uploads)
+    # The file types `uploadFile` takes for media (`content-property` uploads)
     attr_accessor :multipart_mime_types
 
-    # Whether resumable uploads are switched on. They need a signed-in session; an API key uses `uploadsPost`.
+    # Whether resumable uploads are switched on. They need a signed-in session; an API key uses `uploadFile`.
     attr_accessor :tus_enabled
 
     # The largest file a resumable upload takes, in bytes (250 MB by default). The same for every account, whatever its plan. A file over `multipart_max_bytes` goes through a resumable upload.