fastly 8.6.0 → 8.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 448ec99e562b3c1676294cb52992811a2299e596ad7c9b415011f3b02396d4c6
-  data.tar.gz: 678b891bd1b3cf0570fdb2c5990258b733a6069c6c0f28bf2d46d000086991de
+  metadata.gz: 4904654b7cf5c6adc507b5ba620ed04e76e9672249aefb62e05ecec142dc80f1
+  data.tar.gz: bb40afec36a8917d70eb9175fbaa25fc12961503ddda96b9b731364732d14cbd
 SHA512:
-  metadata.gz: 7cf5b677d87891764c92af9b2b78f0496b2d55524c3f5aefb99ae277c4c1da4da940aa17f711e5052b94a2c25ebef228b705478c21ac3e0c2c5ae629e7828b7e
-  data.tar.gz: 7fe8ba6ef682f2d60f44555b0f125ec342e64fa8bc820b6bbd1a5684f55397da39022063f908dff895712179c1369e187709dbf1d04311f5605c82f7fcc9d648
+  metadata.gz: 659c8c3f1e002e1be7f2742f7246cccdd0271c367a5b5a70fb8acc9c047060d7c1d8987c95ffb2833ce3bc29bb6a1bd3f57a4c34bbcc051da823a7709b569607
+  data.tar.gz: 69703109588baa937fc2908c0c1ecd1ee9f9eb30dd9acf51d3885ab052f4fe085d8bb842dd028cfe30a10d11e4fc90a94e2fd08498e1b1cb8d9169cb03ee8f63

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## [v8.7.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.7.0) (2024-08-08)
+
+**Bug fixes:**
+
+- fix(billing): Adjust type of regional data to help the generator
+- fix(billing): Correct type of invoice_id field
+
 ## [v8.6.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v8.6.0) (2024-08-04)
 
 **Enhancements:**

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fastly (8.6.0)
+    fastly (8.7.0)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
 To install via RubyGems, add the following to your project's `Gemfile`:
 
 ```ruby
-gem 'fastly', '~> 8.6.0'
+gem 'fastly', '~> 8.7.0'
 ```
 
 Then run `bundle install`.

data/docs/Billing.md

@@ -6,12 +6,11 @@
 | ---- | ---- | ----------- | ----- |
 | **end_time** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
 | **start_time** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
-| **invoice_id** | **String** |  | [optional][readonly] |
 | **customer_id** | **String** |  | [optional][readonly] |
 | **vendor_state** | **String** | The current state of our third-party billing vendor. One of `up` or `down`. | [optional][readonly] |
 | **status** | [**BillingStatus**](BillingStatus.md) |  | [optional] |
 | **total** | [**BillingTotal**](BillingTotal.md) |  | [optional] |
-| **regions** | **Hash<String, Hash<String, Object>>** | Breakdown of regional data for products that are region based. | [optional] |
+| **regions** | [**Hash<String, BillingRegions>**](BillingRegions.md) | Breakdown of regional data for products that are region based. | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
 

data/docs/BillingApi.md

@@ -71,7 +71,7 @@ Get the invoice for the given invoice_id.
 api_instance = Fastly::BillingApi.new
 opts = {
     customer_id: 'customer_id_example', # String | Alphanumeric string identifying the customer.
-    invoice_id: 'invoice_id_example', # String | Alphanumeric string identifying the invoice.
+    invoice_id: 4183280, # Integer | 
 }
 
 begin
@@ -88,7 +88,7 @@ end
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **customer_id** | **String** | Alphanumeric string identifying the customer. |  |
-| **invoice_id** | **String** | Alphanumeric string identifying the invoice. |  |
+| **invoice_id** | **Integer** |  |  |
 
 ### Return type
 

data/docs/BillingBandwidth.md

