fastly 9.0.0 → 11.0.0

data/lib/fastly/api/billing_usage_metrics_api.rb

@@ -17,13 +17,14 @@ module Fastly
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Retrieve service-level usage metrics for a product.
+    # Retrieve service-level usage metrics for services with non-zero usage units.
     # Returns product usage, broken down by service.
-    # @option opts [String] :product_id The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. (required)
-    # @option opts [String] :usage_type_name The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests. (required)
+    # @option opts [String] :product_id The product identifier for the metrics returned (e.g., `cdn_usage`). This should be used along with `usage_type_name`.
+    # @option opts [String] :service The service identifier for the metrics being requested.
+    # @option opts [String] :usage_type_name The usage type name for the metrics returned (e.g., `North America Requests`). This should be used along with `product_id`.
     # @option opts [String] :start_month 
     # @option opts [String] :end_month 
-    # @option opts [String] :limit Number of results per page. The maximum is 100. (default to '5')
+    # @option opts [String] :limit Number of results per page. The maximum is 10000. (default to '1000')
     # @option opts [String] :cursor Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
     # @return [Serviceusagemetrics]
     def get_service_level_usage(opts = {})
@@ -31,13 +32,14 @@ module Fastly
       data
     end
 
-    # Retrieve service-level usage metrics for a product.
+    # Retrieve service-level usage metrics for services with non-zero usage units.
     # Returns product usage, broken down by service.
-    # @option opts [String] :product_id The product identifier for the metrics returned (e.g., `cdn_usage`). This field is not required for CSV requests. (required)
-    # @option opts [String] :usage_type_name The usage type name for the metrics returned (e.g., `North America Requests`). This field is not required for CSV requests. (required)
+    # @option opts [String] :product_id The product identifier for the metrics returned (e.g., `cdn_usage`). This should be used along with `usage_type_name`.
+    # @option opts [String] :service The service identifier for the metrics being requested.
+    # @option opts [String] :usage_type_name The usage type name for the metrics returned (e.g., `North America Requests`). This should be used along with `product_id`.
     # @option opts [String] :start_month 
     # @option opts [String] :end_month 
-    # @option opts [String] :limit Number of results per page. The maximum is 100. (default to '5')
+    # @option opts [String] :limit Number of results per page. The maximum is 10000. (default to '1000')
     # @option opts [String] :cursor Cursor value from the `next_cursor` field of a previous response, used to retrieve the next page. To request the first page, this should be empty.
     # @return [Array<(Serviceusagemetrics, Integer, Hash)>] Serviceusagemetrics data, response status code and response headers
     def get_service_level_usage_with_http_info(opts = {})
@@ -45,16 +47,6 @@ module Fastly
         @api_client.config.logger.debug 'Calling API: BillingUsageMetricsApi.get_service_level_usage ...'
       end
       # unbox the parameters from the hash
-      product_id = opts[:'product_id']
-      usage_type_name = opts[:'usage_type_name']
-      # verify the required parameter 'product_id' is set
-      if @api_client.config.client_side_validation && product_id.nil?
-        fail ArgumentError, "Missing the required parameter 'product_id' when calling BillingUsageMetricsApi.get_service_level_usage"
-      end
-      # verify the required parameter 'usage_type_name' is set
-      if @api_client.config.client_side_validation && usage_type_name.nil?
-        fail ArgumentError, "Missing the required parameter 'usage_type_name' when calling BillingUsageMetricsApi.get_service_level_usage"
-      end
       pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/)
       if @api_client.config.client_side_validation && !opts[:'start_month'].nil? && opts[:'start_month'] !~ pattern
         fail ArgumentError, "invalid value for 'opts[:\"start_month\"]' when calling BillingUsageMetricsApi.get_service_level_usage, must conform to the pattern #{pattern}."
