plainrouter-sdk 0.5.0 → 0.6.1

data/lib/plainrouter/openapi/models/creative_mcp_preview.rb

@@ -0,0 +1,283 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  # Missing derivatives return pending and queue a creative-queue build, including creatives created before these tools shipped. No image bytes are sent to the model.
+  class CreativeMcpPreview < ApiModelBase
+    attr_accessor :id
+
+    attr_accessor :state
+
+    # Ready items only, delivered in tool-result _meta.creative_previews to the MCP App. Signed R2 derivative URL valid for at most 300 seconds; never an original or provider URL.
+    attr_accessor :url
+
+    attr_accessor :mime_type
+
+    attr_accessor :width
+
+    attr_accessor :height
+
+    # Stored derivative at most 1048576 bytes and 4000000 pixels. SVG refused; the existing decode cap applies.
+    attr_accessor :byte_size
+
+    attr_accessor :expires_at
+
+    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
+      {
+        :'id' => :'id',
+        :'state' => :'state',
+        :'url' => :'url',
+        :'mime_type' => :'mime_type',
+        :'width' => :'width',
+        :'height' => :'height',
+        :'byte_size' => :'byte_size',
+        :'expires_at' => :'expires_at'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'id' => :'String',
+        :'state' => :'String',
+        :'url' => :'String',
+        :'mime_type' => :'String',
+        :'width' => :'Integer',
+        :'height' => :'Integer',
+        :'byte_size' => :'Integer',
+        :'expires_at' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    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 `PlainRouter::OpenAPI::CreativeMcpPreview` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `PlainRouter::OpenAPI::CreativeMcpPreview`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'id')
+        self.id = attributes[:'id']
+      else
+        self.id = nil
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      else
+        self.state = nil
+      end
+
+      if attributes.key?(:'url')
+        self.url = attributes[:'url']
+      end
+
+      if attributes.key?(:'mime_type')
+        self.mime_type = attributes[:'mime_type']
+      end
+
+      if attributes.key?(:'width')
+        self.width = attributes[:'width']
+      end
+
+      if attributes.key?(:'height')
+        self.height = attributes[:'height']
+      end
+
+      if attributes.key?(:'byte_size')
+        self.byte_size = attributes[:'byte_size']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      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
+      if @id.nil?
+        invalid_properties.push('invalid value for "id", id cannot be nil.')
+      end
+
+      if @state.nil?
+        invalid_properties.push('invalid value for "state", state cannot be nil.')
+      end
+
+      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'
+      return false if @id.nil?
+      return false if @state.nil?
+      state_validator = EnumAttributeValidator.new('String', ["pending", "ready", "refused"])
+      return false unless state_validator.valid?(@state)
+      mime_type_validator = EnumAttributeValidator.new('String', ["image/jpeg"])
+      return false unless mime_type_validator.valid?(@mime_type)
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] id Value to be assigned
+    def id=(id)
+      if id.nil?
+        fail ArgumentError, 'id cannot be nil'
+      end
+
+      @id = id
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] state Object to be assigned
+    def state=(state)
+      validator = EnumAttributeValidator.new('String', ["pending", "ready", "refused"])
+      unless validator.valid?(state)
+        fail ArgumentError, "invalid value for \"state\", must be one of #{validator.allowable_values}."
+      end
+      @state = state
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] mime_type Object to be assigned
+    def mime_type=(mime_type)
+      validator = EnumAttributeValidator.new('String', ["image/jpeg"])
+      unless validator.valid?(mime_type)
+        fail ArgumentError, "invalid value for \"mime_type\", must be one of #{validator.allowable_values}."
+      end
+      @mime_type = mime_type
+    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 &&
+          state == o.state &&
+          url == o.url &&
+          mime_type == o.mime_type &&
+          width == o.width &&
+          height == o.height &&
+          byte_size == o.byte_size &&
+          expires_at == o.expires_at
+    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
+      [id, state, url, mime_type, width, height, byte_size, expires_at].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
+
+    # 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
+
+  end
+
+end

