fastly 17.2.0 → 18.0.0

data/lib/fastly/models/arc_virtual_keys_response.rb

@@ -0,0 +1,238 @@
+=begin
+#Fastly API
+
+#Via the Fastly API you can perform any of the operations that are possible within the management console,  including creating services, domains, and backends, configuring rules or uploading your own application code, as well as account operations such as user administration and billing reports. The API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts. For the most accurate and up-to-date API reference content, visit our [Developer Hub](https://www.fastly.com/documentation/reference/api/) 
+
+The version of the OpenAPI document: 1.0.0
+Contact: oss@fastly.com
+
+=end
+
+require 'date'
+require 'time'
+
+module Fastly
+  class ArcVirtualKeysResponse
+    # The virtual keys returned by the request.
+    attr_accessor :data
+
+    attr_accessor :meta
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'data' => :'data',
+        :'meta' => :'meta'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.fastly_types
+      {
+        :'data' => :'Array<ArcVirtualKeyListItemResponse>',
+        :'meta' => :'ArcVirtualKeysMeta'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.fastly_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 `Fastly::ArcVirtualKeysResponse` 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 `Fastly::ArcVirtualKeysResponse`. 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?(:'data')
+        if (value = attributes[:'data']).is_a?(Array)
+          self.data = value
+        end
+      end
+
+      if attributes.key?(:'meta')
+        self.meta = attributes[:'meta']
+      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
+      if @data.nil?
+        invalid_properties.push('invalid value for "data", data cannot be nil.')
+      end
+
+      if @meta.nil?
+        invalid_properties.push('invalid value for "meta", meta 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?
+      return false if @data.nil?
+      return false if @meta.nil?
+      true
+    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 &&
+          data == o.data &&
+          meta == o.meta
+    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
+      [data, meta].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)
+      self.class.fastly_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.fastly_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 = Fastly.const_get(type)
+        klass.respond_to?(:fastly_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.fastly_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/fastly/models/automation_token.rb

@@ -16,12 +16,24 @@ module Fastly
     # The name of the token.
     attr_accessor :name
 
-    # The role on the token.
+    # The primary role on the token. For tokens with multiple roles, this returns the highest-priority role for backwards compatibility.
     attr_accessor :role
 
-    # (Optional) The service IDs of the services the token will have access to. Separate service IDs with a space. If no services are specified, the token will have access to all services on the account. 
+    # All roles assigned to the token. Each role includes an `id` and `name`.
+    attr_accessor :roles
+
+    # The service IDs of the services the token has access to. Empty when `limit_services` is `false` (full access) or when the token has no service access.
     attr_accessor :services
 
+    # When `true`, the token is restricted to only the services in the `services` array. When `false`, the token has access to all services.
+    attr_accessor :limit_services
+
+    # When `true`, the token is restricted to only the workspaces in the `workspaces` array. When `false`, the token has access to all workspaces. Only applies to roles that support workspace access.
+    attr_accessor :limit_workspaces
+
+    # The workspace IDs of the workspaces the token has access to. Returns an empty array for tokens without workspace access.
+    attr_accessor :workspaces
+
     # A space-delimited list of authorization scope.
     attr_accessor :scope
 
@@ -55,7 +67,11 @@ module Fastly
       {
         :'name' => :'name',
         :'role' => :'role',
+        :'roles' => :'roles',
         :'services' => :'services',
+        :'limit_services' => :'limit_services',
+        :'limit_workspaces' => :'limit_workspaces',
+        :'workspaces' => :'workspaces',
         :'scope' => :'scope',
         :'expires_at' => :'expires_at'
       }
@@ -71,7 +87,11 @@ module Fastly
       {
         :'name' => :'String',
         :'role' => :'String',
+        :'roles' => :'Array<AutomationTokenRole>',
         :'services' => :'Array<String>',
+        :'limit_services' => :'Boolean',
+        :'limit_workspaces' => :'Boolean',
+        :'workspaces' => :'Array<String>',
         :'scope' => :'String',
         :'expires_at' => :'String'
       }
@@ -106,12 +126,32 @@ module Fastly
         self.role = attributes[:'role']
       end
 
+      if attributes.key?(:'roles')
+        if (value = attributes[:'roles']).is_a?(Array)
+          self.roles = value
+        end
+      end
+
       if attributes.key?(:'services')
         if (value = attributes[:'services']).is_a?(Array)
           self.services = value
         end
       end
 
+      if attributes.key?(:'limit_services')
+        self.limit_services = attributes[:'limit_services']
+      end
+
+      if attributes.key?(:'limit_workspaces')
+        self.limit_workspaces = attributes[:'limit_workspaces']
+      end
+
+      if attributes.key?(:'workspaces')
+        if (value = attributes[:'workspaces']).is_a?(Array)
+          self.workspaces = value
+        end
+      end
+
       if attributes.key?(:'scope')
         self.scope = attributes[:'scope']
       else
@@ -133,7 +173,7 @@ module Fastly
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      role_validator = EnumAttributeValidator.new('String', ["billing", "engineer", "user"])
+      role_validator = EnumAttributeValidator.new('String', ["billing", "engineer", "user", "ngwaf_user_imported", "ngwaf_admin_imported", "ngwaf_owner_imported", "ngwaf_observer_imported", "tls_admin", "tls_viewer"])
       return false unless role_validator.valid?(@role)
       scope_validator = EnumAttributeValidator.new('String', ["global", "purge_select", "purge_all", "global:read"])
       return false unless scope_validator.valid?(@scope)
@@ -143,7 +183,7 @@ module Fastly
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] role Object to be assigned
     def role=(role)
-      validator = EnumAttributeValidator.new('String', ["billing", "engineer", "user"])
+      validator = EnumAttributeValidator.new('String', ["billing", "engineer", "user", "ngwaf_user_imported", "ngwaf_admin_imported", "ngwaf_owner_imported", "ngwaf_observer_imported", "tls_admin", "tls_viewer"])
       unless validator.valid?(role)
         fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
       end
@@ -167,7 +207,11 @@ module Fastly
       self.class == o.class &&
           name == o.name &&
           role == o.role &&
+          roles == o.roles &&
           services == o.services &&
+          limit_services == o.limit_services &&
+          limit_workspaces == o.limit_workspaces &&
+          workspaces == o.workspaces &&
           scope == o.scope &&
           expires_at == o.expires_at
     end
@@ -181,7 +225,7 @@ module Fastly
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [name, role, services, scope, expires_at].hash
+      [name, role, roles, services, limit_services, limit_workspaces, workspaces, scope, expires_at].hash
     end
 
     # Builds the object from hash

data/lib/fastly/models/automation_token_create_request.rb

@@ -13,12 +13,70 @@ require 'time'
 
 module Fastly
   class AutomationTokenCreateRequest
-    attr_accessor :attributes
+    # The name of the token.
+    attr_accessor :name
+
+    # A UTC timestamp of when the token will expire.
+    attr_accessor :expires_at
+
+    # The role for the token. The `roles` field is the preferred way to assign roles. This field is supported for backwards compatibility with single-role tokens.
+    attr_accessor :role
+
+    # Array of role IDs to assign to the token. Use this field for tokens with multiple roles. When provided, this takes precedence over the `role` field. To get available role IDs, use [GET /roles](https://www.fastly.com/documentation/reference/api/account/roles/).
+    attr_accessor :roles
+
+    # List of service IDs the token can access. Only used when `limit_services` is `true`.
+    attr_accessor :services
+
+    # When `true`, restricts the token to only the services specified in the `services` array. When `false` (default), the token has access to all services.
+    attr_accessor :limit_services
+
+    # When `true` (default), restricts the token to only the workspaces specified in the `workspaces` array. When `false`, the token has access to all workspaces. Only applies to roles that support workspace access (such as Next-Gen WAF roles). For roles without workspace support, this field has no effect.
+    attr_accessor :limit_workspaces
+
+    # List of workspace IDs the token can access. Only used when `limit_workspaces` is `true` and the token has roles that support workspace access.
+    attr_accessor :workspaces
+
+    attr_accessor :scope
+
+    # Indicates whether TLS access is enabled for the token. Only applicable when using the single-role `role` field. For tokens with multiple roles, assign TLS roles (`tls_admin` or `tls_viewer`) via the `roles` field instead.
+    attr_accessor :tls_access
+
+    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
       {
-        :'attributes' => :'attributes'
+        :'name' => :'name',
+        :'expires_at' => :'expires_at',
+        :'role' => :'role',
+        :'roles' => :'roles',
+        :'services' => :'services',
+        :'limit_services' => :'limit_services',
+        :'limit_workspaces' => :'limit_workspaces',
+        :'workspaces' => :'workspaces',
+        :'scope' => :'scope',
+        :'tls_access' => :'tls_access'
       }
     end
 
@@ -30,13 +88,23 @@ module Fastly
     # Attribute type mapping.
     def self.fastly_types
       {
-        :'attributes' => :'AutomationTokenCreateRequestAttributes'
+        :'name' => :'String',
+        :'expires_at' => :'Time',
+        :'role' => :'String',
+        :'roles' => :'Array<String>',
+        :'services' => :'Array<String>',
+        :'limit_services' => :'Boolean',
+        :'limit_workspaces' => :'Boolean',
+        :'workspaces' => :'Array<String>',
+        :'scope' => :'String',
+        :'tls_access' => :'Boolean'
       }
     end
 
     # List of attributes with nullable: true
     def self.fastly_nullable
       Set.new([
+        :'expires_at',
       ])
     end
 
@@ -55,8 +123,56 @@ module Fastly
         h[k.to_sym] = v
       }
 