@@ -70,8 +62,9 @@ module Fastly
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'product_id'] = product_id
-      query_params[:'usage_type_name'] = usage_type_name
+      query_params[:'product_id'] = opts[:'product_id'] if !opts[:'product_id'].nil?
+      query_params[:'service'] = opts[:'service'] if !opts[:'service'].nil?
+      query_params[:'usage_type_name'] = opts[:'usage_type_name'] if !opts[:'usage_type_name'].nil?
       query_params[:'start_month'] = opts[:'start_month'] if !opts[:'start_month'].nil?
       query_params[:'end_month'] = opts[:'end_month'] if !opts[:'end_month'].nil?
       query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
@@ -113,8 +106,8 @@ module Fastly
 
     # Get monthly usage metrics
     # Returns monthly usage metrics for customer by product.
-    # @option opts [String] :start_month 
-    # @option opts [String] :end_month 
+    # @option opts [String] :start_month  (required)
+    # @option opts [String] :end_month  (required)
     # @return [Usagemetric]
     def get_usage_metrics(opts = {})
       data, _status_code, _headers = get_usage_metrics_with_http_info(opts)
@@ -123,22 +116,32 @@ module Fastly
 
     # Get monthly usage metrics
     # Returns monthly usage metrics for customer by product.
-    # @option opts [String] :start_month 
-    # @option opts [String] :end_month 
+    # @option opts [String] :start_month  (required)
+    # @option opts [String] :end_month  (required)
     # @return [Array<(Usagemetric, Integer, Hash)>] Usagemetric data, response status code and response headers
     def get_usage_metrics_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: BillingUsageMetricsApi.get_usage_metrics ...'
       end
       # unbox the parameters from the hash
+      start_month = opts[:'start_month']
+      end_month = opts[:'end_month']
+      # verify the required parameter 'start_month' is set
+      if @api_client.config.client_side_validation && start_month.nil?
+        fail ArgumentError, "Missing the required parameter 'start_month' when calling BillingUsageMetricsApi.get_usage_metrics"
+      end
       pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/)
-      if @api_client.config.client_side_validation && !opts[:'start_month'].nil? && opts[:'start_month'] !~ pattern
-        fail ArgumentError, "invalid value for 'opts[:\"start_month\"]' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}."
+      if @api_client.config.client_side_validation && start_month !~ pattern
+        fail ArgumentError, "invalid value for 'start_month' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}."
       end
 
+      # verify the required parameter 'end_month' is set
+      if @api_client.config.client_side_validation && end_month.nil?
+        fail ArgumentError, "Missing the required parameter 'end_month' when calling BillingUsageMetricsApi.get_usage_metrics"
+      end
       pattern = Regexp.new(/^[0-9]{4}-[0-9]{2}$/)
-      if @api_client.config.client_side_validation && !opts[:'end_month'].nil? && opts[:'end_month'] !~ pattern
-        fail ArgumentError, "invalid value for 'opts[:\"end_month\"]' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}."
+      if @api_client.config.client_side_validation && end_month !~ pattern
+        fail ArgumentError, "invalid value for 'end_month' when calling BillingUsageMetricsApi.get_usage_metrics, must conform to the pattern #{pattern}."
       end
 
       # resource path
@@ -146,8 +149,8 @@ module Fastly
 
       # query parameters
       query_params = opts[:query_params] || {}
-      query_params[:'start_month'] = opts[:'start_month'] if !opts[:'start_month'].nil?
-      query_params[:'end_month'] = opts[:'end_month'] if !opts[:'end_month'].nil?
+      query_params[:'start_month'] = start_month
+      query_params[:'end_month'] = end_month
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/fastly/api/header_api.rb

@@ -31,8 +31,8 @@ module Fastly
     # @option opts [String] :src Variable to be used as a source for the header content. Does not apply to `delete` action.
     # @option opts [String] :substitution Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions.
     # @option opts [String] :type Accepts a string value.