data/lib/plainrouter/openapi/models/creative_mcp_refusal.rb

@@ -0,0 +1,45 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class CreativeMcpRefusal
+    REQUEST_KEY_CONFLICT = "request_key_conflict".freeze
+    RATE_LIMITED = "rate_limited".freeze
+    INVALID_ARGUMENTS = "invalid_arguments".freeze
+    INSUFFICIENT_SCOPE = "insufficient_scope".freeze
+    INVALID_TOKEN = "invalid_token".freeze
+    NOT_FOUND = "not_found".freeze
+    WORKSPACE_REQUIRED = "workspace_required".freeze
+
+    def self.all_vars
+      @all_vars ||= [REQUEST_KEY_CONFLICT, RATE_LIMITED, INVALID_ARGUMENTS, INSUFFICIENT_SCOPE, INVALID_TOKEN, NOT_FOUND, WORKSPACE_REQUIRED].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CreativeMcpRefusal.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CreativeMcpRefusal"
+    end
+  end
+end

data/lib/plainrouter/openapi/models/creative_mcp_tool.rb

@@ -0,0 +1,44 @@
+=begin
+#Plainrouter Conversion API
+
+#Plainrouter public Signals Conversion API.
+
+The version of the OpenAPI document: 0.5.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.25.0
+
+=end
+
+require 'date'
+require 'time'
+
+module PlainRouter::OpenAPI
+  class CreativeMcpTool
+    LIST_TEMPLATES = "list_templates".freeze
+    RENDER_AD = "render_ad".freeze
+    GET_RENDER = "get_render".freeze
+    RESUME_RENDER = "resume_render".freeze
+    LIST_CREATIVES = "list_creatives".freeze
+    PREVIEW_CREATIVES = "preview_creatives".freeze
+
+    def self.all_vars
+      @all_vars ||= [LIST_TEMPLATES, RENDER_AD, GET_RENDER, RESUME_RENDER, LIST_CREATIVES, PREVIEW_CREATIVES].freeze
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def self.build_from_hash(value)
+      new.build_from_hash(value)
+    end
+
+    # Builds the enum from string
+    # @param [String] The enum value in the form of the string
+    # @return [String] The enum value
+    def build_from_hash(value)
+      return value if CreativeMcpTool.all_vars.include?(value)
+      raise "Invalid ENUM value #{value} for class #CreativeMcpTool"
+    end
+  end
+end

data/lib/plainrouter/openapi/models/delivery_status.rb

@@ -17,6 +17,7 @@ module PlainRouter::OpenAPI
   class DeliveryStatus
     QUEUED = "queued".freeze
     SENT = "sent".freeze
+    HELD = "held".freeze
     ACCEPTED = "accepted".freeze
     RETRYING = "retrying".freeze
     FAILED_AUTH = "failed:auth".freeze
@@ -28,7 +29,7 @@ module PlainRouter::OpenAPI
     SKIPPED_DUPLICATE = "skipped:duplicate".freeze
 
     def self.all_vars
-      @all_vars ||= [QUEUED, SENT, ACCEPTED, RETRYING, FAILED_AUTH, FAILED_PERMANENT, FAILED_UNKNOWN, EXPIRED, SKIPPED_CONSENT, SKIPPED_NO_DESTINATION, SKIPPED_DUPLICATE].freeze
+      @all_vars ||= [QUEUED, SENT, HELD, ACCEPTED, RETRYING, FAILED_AUTH, FAILED_PERMANENT, FAILED_UNKNOWN, EXPIRED, SKIPPED_CONSENT, SKIPPED_NO_DESTINATION, SKIPPED_DUPLICATE].freeze
     end
 
     # Builds the enum from string

data/lib/plainrouter/openapi/models/deployment_plan_read.rb