-      if attributes.key?(:'attributes')
-        self.attributes = attributes[:'attributes']
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'expires_at')
+        self.expires_at = attributes[:'expires_at']
+      end
+
+      if attributes.key?(:'role')
+        self.role = attributes[:'role']
+      end
+
+      if attributes.key?(:'roles')
+        if (value = attributes[:'roles']).is_a?(Array)
+          self.roles = value
+        end
+      end
+
+      if attributes.key?(:'services')
+        if (value = attributes[:'services']).is_a?(Array)
+          self.services = value
+        end
+      end
+
+      if attributes.key?(:'limit_services')
+        self.limit_services = attributes[:'limit_services']
+      else
+        self.limit_services = false
+      end
+
+      if attributes.key?(:'limit_workspaces')
+        self.limit_workspaces = attributes[:'limit_workspaces']
+      else
+        self.limit_workspaces = true
+      end
+
+      if attributes.key?(:'workspaces')
+        if (value = attributes[:'workspaces']).is_a?(Array)
+          self.workspaces = value
+        end
+      end
+
+      if attributes.key?(:'scope')
+        self.scope = attributes[:'scope']
+      else
+        self.scope = 'global'
+      end
+
+      if attributes.key?(:'tls_access')
+        self.tls_access = attributes[:'tls_access']
       end
     end
 
