ultracart_api 3.10.11 → 3.10.12

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b793c9f5c6226c2d93d02c2bb1be367d1d69ff0490a831d4fcfae5bfe9d00acb
4
- data.tar.gz: a2d23c7c71322745264de1ae6688165b04d208b9bf9582811ae88d6451e5ee7c
3
+ metadata.gz: 2d124d80a1cb88bc420c5b375614e3e401c8416d74f33d7fa353f70068fce04c
4
+ data.tar.gz: bfdc8224836e8d5db793f23bc9fa78b537174bad73e82e13d4f027939a316715
5
5
  SHA512:
6
- metadata.gz: 58ef54881f616391a3080e7bb3880f07052b4dad6da72b5b5423904c634b451df754bb45516059c4175ec69ca3191ce3897617f48a6ccfe06bb1de1ba6f0a40b
7
- data.tar.gz: cbead0b3a548d120a51d4ff81102cfff3f186f5bc94dff18f3c6924d46c4a94c17b7f45f9c220e79808d790b775cde65a2b248a22bef812fb50d20bb9b0fe642
6
+ metadata.gz: 19cbcf7c0418f1411b5e739d097848eaa8e50e66eeaa36e90323daf35720424613b44bef53df6d51eff563ab88e2b3787c743afb4aeb54318e57f423277807bf
7
+ data.tar.gz: c62fd88712ddfa523bfa511d72f6ab01e4c1762733270b01ec3f5d897dec257f1209c3199d15e51e2fdf88d8f118184dec9ef7fb9ac1b2683119c5e9957c17a9
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 3.10.11
10
+ - Package version: 3.10.12
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-3.10.11.gem
27
+ gem install ./ultracart_api-3.10.12.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.10.11.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.10.12.gem` to install the development dependencies)
30
30
 
31
31
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
32
32
 
33
33
  Finally add this to the Gemfile:
34
34
 
35
- gem 'ultracart_api', '~> 3.10.11'
35
+ gem 'ultracart_api', '~> 3.10.12'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -171,6 +171,7 @@ Class | Method | HTTP request | Description
171
171
  *UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
172
172
  *UltracartClient::CustomerApi* | [**get_email_verification_token**](docs/CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
173
173
  *UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
174
+ *UltracartClient::CustomerApi* | [**search**](docs/CustomerApi.md#search) | **POST** /customer/search | Searches for all matching values (using POST)
174
175
  *UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
175
176
  *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
176
177
  *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
@@ -1132,10 +1133,10 @@ Class | Method | HTTP request | Description
1132
1133
  - affiliate_write: Allows you to write affiliate information.
1133
1134
  - auto_order_read: Allows you to read auto order information.
1134
1135
  - auto_order_write: Allows you to write auto order information.
1135
- - chargeback_read: Allows you to read chargeback information.
1136
- - chargeback_write: Allows you to write chargeback information.
1137
1136
  - channel_partner_read: Allows you to read channel partner information.
1138
1137
  - channel_partner_write: Allows you to write channel partner information.
1138
+ - chargeback_read: Allows you to read chargeback information.
1139
+ - chargeback_write: Allows you to write chargeback information.
1139
1140
  - checkout_read: Allows you to read checkout information.
1140
1141
  - checkout_write: Allows you to write checkout information.
1141
1142
  - configuration_read: Allows you to read configuration information.
@@ -1146,6 +1147,8 @@ Class | Method | HTTP request | Description
1146
1147
  - customer_write: Allows you to write customer information.
1147
1148
  - fulfillment_read: Allows you to read fulfillment information.
1148
1149
  - fulfillment_write: Allows you to write fulfillment information.
1150
+ - gift_certificate_read: Allows you to read gift certificate information.
1151
+ - gift_certificate_write: Allows you to write gift certificate information.
1149
1152
  - integration_log_read: Allows you to read integration log information.
1150
1153
  - integration_log_write: Allows you to write integration log information.
1151
1154
  - order_read: Allows you to read order information.
@@ -1162,8 +1165,6 @@ Class | Method | HTTP request | Description
1162
1165
  - ultrabooks_write: 2 of 2 required to use UltraBooks
1163
1166
  - user_read: Allows you to read user information.
1164
1167
  - user_write: Allows you to write user information.
1165
- - gift_certificate_read: Allows you to read gift certificate information.
1166
- - gift_certificate_write: Allows you to write gift certificate information.
1167
1168
 
1168
1169
  ### ultraCartSimpleApiKey
1169
1170
 
@@ -1179,6 +1180,7 @@ Not every change is committed to every SDK.
1179
1180
 
1180
1181
  | Version | Date | Comments |
1181
1182
  | --: | :-: | --- |
1183
+ | 3.10.12 | 06/16/2022 | Customer profile search method to look up tags |
1182
1184
  | 3.10.11 | 06/10/2022 | esp segment 3rd party sync add/remove tag fields |
1183
1185
  | 3.10.10 | 06/06/2022 | storefront communication options for syncing to third party provider list |
1184
1186
  | 3.10.9 | 06/01/2022 | bug fixes for customer profile store credit |
data/docs/CustomerApi.md CHANGED
@@ -17,6 +17,7 @@ Method | HTTP request | Description
17
17
  [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
18
18
  [**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
19
19
  [**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
20
+ [**search**](CustomerApi.md#search) | **POST** /customer/search | Searches for all matching values (using POST)
20
21
  [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
21
22
  [**update_customer_email_lists**](CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
22
23
  [**validate_email_verification_token**](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
@@ -755,6 +756,54 @@ Name | Type | Description | Notes
755
756
 
756
757
 
757
758
 
759
+ # **search**
760
+ > LookupResponse search(lookup_request)
761
+
762
+ Searches for all matching values (using POST)
763
+
764
+ ### Example
765
+ ```ruby
766
+ # load the gem
767
+ require 'ultracart_api'
768
+
769
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
770
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
771
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
772
+
773
+
774
+ lookup_request = UltracartClient::LookupRequest.new # LookupRequest | LookupRequest
775
+
776
+
777
+ begin
778
+ #Searches for all matching values (using POST)
779
+ result = api_instance.search(lookup_request)
780
+ p result
781
+ rescue UltracartClient::ApiError => e
782
+ puts "Exception when calling CustomerApi->search: #{e}"
783
+ end
784
+ ```
785
+
786
+ ### Parameters
787
+
788
+ Name | Type | Description | Notes
789
+ ------------- | ------------- | ------------- | -------------
790
+ **lookup_request** | [**LookupRequest**](LookupRequest.md)| LookupRequest |
791
+
792
+ ### Return type
793
+
794
+ [**LookupResponse**](LookupResponse.md)
795
+
796
+ ### Authorization
797
+
798
+ [ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
799
+
800
+ ### HTTP request headers
801
+
802
+ - **Content-Type**: application/json
803
+ - **Accept**: application/json
804
+
805
+
806
+
758
807
  # **update_customer**
759
808
  > CustomerResponse update_customer(customer, customer_profile_oid, opts)
760
809
 
data/docs/OrderApi.md CHANGED
@@ -692,18 +692,6 @@ opts = {
692
692
  current_stage: 'current_stage_example', # String | Current Stage
693
693
  channel_partner_code: 'channel_partner_code_example', # String | Channel Partner Code
694
694
  channel_partner_order_id: 'channel_partner_order_id_example', # String | Channel Partner Order ID
695
- customer_profile_oid: 56, # Integer |
696
- refund_date_begin: 'refund_date_begin_example', # String |
697
- refund_date_end: 'refund_date_end_example', # String |
698
- custom_field_1: 'custom_field_1_example', # String |
699
- custom_field_2: 'custom_field_2_example', # String |
700
- custom_field_3: 'custom_field_3_example', # String |
701
- custom_field_4: 'custom_field_4_example', # String |
702
- custom_field_5: 'custom_field_5_example', # String |
703
- custom_field_6: 'custom_field_6_example', # String |
704
- custom_field_7: 'custom_field_7_example', # String |
705
- ship_on_date_begin: 'ship_on_date_begin_example', # String |
706
- ship_on_date_end: 'ship_on_date_end_example', # String |
707
695
  _limit: 100, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
708
696
  _offset: 0, # Integer | Pagination of the record set. Offset is a zero based index.
709
697
  _sort: '_sort_example', # String | The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
@@ -750,18 +738,6 @@ Name | Type | Description | Notes
750
738
  **current_stage** | **String**| Current Stage | [optional]
751
739
  **channel_partner_code** | **String**| Channel Partner Code | [optional]
752
740
  **channel_partner_order_id** | **String**| Channel Partner Order ID | [optional]
753
- **customer_profile_oid** | **Integer**| | [optional]
754
- **refund_date_begin** | **String**| | [optional]
755
- **refund_date_end** | **String**| | [optional]
756
- **custom_field_1** | **String**| | [optional]
757
- **custom_field_2** | **String**| | [optional]
758
- **custom_field_3** | **String**| | [optional]
759
- **custom_field_4** | **String**| | [optional]
760
- **custom_field_5** | **String**| | [optional]
761
- **custom_field_6** | **String**| | [optional]
762
- **custom_field_7** | **String**| | [optional]
763
- **ship_on_date_begin** | **String**| | [optional]
764
- **ship_on_date_end** | **String**| | [optional]
765
741
  **_limit** | **Integer**| The maximum number of records to return on this one API call. (Maximum 200) | [optional] [default to 100]
766
742
  **_offset** | **Integer**| Pagination of the record set. Offset is a zero based index. | [optional] [default to 0]
767
743
  **_sort** | **String**| The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional]
@@ -857,6 +857,59 @@ module UltracartClient
857
857
  end
858
858
  return data, status_code, headers
859
859
  end
860
+ # Searches for all matching values (using POST)
861
+ # @param lookup_request LookupRequest
862
+ # @param [Hash] opts the optional parameters
863
+ # @return [LookupResponse]
864
+ def search(lookup_request, opts = {})
865
+ data, _status_code, _headers = search_with_http_info(lookup_request, opts)
866
+ data
867
+ end
868
+
869
+ # Searches for all matching values (using POST)
870
+ # @param lookup_request LookupRequest
871
+ # @param [Hash] opts the optional parameters
872
+ # @return [Array<(LookupResponse, Fixnum, Hash)>] LookupResponse data, response status code and response headers
873
+ def search_with_http_info(lookup_request, opts = {})
874
+ if @api_client.config.debugging
875
+ @api_client.config.logger.debug 'Calling API: CustomerApi.search ...'
876
+ end
877
+ # verify the required parameter 'lookup_request' is set
878
+ if @api_client.config.client_side_validation && lookup_request.nil?
879
+ fail ArgumentError, "Missing the required parameter 'lookup_request' when calling CustomerApi.search"
880
+ end
881
+ # resource path
882
+ local_var_path = '/customer/search'
883
+
884
+ # query parameters
885
+ query_params = {}
886
+
887
+ # header parameters
888
+ header_params = {}
889
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
890
+ # HTTP header 'Accept' (if needed)
891
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
892
+ # HTTP header 'Content-Type'
893
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
894
+
895
+ # form parameters
896
+ form_params = {}
897
+
898
+ # http body (model)
899
+ post_body = @api_client.object_to_http_body(lookup_request)
900
+ auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
901
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
902
+ :header_params => header_params,
903
+ :query_params => query_params,
904
+ :form_params => form_params,
905
+ :body => post_body,
906
+ :auth_names => auth_names,
907
+ :return_type => 'LookupResponse')
908
+ if @api_client.config.debugging
909
+ @api_client.config.logger.debug "API called: CustomerApi#search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
910
+ end
911
+ return data, status_code, headers
912
+ end
860
913
  # Update a customer
861
914
  # Update a customer on the UltraCart account.
862
915
  # @param customer Customer to update
@@ -742,18 +742,6 @@ module UltracartClient
742
742
  # @option opts [String] :current_stage Current Stage
743
743
  # @option opts [String] :channel_partner_code Channel Partner Code
744
744
  # @option opts [String] :channel_partner_order_id Channel Partner Order ID
745
- # @option opts [Integer] :customer_profile_oid
746
- # @option opts [String] :refund_date_begin
747
- # @option opts [String] :refund_date_end
748
- # @option opts [String] :custom_field_1
749
- # @option opts [String] :custom_field_2
750
- # @option opts [String] :custom_field_3
751
- # @option opts [String] :custom_field_4
752
- # @option opts [String] :custom_field_5
753
- # @option opts [String] :custom_field_6
754
- # @option opts [String] :custom_field_7
755
- # @option opts [String] :ship_on_date_begin
756
- # @option opts [String] :ship_on_date_end
757
745
  # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200) (default to 100)
758
746
  # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index. (default to 0)
759
747
  # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
@@ -794,18 +782,6 @@ module UltracartClient
794
782
  # @option opts [String] :current_stage Current Stage
795
783
  # @option opts [String] :channel_partner_code Channel Partner Code
796
784
  # @option opts [String] :channel_partner_order_id Channel Partner Order ID
797
- # @option opts [Integer] :customer_profile_oid
798
- # @option opts [String] :refund_date_begin
799
- # @option opts [String] :refund_date_end
800
- # @option opts [String] :custom_field_1
801
- # @option opts [String] :custom_field_2
802
- # @option opts [String] :custom_field_3
803
- # @option opts [String] :custom_field_4
804
- # @option opts [String] :custom_field_5
805
- # @option opts [String] :custom_field_6
806
- # @option opts [String] :custom_field_7
807
- # @option opts [String] :ship_on_date_begin
808
- # @option opts [String] :ship_on_date_end
809
785
  # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Maximum 200)
810
786
  # @option opts [Integer] :_offset Pagination of the record set. Offset is a zero based index.
811
787
  # @option opts [String] :_sort The sort order of the orders. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
@@ -847,18 +823,6 @@ module UltracartClient
847
823
  query_params[:'current_stage'] = opts[:'current_stage'] if !opts[:'current_stage'].nil?
848
824
  query_params[:'channel_partner_code'] = opts[:'channel_partner_code'] if !opts[:'channel_partner_code'].nil?
849
825
  query_params[:'channel_partner_order_id'] = opts[:'channel_partner_order_id'] if !opts[:'channel_partner_order_id'].nil?
850
- query_params[:'customer_profile_oid'] = opts[:'customer_profile_oid'] if !opts[:'customer_profile_oid'].nil?
851
- query_params[:'Refund Date Begin'] = opts[:'refund_date_begin'] if !opts[:'refund_date_begin'].nil?
852
- query_params[:'Refund Date End'] = opts[:'refund_date_end'] if !opts[:'refund_date_end'].nil?
853
- query_params[:'Custom Field 1'] = opts[:'custom_field_1'] if !opts[:'custom_field_1'].nil?
854
- query_params[:'Custom Field 2'] = opts[:'custom_field_2'] if !opts[:'custom_field_2'].nil?
855
- query_params[:'Custom Field 3'] = opts[:'custom_field_3'] if !opts[:'custom_field_3'].nil?
856
- query_params[:'Custom Field 4'] = opts[:'custom_field_4'] if !opts[:'custom_field_4'].nil?
857
- query_params[:'Custom Field 5'] = opts[:'custom_field_5'] if !opts[:'custom_field_5'].nil?
858
- query_params[:'Custom Field 6'] = opts[:'custom_field_6'] if !opts[:'custom_field_6'].nil?
859
- query_params[:'Custom Field 7'] = opts[:'custom_field_7'] if !opts[:'custom_field_7'].nil?
860
- query_params[:'ship_on_date_begin'] = opts[:'ship_on_date_begin'] if !opts[:'ship_on_date_begin'].nil?
861
- query_params[:'ship_on_date_end'] = opts[:'ship_on_date_end'] if !opts[:'ship_on_date_end'].nil?
862
826
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
863
827
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
864
828
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '3.10.11'
14
+ VERSION = '3.10.12'
15
15
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.10.11
4
+ version: 3.10.12
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2022-06-10 00:00:00.000000000 Z
11
+ date: 2022-06-16 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: typhoeus