-    # @option opts [Integer] :ignore_if_set Don't add the header if it is added already. Only applies to 'set' action.
-    # @option opts [Integer] :priority Priority determines execution order. Lower numbers execute first. (default to 100)
+    # @option opts [String] :ignore_if_set Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\\\"0\\\" = false, \\\"1\\\" = true)
+    # @option opts [String] :priority Priority determines execution order. Lower numbers execute first. (default to '100')
     # @return [HeaderResponse]
     def create_header_object(opts = {})
       data, _status_code, _headers = create_header_object_with_http_info(opts)
@@ -53,8 +53,8 @@ module Fastly
     # @option opts [String] :src Variable to be used as a source for the header content. Does not apply to `delete` action.
     # @option opts [String] :substitution Value to substitute in place of regular expression. Only applies to `regex` and `regex_repeat` actions.
     # @option opts [String] :type Accepts a string value.
-    # @option opts [Integer] :ignore_if_set Don't add the header if it is added already. Only applies to 'set' action.
-    # @option opts [Integer] :priority Priority determines execution order. Lower numbers execute first. (default to 100)
+    # @option opts [String] :ignore_if_set Don't add the header if it is added already. Only applies to 'set' action. Numerical value (\\\"0\\\" = false, \\\"1\\\" = true)
+    # @option opts [String] :priority Priority determines execution order. Lower numbers execute first. (default to '100')
     # @return [Array<(HeaderResponse, Integer, Hash)>] HeaderResponse data, response status code and response headers
     def create_header_object_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -375,8 +375,8 @@ module Fastly
     # @option opts [String] :src Variable to be used as a source for the header content. Does not apply to &#x60;delete&#x60; action.
     # @option opts [String] :substitution Value to substitute in place of regular expression. Only applies to &#x60;regex&#x60; and &#x60;regex_repeat&#x60; actions.
     # @option opts [String] :type Accepts a string value.
-    # @option opts [Integer] :ignore_if_set Don&#39;t add the header if it is added already. Only applies to &#39;set&#39; action.
-    # @option opts [Integer] :priority Priority determines execution order. Lower numbers execute first. (default to 100)
+    # @option opts [String] :ignore_if_set Don&#39;t add the header if it is added already. Only applies to &#39;set&#39; action. Numerical value (\\\&quot;0\\\&quot; &#x3D; false, \\\&quot;1\\\&quot; &#x3D; true)
+    # @option opts [String] :priority Priority determines execution order. Lower numbers execute first. (default to '100')
     # @return [HeaderResponse]
     def update_header_object(opts = {})
       data, _status_code, _headers = update_header_object_with_http_info(opts)
@@ -398,8 +398,8 @@ module Fastly
     # @option opts [String] :src Variable to be used as a source for the header content. Does not apply to &#x60;delete&#x60; action.
     # @option opts [String] :substitution Value to substitute in place of regular expression. Only applies to &#x60;regex&#x60; and &#x60;regex_repeat&#x60; actions.
     # @option opts [String] :type Accepts a string value.
-    # @option opts [Integer] :ignore_if_set Don&#39;t add the header if it is added already. Only applies to &#39;set&#39; action.
-    # @option opts [Integer] :priority Priority determines execution order. Lower numbers execute first. (default to 100)
+    # @option opts [String] :ignore_if_set Don&#39;t add the header if it is added already. Only applies to &#39;set&#39; action. Numerical value (\\\&quot;0\\\&quot; &#x3D; false, \\\&quot;1\\\&quot; &#x3D; true)
+    # @option opts [String] :priority Priority determines execution order. Lower numbers execute first. (default to '100')
     # @return [Array<(HeaderResponse, Integer, Hash)>] HeaderResponse data, response status code and response headers
     def update_header_object_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/fastly/api/kv_store_api.rb

@@ -18,25 +18,29 @@ module Fastly
       @api_client = api_client
     end
     # Create a KV store.
-    # Create a new KV store.
+    # Create a KV store.
     # @option opts [String] :location 
