ultracart_api 4.0.68.rc → 4.0.69.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8c4b903ce14ec1f657043bf48cc9c634b9826688b4d4ff1a08db79607e33202
-  data.tar.gz: e65e687aa31e65bf23177fc0da02ca3d7cc23d96bbe53c1c5d6314913f9f75d8
+  metadata.gz: 74812ef9dacbb6bb7e8d9cdc4d21e7c29b31b4c284b2dbb44eead47c2d9ef6d0
+  data.tar.gz: 39ff1acb4854db3ad3b0c7092ceee7494c734ea32573b02fa9d4b66013ee69f5
 SHA512:
-  metadata.gz: 6f5436e24c2a2cf0b532b5ab1b709cbd2626c076ac1df51cf248f9e9af050c1f99371c9e76f19c21135b67def035fac251387693516d22db674365f0ebeedef3
-  data.tar.gz: 2ba409aa671f317e42d0a99cfe347475d21b8f23038a0eb9d83cbdf411dda9c4e5f3993f76da31703325af9cfa8ef24577462e440428dc450fd75f519979b804
+  metadata.gz: e0785b439a3d1195c8465abc2096e275c548a976197403ae570900b3daced2459eccb41b088dbc0ba63dd04fdfd66c60dc1f667f379492406502ac8308021364
+  data.tar.gz: ca4ca4f9f3a1b9d1f4a5f240bc30944a43182a419e27227ff5dccf523acdcc72ff4a69542df3a886412d0bc0e37484b7a2f09e89dc54234472b069b5abac8de8

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: 2.0.0
-- Package version: 4.0.68.rc
+- Package version: 4.0.69.rc
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-4.0.68.rc.gem
+gem install ./ultracart_api-4.0.69.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.68.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.69.rc.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ultracart_api', '~> 4.0.68.rc'
+    gem 'ultracart_api', '~> 4.0.69.rc'
 
 ### Install from Git
 
@@ -831,6 +831,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::FileManagerDirectory](docs/FileManagerDirectory.md)
  - [UltracartClient::FileManagerFile](docs/FileManagerFile.md)
  - [UltracartClient::FileManagerPage](docs/FileManagerPage.md)
+ - [UltracartClient::FileManagerPageResponse](docs/FileManagerPageResponse.md)
  - [UltracartClient::FileManagerUploadRequest](docs/FileManagerUploadRequest.md)
  - [UltracartClient::FileManagerUploadUrlResponse](docs/FileManagerUploadUrlResponse.md)
  - [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
@@ -1217,6 +1218,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.69-RC | 09/29/2022 | storefront file mgr calls tweaks |
 | 4.0.68-RC | 09/29/2022 | storefront methods for file manager ui |
 | 4.0.67-RC | 09/27/2022 | added digital library call for unassociated content |
 | 4.0.66-RC | 09/22/2022 | digital item mgmt testing |

data/docs/FileManagerPageResponse.md

@@ -0,0 +1,26 @@
+# UltracartClient::FileManagerPageResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**Error**](Error.md) |  | [optional] |
+| **file_manager_page** | [**FileManagerPage**](FileManagerPage.md) |  | [optional] |
+| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] |
+| **success** | **Boolean** | Indicates if API call was successful | [optional] |
+| **warning** | [**Warning**](Warning.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ultracart_api'
+
+instance = UltracartClient::FileManagerPageResponse.new(
+  error: null,
+  file_manager_page: null,
+  metadata: null,
+  success: null,
+  warning: null
+)
+```
+

data/docs/StorefrontApi.md

@@ -893,7 +893,7 @@ end
 
 ## create_fs_directory
 
-> <FileManagerPage> create_fs_directory(id, opts)
+> <FileManagerPageResponse> create_fs_directory(id, opts)
 
 Create file manager directory
 
@@ -930,7 +930,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<FileManagerPage>, Integer, Hash)> create_fs_directory_with_http_info(id, opts)
+> <Array(<FileManagerPageResponse>, Integer, Hash)> create_fs_directory_with_http_info(id, opts)
 
 ```ruby
 begin
@@ -938,7 +938,7 @@ begin
   data, status_code, headers = api_instance.create_fs_directory_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <FileManagerPage>
+  p data # => <FileManagerPageResponse>
 rescue UltracartClient::ApiError => e
   puts "Error when calling StorefrontApi->create_fs_directory_with_http_info: #{e}"
 end
@@ -954,7 +954,7 @@ end
 
 ### Return type
 
-[**FileManagerPage**](FileManagerPage.md)
+[**FileManagerPageResponse**](FileManagerPageResponse.md)
 
 ### Authorization
 
@@ -1674,7 +1674,7 @@ nil (empty response body)
 
 ## delete_fs_file
 
-> <FileManagerPage> delete_fs_file(id, opts)
+> <FileManagerPageResponse> delete_fs_file(id, opts)
 
 Delete file manager directory
 
@@ -1711,7 +1711,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<FileManagerPage>, Integer, Hash)> delete_fs_file_with_http_info(id, opts)
+> <Array(<FileManagerPageResponse>, Integer, Hash)> delete_fs_file_with_http_info(id, opts)
 
 ```ruby
 begin
@@ -1719,7 +1719,7 @@ begin
   data, status_code, headers = api_instance.delete_fs_file_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <FileManagerPage>
+  p data # => <FileManagerPageResponse>
 rescue UltracartClient::ApiError => e
   puts "Error when calling StorefrontApi->delete_fs_file_with_http_info: #{e}"
 end
@@ -1735,7 +1735,7 @@ end
 
 ### Return type
 
-[**FileManagerPage**](FileManagerPage.md)
+[**FileManagerPageResponse**](FileManagerPageResponse.md)
 
 ### Authorization
 
@@ -6436,7 +6436,7 @@ end
 
 ## get_fs_directory
 
-> <FileManagerPage> get_fs_directory(id, opts)
+> <FileManagerPageResponse> get_fs_directory(id, opts)
 
 Get file manager directory
 
@@ -6474,7 +6474,7 @@ end
 
 This returns an Array which contains the response data, status code and headers.
 
-> <Array(<FileManagerPage>, Integer, Hash)> get_fs_directory_with_http_info(id, opts)
+> <Array(<FileManagerPageResponse>, Integer, Hash)> get_fs_directory_with_http_info(id, opts)
 
 ```ruby
 begin
