ultracart_api 3.2.11 → 3.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab4a9230408e849839ffa05f1388f126d79ea05461e32435e17fc36cc368442d
-  data.tar.gz: d7860c7728fe67f723b1c5b156f8922ec4d502c0953dc139000fa8eb4be8c062
+  metadata.gz: a4492cfba82bba9af892da320a4a2516637e3d266247475fc34b1ea0df4fc672
+  data.tar.gz: 10fe7be089f7dd67ea14c9888f1cb9f688eb6a8ce723950f2597f11f812b49f0
 SHA512:
-  metadata.gz: ee1653e846c97444c43922ac2580c468987f99fcd0baf2614f02f413fa0b50200db1f982dc51d8caf62390f9592c2eccd9d09d6c2d931fd701cbb9205d555152
-  data.tar.gz: a251dfca7836f01f542b193ab791a1b00cb4f07f5068aa243190df00e040067251350939e6d23b7f5aa338cd43047d3aabc773bc9f8418c40fe6c8312407391a
+  metadata.gz: 310966e472290ca5de80185a1df26d1191a94708d9cf8777d4e9ed8b14b8781949e0f26e5e4703cb8f9e5be49080f7716640dc2bd62a64a0dcd969c2a89d664d
+  data.tar.gz: bef6c03d1a710fc9a6bf503d49702e7eedd2613d8a334ff895499421b422832a881090b8317bc8b564989ddb55f748cd750ac2cc74558ed3b256aa7a8fad7cef

data/README.md

@@ -7,7 +7,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.2.11
+- Package version: 3.2.12
 - Build package: io.swagger.codegen.languages.RubyClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ultracart_api-3.2.11.gem
+gem install ./ultracart_api-3.2.12.gem
 ```
-(for development, run `gem install --dev ./ultracart_api-3.2.11.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ultracart_api-3.2.12.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', '~> 3.2.11'
+    gem 'ultracart_api', '~> 3.2.12'
 
 ### Install from Git
 
@@ -153,6 +153,7 @@ Class | Method | HTTP request | Description
 *UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
 *UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
 *UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