@@ -14,6 +14,7 @@ require 'date'
 require 'time'
 
 module PlainRouter::OpenAPI
+  # Complete projection rows are paged within 80,000 JSON bytes, accounting for both MCP representations. Defaults are bounded. Follow next_cursor with the same scope and filters. One oversized row is explicitly refused; fields are never silently clipped.
   class DeploymentPlanRead < ApiModelBase
     attr_accessor :name
 
@@ -30,6 +31,14 @@ module PlainRouter::OpenAPI
 
     attr_accessor :creatives
 
+    attr_accessor :next_cursor
+
+    attr_accessor :truncated
+
+    attr_accessor :continuation
+
+    attr_accessor :creative_count
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -39,7 +48,11 @@ module PlainRouter::OpenAPI
         :'review_version' => :'review_version',
         :'copy' => :'copy',
         :'landing_page' => :'landing_page',
-        :'creatives' => :'creatives'
+        :'creatives' => :'creatives',
+        :'next_cursor' => :'next_cursor',
+        :'truncated' => :'truncated',
+        :'continuation' => :'continuation',
+        :'creative_count' => :'creative_count'
       }
     end
 
@@ -62,7 +75,11 @@ module PlainRouter::OpenAPI
         :'review_version' => :'String',
         :'copy' => :'DeploymentPlanReadCopy',
         :'landing_page' => :'String',
-        :'creatives' => :'Array<DeploymentPlanReadCreativesInner>'
+        :'creatives' => :'Array<DeploymentPlanReadCreativesInner>',
+        :'next_cursor' => :'Integer',
+        :'truncated' => :'Boolean',
+        :'continuation' => :'String',
+        :'creative_count' => :'Integer'
       }
     end
 
@@ -71,6 +88,7 @@ module PlainRouter::OpenAPI
       Set.new([
         :'name',
         :'copy',
+        :'next_cursor',
       ])
     end
 
@@ -125,6 +143,22 @@ module PlainRouter::OpenAPI
           self.creatives = value
         end
       end
+
+      if attributes.key?(:'next_cursor')
+        self.next_cursor = attributes[:'next_cursor']
+      end
+
+      if attributes.key?(:'truncated')
+        self.truncated = attributes[:'truncated']
+      end
+
+      if attributes.key?(:'continuation')
+        self.continuation = attributes[:'continuation']
+      end
+
+      if attributes.key?(:'creative_count')
+        self.creative_count = attributes[:'creative_count']
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -209,7 +243,11 @@ module PlainRouter::OpenAPI
           review_version == o.review_version &&
           copy == o.copy &&
           landing_page == o.landing_page &&
-          creatives == o.creatives
+          creatives == o.creatives &&
+          next_cursor == o.next_cursor &&
+          truncated == o.truncated &&
+          continuation == o.continuation &&
+          creative_count == o.creative_count
     end
 
     # @see the `==` method
@@ -221,7 +259,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, id, platform_ad_account_id, review_version, copy, landing_page, creatives].hash
+      [name, id, platform_ad_account_id, review_version, copy, landing_page, creatives, next_cursor, truncated, continuation, creative_count].hash
     end
 
     # Builds the object from hash

data/lib/plainrouter/openapi/models/destination.rb

@@ -36,6 +36,12 @@ module PlainRouter::OpenAPI
 
     attr_accessor :updated_at
 
+    attr_accessor :attention_reason
+
+    attr_accessor :held_count
+
+    attr_accessor :notices
+
     class EnumAttributeValidator
       attr_reader :datatype
       attr_reader :allowable_values
@@ -70,7 +76,10 @@ module PlainRouter::OpenAPI
         :'config' => :'config',
         :'status' => :'status',
         :'created_at' => :'created_at',
-        :'updated_at' => :'updated_at'
+        :'updated_at' => :'updated_at',
+        :'attention_reason' => :'attention_reason',
+        :'held_count' => :'held_count',
+        :'notices' => :'notices'
       }
     end
 