-    # @option opts [Store] :store 
-    # @return [StoreResponse]
-    def create_store(opts = {})
-      data, _status_code, _headers = create_store_with_http_info(opts)
+    # @option opts [KvStoreRequestCreate] :kv_store_request_create 
+    # @return [KvStoreDetails]
+    def kv_store_create(opts = {})
+      data, _status_code, _headers = kv_store_create_with_http_info(opts)
       data
     end
 
     # Create a KV store.
-    # Create a new KV store.
+    # Create a KV store.
     # @option opts [String] :location 
-    # @option opts [Store] :store 
-    # @return [Array<(StoreResponse, Integer, Hash)>] StoreResponse data, response status code and response headers
-    def create_store_with_http_info(opts = {})
+    # @option opts [KvStoreRequestCreate] :kv_store_request_create 
+    # @return [Array<(KvStoreDetails, Integer, Hash)>] KvStoreDetails data, response status code and response headers
+    def kv_store_create_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: KvStoreApi.create_store ...'
+        @api_client.config.logger.debug 'Calling API: KvStoreApi.kv_store_create ...'
       end
       # unbox the parameters from the hash
+      allowable_values = ["US", "EU", "ASIA", "AUS"]
+      if @api_client.config.client_side_validation && opts[:'location'] && !allowable_values.include?(opts[:'location'])
+        fail ArgumentError, "invalid value for \"location\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/resources/stores/kv'
 
@@ -58,16 +62,16 @@ module Fastly
       form_params = opts[:form_params] || {}
 
       # http body (model)
-      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'store'])
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'kv_store_request_create'])
 
       # return_type