@@ -6482,7 +6482,7 @@ begin
   data, status_code, headers = api_instance.get_fs_directory_with_http_info(id, opts)
   p status_code # => 2xx
   p headers # => { ... }
-  p data # => <FileManagerPage>
+  p data # => <FileManagerPageResponse>
 rescue UltracartClient::ApiError => e
   puts "Error when calling StorefrontApi->get_fs_directory_with_http_info: #{e}"
 end
@@ -6499,7 +6499,7 @@ end
 
 ### Return type
 
-[**FileManagerPage**](FileManagerPage.md)
+[**FileManagerPageResponse**](FileManagerPageResponse.md)
 
 ### Authorization
 

data/lib/ultracart_api/api/storefront_api.rb

@@ -731,7 +731,7 @@ module UltracartClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :name 
     # @option opts [Integer] :parent_storefront_fs_directory_oid 
-    # @return [FileManagerPage]
+    # @return [FileManagerPageResponse]
     def create_fs_directory(id, opts = {})
       data, _status_code, _headers = create_fs_directory_with_http_info(id, opts)
       data
@@ -742,7 +742,7 @@ module UltracartClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :name 
     # @option opts [Integer] :parent_storefront_fs_directory_oid 
-    # @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
+    # @return [Array<(FileManagerPageResponse, Integer, Hash)>] FileManagerPageResponse data, response status code and response headers
     def create_fs_directory_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: StorefrontApi.create_fs_directory ...'
@@ -772,7 +772,7 @@ module UltracartClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'FileManagerPage'
+      return_type = opts[:debug_return_type] || 'FileManagerPageResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
@@ -1478,7 +1478,7 @@ module UltracartClient
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :parent_storefront_fs_directory_oid 
     # @option opts [Integer] :storefront_fs_file_oid 
-    # @return [FileManagerPage]
+    # @return [FileManagerPageResponse]
     def delete_fs_file(id, opts = {})
       data, _status_code, _headers = delete_fs_file_with_http_info(id, opts)
       data
@@ -1489,7 +1489,7 @@ module UltracartClient
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :parent_storefront_fs_directory_oid 
     # @option opts [Integer] :storefront_fs_file_oid 
-    # @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
+    # @return [Array<(FileManagerPageResponse, Integer, Hash)>] FileManagerPageResponse data, response status code and response headers
     def delete_fs_file_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_fs_file ...'