@@ -0,0 +1,11 @@
+# Fastly::BillingBandwidth
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Float** |  | [optional] |
+| **tiers** | [**Array<BillingBandwidthTiers>**](BillingBandwidthTiers.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/BillingBandwidthTiers.md

@@ -0,0 +1,14 @@
+# Fastly::BillingBandwidthTiers
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **units** | **Float** |  | [optional] |
+| **price** | **Float** |  | [optional] |
+| **discounted_price** | **Float** |  | [optional] |
+| **total** | **Float** |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/BillingEstimateInvoiceId.md

@@ -0,0 +1,10 @@
+# Fastly::BillingEstimateInvoiceId
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **invoice_id** | **String** |  | [optional][readonly] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/BillingEstimateResponse.md

@@ -6,12 +6,12 @@
 | ---- | ---- | ----------- | ----- |
 | **end_time** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
 | **start_time** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
-| **invoice_id** | **String** |  | [optional][readonly] |
 | **customer_id** | **String** |  | [optional][readonly] |
 | **vendor_state** | **String** | The current state of our third-party billing vendor. One of `up` or `down`. | [optional][readonly] |
 | **status** | [**BillingStatus**](BillingStatus.md) |  | [optional] |
 | **total** | [**BillingTotal**](BillingTotal.md) |  | [optional] |
-| **regions** | **Hash<String, Hash<String, Object>>** | Breakdown of regional data for products that are region based. | [optional] |
+| **regions** | [**Hash<String, BillingRegions>**](BillingRegions.md) | Breakdown of regional data for products that are region based. | [optional] |
+| **invoice_id** | **String** |  | [optional][readonly] |
 | **line_items** | [**Array<BillingEstimateLinesLineItems>**](BillingEstimateLinesLineItems.md) |  | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

data/docs/{LineItemDataReadOnlyInvoiceId.md → BillingInvoiceId.md}

@@ -1,9 +1,10 @@
-# Fastly::LineItemDataReadOnlyInvoiceId
+# Fastly::BillingInvoiceId
 
 ## Properties
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
+| **invoice_id** | **Integer** |  | [optional][readonly] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
 

data/docs/BillingInvoicesApi.md

@@ -31,7 +31,7 @@ Returns invoice associated with the invoice id.
 ```ruby
 api_instance = Fastly::BillingInvoicesApi.new
 opts = {
-    invoice_id: 'invoice_id_example', # String | Alphanumeric string identifying the invoice.
+    invoice_id: 4183280, # Integer | 
 }
 
 begin
@@ -47,7 +47,7 @@ end
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **invoice_id** | **String** | Alphanumeric string identifying the invoice. |  |
+| **invoice_id** | **Integer** |  |  |
 
 ### Return type
 

data/docs/BillingRegions.md

@@ -0,0 +1,13 @@
+# Fastly::BillingRegions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cost** | **Float** |  | [optional] |
+| **bandwidth** | [**BillingBandwidth**](BillingBandwidth.md) |  | [optional] |
+| **percentile** | [**BillingBandwidth**](BillingBandwidth.md) |  | [optional] |
+| **requests** | [**BillingBandwidth**](BillingBandwidth.md) |  | [optional] |
+
+[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
+

data/docs/BillingResponse.md

@@ -6,12 +6,12 @@
 | ---- | ---- | ----------- | ----- |
 | **end_time** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
 | **start_time** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
-| **invoice_id** | **String** |  | [optional][readonly] |
 | **customer_id** | **String** |  | [optional][readonly] |
 | **vendor_state** | **String** | The current state of our third-party billing vendor. One of `up` or `down`. | [optional][readonly] |
 | **status** | [**BillingStatus**](BillingStatus.md) |  | [optional] |
 | **total** | [**BillingTotal**](BillingTotal.md) |  | [optional] |
-| **regions** | **Hash<String, Hash<String, Object>>** | Breakdown of regional data for products that are region based. | [optional] |
+| **regions** | [**Hash<String, BillingRegions>**](BillingRegions.md) | Breakdown of regional data for products that are region based. | [optional] |
+| **invoice_id** | **Integer** |  | [optional][readonly] |
 | **line_items** | [**Array<BillingResponseLineItem>**](BillingResponseLineItem.md) |  | [optional] |
 
 [[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)

data/docs/BillingResponseLineItem.md

@@ -8,7 +8,7 @@
 | **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
 | **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
 | **amount** | **Float** |  | [optional] |
-| **aria_invoice_id** | [**LineItemDataReadOnlyInvoiceId**](LineItemDataReadOnlyInvoiceId.md) |  | [optional] |
+| **aria_invoice_id** | **String** | An alphanumeric string identifying the invoice. | [optional][readonly] |
 | **client_service_id** | **String** |  | [optional] |
 | **credit_coupon_code** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |

data/docs/EomInvoiceResponse.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **customer_id** | **String** | Customer ID associated with the invoice. | [optional] |
-| **invoice_id** | **String** | Alphanumeric string identifying the invoice. | [optional] |
+| **invoice_id** | **String** | Numeric string identifying the invoice. | [optional] |
 | **invoice_posted_on** | **Time** | Date and time invoice was posted on, in ISO 8601 format. | [optional] |
 | **billing_start_date** | **Time** | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] |
 | **billing_end_date** | **Time** | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] |

data/docs/Invoice.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **customer_id** | **String** | Customer ID associated with the invoice. | [optional] |
-| **invoice_id** | **String** | Alphanumeric string identifying the invoice. | [optional] |
+| **invoice_id** | **String** | Numeric string identifying the invoice. | [optional] |
 | **invoice_posted_on** | **Time** | Date and time invoice was posted on, in ISO 8601 format. | [optional] |
 | **billing_start_date** | **Time** | Date and time (in ISO 8601 format) for initiation point of a billing cycle, signifying the start of charges for a service or subscription. | [optional] |
 | **billing_end_date** | **Time** | Date and time (in ISO 8601 format) for termination point of a billing cycle, signifying the end of charges for a service or subscription. | [optional] |

data/docs/LineItemData.md

@@ -5,7 +5,7 @@
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
 | **amount** | **Float** |  | [optional] |
-| **aria_invoice_id** | [**LineItemDataReadOnlyInvoiceId**](LineItemDataReadOnlyInvoiceId.md) |  | [optional] |
+| **aria_invoice_id** | **String** | An alphanumeric string identifying the invoice. | [optional][readonly] |
 | **client_service_id** | **String** |  | [optional] |
 | **credit_coupon_code** | **String** |  | [optional] |
 | **description** | **String** |  | [optional] |

data/lib/fastly/api/billing_api.rb

@@ -90,7 +90,7 @@ module Fastly
     # Get an invoice
     # Get the invoice for the given invoice_id.
     # @option opts [String] :customer_id Alphanumeric string identifying the customer. (required)
-    # @option opts [String] :invoice_id Alphanumeric string identifying the invoice. (required)
+    # @option opts [Integer] :invoice_id  (required)
     # @return [BillingResponse]
     def get_invoice_by_id(opts = {})
       data, _status_code, _headers = get_invoice_by_id_with_http_info(opts)
@@ -100,7 +100,7 @@ module Fastly
     # Get an invoice
     # Get the invoice for the given invoice_id.
     # @option opts [String] :customer_id Alphanumeric string identifying the customer. (required)
-    # @option opts [String] :invoice_id Alphanumeric string identifying the invoice. (required)
+    # @option opts [Integer] :invoice_id  (required)
     # @return [Array<(BillingResponse, Integer, Hash)>] BillingResponse data, response status code and response headers
     def get_invoice_by_id_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/fastly/api/billing_invoices_api.rb

@@ -19,7 +19,7 @@ module Fastly
     end
     # Get invoice by ID.
     # Returns invoice associated with the invoice id.
-    # @option opts [String] :invoice_id Alphanumeric string identifying the invoice. (required)
+    # @option opts [Integer] :invoice_id  (required)
     # @return [EomInvoiceResponse]
     def get_invoice_by_invoice_id(opts = {})
       data, _status_code, _headers = get_invoice_by_invoice_id_with_http_info(opts)
@@ -28,7 +28,7 @@ module Fastly
 
     # Get invoice by ID.
     # Returns invoice associated with the invoice id.
-    # @option opts [String] :invoice_id Alphanumeric string identifying the invoice. (required)
+    # @option opts [Integer] :invoice_id  (required)
     # @return [Array<(EomInvoiceResponse, Integer, Hash)>] EomInvoiceResponse data, response status code and response headers
     def get_invoice_by_invoice_id_with_http_info(opts = {})
       if @api_client.config.debugging

data/lib/fastly/models/billing.rb

@@ -19,8 +19,6 @@ module Fastly
     # Date and time in ISO 8601 format.
     attr_accessor :start_time
 
-    attr_accessor :invoice_id
-
     attr_accessor :customer_id
 
     # The current state of our third-party billing vendor. One of `up` or `down`.
@@ -38,7 +36,6 @@ module Fastly
       {
         :'end_time' => :'end_time',
         :'start_time' => :'start_time',
-        :'invoice_id' => :'invoice_id',
         :'customer_id' => :'customer_id',
         :'vendor_state' => :'vendor_state',
         :'status' => :'status',
@@ -57,12 +54,11 @@ module Fastly
       {
         :'end_time' => :'Time',
         :'start_time' => :'Time',
-        :'invoice_id' => :'String',
         :'customer_id' => :'String',
         :'vendor_state' => :'String',
         :'status' => :'BillingStatus',
         :'total' => :'BillingTotal',
-        :'regions' => :'Hash<String, Hash<String, Object>>'
+        :'regions' => :'Hash<String, BillingRegions>'
       }
     end
 
@@ -97,10 +93,6 @@ module Fastly
         self.start_time = attributes[:'start_time']
       end
 
-      if attributes.key?(:'invoice_id')
-        self.invoice_id = attributes[:'invoice_id']
-      end
-
       if attributes.key?(:'customer_id')
         self.customer_id = attributes[:'customer_id']
       end
@@ -144,7 +136,6 @@ module Fastly
       self.class == o.class &&
           end_time == o.end_time &&
           start_time == o.start_time &&
-          invoice_id == o.invoice_id &&
           customer_id == o.customer_id &&
           vendor_state == o.vendor_state &&
           status == o.status &&
@@ -161,7 +152,7 @@ module Fastly
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [end_time, start_time, invoice_id, customer_id, vendor_state, status, total, regions].hash
+      [end_time, start_time, customer_id, vendor_state, status, total, regions].hash
     end
 
     # Builds the object from hash

data/lib/fastly/models/billing_bandwidth.rb

@@ -0,0 +1,227 @@
+=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 BillingBandwidth
+    attr_accessor :total
+
+    attr_accessor :tiers
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'total' => :'total',
+        :'tiers' => :'tiers'
+      }
+    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
+      {
+        :'total' => :'Float',
+        :'tiers' => :'Array<BillingBandwidthTiers>'
+      }
+    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::BillingBandwidth` 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::BillingBandwidth`. 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?(:'total')
+        self.total = attributes[:'total']
+      end
+
+      if attributes.key?(:'tiers')
+        if (value = attributes[:'tiers']).is_a?(Array)
+          self.tiers = 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
+      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?
+      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 &&
+          total == o.total &&
+          tiers == o.tiers
+    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
+      [total, tiers].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