ultracart_api 4.0.122.rc → 4.0.123.rc

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 385862ada6be86537e5545c20c1ed2fa7cc9f6b8ef17efdb6d91a4dde04e4411
-  data.tar.gz: eedee93bde2d0f8b811931d4152b7b7fd5a3b80e709d4f7693c2cde996a24bfa
+  metadata.gz: 4a0cf7273bf5b90c4e089800e48cdd968b3f7acbdbb63bb99fc73a359b541479
+  data.tar.gz: 12cb66042827943dedbad3f90429c4212e8a0e84e325cb3591fd407749e99bbc
 SHA512:
-  metadata.gz: afb6cc0c5513f3d5084896dfec3c60f71b4e9b4d959b0024b69895723c4f4822404e4bcb70bbfe7542844957eddab88f2f6a459c6c27b1fd142241a0eeb80677
-  data.tar.gz: b78fd1639bb08d42c6840a057506115dab3adcab00161012a39ce84dd4f94d3ae08c63aba7c6ffe9d37a8fe6006555530fffd92e51f348de878a86e59517b525
+  metadata.gz: 7b555fb6ddb95b6a3bdd9ee2a198c639c51cbd85c592cf8c1f9b9331a166b38e0d357994e2760d2f2646ed08c9a4deadbcbfef0c3d482a9789c090112bf742a1
+  data.tar.gz: 5b141644046019938468a9eb05292b96fc89fc19b5abb1416c97058f07c459cc7129ba786e12032495e42513e4af224a293063e13c241eddb30694b242e8d3ae

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.122.rc
+- Package version: 4.0.123.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.122.rc.gem
+gem install ./ultracart_api-4.0.123.rc.gem
 ```
 
-(for development, run `gem install --dev ./ultracart_api-4.0.122.rc.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-4.0.123.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.122.rc'
+    gem 'ultracart_api', '~> 4.0.123.rc'
 
 ### Install from Git
 