+*UltracartClient::FulfillmentApi* | [**generate_packing_slip**](docs/FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
 *UltracartClient::FulfillmentApi* | [**get_distribution_center_orders**](docs/FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
 *UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
 *UltracartClient::FulfillmentApi* | [**ship_orders**](docs/FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
@@ -176,6 +177,8 @@ Class | Method | HTTP request | Description
 *UltracartClient::OrderApi* | [**delete_order**](docs/OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 *UltracartClient::OrderApi* | [**format**](docs/OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format 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 for the given distribution center.
+*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.
 *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_config**](docs/OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
 *UltracartClient::OrderApi* | [**get_accounts_receivable_retry_stats**](docs/OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
 *UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
@@ -1032,6 +1035,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.2.12 | 07/09/2021 | new fulfillment and order methods for generation of packing slips | 
 | 3.2.11 | 07/08/2021 | screen recording - missing external tracking flag added | 
 | 3.2.10 | 07/08/2021 | customer profile - allow drop shipping options | 
 | 3.2.9 | 07/07/2021 | screen recording - provide cost per thousand and retention interval | 

data/docs/FulfillmentApi.md

@@ -5,6 +5,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
 Method | HTTP request | Description
 ------------- | ------------- | -------------
 [**acknowledge_orders**](FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
+[**generate_packing_slip**](FulfillmentApi.md#generate_packing_slip) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id} | Generate a packing slip for this order for the given distribution center.
 [**get_distribution_center_orders**](FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
 [**get_distribution_centers**](FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
 [**ship_orders**](FulfillmentApi.md#ship_orders) | **POST** /fulfillment/distribution_centers/{distribution_center_code}/shipments | Mark orders as shipped
@@ -63,6 +64,59 @@ nil (empty response body)
 
 
 
+# **generate_packing_slip**
+> OrdersResponse generate_packing_slip(distribution_center_code, order_id)
+
+Generate a packing slip for this order for the given distribution center.
+
+The packing slip PDF that is returned is base 64 encoded 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::FulfillmentApi.new_using_api_key(simple_key, false, false)
+
+
+distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
+
+order_id = 'order_id_example' # String | Order ID
+
+
+begin
+  #Generate a packing slip for this order for the given distribution center.
+  result = api_instance.generate_packing_slip(distribution_center_code, order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling FulfillmentApi->generate_packing_slip: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distribution_center_code** | **String**| Distribution center code | 
+ **order_id** | **String**| Order ID | 
+
+### Return type
+
+[**OrdersResponse**](OrdersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_distribution_center_orders**
 > OrdersResponse get_distribution_center_orders(distribution_center_code)
 

data/docs/OrderApi.md

@@ -9,6 +9,8 @@ Method | HTTP request | Description
 [**delete_order**](OrderApi.md#delete_order) | **DELETE** /order/orders/{order_id} | Delete an order
 [**format**](OrderApi.md#format) | **POST** /order/orders/{order_id}/format | Format 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 for the given distribution center.
+[**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.
 [**get_accounts_receivable_retry_config**](OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
 [**get_accounts_receivable_retry_stats**](OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
 [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
@@ -281,6 +283,109 @@ Name | Type | Description  | Notes
 
 
 
+# **generate_packing_slip_all_dc**
+> OrdersResponse generate_packing_slip_all_dc(order_id)
+
+Generate a packing slip for this order for the given distribution center.
+
+The packing slip PDF that is returned is base 64 encoded 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+order_id = 'order_id_example' # String | Order ID
+
+
+begin
+  #Generate a packing slip for this order for the given distribution center.
+  result = api_instance.generate_packing_slip_all_dc(order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->generate_packing_slip_all_dc: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **order_id** | **String**| Order ID | 
+
+### Return type
+
+[**OrdersResponse**](OrdersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **generate_packing_slip_specific_dc**
+> OrdersResponse generate_packing_slip_specific_dc(distribution_center_code, order_id)
+
+Generate a packing slip for this order for the given distribution center.
+
+The packing slip PDF that is returned is base 64 encoded 
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
+
+
+distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
+
+order_id = 'order_id_example' # String | Order ID
+
+
+begin
+  #Generate a packing slip for this order for the given distribution center.
+  result = api_instance.generate_packing_slip_specific_dc(distribution_center_code, order_id)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling OrderApi->generate_packing_slip_specific_dc: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **distribution_center_code** | **String**| Distribution center code | 
+ **order_id** | **String**| Order ID | 
+
+### Return type
+
+[**OrdersResponse**](OrdersResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_accounts_receivable_retry_config**
 > AccountsReceivableRetryConfigResponse get_accounts_receivable_retry_config
 

data/lib/ultracart_api/api/fulfillment_api.rb

@@ -92,6 +92,67 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Generate a packing slip for this order for the given distribution center.
+    # The packing slip PDF that is returned is base 64 encoded 
+    # @param distribution_center_code Distribution center code
+    # @param order_id Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [OrdersResponse]
+    def generate_packing_slip(distribution_center_code, order_id, opts = {})
+      data, _status_code, _headers = generate_packing_slip_with_http_info(distribution_center_code, order_id, opts)
+      data
+    end
+
+    # Generate a packing slip for this order for the given distribution center.
+    # The packing slip PDF that is returned is base 64 encoded 
+    # @param distribution_center_code Distribution center code
+    # @param order_id Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
+    def generate_packing_slip_with_http_info(distribution_center_code, order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FulfillmentApi.generate_packing_slip ...'
+      end
+      # verify the required parameter 'distribution_center_code' is set
+      if @api_client.config.client_side_validation && distribution_center_code.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling FulfillmentApi.generate_packing_slip"
+      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 FulfillmentApi.generate_packing_slip"
+      end
+      # resource path
+      local_var_path = '/fulfillment/distribution_centers/{distribution_center_code}/orders/{order_id}'.sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s).sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrdersResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FulfillmentApi#generate_packing_slip\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve orders queued up for this distribution center.
     # Retrieves up to 100 orders that are queued up in this distribution center.  You must acknowledge them before additional new orders will be returned.  There is NO record chunking.  You'll get the same 100 records again and again until you acknowledge orders.  The orders that are returned contain only items for this distribution center and are by default completely expanded with billing, buysafe, channel_partner, checkout, coupons, customer_profile, edi, gift, gift_certificate, internal, items, payment, shipping, summary, taxes. 
     # @param distribution_center_code Distribution center code

data/lib/ultracart_api/api/order_api.rb

@@ -318,6 +318,122 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Generate a packing slip for this order for the given distribution center.
+    # The packing slip PDF that is returned is base 64 encoded 
+    # @param order_id Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [OrdersResponse]
+    def generate_packing_slip_all_dc(order_id, opts = {})
+      data, _status_code, _headers = generate_packing_slip_all_dc_with_http_info(order_id, opts)
+      data
+    end
+
+    # Generate a packing slip for this order for the given distribution center.
+    # The packing slip PDF that is returned is base 64 encoded 
+    # @param order_id Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
+    def generate_packing_slip_all_dc_with_http_info(order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_all_dc ...'
+      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_packing_slip_all_dc"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/packing_slip'.sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrdersResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_all_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Generate a packing slip for this order for the given distribution center.
+    # The packing slip PDF that is returned is base 64 encoded 
+    # @param distribution_center_code Distribution center code
+    # @param order_id Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [OrdersResponse]
+    def generate_packing_slip_specific_dc(distribution_center_code, order_id, opts = {})
+      data, _status_code, _headers = generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts)
+      data
+    end
+
+    # Generate a packing slip for this order for the given distribution center.
+    # The packing slip PDF that is returned is base 64 encoded 
+    # @param distribution_center_code Distribution center code
+    # @param order_id Order ID
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(OrdersResponse, Fixnum, Hash)>] OrdersResponse data, response status code and response headers
+    def generate_packing_slip_specific_dc_with_http_info(distribution_center_code, order_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: OrderApi.generate_packing_slip_specific_dc ...'
+      end
+      # verify the required parameter 'distribution_center_code' is set
+      if @api_client.config.client_side_validation && distribution_center_code.nil?
+        fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling OrderApi.generate_packing_slip_specific_dc"
+      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_packing_slip_specific_dc"
+      end
+      # resource path
+      local_var_path = '/order/orders/{order_id}/packing_slip/{distribution_center_code}'.sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s).sub('{' + 'order_id' + '}', order_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      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'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'OrdersResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: OrderApi#generate_packing_slip_specific_dc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve A/R Retry Configuration
     # Retrieve A/R Retry Configuration. This is primarily an internal API call.  It is doubtful you would ever need to use it. 
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/version.rb

@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
 =end
 
 module UltracartClient
-  VERSION = '3.2.11'
+  VERSION = '3.2.12'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ultracart_api
 version: !ruby/object:Gem::Version
-  version: 3.2.11
+  version: 3.2.12
 platform: ruby
 authors:
 - UltraCart
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-08 00:00:00.000000000 Z
+date: 2021-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: typhoeus