-
Notifications
You must be signed in to change notification settings - Fork 0
/
CHANGELOG
371 lines (370 loc) · 14.8 KB
/
CHANGELOG
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
v2.6.0
New Functions
BranchPageVersionList_Load_Query [MMAPI-268]
CouponBusinessAccountList_Load_Query [MMAPI-289]
CouponBusinessAccount_Update_Assigned [MMAPI-289]
BranchItemVersionList_Load_Query [MMAPI-294]
ChangesetItemVersionList_Load_Query [MMAPI-299]
Page_Copy_Branch [MMAPI-304]
ProductShippingRules_Update [MMAPI-316]
ProductVariantPricing_Update [MMAPI-321]
MMAPI-274 - Add support for branch loaders on page related functions
MMAPI-278 - New field version_id on Page object
MMAPI-284 - New field page_id on Product model
MMAPI-309 - New field priority on Module object
v2.5.0
New Functions:
OrderListArchive [MMAPI-249]
MMAPI-99 - New field on ChangesetCreate: ModuleChanges
New Model ModuleChange
MMAPI-188 - New fields on Store model:
boxpack_id
addrval_id
MMAPI-189 - Added support for new CSS and JS Resource types: Module and ModuleInline
New search and sort fields on CSSResourceListLoadQuery and JavaScriptResourceListLoadQuery
mod_code
mod_data
New fields on CSSResourceInsert and CSSResourceUpdate
CSSResourceModuleCode
CSSResourceModuleData
New fields on JavaScriptResourceInsert and JavaScriptResourceUpdate
JavaScriptResourceModuleCode
JavaScriptResourceModuleData
New resource type constants on CSSResource and JavaScriptResource models:
RESOURCE_TYPE_MODULE
RESOURCE_TYPE_INLINE_MODULE
RESOURCE_TYPE_MANAGED_MODULE
MMAPI-190 - New field on model OrderItem: group_id
MMAPI-191 - New ondemandcolumn url in CategoryListLoadQuery
New field url in Category model
MMAPI-187 - FilterExpression does not always create a valid array/object when flattened.
Expressions are now nested under one top level entry
MMAPI-217 - New search fields in ChangesetChangeListLoadQuery:
item_user_id
item_user_name
item_user_icon
item_change_type
New sort fields in ChangesetChangeListLoadQuery
item_user_id
item_user_name
item_change_type
New fields in model ChangesetChange:
item_user_id
item_user_name
item_user_icon
item_change_type
MMAPI-223 - Request Exceptions which had no message now have one
MMAPI-230 - Added missing ondemandcolumn payment_data in OrderListLoadQuery
MMAPI-236 - OrderPayment field payment_data is now represented as a string dictionary
MMAPI-237 - Added missing field module to OrderPayment model
v2.4.0
New Functions:
PageList_Load_Query [MMAPI-95]
CSSResource_List_Load_Query [MMAPI-96]
JavaScriptResource_List_Load_Query [MMAPI-97]
CopyPageRulesList_Load_Query [MMAPI-135]
CopyPageRules_Insert [MMAPI-135]
CopyPageRules_Update [MMAPI-135]
CopyPageRulesList_Delete [MMAPI-135]
CopyPageRulesSettingsList_Load_Query [MMAPI-135]
CopyPageRulesSettings_Update_Assigned [MMAPI-135]
Product_Copy [MMAPI-134]
CopyProductRules_Insert [MMAPI-136]
CopyProductRules_Update [MMAPI-136]
CopyProductRulesList_Delete [MMAPI-136]
CopyProductRulesList_Load_Query [MMAPI-136]
CopyProductRulesModuleList_Load_Query [MMAPI-136]
CopyProductRulesModule_Update_Assigned [MMAPI-136]
CopyProductRulesCustomFieldList_Load_Query [MMAPI-136]
CopyProductRulesCustomField_Update_Assigned [MMAPI-136]
MMAPI-98 - CSSResource_Insert and JavaScriptResource_Insert now return the created resource in the response object
MMAPI-167 – New ondemand columns on ProductList_Load_Query: subscriptionsettings and subscriptionterms.
New Model ProcuctSubscriptionSettings.
Product model updated with new field: subscriptionsettings
v2.3.0
MMAPI-53 - Model, Request, and Response objects are now broken up into individual files
MMAPI-58 - Updated examples/list_query_request.py with updated filter examples and fixed invalid method references.
MMAPI-78 - Request boolean values are now None by default
MMAPI-79 - Corrected invalid model fields:
Store.omin_price is now float
AttributeTemplateOption.attemp_id is now int
MMAPI-80 - New Functions:
PageInsertRequest
PageUpdateRequest
PageDeleteRequest
PageCopyRequest
MMAPI-81 - New Functions:
CSSResourceInsertRequest
CSSResourceUpdateRequest
CSSResourceDeleteRequest
MMAPI-82 - New Functions:
JavaScriptResourceInsertRequest
JavaScriptResourceUpdateRequest
JavaScriptResourceDeleteRequest
MMAPI-83 - New Function AllOrderPaymentListLoadQueryRequest
New Model AllOrderPayment
New Field ip on OrderPayment Model
MMAPI-84 - OrderItemSplitResponse now returns a model, SplitOrderItem
New Model SplitOrderItem
MMAPI-85 - All Request and Model objects now implement JsonSerializable
MMAPI-88 - Added field product_id to model OrderItem
MMAPI-89 - Added display order fields to the following models:
Product
ProductKit
ProductSubscriptionTerm
RelatedProduct
MMAPI-90 - Added new field attributes to model ProductVariant
New model ProductVariantAttribute
MMAPI-91 - Added new field has_variant_parts to model ProductAttributeListOption
MMAPI-92 - ProductKit model has had its member names made friendlier
MMAPI-103 - Improved handling of timestamp field types
MMAPI-116 - New constant: ProductSubscriptionTerm.TERM_FREQUENCY
Fixed Constants in:
InventoryProductSettingsUpdateRequest.INVENTORY_CHOICES
Store.CACHE_TYPE
v2.2.0
- MMAPI-60 - Fixed exception due to incorrect field type for expires in OrderPayments mode. Now a Date type.
- MMAPI-61 - Added missing member discounts in mode OrderItemOption.
- MMAPI-62 - The following requests now have their associated model object returned in their response objects:
AttributeInsert
AttributeTemplateAttributeInsert
AttributeTemplateInsert
AttributeTemplateOptionInsert
AvailabilityGroupInsert
BusinessAccountInsert
CategoryInsert
CategoryURIInsert
CouponInsert
CustomerAddressInsert
CustomerCreditHistoryInsert
FeedURIInsert
NoteInsert
OptionInsert
OrderItemAdd
PageURIInsert
PriceGroupInsert
PrintQueueJobInsert
ProductImageAdd
ProductInsert
ProductURIInsert
ProductVariantInsert
SubscriptionAndOrderItemAdd
SubscriptionAndOrderItemUpdate
URIInsert
- MMAPI-63 - New request for SubscriptionList_Load_Query requests
- MMAPI-64 - ProductVariantInsert/Update now support code inputs
- MMAPI-65 - ProductVariantGenerate, ProductVariantGenerateDelimiter, and ProductKitGenerateVariant now support string values for pricing method
- MMAPI-66 - Removed unused fields from ProductVariantUpdate response
- MMAPI-67 - The following model fields have been renamed:
CustomerSubscription.adress_descrip -> CustomerSubscription.address_description
CustomerSubscription.address_adress -> CustomerSubscription.address_address
CustomerSubscription.address_address_1 -> CustomerSubscription.address_address1
CustomerSubscription.address_address_2 -> CustomerSubscription.address_address2
ProductAndSubscriptionTerm.term_descrip -> ProductAndSubscriptionTerm.term_description
- MMAPI-68 - Added new utility class, ListQueryRequestBuilder
- MMAPI-69 - Added build support for net6.0 targets
- MMAPI-71 - Removed invalid field in PrintQueueJob model, printqueue_descript
- MMAPI-72 - Fixed broken request class, RequestBuilder
v2.1.0
- MMAPI-39 - Added the following functions introduced in 10.03.00
CustomerSubscriptionList_Load_Query
ProductAndSubscriptionTermList_Load_Query
ProductSubscriptionTermList_Load_Query
SubscriptionShippingMethodList_Load_Query
Subscription_Update
Subscription_Insert
SubscriptionList_Delete
SubscriptionAndOrderItem_Add
SubscriptionAndOrderItem_Update
- MMAPI-40 - TemplateVersionSettings renamed to VersionSettings
- MMAPI-43 - Add support for the new JSON_DateTime structure format
- MMAPI-44 - New fields on Order model - shipment and returns
New ondemand column support for shipment and returns on OrderList_Load_Query
- MMAPI-45 - Added url ondemandcolumn to ProductList_Load_Query
Added imagetype ondemandcolumn to ProductList_Load_Query
- MMAPI-46 - Added new field on Order model - dt_updated
- MMAPI-47 - Added support for image properties when creating managed property changes (MM-11193)
- MMAPI-48 - OrderItemSubscription now inherits from Subscription model
- MMAPI-50 - Add example subscription usage
v2.0.3
MM-10502 - Added the following API Functions introduced in 10.01.00:
Attribute_CopyTemplate
Attribute_CopyLinkedTemplate
ProductAttributeAndOptionList_Load_Query
MMAPI-34 - Added parts on demand column to OrderList_Load_Query and related model fields in Order model
MMAPI-20 - Added Notes field to CSSResourceChange, JavaScriptResourceChange, TemplateChange, and PropertyChange models. Addresses changes in MM-10341.
MM-10341 - Added Note fields to Changeset resource change models
MM-10930 - Added formatted versions of currency fields in OrderCharge model
MM-10849 - Added cache configuration fields to Store model
MM-10814 MM-10502 - OrderItem tax field is now mutable
Added fields on Customer model: tax_exempt, order_cnt, order_avg, formatted_order_avg, order_tot, formatted_order_tot,
Added Tax_Exempt field to Customer_Insert and Customer_Update
v2.0.2
- MMAPI-23, MMAPI-24 - Logging now logs response content when unable to parse json correctly
- MMAPI-31 - ListQueryRequest now initializes a FilterExpression during construction.
- MMAPI-25 - Added the follwing API functions introduced in Miva Merchant 10.01.00:
Attribute_Delete
Attribute_Insert
Attribute_Load_Code
Attribute_Update
AttributeAndOptionList_Load_Product
AttributeTemplate_Delete
AttributeTemplate_Insert
AttributeTemplate_Update
AttributeTemplateAttribute_Delete
AttributeTemplateAttribute_Insert
AttributeTemplateAttribute_Update
AttributeTemplateAttributeList_Load_Query
AttributeTemplateList_Load_Query
AttributeTemplateOption_Delete
AttributeTemplateOption_Insert
AttributeTemplateOption_Set_Default
AttributeTemplateOption_Update
AttributeTemplateOptionList_Load_Attribute
AttributeTemplateProduct_Update_Assigned
AttributeTemplateProductList_Load_Query
AvailabilityGroup_Delete
AvailabilityGroup_Insert
AvailabilityGroup_Update
AvailabilityGroupBusinessAccountList_Load_Query
AvailabilityGroupCategory_Update_Assigned
AvailabilityGroupCategoryList_Load_Query
AvailabilityGroupCustomerList_Load_Query
AvailabilityGroupProductList_Load_Query
AvailabilityGroupShippingMethodList_Load_Query
Branch_SetPrimary
Branch_Update
BusinessAccount_Insert
BusinessAccount_Update
BusinessAccountCustomer_Update_Assigned
BusinessAccountCustomerList_Load_Query
BusinessAccountList_Delete
BusinessAccountList_Load_Query
CategoryURI_Insert
CategoryURI_Redirect
CategoryURI_Update
CategoryURIList_Delete
CategoryURIList_Load_Query
ChildCategoryList_Load_Query
CouponCustomer_Update_Assigned
CouponCustomerList_Load_Query
CustomerAddress_Delete
CustomerAddress_Insert
CustomerAddress_Update
CustomerAddress_Update_Residential
CustomerAddressList_Delete
FeedURI_Insert
FeedURI_Update
FeedURIList_Delete
FeedURIList_Load_Query
ImageTypeList_Load_Query
InventoryProductSettings_Update
Option_Delete
Option_Insert
Option_Load_Code
Option_Set_Default
Option_Update
OptionList_Load_Attribute
OrderItem_Split
OrderItemList_RemoveFromShipment
OrderShipmentList_Load_Query
PageURI_Insert
PageURI_Redirect
PageURI_Update
PageURIList_Delete
PageURIList_Load_Query
PriceGroup_Delete
PriceGroup_Insert
PriceGroup_Update
PriceGroupBusinessAccount_Update_Assigned
PriceGroupBusinessAccountList_Load_Query
PriceGroupCategory_Update_Assigned
PriceGroupCategoryList_Load_Query
PriceGroupExcludedCategory_Update_Assigned
PriceGroupExcludedCategoryList_Load_Query
PriceGroupExcludedProduct_Update_Assigned
PriceGroupExcludedProductList_Load_Query
PriceGroupQualifyingProduct_Update_Assigned
PriceGroupQualifyingProductList_Load_Query
ProductImage_Update_Type
ProductKit_Generate_Variants
ProductKit_Update_Parts
ProductKit_Variant_Count
ProductKitList_Load_Query
ProductURI_Insert
ProductURI_Redirect
ProductURI_Update
ProductURIList_Delete
ProductURIList_Load_Query
ProductVariant_Generate
ProductVariant_Generate_Delimiter
ProductVariant_Insert
ProductVariant_Update
ProductVariantList_Delete
ProductVariantList_Load_Query
RelatedProduct_Update_Assigned
RelatedProductList_Load_Query
Store_Load
StoreList_Load_Query
URI_Delete
URI_Insert
URI_Update
URIList_Delete
URIList_Load_Query
v2.0.1
MMAPI-12 - Client can now set global http headers to send with every request.
v2.0.0
There are possible breaking changes in this release. Please consult the UPGRADING.md file included in this repository
for assistance in upgrading your existing code base from 1.x to 2.x
- Minimum Merchant version required is now 10.x. For 9.x use the 1.x release.
- Added the following API functions introduced in 10.00.00:
Branch_Copy
Branch_Create
Branch_Delete
BranchCSSResourceVersionList_Load_Query
BranchJavaScriptResourceVersionList_Load_Query
BranchList_Load_Query
BranchPropertyVersionList_Load_Query
BranchTemplateVersionList_Load_Query
Changeset_Create
ChangesetChangeList_Load_Query
ChangesetCSSResourceVersionList_Load_Query
ChangesetJavaScriptResourceVersionList_Load_Query
ChangesetList_Load_Query
ChangesetList_Merge
ChangesetPropertyVersionList_Load_Query
ChangesetTemplateVersionList_Load_Query
CustomerCreditHistory_Delete
CustomerCreditHistory_Insert
CustomerCreditHistoryList_Load_Query
MivaMerchantVersion
OrderCoupon_Update_Assigned
OrderCouponList_Load_Query
OrderItemList_CreateReturn
OrderPriceGroup_Update_Assigned
OrderPriceGroupList_Load_Query
OrderReturnList_Received
ResourceGroupList_Load_Query
- OrderItemOption model no longer has the attribute property. It has been renamed to attribute_code.
- Removed fields from OrderItemOption model:
- attribute (now use attribute_code)
- New fields on OrderItemOption model:
- attribute_id (attr_code)
- attribute_code (attr_id)
- attribute_template_attribute_id (attmpat_id)
- New client option `operation_timeout` allows the control of the timeout for multicall operations
- New MultiCallRequest option, auto_timeout_continue
- All Request objects can now set header data in the underlying request with `Request::process_request_headers`
- All Response objects now include the underlying HTTP Response object
- New Request option, binary_encoding allows specifying the exchange of binary information for supported requests.
- Client now supports logging. See Client.set_logger()
- ConsoleLogger - Logs to STDOUT or STDERR
- FileLogger - Logs to a specified local file
- Added support for SSH Private Key authentication
- See merchantapi.SSHClient
- See examples/client_example.py
- Added support for SSH Private Key authentication via a local SSH Agent (allows for authentication via security keys)
- See merchantapi.SSHAgentClient
- See examples/client_example.py
v1.0.0
- Initial Release