@@ -93,10 +102,13 @@ module PlainRouter::OpenAPI
         :'platform_ad_account_id' => :'Integer',
         :'type' => :'DestinationType',
         :'credential_source' => :'DestinationCredentialSource',
-        :'config' => :'Array<Object>',
+        :'config' => :'DestinationConfig',
         :'status' => :'DestinationStatus',
         :'created_at' => :'Time',
-        :'updated_at' => :'Time'
+        :'updated_at' => :'Time',
+        :'attention_reason' => :'GetEvent200ResponseEventConsent',
+        :'held_count' => :'Integer',
+        :'notices' => :'Array<Hash<String, Object>>'
       }
     end
 
@@ -105,7 +117,8 @@ module PlainRouter::OpenAPI
       Set.new([
         :'platform_ad_account_id',
         :'created_at',
-        :'updated_at'
+        :'updated_at',
+        :'attention_reason',
       ])
     end
 
@@ -162,9 +175,7 @@ module PlainRouter::OpenAPI
       end
 
       if attributes.key?(:'config')
-        if (value = attributes[:'config']).is_a?(Array)
-          self.config = value
-        end
+        self.config = attributes[:'config']
       else
         self.config = nil
       end
@@ -186,6 +197,26 @@ module PlainRouter::OpenAPI
       else
         self.updated_at = nil
       end
+
+      if attributes.key?(:'attention_reason')
+        self.attention_reason = attributes[:'attention_reason']
+      else
+        self.attention_reason = nil
+      end
+
+      if attributes.key?(:'held_count')
+        self.held_count = attributes[:'held_count']
+      else
+        self.held_count = nil
+      end
+
+      if attributes.key?(:'notices')
+        if (value = attributes[:'notices']).is_a?(Array)
+          self.notices = value
+        end
+      else
+        self.notices = nil
+      end
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -221,6 +252,14 @@ module PlainRouter::OpenAPI
         invalid_properties.push('invalid value for "status", status cannot be nil.')
       end
 
+      if @held_count.nil?
+        invalid_properties.push('invalid value for "held_count", held_count cannot be nil.')
+      end
+
+      if @notices.nil?
+        invalid_properties.push('invalid value for "notices", notices cannot be nil.')
+      end
+
       invalid_properties
     end
 
@@ -235,6 +274,8 @@ module PlainRouter::OpenAPI
       return false if @credential_source.nil?
       return false if @config.nil?
       return false if @status.nil?
+      return false if @held_count.nil?
+      return false if @notices.nil?
       true
     end
 
@@ -308,6 +349,26 @@ module PlainRouter::OpenAPI
       @status = status
     end
 
+    # Custom attribute writer method with validation
+    # @param [Object] held_count Value to be assigned
+    def held_count=(held_count)
+      if held_count.nil?
+        fail ArgumentError, 'held_count cannot be nil'
+      end
+
+      @held_count = held_count
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] notices Value to be assigned
+    def notices=(notices)
+      if notices.nil?
+        fail ArgumentError, 'notices cannot be nil'
+      end
+
+      @notices = notices
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -322,7 +383,10 @@ module PlainRouter::OpenAPI
           config == o.config &&
           status == o.status &&
           created_at == o.created_at &&
-          updated_at == o.updated_at
+          updated_at == o.updated_at &&
+          attention_reason == o.attention_reason &&
+          held_count == o.held_count &&
+          notices == o.notices
     end
 
     # @see the `==` method
@@ -334,7 +398,7 @@ module PlainRouter::OpenAPI
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [id, workspace_id, signal_tracker_id, platform_ad_account_id, type, credential_source, config, status, created_at, updated_at].hash
+      [id, workspace_id, signal_tracker_id, platform_ad_account_id, type, credential_source, config, status, created_at, updated_at, attention_reason, held_count, notices].hash
     end
 
     # Builds the object from hash