@@ -248,6 +248,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 *UltracartClient::OrderApi* | [**duplicate_order**](docs/OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order
 *UltracartClient::OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order
+*UltracartClient::OrderApi* | [**generate_invoice**](docs/OrderApi.md#generate_invoice) | **GET** /order/orders/{order_id}/invoice | Generate an invoice for this order.
 *UltracartClient::OrderApi* | [**generate_order_token**](docs/OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
 *UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
 *UltracartClient::OrderApi* | [**generate_packing_slip_specific_dc**](docs/OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
@@ -1054,6 +1055,7 @@ Class | Method | HTTP request | Description
  - [UltracartClient::OrderGift](docs/OrderGift.md)
  - [UltracartClient::OrderGiftCertificate](docs/OrderGiftCertificate.md)
  - [UltracartClient::OrderInternal](docs/OrderInternal.md)
+ - [UltracartClient::OrderInvoiceResponse](docs/OrderInvoiceResponse.md)
  - [UltracartClient::OrderItem](docs/OrderItem.md)
  - [UltracartClient::OrderItemEdi](docs/OrderItemEdi.md)
  - [UltracartClient::OrderItemEdiIdentification](docs/OrderItemEdiIdentification.md)
@@ -1298,6 +1300,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.0.123-RC | 01/25/2023 | order api method generateInvoice |
 | 4.0.122-RC | 01/24/2023 | auto order - cancel minimum and change balance options |
 | 4.0.121-RC | 01/23/2023 | conversation - method to fetch single engagement record |
 | 4.0.120-RC | 01/19/2023 | added skip_on_rebill field to coupon object |

data/docs/OrderApi.md

@@ -9,6 +9,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 | [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order |
 | [**duplicate_order**](OrderApi.md#duplicate_order) | **POST** /order/orders/{order_id}/duplicate | Duplicate an order |
 | [**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format order |
+| [**generate_invoice**](OrderApi.md#generate_invoice) | **GET** /order/orders/{order_id}/invoice | Generate an invoice for this order. |
 | [**generate_order_token**](OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id |
 | [**generate_packing_slip_all_dc**](OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers. |
 | [**generate_packing_slip_specific_dc**](OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center. |
@@ -392,6 +393,77 @@ end
 - **Accept**: application/json
 
 
+## generate_invoice
+
+> <OrderInvoiceResponse> generate_invoice(order_id)
+
+Generate an invoice for this order.
+
+The invoice PDF that is returned is base 64 encoded 
+
+### Examples
+
+```ruby
+require 'time'
+require 'ultracart_api'
+require 'json'
+require 'yaml'
+require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
+
+# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
+# As such, this might not be the best way to use this object.
+# Please see https://github.com/UltraCart/sdk_samples for working examples.
+
+api = UltracartClient::OrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
+order_id = 'order_id_example' # String | Order ID
+
+begin
+  # Generate an invoice for this order.
+  result = api_instance.generate_invoice(order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->generate_invoice: #{e}"
+end
+```
+
+#### Using the generate_invoice_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<OrderInvoiceResponse>, Integer, Hash)> generate_invoice_with_http_info(order_id)
+
+```ruby
+begin
+  # Generate an invoice for this order.
+  data, status_code, headers = api_instance.generate_invoice_with_http_info(order_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <OrderInvoiceResponse>
+rescue UltracartClient::ApiError => e
+  puts "Error when calling OrderApi->generate_invoice_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **order_id** | **String** | Order ID |  |
+
+### Return type
+
+[**OrderInvoiceResponse**](OrderInvoiceResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## generate_order_token
 
 > <OrderTokenResponse> generate_order_token(order_id)

data/docs/OrderInvoiceResponse.md

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

data/lib/ultracart_api/api/order_api.rb

@@ -372,6 +372,70 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Generate an invoice for this order.
+    # The invoice PDF that is returned is base 64 encoded 
+    # @param order_id [String] Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [OrderInvoiceResponse]
+    def generate_invoice(order_id, opts = {})
+      data, _status_code, _headers = generate_invoice_with_http_info(order_id, opts)
+      data
+    end
+
+    # Generate an invoice for this order.
+    # The invoice PDF that is returned is base 64 encoded 
+    # @param order_id [String] Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrderInvoiceResponse, Integer, Hash)>] OrderInvoiceResponse data, response status code and response headers
+    def generate_invoice_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.generate_invoice ...'
+      end
+      # verify the required parameter 'order_id' is set
+      if @api_client.config.client_side_validation && order_id.nil?
+        fail ArgumentError, "Missing the required parameter 'order_id' when calling OrderApi.generate_invoice"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/invoice'.sub('{' + 'order_id' + '}', CGI.escape(order_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'OrderInvoiceResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"OrderApi.generate_invoice",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      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: OrderApi#generate_invoice\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Generate an order token for a given order id
     # Retrieves a single order token for a given order id.  The token can be used with the getOrderByToken API. 
     # @param order_id [String] The order id to generate a token for.

data/lib/ultracart_api/models/order_invoice_response.rb

@@ -0,0 +1,257 @@
+=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 OrderInvoiceResponse
+    attr_accessor :error
+
+    attr_accessor :metadata
+
+    # pdf_base64
+    attr_accessor :pdf_base64
+
+    # 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',
+        :'metadata' => :'metadata',
+        :'pdf_base64' => :'pdfBase64',
+        :'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',
+        :'metadata' => :'ResponseMetadata',
+        :'pdf_base64' => :'String',
+        :'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::OrderInvoiceResponse` 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::OrderInvoiceResponse`. 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?(:'metadata')
+        self.metadata = attributes[:'metadata']
+      end
+
+      if attributes.key?(:'pdf_base64')
+        self.pdf_base64 = attributes[:'pdf_base64']
+      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 &&
+          metadata == o.metadata &&
+          pdf_base64 == o.pdf_base64 &&
+          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, metadata, pdf_base64, 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.122.rc'
+  VERSION = '4.0.123.rc'
 end

data/lib/ultracart_api.rb

@@ -577,6 +577,7 @@ require 'ultracart_api/models/order_fraud_score'
 require 'ultracart_api/models/order_gift'
 require 'ultracart_api/models/order_gift_certificate'
 require 'ultracart_api/models/order_internal'
+require 'ultracart_api/models/order_invoice_response'
 require 'ultracart_api/models/order_item'
 require 'ultracart_api/models/order_item_edi'
 require 'ultracart_api/models/order_item_edi_identification'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 4.0.122.rc
+  version: 4.0.123.rc
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-24 00:00:00.000000000 Z
+date: 2023-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus
@@ -635,6 +635,7 @@ files:
 - docs/OrderGift.md
 - docs/OrderGiftCertificate.md
 - docs/OrderInternal.md
+- docs/OrderInvoiceResponse.md
 - docs/OrderItem.md
 - docs/OrderItemEdi.md
 - docs/OrderItemEdiIdentification.md
@@ -1395,6 +1396,7 @@ files:
 - lib/ultracart_api/models/order_gift.rb
 - lib/ultracart_api/models/order_gift_certificate.rb
 - lib/ultracart_api/models/order_internal.rb
+- lib/ultracart_api/models/order_invoice_response.rb
 - lib/ultracart_api/models/order_item.rb
 - lib/ultracart_api/models/order_item_edi.rb
 - lib/ultracart_api/models/order_item_edi_identification.rb