-      return_type = opts[:debug_return_type] || 'StoreResponse'
+      return_type = opts[:debug_return_type] || 'KvStoreDetails'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['token']
 
       new_options = opts.merge(
-        :operation => :"KvStoreApi.create_store",
+        :operation => :"KvStoreApi.kv_store_create",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -78,33 +82,33 @@ module Fastly
 
       data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: KvStoreApi#create_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: KvStoreApi#kv_store_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Delete a KV store.
-    # A KV store must be empty before it can be deleted.  Deleting a KV store that still contains keys will result in a `409` (Conflict).
+    # A KV store must be empty before it can be deleted. Attempting to delete a KV store that contains items will result in a response with a `409` status code.
     # @option opts [String] :store_id  (required)
     # @return [nil]
-    def delete_store(opts = {})
-      delete_store_with_http_info(opts)
+    def kv_store_delete(opts = {})
+      kv_store_delete_with_http_info(opts)
       nil
     end
 
     # Delete a KV store.
-    # A KV store must be empty before it can be deleted.  Deleting a KV store that still contains keys will result in a &#x60;409&#x60; (Conflict).
+    # A KV store must be empty before it can be deleted. Attempting to delete a KV store that contains items will result in a response with a &#x60;409&#x60; status code.
     # @option opts [String] :store_id  (required)
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
-    def delete_store_with_http_info(opts = {})
+    def kv_store_delete_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: KvStoreApi.delete_store ...'
+        @api_client.config.logger.debug 'Calling API: KvStoreApi.kv_store_delete ...'
       end
       # unbox the parameters from the hash
       store_id = opts[:'store_id']
       # verify the required parameter 'store_id' is set
       if @api_client.config.client_side_validation && store_id.nil?
-        fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreApi.delete_store"
+        fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreApi.kv_store_delete"
       end
       # resource path
       local_var_path = '/resources/stores/kv/{store_id}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s))
@@ -128,7 +132,7 @@ module Fastly
       auth_names = opts[:debug_auth_names] || ['token']
 
       new_options = opts.merge(
-        :operation => :"KvStoreApi.delete_store",
+        :operation => :"KvStoreApi.kv_store_delete",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -139,33 +143,33 @@ module Fastly
 
       data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: KvStoreApi#delete_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: KvStoreApi#kv_store_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
     # Describe a KV store.
-    # Get a KV store by ID.
+    # Get details of a KV store.
     # @option opts [String] :store_id  (required)
-    # @return [StoreResponse]
-    def get_store(opts = {})
-      data, _status_code, _headers = get_store_with_http_info(opts)
+    # @return [KvStoreDetails]
+    def kv_store_get(opts = {})
+      data, _status_code, _headers = kv_store_get_with_http_info(opts)
       data
     end
 
     # Describe a KV store.
-    # Get a KV store by ID.
+    # Get details of a KV store.
     # @option opts [String] :store_id  (required)
-    # @return [Array<(StoreResponse, Integer, Hash)>] StoreResponse data, response status code and response headers
-    def get_store_with_http_info(opts = {})
+    # @return [Array<(KvStoreDetails, Integer, Hash)>] KvStoreDetails data, response status code and response headers
+    def kv_store_get_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: KvStoreApi.get_store ...'
+        @api_client.config.logger.debug 'Calling API: KvStoreApi.kv_store_get ...'
       end
       # unbox the parameters from the hash
       store_id = opts[:'store_id']
       # verify the required parameter 'store_id' is set
       if @api_client.config.client_side_validation && store_id.nil?
-        fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreApi.get_store"
+        fail ArgumentError, "Missing the required parameter 'store_id' when calling KvStoreApi.kv_store_get"
       end
       # resource path
       local_var_path = '/resources/stores/kv/{store_id}'.sub('{' + 'store_id' + '}', CGI.escape(store_id.to_s))
@@ -185,13 +189,13 @@ module Fastly
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'StoreResponse'
+      return_type = opts[:debug_return_type] || 'KvStoreDetails'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['token']
 
       new_options = opts.merge(
-        :operation => :"KvStoreApi.get_store",
+        :operation => :"KvStoreApi.kv_store_get",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -202,31 +206,35 @@ module Fastly
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: KvStoreApi#get_store\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: KvStoreApi#kv_store_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end
 
-    # List KV stores.
-    # Get all stores for a given customer.
+    # List all KV stores.
+    # List all KV stores.
     # @option opts [String] :cursor 
     # @option opts [Integer] :limit  (default to 1000)
     # @return [InlineResponse2003]
-    def get_stores(opts = {})
-      data, _status_code, _headers = get_stores_with_http_info(opts)
+    def kv_store_list(opts = {})
+      data, _status_code, _headers = kv_store_list_with_http_info(opts)
       data
     end
 
-    # List KV stores.
-    # Get all stores for a given customer.
+    # List all KV stores.
+    # List all KV stores.
     # @option opts [String] :cursor 
     # @option opts [Integer] :limit  (default to 1000)
     # @return [Array<(InlineResponse2003, Integer, Hash)>] InlineResponse2003 data, response status code and response headers
-    def get_stores_with_http_info(opts = {})
+    def kv_store_list_with_http_info(opts = {})
       if @api_client.config.debugging
-        @api_client.config.logger.debug 'Calling API: KvStoreApi.get_stores ...'
+        @api_client.config.logger.debug 'Calling API: KvStoreApi.kv_store_list ...'
       end
       # unbox the parameters from the hash
+      if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
+        fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling KvStoreApi.kv_store_list, must be greater than or equal to 1.'
+      end
+
       # resource path
       local_var_path = '/resources/stores/kv'
 
@@ -253,7 +261,7 @@ module Fastly
       auth_names = opts[:debug_auth_names] || ['token']
 
       new_options = opts.merge(
-        :operation => :"KvStoreApi.get_stores",
+        :operation => :"KvStoreApi.kv_store_list",
         :header_params => header_params,
         :query_params => query_params,
         :form_params => form_params,
@@ -264,7 +272,7 @@ module Fastly
 
       data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
       if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: KvStoreApi#get_stores\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+        @api_client.config.logger.debug "API called: KvStoreApi#kv_store_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
       return data, status_code, headers
     end