ultracart_api 3.9.6 → 3.9.7

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: 7b24e98917ef5f54fb712aead6d1f544fe121294afac179e2181e0ef18148612
4
- data.tar.gz: 01beb929c534c20da76a204106e9f5b3bd65d24576fc22be521d497356b6e8b6
3
+ metadata.gz: 43a07eddc5c99c9920bbd8bf1fe28596f70900ae0902b414eb8679565d0343a6
4
+ data.tar.gz: 4a71b8562d418238eacf9295d58db2d800c25ddae12cc35ddddf1752609b4929
5
5
  SHA512:
6
- metadata.gz: 15849669dc4c8acd98804036dcdd1f29b657b42aae7ba3986c0671d91e30c1c53d148791ad074e8a6d074d87bc198cefb2d5c38014ff9f97d3ab12cf5529f47e
7
- data.tar.gz: 118a3d786da54a1d1954c28c14f4eb2765fdfb65f2d15d7ff18ac7c966fc108bd9467d9dedf46a0cc01c7866e7d60a58f8dd6a6bf2031c38d6206298430b6e9d
6
+ metadata.gz: 591d74224b428b0897ef5f6548081dba6d336d43f96dda1a6149c192788d9d89a495a71176811240ba823de882c20a529f297f3b3c9cff5247438dd1163ffae1
7
+ data.tar.gz: 697468259ad8f4c2e7441efd269d25dabe3bf5054e4d7080c9d7cb97d5ba1ccbe0b9d77ebd0bd27224dadc40e795683e81ac64f91e721de068ab666968fef2b9
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.9.6
10
+ - Package version: 3.9.7
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.9.6.gem
27
+ gem install ./ultracart_api-3.9.7.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.9.6.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.9.7.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.9.6'
35
+ gem 'ultracart_api', '~> 3.9.7'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -154,6 +154,7 @@ Class | Method | HTTP request | Description
154
154
  *UltracartClient::CouponApi* | [**update_coupon**](docs/CouponApi.md#update_coupon) | **PUT** /coupon/coupons/{coupon_oid} | Update a coupon
155
155
  *UltracartClient::CouponApi* | [**update_coupons**](docs/CouponApi.md#update_coupons) | **PUT** /coupon/coupons/batch | Update multiple coupons
156
156
  *UltracartClient::CouponApi* | [**upload_coupon_codes**](docs/CouponApi.md#upload_coupon_codes) | **POST** /coupon/coupons/{coupon_oid}/upload_codes | Upload one-time codes for a coupon
157
+ *UltracartClient::CustomerApi* | [**adjust_internal_certificate**](docs/CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
157
158
  *UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
158
159
  *UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
159
160
  *UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -183,6 +184,7 @@ Class | Method | HTTP request | Description
183
184
  *UltracartClient::GiftCertificateApi* | [**update_gift_certificate**](docs/GiftCertificateApi.md#update_gift_certificate) | **PUT** /gift_certificate/gift_certificates/{gift_certificate_oid} | Update a gift certificate
184
185
  *UltracartClient::IntegrationLogApi* | [**get_integration_log**](docs/IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
185
186
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_file**](docs/IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
187
+ *UltracartClient::IntegrationLogApi* | [**get_integration_log_file_pdf**](docs/IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
186
188
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
187
189
  *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
188
190
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
@@ -442,6 +444,8 @@ Class | Method | HTTP request | Description
442
444
  - [UltracartClient::AccountsReceivableRetryStatsResponse](docs/AccountsReceivableRetryStatsResponse.md)
443
445
  - [UltracartClient::Activity](docs/Activity.md)
444
446
  - [UltracartClient::AddLibraryItemRequest](docs/AddLibraryItemRequest.md)
447
+ - [UltracartClient::AdjustInternalCertificateRequest](docs/AdjustInternalCertificateRequest.md)
448
+ - [UltracartClient::AdjustInternalCertificateResponse](docs/AdjustInternalCertificateResponse.md)
445
449
  - [UltracartClient::AffiliateClick](docs/AffiliateClick.md)
446
450
  - [UltracartClient::AffiliateClickQuery](docs/AffiliateClickQuery.md)
447
451
  - [UltracartClient::AffiliateClicksResponse](docs/AffiliateClicksResponse.md)
@@ -1151,6 +1155,7 @@ Not every change is committed to every SDK.
1151
1155
 
1152
1156
  | Version | Date | Comments |
1153
1157
  | --: | :-: | --- |
1158
+ | 3.9.7 | 04/25/2022 | integration logs method for zpl to pdf conversion |
1154
1159
  | 3.9.6 | 04/25/2022 | storefront communications email magic link setting |
1155
1160
  | 3.9.5 | 04/14/2022 | postcard screenshot bug fixes |
1156
1161
  | 3.9.4 | 04/13/2022 | Added spf DNS record to the sending domain object |
@@ -0,0 +1,13 @@
1
+ # UltracartClient::AdjustInternalCertificateRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **adjustment_amount** | **Float** | The adjustment amount | [optional]
7
+ **description** | **String** | Description of this adjustment, 50 characters max | [optional]
8
+ **entry_dts** | **String** | Optional timestamp for the adjustment, defaults to current time | [optional]
9
+ **expiration_days** | **Integer** | Optional expiration days from the entry_dts when these adjustment becomes worthless | [optional]
10
+ **order_id** | **String** | Optional order id if this adjustment is related to a particular order | [optional]
11
+ **vesting_days** | **Integer** | Optional days required for this adjustment to vest | [optional]
12
+
13
+
@@ -0,0 +1,13 @@
1
+ # UltracartClient::AdjustInternalCertificateResponse
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **adjustment_amount** | **Float** | The adjustment amount | [optional]
7
+ **balance_amount** | **Float** | The balance amount after the adjustment was made | [optional]
8
+ **error** | [**Error**](Error.md) | | [optional]
9
+ **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
10
+ **success** | **BOOLEAN** | Indicates if API call was successful | [optional]
11
+ **warning** | [**Warning**](Warning.md) | | [optional]
12
+
13
+
data/docs/CustomerApi.md CHANGED
@@ -4,6 +4,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
+ [**adjust_internal_certificate**](CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
7
8
  [**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
8
9
  [**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
9
10
  [**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
@@ -19,6 +20,59 @@ Method | HTTP request | Description
19
20
  [**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
20
21
 
21
22
 
23
+ # **adjust_internal_certificate**
24
+ > AdjustInternalCertificateResponse adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
25
+
26
+ Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
27
+
28
+ Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
29
+
30
+ ### Example
31
+ ```ruby
32
+ # load the gem
33
+ require 'ultracart_api'
34
+
35
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
36
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
37
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
38
+
39
+
40
+ customer_profile_oid = 56 # Integer | The customer profile oid
41
+
42
+ adjust_internal_certificate_request = UltracartClient::AdjustInternalCertificateRequest.new # AdjustInternalCertificateRequest | adjustInternalCertificateRequest
43
+
44
+
45
+ begin
46
+ #Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
47
+ result = api_instance.adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request)
48
+ p result
49
+ rescue UltracartClient::ApiError => e
50
+ puts "Exception when calling CustomerApi->adjust_internal_certificate: #{e}"
51
+ end
52
+ ```
53
+
54
+ ### Parameters
55
+
56
+ Name | Type | Description | Notes
57
+ ------------- | ------------- | ------------- | -------------
58
+ **customer_profile_oid** | **Integer**| The customer profile oid |
59
+ **adjust_internal_certificate_request** | [**AdjustInternalCertificateRequest**](AdjustInternalCertificateRequest.md)| adjustInternalCertificateRequest |
60
+
61
+ ### Return type
62
+
63
+ [**AdjustInternalCertificateResponse**](AdjustInternalCertificateResponse.md)
64
+
65
+ ### Authorization
66
+
67
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
68
+
69
+ ### HTTP request headers
70
+
71
+ - **Content-Type**: application/json; charset=UTF-8
72
+ - **Accept**: application/json
73
+
74
+
75
+
22
76
  # **delete_customer**
23
77
  > delete_customer(customer_profile_oid)
24
78
 
@@ -3,7 +3,8 @@
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
- **current_points** | **Integer** | Current Points | [optional]
6
+ **current_points** | **Integer** | Current points | [optional]
7
+ **internal_gift_certificate** | [**GiftCertificate**](GiftCertificate.md) | | [optional]
7
8
  **internal_gift_certificate_balance** | **String** | Loyalty Cashback / Store credit balance (internal gift certificate balance) | [optional]
8
9
  **internal_gift_certificate_oid** | **Integer** | Internal gift certificate oid used to tracking loyalty cashback / store credit. | [optional]
9
10
  **ledger_entries** | [**Array<CustomerLoyaltyLedger>**](CustomerLoyaltyLedger.md) | Ledger entries | [optional]
@@ -6,6 +6,7 @@ Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**get_integration_log**](IntegrationLogApi.md#get_integration_log) | **GET** /integration_log/query/{pk}/{sk} | Retrieve an integration log
8
8
  [**get_integration_log_file**](IntegrationLogApi.md#get_integration_log_file) | **GET** /integration_log/query/{pk}/{sk}/{uuid} | Retrieve an integration log file
9
+ [**get_integration_log_file_pdf**](IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
9
10
  [**get_integration_log_summaries_query**](IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
10
11
  [**get_integration_logs_query**](IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
11
12
 
@@ -119,6 +120,62 @@ Name | Type | Description | Notes
119
120
 
120
121
 
121
122
 
123
+ # **get_integration_log_file_pdf**
124
+ > File get_integration_log_file_pdf(pk, sk, uuid)
125
+
126
+ Retrieve an integration log file converted to PDF
127
+
128
+ Retrieve an integration log file from the account based identifiers
129
+
130
+ ### Example
131
+ ```ruby
132
+ # load the gem
133
+ require 'ultracart_api'
134
+
135
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
136
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
137
+ api_instance = UltracartClient::IntegrationLogApi.new_using_api_key(simple_key, false, false)
138
+
139
+
140
+ pk = 'pk_example' # String |
141
+
142
+ sk = 'sk_example' # String |
143
+
144
+ uuid = 'uuid_example' # String |
145
+
146
+
147
+ begin
148
+ #Retrieve an integration log file converted to PDF
149
+ result = api_instance.get_integration_log_file_pdf(pk, sk, uuid)
150
+ p result
151
+ rescue UltracartClient::ApiError => e
152
+ puts "Exception when calling IntegrationLogApi->get_integration_log_file_pdf: #{e}"
153
+ end
154
+ ```
155
+
156
+ ### Parameters
157
+
158
+ Name | Type | Description | Notes
159
+ ------------- | ------------- | ------------- | -------------
160
+ **pk** | **String**| |
161
+ **sk** | **String**| |
162
+ **uuid** | **String**| |
163
+
164
+ ### Return type
165
+
166
+ **File**
167
+
168
+ ### Authorization
169
+
170
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
171
+
172
+ ### HTTP request headers
173
+
174
+ - **Content-Type**: application/json
175
+ - **Accept**: application/octet-stream
176
+
177
+
178
+
122
179
  # **get_integration_log_summaries_query**
123
180
  > IntegrationLogSummaryQueryResponse get_integration_log_summaries_query(integration_log_summaries_query)
124
181
 
@@ -32,6 +32,67 @@ module UltracartClient
32
32
  UltracartClient::CustomerApi.new(api_client)
33
33
  end
34
34
 
35
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
36
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
37
+ # @param customer_profile_oid The customer profile oid
38
+ # @param adjust_internal_certificate_request adjustInternalCertificateRequest
39
+ # @param [Hash] opts the optional parameters
40
+ # @return [AdjustInternalCertificateResponse]
41
+ def adjust_internal_certificate(customer_profile_oid, adjust_internal_certificate_request, opts = {})
42
+ data, _status_code, _headers = adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request, opts)
43
+ data
44
+ end
45
+
46
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
47
+ # Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
48
+ # @param customer_profile_oid The customer profile oid
49
+ # @param adjust_internal_certificate_request adjustInternalCertificateRequest
50
+ # @param [Hash] opts the optional parameters
51
+ # @return [Array<(AdjustInternalCertificateResponse, Fixnum, Hash)>] AdjustInternalCertificateResponse data, response status code and response headers
52
+ def adjust_internal_certificate_with_http_info(customer_profile_oid, adjust_internal_certificate_request, opts = {})
53
+ if @api_client.config.debugging
54
+ @api_client.config.logger.debug 'Calling API: CustomerApi.adjust_internal_certificate ...'
55
+ end
56
+ # verify the required parameter 'customer_profile_oid' is set
57
+ if @api_client.config.client_side_validation && customer_profile_oid.nil?
58
+ fail ArgumentError, "Missing the required parameter 'customer_profile_oid' when calling CustomerApi.adjust_internal_certificate"
59
+ end
60
+ # verify the required parameter 'adjust_internal_certificate_request' is set
61
+ if @api_client.config.client_side_validation && adjust_internal_certificate_request.nil?
62
+ fail ArgumentError, "Missing the required parameter 'adjust_internal_certificate_request' when calling CustomerApi.adjust_internal_certificate"
63
+ end
64
+ # resource path
65
+ local_var_path = '/customer/customers/{customer_profile_oid}/adjust_cashback_balance'.sub('{' + 'customer_profile_oid' + '}', customer_profile_oid.to_s)
66
+
67
+ # query parameters
68
+ query_params = {}
69
+
70
+ # header parameters
71
+ header_params = {}
72
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
73
+ # HTTP header 'Accept' (if needed)
74
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
75
+ # HTTP header 'Content-Type'
76
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
77
+
78
+ # form parameters
79
+ form_params = {}
80
+
81
+ # http body (model)
82
+ post_body = @api_client.object_to_http_body(adjust_internal_certificate_request)
83
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
84
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
85
+ :header_params => header_params,
86
+ :query_params => query_params,
87
+ :form_params => form_params,
88
+ :body => post_body,
89
+ :auth_names => auth_names,
90
+ :return_type => 'AdjustInternalCertificateResponse')
91
+ if @api_client.config.debugging
92
+ @api_client.config.logger.debug "API called: CustomerApi#adjust_internal_certificate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
93
+ end
94
+ return data, status_code, headers
95
+ end
35
96
  # Delete a customer
36
97
  # Delete a customer on the UltraCart account.
37
98
  # @param customer_profile_oid The customer_profile_oid to delete.
@@ -160,6 +160,73 @@ module UltracartClient
160
160
  end
161
161
  return data, status_code, headers
162
162
  end
163
+ # Retrieve an integration log file converted to PDF
164
+ # Retrieve an integration log file from the account based identifiers
165
+ # @param pk
166
+ # @param sk
167
+ # @param uuid
168
+ # @param [Hash] opts the optional parameters
169
+ # @return [File]
170
+ def get_integration_log_file_pdf(pk, sk, uuid, opts = {})
171
+ data, _status_code, _headers = get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts)
172
+ data
173
+ end
174
+
175
+ # Retrieve an integration log file converted to PDF
176
+ # Retrieve an integration log file from the account based identifiers
177
+ # @param pk
178
+ # @param sk
179
+ # @param uuid
180
+ # @param [Hash] opts the optional parameters
181
+ # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
182
+ def get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts = {})
183
+ if @api_client.config.debugging
184
+ @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log_file_pdf ...'
185
+ end
186
+ # verify the required parameter 'pk' is set
187
+ if @api_client.config.client_side_validation && pk.nil?
188
+ fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log_file_pdf"
189
+ end
190
+ # verify the required parameter 'sk' is set
191
+ if @api_client.config.client_side_validation && sk.nil?
192
+ fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log_file_pdf"
193
+ end
194
+ # verify the required parameter 'uuid' is set
195
+ if @api_client.config.client_side_validation && uuid.nil?
196
+ fail ArgumentError, "Missing the required parameter 'uuid' when calling IntegrationLogApi.get_integration_log_file_pdf"
197
+ end
198
+ # resource path
199
+ local_var_path = '/integration_log/query/{pk}/{sk}/{uuid}/pdf'.sub('{' + 'pk' + '}', pk.to_s).sub('{' + 'sk' + '}', sk.to_s).sub('{' + 'uuid' + '}', uuid.to_s)
200
+
201
+ # query parameters
202
+ query_params = {}
203
+
204
+ # header parameters
205
+ header_params = {}
206
+ header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
207
+ # HTTP header 'Accept' (if needed)
208
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
209
+ # HTTP header 'Content-Type'
210
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
211
+
212
+ # form parameters
213
+ form_params = {}
214
+
215
+ # http body (model)
216
+ post_body = nil
217
+ auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
218
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
219
+ :header_params => header_params,
220
+ :query_params => query_params,
221
+ :form_params => form_params,
222
+ :body => post_body,
223
+ :auth_names => auth_names,
224
+ :return_type => 'File')
225
+ if @api_client.config.debugging
226
+ @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log_file_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
227
+ end
228
+ return data, status_code, headers
229
+ end
163
230
  # Retrieve integration log summaries
164
231
  # Retrieves a set of integration log summaries from the account based on a query object.
165
232
  # @param integration_log_summaries_query Integration log summaries query
@@ -0,0 +1,235 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ OpenAPI spec version: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.15-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module UltracartClient
16
+ class AdjustInternalCertificateRequest
17
+ # The adjustment amount
18
+ attr_accessor :adjustment_amount
19
+
20
+ # Description of this adjustment, 50 characters max
21
+ attr_accessor :description
22
+
23
+ # Optional timestamp for the adjustment, defaults to current time
24
+ attr_accessor :entry_dts
25
+
26
+ # Optional expiration days from the entry_dts when these adjustment becomes worthless
27
+ attr_accessor :expiration_days
28
+
29
+ # Optional order id if this adjustment is related to a particular order
30
+ attr_accessor :order_id
31
+
32
+ # Optional days required for this adjustment to vest
33
+ attr_accessor :vesting_days
34
+
35
+ # Attribute mapping from ruby-style variable name to JSON key.
36
+ def self.attribute_map
37
+ {
38
+ :'adjustment_amount' => :'adjustment_amount',
39
+ :'description' => :'description',
40
+ :'entry_dts' => :'entry_dts',
41
+ :'expiration_days' => :'expiration_days',
42
+ :'order_id' => :'order_id',
43
+ :'vesting_days' => :'vesting_days'
44
+ }
45
+ end
46
+
47
+ # Attribute type mapping.
48
+ def self.swagger_types
49
+ {
50
+ :'adjustment_amount' => :'Float',
51
+ :'description' => :'String',
52
+ :'entry_dts' => :'String',
53
+ :'expiration_days' => :'Integer',
54
+ :'order_id' => :'String',
55
+ :'vesting_days' => :'Integer'
56
+ }
57
+ end
58
+
59
+ # Initializes the object
60
+ # @param [Hash] attributes Model attributes in the form of hash
61
+ def initialize(attributes = {})
62
+ return unless attributes.is_a?(Hash)
63
+
64
+ # convert string to symbol for hash key
65
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
66
+
67
+ if attributes.has_key?(:'adjustment_amount')
68
+ self.adjustment_amount = attributes[:'adjustment_amount']
69
+ end
70
+
71
+ if attributes.has_key?(:'description')
72
+ self.description = attributes[:'description']
73
+ end
74
+
75
+ if attributes.has_key?(:'entry_dts')
76
+ self.entry_dts = attributes[:'entry_dts']
77
+ end
78
+
79
+ if attributes.has_key?(:'expiration_days')
80
+ self.expiration_days = attributes[:'expiration_days']
81
+ end
82
+
83
+ if attributes.has_key?(:'order_id')
84
+ self.order_id = attributes[:'order_id']
85
+ end
86
+
87
+ if attributes.has_key?(:'vesting_days')
88
+ self.vesting_days = attributes[:'vesting_days']
89
+ end
90
+ end
91
+
92
+ # Show invalid properties with the reasons. Usually used together with valid?
93
+ # @return Array for valid properties with the reasons
94
+ def list_invalid_properties
95
+ invalid_properties = Array.new
96
+ invalid_properties
97
+ end
98
+
99
+ # Check to see if the all the properties in the model are valid
100
+ # @return true if the model is valid
101
+ def valid?
102
+ true
103
+ end
104
+
105
+ # Checks equality by comparing each attribute.
106
+ # @param [Object] Object to be compared
107
+ def ==(o)
108
+ return true if self.equal?(o)
109
+ self.class == o.class &&
110
+ adjustment_amount == o.adjustment_amount &&
111
+ description == o.description &&
112
+ entry_dts == o.entry_dts &&
113
+ expiration_days == o.expiration_days &&
114
+ order_id == o.order_id &&
115
+ vesting_days == o.vesting_days
116
+ end
117
+
118
+ # @see the `==` method
119
+ # @param [Object] Object to be compared
120
+ def eql?(o)
121
+ self == o
122
+ end
123
+
124
+ # Calculates hash code according to all attributes.
125
+ # @return [Fixnum] Hash code
126
+ def hash
127
+ [adjustment_amount, description, entry_dts, expiration_days, order_id, vesting_days].hash
128
+ end
129
+
130
+ # Builds the object from hash
131
+ # @param [Hash] attributes Model attributes in the form of hash
132
+ # @return [Object] Returns the model itself
133
+ def build_from_hash(attributes)
134
+ return nil unless attributes.is_a?(Hash)
135
+ self.class.swagger_types.each_pair do |key, type|
136
+ if type =~ /\AArray<(.*)>/i
137
+ # check to ensure the input is an array given that the attribute
138
+ # is documented as an array but the input is not
139
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
140
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
141
+ end
142
+ elsif !attributes[self.class.attribute_map[key]].nil?
143
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
144
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
145
+ end
146
+
147
+ self
148
+ end
149
+
150
+ # Deserializes the data based on type
151
+ # @param string type Data type
152
+ # @param string value Value to be deserialized
153
+ # @return [Object] Deserialized data
154
+ def _deserialize(type, value)
155
+ case type.to_sym
156
+ when :DateTime
157
+ DateTime.parse(value)
158
+ when :Date
159
+ Date.parse(value)
160
+ when :String
161
+ value.to_s
162
+ when :Integer
163
+ value.to_i
164
+ when :Float
165
+ value.to_f
166
+ when :BOOLEAN
167
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
168
+ true
169
+ else
170
+ false
171
+ end
172
+ when :Object
173
+ # generic object (usually a Hash), return directly
174
+ value
175
+ when /\AArray<(?<inner_type>.+)>\z/
176
+ inner_type = Regexp.last_match[:inner_type]
177
+ value.map { |v| _deserialize(inner_type, v) }
178
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
179
+ k_type = Regexp.last_match[:k_type]
180
+ v_type = Regexp.last_match[:v_type]
181
+ {}.tap do |hash|
182
+ value.each do |k, v|
183
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
184
+ end
185
+ end
186
+ else # model
187
+ temp_model = UltracartClient.const_get(type).new
188
+ temp_model.build_from_hash(value)
189
+ end
190
+ end
191
+
192
+ # Returns the string representation of the object
193
+ # @return [String] String presentation of the object
194
+ def to_s
195
+ to_hash.to_s
196
+ end
197
+
198
+ # to_body is an alias to to_hash (backward compatibility)
199
+ # @return [Hash] Returns the object in the form of hash
200
+ def to_body
201
+ to_hash
202
+ end
203
+
204
+ # Returns the object in the form of hash
205
+ # @return [Hash] Returns the object in the form of hash
206
+ def to_hash
207
+ hash = {}
208
+ self.class.attribute_map.each_pair do |attr, param|
209
+ value = self.send(attr)
210
+ next if value.nil?
211
+ hash[param] = _to_hash(value)
212
+ end
213
+ hash
214
+ end
215
+
216
+ # Outputs non-array value in the form of hash
217
+ # For object, use to_hash. Otherwise, just return the value
218
+ # @param [Object] value Any valid value
219
+ # @return [Hash] Returns the value in the form of hash
220
+ def _to_hash(value)
221
+ if value.is_a?(Array)
222
+ value.compact.map { |v| _to_hash(v) }
223
+ elsif value.is_a?(Hash)
224
+ {}.tap do |hash|
225
+ value.each { |k, v| hash[k] = _to_hash(v) }
226
+ end
227
+ elsif value.respond_to? :to_hash
228
+ value.to_hash
229
+ else
230
+ value
231
+ end
232
+ end
233
+
234
+ end
235
+ end
@@ -0,0 +1,232 @@
1
+ =begin
2
+ #UltraCart Rest API V2
3
+
4
+ #UltraCart REST API Version 2
5
+
6
+ OpenAPI spec version: 2.0.0
7
+ Contact: support@ultracart.com
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.15-SNAPSHOT
10
+
11
+ =end
12
+
13
+ require 'date'
14
+
15
+ module UltracartClient
16
+ class AdjustInternalCertificateResponse
17
+ # The adjustment amount
18
+ attr_accessor :adjustment_amount
19
+
20
+ # The balance amount after the adjustment was made
21
+ attr_accessor :balance_amount
22
+
23
+ attr_accessor :error
24
+
25
+ attr_accessor :metadata
26
+
27
+ # Indicates if API call was successful
28
+ attr_accessor :success
29
+
30
+ attr_accessor :warning
31
+
32
+ # Attribute mapping from ruby-style variable name to JSON key.
33
+ def self.attribute_map
34
+ {
35
+ :'adjustment_amount' => :'adjustment_amount',
36
+ :'balance_amount' => :'balance_amount',
37
+ :'error' => :'error',
38
+ :'metadata' => :'metadata',
39
+ :'success' => :'success',
40
+ :'warning' => :'warning'
41
+ }
42
+ end
43
+
44
+ # Attribute type mapping.
45
+ def self.swagger_types
46
+ {
47
+ :'adjustment_amount' => :'Float',
48
+ :'balance_amount' => :'Float',
49
+ :'error' => :'Error',
50
+ :'metadata' => :'ResponseMetadata',
51
+ :'success' => :'BOOLEAN',
52
+ :'warning' => :'Warning'
53
+ }
54
+ end
55
+
56
+ # Initializes the object
57
+ # @param [Hash] attributes Model attributes in the form of hash
58
+ def initialize(attributes = {})
59
+ return unless attributes.is_a?(Hash)
60
+
61
+ # convert string to symbol for hash key
62
+ attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
63
+
64
+ if attributes.has_key?(:'adjustment_amount')
65
+ self.adjustment_amount = attributes[:'adjustment_amount']
66
+ end
67
+
68
+ if attributes.has_key?(:'balance_amount')
69
+ self.balance_amount = attributes[:'balance_amount']
70
+ end
71
+
72
+ if attributes.has_key?(:'error')
73
+ self.error = attributes[:'error']
74
+ end
75
+
76
+ if attributes.has_key?(:'metadata')
77
+ self.metadata = attributes[:'metadata']
78
+ end
79
+
80
+ if attributes.has_key?(:'success')
81
+ self.success = attributes[:'success']
82
+ end
83
+
84
+ if attributes.has_key?(:'warning')
85
+ self.warning = attributes[:'warning']
86
+ end
87
+ end
88
+
89
+ # Show invalid properties with the reasons. Usually used together with valid?
90
+ # @return Array for valid properties with the reasons
91
+ def list_invalid_properties
92
+ invalid_properties = Array.new
93
+ invalid_properties
94
+ end
95
+
96
+ # Check to see if the all the properties in the model are valid
97
+ # @return true if the model is valid
98
+ def valid?
99
+ true
100
+ end
101
+
102
+ # Checks equality by comparing each attribute.
103
+ # @param [Object] Object to be compared
104
+ def ==(o)
105
+ return true if self.equal?(o)
106
+ self.class == o.class &&
107
+ adjustment_amount == o.adjustment_amount &&
108
+ balance_amount == o.balance_amount &&
109
+ error == o.error &&
110
+ metadata == o.metadata &&
111
+ success == o.success &&
112
+ warning == o.warning
113
+ end
114
+
115
+ # @see the `==` method
116
+ # @param [Object] Object to be compared
117
+ def eql?(o)
118
+ self == o
119
+ end
120
+
121
+ # Calculates hash code according to all attributes.
122
+ # @return [Fixnum] Hash code
123
+ def hash
124
+ [adjustment_amount, balance_amount, error, metadata, success, warning].hash
125
+ end
126
+
127
+ # Builds the object from hash
128
+ # @param [Hash] attributes Model attributes in the form of hash
129
+ # @return [Object] Returns the model itself
130
+ def build_from_hash(attributes)
131
+ return nil unless attributes.is_a?(Hash)
132
+ self.class.swagger_types.each_pair do |key, type|
133
+ if type =~ /\AArray<(.*)>/i
134
+ # check to ensure the input is an array given that the attribute
135
+ # is documented as an array but the input is not
136
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
137
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
138
+ end
139
+ elsif !attributes[self.class.attribute_map[key]].nil?
140
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
141
+ end # or else data not found in attributes(hash), not an issue as the data can be optional
142
+ end
143
+
144
+ self
145
+ end
146
+
147
+ # Deserializes the data based on type
148
+ # @param string type Data type
149
+ # @param string value Value to be deserialized
150
+ # @return [Object] Deserialized data
151
+ def _deserialize(type, value)
152
+ case type.to_sym
153
+ when :DateTime
154
+ DateTime.parse(value)
155
+ when :Date
156
+ Date.parse(value)
157
+ when :String
158
+ value.to_s
159
+ when :Integer
160
+ value.to_i
161
+ when :Float
162
+ value.to_f
163
+ when :BOOLEAN
164
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
165
+ true
166
+ else
167
+ false
168
+ end
169
+ when :Object
170
+ # generic object (usually a Hash), return directly
171
+ value
172
+ when /\AArray<(?<inner_type>.+)>\z/
173
+ inner_type = Regexp.last_match[:inner_type]
174
+ value.map { |v| _deserialize(inner_type, v) }
175
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
176
+ k_type = Regexp.last_match[:k_type]
177
+ v_type = Regexp.last_match[:v_type]
178
+ {}.tap do |hash|
179
+ value.each do |k, v|
180
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
181
+ end
182
+ end
183
+ else # model
184
+ temp_model = UltracartClient.const_get(type).new
185
+ temp_model.build_from_hash(value)
186
+ end
187
+ end
188
+
189
+ # Returns the string representation of the object
190
+ # @return [String] String presentation of the object
191
+ def to_s
192
+ to_hash.to_s
193
+ end
194
+
195
+ # to_body is an alias to to_hash (backward compatibility)
196
+ # @return [Hash] Returns the object in the form of hash
197
+ def to_body
198
+ to_hash
199
+ end
200
+
201
+ # Returns the object in the form of hash
202
+ # @return [Hash] Returns the object in the form of hash
203
+ def to_hash
204
+ hash = {}
205
+ self.class.attribute_map.each_pair do |attr, param|
206
+ value = self.send(attr)
207
+ next if value.nil?
208
+ hash[param] = _to_hash(value)
209
+ end
210
+ hash
211
+ end
212
+
213
+ # Outputs non-array value in the form of hash
214
+ # For object, use to_hash. Otherwise, just return the value
215
+ # @param [Object] value Any valid value
216
+ # @return [Hash] Returns the value in the form of hash
217
+ def _to_hash(value)
218
+ if value.is_a?(Array)
219
+ value.compact.map { |v| _to_hash(v) }
220
+ elsif value.is_a?(Hash)
221
+ {}.tap do |hash|
222
+ value.each { |k, v| hash[k] = _to_hash(v) }
223
+ end
224
+ elsif value.respond_to? :to_hash
225
+ value.to_hash
226
+ else
227
+ value
228
+ end
229
+ end
230
+
231
+ end
232
+ end
@@ -14,9 +14,11 @@ require 'date'
14
14
 
15
15
  module UltracartClient
16
16
  class CustomerLoyalty
17
- # Current Points
17
+ # Current points
18
18
  attr_accessor :current_points
19
19
 
20
+ attr_accessor :internal_gift_certificate
21
+
20
22
  # Loyalty Cashback / Store credit balance (internal gift certificate balance)
21
23
  attr_accessor :internal_gift_certificate_balance
22
24
 
@@ -36,6 +38,7 @@ module UltracartClient
36
38
  def self.attribute_map
37
39
  {
38
40
  :'current_points' => :'current_points',
41
+ :'internal_gift_certificate' => :'internal_gift_certificate',
39
42
  :'internal_gift_certificate_balance' => :'internal_gift_certificate_balance',
40
43
  :'internal_gift_certificate_oid' => :'internal_gift_certificate_oid',
41
44
  :'ledger_entries' => :'ledger_entries',
@@ -48,6 +51,7 @@ module UltracartClient
48
51
  def self.swagger_types
49
52
  {
50
53
  :'current_points' => :'Integer',
54
+ :'internal_gift_certificate' => :'GiftCertificate',
51
55
  :'internal_gift_certificate_balance' => :'String',
52
56
  :'internal_gift_certificate_oid' => :'Integer',
53
57
  :'ledger_entries' => :'Array<CustomerLoyaltyLedger>',
@@ -68,6 +72,10 @@ module UltracartClient
68
72
  self.current_points = attributes[:'current_points']
69
73
  end
70
74
 
75
+ if attributes.has_key?(:'internal_gift_certificate')
76
+ self.internal_gift_certificate = attributes[:'internal_gift_certificate']
77
+ end
78
+
71
79
  if attributes.has_key?(:'internal_gift_certificate_balance')
72
80
  self.internal_gift_certificate_balance = attributes[:'internal_gift_certificate_balance']
73
81
  end
@@ -112,6 +120,7 @@ module UltracartClient
112
120
  return true if self.equal?(o)
113
121
  self.class == o.class &&
114
122
  current_points == o.current_points &&
123
+ internal_gift_certificate == o.internal_gift_certificate &&
115
124
  internal_gift_certificate_balance == o.internal_gift_certificate_balance &&
116
125
  internal_gift_certificate_oid == o.internal_gift_certificate_oid &&
117
126
  ledger_entries == o.ledger_entries &&
@@ -128,7 +137,7 @@ module UltracartClient
128
137
  # Calculates hash code according to all attributes.
129
138
  # @return [Fixnum] Hash code
130
139
  def hash
131
- [current_points, internal_gift_certificate_balance, internal_gift_certificate_oid, ledger_entries, pending_points, redemptions].hash
140
+ [current_points, internal_gift_certificate, internal_gift_certificate_balance, internal_gift_certificate_oid, ledger_entries, pending_points, redemptions].hash
132
141
  end
133
142
 
134
143
  # Builds the object from hash
@@ -11,5 +11,5 @@ Swagger Codegen version: 2.4.15-SNAPSHOT
11
11
  =end
12
12
 
13
13
  module UltracartClient
14
- VERSION = '3.9.6'
14
+ VERSION = '3.9.7'
15
15
  end
data/lib/ultracart_api.rb CHANGED
@@ -26,6 +26,8 @@ require 'ultracart_api/models/accounts_receivable_retry_stat_revenue'
26
26
  require 'ultracart_api/models/accounts_receivable_retry_stats_response'
27
27
  require 'ultracart_api/models/activity'
28
28
  require 'ultracart_api/models/add_library_item_request'
29
+ require 'ultracart_api/models/adjust_internal_certificate_request'
30
+ require 'ultracart_api/models/adjust_internal_certificate_response'
29
31
  require 'ultracart_api/models/affiliate_click'
30
32
  require 'ultracart_api/models/affiliate_click_query'
31
33
  require 'ultracart_api/models/affiliate_clicks_response'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: ultracart_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.9.6
4
+ version: 3.9.7
5
5
  platform: ruby
6
6
  authors:
7
7
  - UltraCart
@@ -230,6 +230,8 @@ files:
230
230
  - docs/AccountsReceivableRetryStatsResponse.md
231
231
  - docs/Activity.md
232
232
  - docs/AddLibraryItemRequest.md
233
+ - docs/AdjustInternalCertificateRequest.md
234
+ - docs/AdjustInternalCertificateResponse.md
233
235
  - docs/AffiliateApi.md
234
236
  - docs/AffiliateClick.md
235
237
  - docs/AffiliateClickQuery.md
@@ -923,6 +925,8 @@ files:
923
925
  - lib/ultracart_api/models/accounts_receivable_retry_stats_response.rb
924
926
  - lib/ultracart_api/models/activity.rb
925
927
  - lib/ultracart_api/models/add_library_item_request.rb
928
+ - lib/ultracart_api/models/adjust_internal_certificate_request.rb
929
+ - lib/ultracart_api/models/adjust_internal_certificate_response.rb
926
930
  - lib/ultracart_api/models/affiliate_click.rb
927
931
  - lib/ultracart_api/models/affiliate_click_query.rb
928
932
  - lib/ultracart_api/models/affiliate_clicks_response.rb