@@ -64,21 +180,59 @@ module Fastly
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
+      if @name.nil?
+        invalid_properties.push('invalid value for "name", name 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?
+      return false if @name.nil?
+      role_validator = EnumAttributeValidator.new('String', ["engineer", "billing", "user"])
+      return false unless role_validator.valid?(@role)
+      scope_validator = EnumAttributeValidator.new('String', ["global", "global:read", "purge_all", "purge_select"])
+      return false unless scope_validator.valid?(@scope)
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] role Object to be assigned
+    def role=(role)
+      validator = EnumAttributeValidator.new('String', ["engineer", "billing", "user"])
+      unless validator.valid?(role)
+        fail ArgumentError, "invalid value for \"role\", must be one of #{validator.allowable_values}."
+      end
+      @role = role
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] scope Object to be assigned
+    def scope=(scope)
+      validator = EnumAttributeValidator.new('String', ["global", "global:read", "purge_all", "purge_select"])
+      unless validator.valid?(scope)
+        fail ArgumentError, "invalid value for \"scope\", must be one of #{validator.allowable_values}."
+      end
+      @scope = scope
+    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 &&
-          attributes == o.attributes
+          name == o.name &&
+          expires_at == o.expires_at &&
+          role == o.role &&
+          roles == o.roles &&
+          services == o.services &&
+          limit_services == o.limit_services &&
+          limit_workspaces == o.limit_workspaces &&
+          workspaces == o.workspaces &&
+          scope == o.scope &&
+          tls_access == o.tls_access
     end
 
     # @see the `==` method
@@ -90,7 +244,7 @@ module Fastly
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attributes].hash
+      [name, expires_at, role, roles, services, limit_services, limit_workspaces, workspaces, scope, tls_access].hash
     end
 
     # Builds the object from hash