@@ -1519,7 +1519,7 @@ module UltracartClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'FileManagerPage'
+      return_type = opts[:debug_return_type] || 'FileManagerPageResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
@@ -5999,7 +5999,7 @@ module UltracartClient
     # @option opts [String] :path 
     # @option opts [Integer] :storefront_fs_directory_oid 
     # @option opts [Integer] :storefront_theme_oid 
-    # @return [FileManagerPage]
+    # @return [FileManagerPageResponse]
     def get_fs_directory(id, opts = {})
       data, _status_code, _headers = get_fs_directory_with_http_info(id, opts)
       data
@@ -6011,7 +6011,7 @@ module UltracartClient
     # @option opts [String] :path 
     # @option opts [Integer] :storefront_fs_directory_oid 
     # @option opts [Integer] :storefront_theme_oid 
-    # @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
+    # @return [Array<(FileManagerPageResponse, Integer, Hash)>] FileManagerPageResponse data, response status code and response headers
     def get_fs_directory_with_http_info(id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: StorefrontApi.get_fs_directory ...'
@@ -6042,7 +6042,7 @@ module UltracartClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'FileManagerPage'
+      return_type = opts[:debug_return_type] || 'FileManagerPageResponse'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']

data/lib/ultracart_api/models/file_manager_page_response.rb

@@ -0,0 +1,256 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class FileManagerPageResponse
+    attr_accessor :error
+
+    attr_accessor :file_manager_page
+
+    attr_accessor :metadata
+
+    # Indicates if API call was successful
+    attr_accessor :success
+
+    attr_accessor :warning
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'error' => :'error',
+        :'file_manager_page' => :'file_manager_page',
+        :'metadata' => :'metadata',
+        :'success' => :'success',
+        :'warning' => :'warning'
+      }
+    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
+      {
+        :'error' => :'Error',
+        :'file_manager_page' => :'FileManagerPage',
+        :'metadata' => :'ResponseMetadata',
+        :'success' => :'Boolean',
+        :'warning' => :'Warning'
+      }
+    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 `UltracartClient::FileManagerPageResponse` 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 `UltracartClient::FileManagerPageResponse`. 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?(:'error')
+        self.error = attributes[:'error']
+      end
+
+      if attributes.key?(:'file_manager_page')
+        self.file_manager_page = attributes[:'file_manager_page']
+      end
+
+      if attributes.key?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'success')
+        self.success = attributes[:'success']
+      end
+
+      if attributes.key?(:'warning')
+        self.warning = attributes[:'warning']
+      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 &&
+          error == o.error &&
+          file_manager_page == o.file_manager_page &&
+          metadata == o.metadata &&
+          success == o.success &&
+          warning == o.warning
+    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
+      [error, file_manager_page, metadata, success, warning].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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_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 = UltracartClient.const_get(type)
+        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/ultracart_api/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 6.0.1-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '4.0.68.rc'
+  VERSION = '4.0.69.rc'
 end

data/lib/ultracart_api.rb

@@ -382,6 +382,7 @@ require 'ultracart_api/models/experiments_response'
 require 'ultracart_api/models/file_manager_directory'
 require 'ultracart_api/models/file_manager_file'
 require 'ultracart_api/models/file_manager_page'
+require 'ultracart_api/models/file_manager_page_response'
 require 'ultracart_api/models/file_manager_upload_request'
 require 'ultracart_api/models/file_manager_upload_url_response'
 require 'ultracart_api/models/fulfillment_inventory'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.68.rc
+  version: 4.0.69.rc
 platform: ruby
 authors:
 - UltraCart
@@ -434,6 +434,7 @@ files:
 - docs/FileManagerDirectory.md
 - docs/FileManagerFile.md
 - docs/FileManagerPage.md
+- docs/FileManagerPageResponse.md
 - docs/FileManagerUploadRequest.md
 - docs/FileManagerUploadUrlResponse.md
 - docs/FulfillmentApi.md
@@ -1147,6 +1148,7 @@ files:
 - lib/ultracart_api/models/file_manager_directory.rb
 - lib/ultracart_api/models/file_manager_file.rb
 - lib/ultracart_api/models/file_manager_page.rb
+- lib/ultracart_api/models/file_manager_page_response.rb
 - lib/ultracart_api/models/file_manager_upload_request.rb
 - lib/ultracart_api/models/file_manager_upload_url_response.rb
 - lib/ultracart_api/models/fulfillment_inventory.rb