qube_sync 0.3.0 → 0.4.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (260) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +48 -0
  3. data/README.md +235 -75
  4. data/Rakefile +12 -0
  5. data/lib/qube_sync/client.rb +579 -0
  6. data/lib/qube_sync/operations/account.rb +337 -0
  7. data/lib/qube_sync/operations/account_tax_line_info.rb +30 -0
  8. data/lib/qube_sync/operations/aging_report.rb +160 -0
  9. data/lib/qube_sync/operations/alert.rb +91 -0
  10. data/lib/qube_sync/operations/ar_refund_credit_card.rb +399 -0
  11. data/lib/qube_sync/operations/bar_code.rb +37 -0
  12. data/lib/qube_sync/operations/bill.rb +1073 -0
  13. data/lib/qube_sync/operations/bill_payment_check.rb +413 -0
  14. data/lib/qube_sync/operations/bill_payment_credit_card.rb +315 -0
  15. data/lib/qube_sync/operations/bill_to_pay.rb +66 -0
  16. data/lib/qube_sync/operations/billing_rate.rb +172 -0
  17. data/lib/qube_sync/operations/budget_summary_report.rb +80 -0
  18. data/lib/qube_sync/operations/build_assembly.rb +318 -0
  19. data/lib/qube_sync/operations/charge.rb +452 -0
  20. data/lib/qube_sync/operations/check.rb +1055 -0
  21. data/lib/qube_sync/operations/class.rb +176 -0
  22. data/lib/qube_sync/operations/cleared_status.rb +39 -0
  23. data/lib/qube_sync/operations/company.rb +39 -0
  24. data/lib/qube_sync/operations/company_activity.rb +31 -0
  25. data/lib/qube_sync/operations/credit_card_charge.rb +1000 -0
  26. data/lib/qube_sync/operations/credit_card_credit.rb +1000 -0
  27. data/lib/qube_sync/operations/credit_memo.rb +1243 -0
  28. data/lib/qube_sync/operations/currency.rb +195 -0
  29. data/lib/qube_sync/operations/custom_detail_report.rb +176 -0
  30. data/lib/qube_sync/operations/custom_summary_report.rb +180 -0
  31. data/lib/qube_sync/operations/customer.rb +744 -0
  32. data/lib/qube_sync/operations/customer_msg.rb +117 -0
  33. data/lib/qube_sync/operations/customer_type.rb +133 -0
  34. data/lib/qube_sync/operations/data_event_recovery_info.rb +54 -0
  35. data/lib/qube_sync/operations/data_ext.rb +201 -0
  36. data/lib/qube_sync/operations/data_ext_def.rb +179 -0
  37. data/lib/qube_sync/operations/date_driven_terms.rb +131 -0
  38. data/lib/qube_sync/operations/deposit.rb +555 -0
  39. data/lib/qube_sync/operations/employee.rb +577 -0
  40. data/lib/qube_sync/operations/employee_default.rb +100 -0
  41. data/lib/qube_sync/operations/entity.rb +118 -0
  42. data/lib/qube_sync/operations/estimate.rb +1055 -0
  43. data/lib/qube_sync/operations/form1099_category_account_mapping.rb +90 -0
  44. data/lib/qube_sync/operations/general_detail_report.rb +185 -0
  45. data/lib/qube_sync/operations/general_summary_report.rb +180 -0
  46. data/lib/qube_sync/operations/host.rb +36 -0
  47. data/lib/qube_sync/operations/inventory_adjustment.rb +482 -0
  48. data/lib/qube_sync/operations/inventory_site.rb +214 -0
  49. data/lib/qube_sync/operations/invoice.rb +1208 -0
  50. data/lib/qube_sync/operations/item.rb +115 -0
  51. data/lib/qube_sync/operations/item_assemblies_can_build.rb +44 -0
  52. data/lib/qube_sync/operations/item_discount.rb +319 -0
  53. data/lib/qube_sync/operations/item_fixed_asset.rb +317 -0
  54. data/lib/qube_sync/operations/item_group.rb +253 -0
  55. data/lib/qube_sync/operations/item_inventory.rb +446 -0
  56. data/lib/qube_sync/operations/item_inventory_assembly.rb +483 -0
  57. data/lib/qube_sync/operations/item_non_inventory.rb +461 -0
  58. data/lib/qube_sync/operations/item_other_charge.rb +434 -0
  59. data/lib/qube_sync/operations/item_payment.rb +268 -0
  60. data/lib/qube_sync/operations/item_receipt.rb +1011 -0
  61. data/lib/qube_sync/operations/item_sales_tax.rb +270 -0
  62. data/lib/qube_sync/operations/item_sales_tax_group.rb +200 -0
  63. data/lib/qube_sync/operations/item_service.rb +455 -0
  64. data/lib/qube_sync/operations/item_sites.rb +96 -0
  65. data/lib/qube_sync/operations/item_subtotal.rb +182 -0
  66. data/lib/qube_sync/operations/job_report.rb +156 -0
  67. data/lib/qube_sync/operations/job_type.rb +131 -0
  68. data/lib/qube_sync/operations/journal_entry.rb +518 -0
  69. data/lib/qube_sync/operations/lead.rb +216 -0
  70. data/lib/qube_sync/operations/list.rb +42 -0
  71. data/lib/qube_sync/operations/list_deleted.rb +57 -0
  72. data/lib/qube_sync/operations/list_display.rb +59 -0
  73. data/lib/qube_sync/operations/list_merge.rb +55 -0
  74. data/lib/qube_sync/operations/other_name.rb +245 -0
  75. data/lib/qube_sync/operations/paycheck.rb +139 -0
  76. data/lib/qube_sync/operations/payment_method.rb +128 -0
  77. data/lib/qube_sync/operations/payroll_detail_report.rb +161 -0
  78. data/lib/qube_sync/operations/payroll_item.rb +75 -0
  79. data/lib/qube_sync/operations/payroll_item_addition.rb +98 -0
  80. data/lib/qube_sync/operations/payroll_item_company_contribution.rb +134 -0
  81. data/lib/qube_sync/operations/payroll_item_deduction.rb +124 -0
  82. data/lib/qube_sync/operations/payroll_item_direct_deposit.rb +70 -0
  83. data/lib/qube_sync/operations/payroll_item_non_wage.rb +93 -0
  84. data/lib/qube_sync/operations/payroll_item_tax.rb +123 -0
  85. data/lib/qube_sync/operations/payroll_item_wage.rb +168 -0
  86. data/lib/qube_sync/operations/payroll_item_workers_compensation.rb +108 -0
  87. data/lib/qube_sync/operations/payroll_last_period.rb +30 -0
  88. data/lib/qube_sync/operations/payroll_liability_adjustment.rb +204 -0
  89. data/lib/qube_sync/operations/payroll_liability_check.rb +137 -0
  90. data/lib/qube_sync/operations/payroll_prior_payment.rb +178 -0
  91. data/lib/qube_sync/operations/payroll_summary_report.rb +157 -0
  92. data/lib/qube_sync/operations/payroll_year_to_date_adjustment.rb +211 -0
  93. data/lib/qube_sync/operations/preferences.rb +61 -0
  94. data/lib/qube_sync/operations/price_level.rb +305 -0
  95. data/lib/qube_sync/operations/purchase_order.rb +1038 -0
  96. data/lib/qube_sync/operations/qb_command_exec.rb +37 -0
  97. data/lib/qube_sync/operations/receive_payment.rb +627 -0
  98. data/lib/qube_sync/operations/receive_payment_to_deposit.rb +38 -0
  99. data/lib/qube_sync/operations/sales_order.rb +1045 -0
  100. data/lib/qube_sync/operations/sales_receipt.rb +1337 -0
  101. data/lib/qube_sync/operations/sales_rep.rb +172 -0
  102. data/lib/qube_sync/operations/sales_tax_code.rb +205 -0
  103. data/lib/qube_sync/operations/sales_tax_payable.rb +37 -0
  104. data/lib/qube_sync/operations/sales_tax_payment_check.rb +375 -0
  105. data/lib/qube_sync/operations/sales_tax_return.rb +35 -0
  106. data/lib/qube_sync/operations/sales_tax_return_line.rb +43 -0
  107. data/lib/qube_sync/operations/ship_method.rb +116 -0
  108. data/lib/qube_sync/operations/special_account.rb +55 -0
  109. data/lib/qube_sync/operations/special_item.rb +44 -0
  110. data/lib/qube_sync/operations/standard_terms.rb +125 -0
  111. data/lib/qube_sync/operations/template.rb +36 -0
  112. data/lib/qube_sync/operations/terms.rb +91 -0
  113. data/lib/qube_sync/operations/time_report.rb +127 -0
  114. data/lib/qube_sync/operations/time_tracking.rb +303 -0
  115. data/lib/qube_sync/operations/to_do.rb +260 -0
  116. data/lib/qube_sync/operations/transaction.rb +356 -0
  117. data/lib/qube_sync/operations/transfer.rb +213 -0
  118. data/lib/qube_sync/operations/transfer_inventory.rb +384 -0
  119. data/lib/qube_sync/operations/txn.rb +38 -0
  120. data/lib/qube_sync/operations/txn_deleted.rb +54 -0
  121. data/lib/qube_sync/operations/txn_display.rb +76 -0
  122. data/lib/qube_sync/operations/txn_void.rb +36 -0
  123. data/lib/qube_sync/operations/unit_of_measure_set.rb +149 -0
  124. data/lib/qube_sync/operations/vehicle.rb +152 -0
  125. data/lib/qube_sync/operations/vehicle_mileage.rb +191 -0
  126. data/lib/qube_sync/operations/vendor.rb +661 -0
  127. data/lib/qube_sync/operations/vendor_credit.rb +1008 -0
  128. data/lib/qube_sync/operations/vendor_type.rb +131 -0
  129. data/lib/qube_sync/operations/workers_comp_code.rb +184 -0
  130. data/lib/qube_sync/operations.rb +1165 -0
  131. data/lib/qube_sync/version.rb +1 -1
  132. data/lib/qube_sync.rb +1 -0
  133. data/sig/qube_sync/client.rbs +82 -0
  134. data/sig/qube_sync/operations/account.rbs +65 -0
  135. data/sig/qube_sync/operations/account_tax_line_info.rbs +13 -0
  136. data/sig/qube_sync/operations/aging_report.rbs +29 -0
  137. data/sig/qube_sync/operations/alert.rbs +53 -0
  138. data/sig/qube_sync/operations/ar_refund_credit_card.rbs +53 -0
  139. data/sig/qube_sync/operations/bar_code.rbs +16 -0
  140. data/sig/qube_sync/operations/bill.rbs +78 -0
  141. data/sig/qube_sync/operations/bill_payment_check.rbs +62 -0
  142. data/sig/qube_sync/operations/bill_payment_credit_card.rbs +45 -0
  143. data/sig/qube_sync/operations/bill_to_pay.rbs +19 -0
  144. data/sig/qube_sync/operations/billing_rate.rbs +40 -0
  145. data/sig/qube_sync/operations/budget_summary_report.rbs +22 -0
  146. data/sig/qube_sync/operations/build_assembly.rbs +64 -0
  147. data/sig/qube_sync/operations/charge.rbs +80 -0
  148. data/sig/qube_sync/operations/check.rbs +81 -0
  149. data/sig/qube_sync/operations/class.rbs +43 -0
  150. data/sig/qube_sync/operations/cleared_status.rbs +16 -0
  151. data/sig/qube_sync/operations/company.rbs +15 -0
  152. data/sig/qube_sync/operations/company_activity.rbs +14 -0
  153. data/sig/qube_sync/operations/credit_card_charge.rbs +69 -0
  154. data/sig/qube_sync/operations/credit_card_credit.rbs +69 -0
  155. data/sig/qube_sync/operations/credit_memo.rbs +162 -0
  156. data/sig/qube_sync/operations/currency.rbs +52 -0
  157. data/sig/qube_sync/operations/custom_detail_report.rbs +31 -0
  158. data/sig/qube_sync/operations/custom_summary_report.rbs +33 -0
  159. data/sig/qube_sync/operations/customer.rbs +174 -0
  160. data/sig/qube_sync/operations/customer_msg.rbs +31 -0
  161. data/sig/qube_sync/operations/customer_type.rbs +32 -0
  162. data/sig/qube_sync/operations/data_event_recovery_info.rbs +20 -0
  163. data/sig/qube_sync/operations/data_ext.rbs +53 -0
  164. data/sig/qube_sync/operations/data_ext_def.rbs +51 -0
  165. data/sig/qube_sync/operations/date_driven_terms.rbs +35 -0
  166. data/sig/qube_sync/operations/deposit.rbs +100 -0
  167. data/sig/qube_sync/operations/employee.rbs +173 -0
  168. data/sig/qube_sync/operations/employee_default.rbs +68 -0
  169. data/sig/qube_sync/operations/entity.rbs +24 -0
  170. data/sig/qube_sync/operations/estimate.rbs +148 -0
  171. data/sig/qube_sync/operations/form1099_category_account_mapping.rbs +33 -0
  172. data/sig/qube_sync/operations/general_detail_report.rbs +31 -0
  173. data/sig/qube_sync/operations/general_summary_report.rbs +32 -0
  174. data/sig/qube_sync/operations/host.rbs +19 -0
  175. data/sig/qube_sync/operations/inventory_adjustment.rbs +105 -0
  176. data/sig/qube_sync/operations/inventory_site.rbs +66 -0
  177. data/sig/qube_sync/operations/invoice.rbs +144 -0
  178. data/sig/qube_sync/operations/item.rbs +25 -0
  179. data/sig/qube_sync/operations/item_assemblies_can_build.rbs +15 -0
  180. data/sig/qube_sync/operations/item_discount.rbs +62 -0
  181. data/sig/qube_sync/operations/item_fixed_asset.rbs +97 -0
  182. data/sig/qube_sync/operations/item_group.rbs +62 -0
  183. data/sig/qube_sync/operations/item_inventory.rbs +87 -0
  184. data/sig/qube_sync/operations/item_inventory_assembly.rbs +94 -0
  185. data/sig/qube_sync/operations/item_non_inventory.rbs +64 -0
  186. data/sig/qube_sync/operations/item_other_charge.rbs +59 -0
  187. data/sig/qube_sync/operations/item_payment.rbs +55 -0
  188. data/sig/qube_sync/operations/item_receipt.rbs +71 -0
  189. data/sig/qube_sync/operations/item_sales_tax.rbs +57 -0
  190. data/sig/qube_sync/operations/item_sales_tax_group.rbs +50 -0
  191. data/sig/qube_sync/operations/item_service.rbs +62 -0
  192. data/sig/qube_sync/operations/item_sites.rbs +26 -0
  193. data/sig/qube_sync/operations/item_subtotal.rbs +48 -0
  194. data/sig/qube_sync/operations/job_report.rbs +28 -0
  195. data/sig/qube_sync/operations/job_type.rbs +32 -0
  196. data/sig/qube_sync/operations/journal_entry.rbs +88 -0
  197. data/sig/qube_sync/operations/lead.rbs +91 -0
  198. data/sig/qube_sync/operations/list.rbs +15 -0
  199. data/sig/qube_sync/operations/list_deleted.rbs +17 -0
  200. data/sig/qube_sync/operations/list_display.rbs +21 -0
  201. data/sig/qube_sync/operations/list_merge.rbs +22 -0
  202. data/sig/qube_sync/operations/other_name.rbs +71 -0
  203. data/sig/qube_sync/operations/paycheck.rbs +27 -0
  204. data/sig/qube_sync/operations/payment_method.rbs +33 -0
  205. data/sig/qube_sync/operations/payroll_detail_report.rbs +29 -0
  206. data/sig/qube_sync/operations/payroll_item.rbs +23 -0
  207. data/sig/qube_sync/operations/payroll_item_addition.rbs +48 -0
  208. data/sig/qube_sync/operations/payroll_item_company_contribution.rbs +58 -0
  209. data/sig/qube_sync/operations/payroll_item_deduction.rbs +54 -0
  210. data/sig/qube_sync/operations/payroll_item_direct_deposit.rbs +30 -0
  211. data/sig/qube_sync/operations/payroll_item_non_wage.rbs +23 -0
  212. data/sig/qube_sync/operations/payroll_item_tax.rbs +58 -0
  213. data/sig/qube_sync/operations/payroll_item_wage.rbs +48 -0
  214. data/sig/qube_sync/operations/payroll_item_workers_compensation.rbs +42 -0
  215. data/sig/qube_sync/operations/payroll_last_period.rbs +13 -0
  216. data/sig/qube_sync/operations/payroll_liability_adjustment.rbs +59 -0
  217. data/sig/qube_sync/operations/payroll_liability_check.rbs +27 -0
  218. data/sig/qube_sync/operations/payroll_prior_payment.rbs +48 -0
  219. data/sig/qube_sync/operations/payroll_summary_report.rbs +30 -0
  220. data/sig/qube_sync/operations/payroll_year_to_date_adjustment.rbs +66 -0
  221. data/sig/qube_sync/operations/preferences.rbs +26 -0
  222. data/sig/qube_sync/operations/price_level.rbs +57 -0
  223. data/sig/qube_sync/operations/purchase_order.rbs +159 -0
  224. data/sig/qube_sync/operations/qb_command_exec.rbs +22 -0
  225. data/sig/qube_sync/operations/receive_payment.rbs +102 -0
  226. data/sig/qube_sync/operations/receive_payment_to_deposit.rbs +15 -0
  227. data/sig/qube_sync/operations/sales_order.rbs +153 -0
  228. data/sig/qube_sync/operations/sales_receipt.rbs +139 -0
  229. data/sig/qube_sync/operations/sales_rep.rbs +43 -0
  230. data/sig/qube_sync/operations/sales_tax_code.rbs +49 -0
  231. data/sig/qube_sync/operations/sales_tax_payable.rbs +16 -0
  232. data/sig/qube_sync/operations/sales_tax_payment_check.rbs +64 -0
  233. data/sig/qube_sync/operations/sales_tax_return.rbs +14 -0
  234. data/sig/qube_sync/operations/sales_tax_return_line.rbs +15 -0
  235. data/sig/qube_sync/operations/ship_method.rbs +31 -0
  236. data/sig/qube_sync/operations/special_account.rbs +16 -0
  237. data/sig/qube_sync/operations/special_item.rbs +17 -0
  238. data/sig/qube_sync/operations/standard_terms.rbs +34 -0
  239. data/sig/qube_sync/operations/template.rbs +15 -0
  240. data/sig/qube_sync/operations/terms.rbs +23 -0
  241. data/sig/qube_sync/operations/time_report.rbs +26 -0
  242. data/sig/qube_sync/operations/time_tracking.rbs +57 -0
  243. data/sig/qube_sync/operations/to_do.rbs +59 -0
  244. data/sig/qube_sync/operations/transaction.rbs +39 -0
  245. data/sig/qube_sync/operations/transfer.rbs +47 -0
  246. data/sig/qube_sync/operations/transfer_inventory.rbs +76 -0
  247. data/sig/qube_sync/operations/txn.rbs +15 -0
  248. data/sig/qube_sync/operations/txn_deleted.rbs +17 -0
  249. data/sig/qube_sync/operations/txn_display.rbs +22 -0
  250. data/sig/qube_sync/operations/txn_void.rbs +15 -0
  251. data/sig/qube_sync/operations/types.rbs +434 -0
  252. data/sig/qube_sync/operations/unit_of_measure_set.rbs +51 -0
  253. data/sig/qube_sync/operations/vehicle.rbs +43 -0
  254. data/sig/qube_sync/operations/vehicle_mileage.rbs +38 -0
  255. data/sig/qube_sync/operations/vendor.rbs +142 -0
  256. data/sig/qube_sync/operations/vendor_credit.rbs +70 -0
  257. data/sig/qube_sync/operations/vendor_type.rbs +32 -0
  258. data/sig/qube_sync/operations/workers_comp_code.rbs +52 -0
  259. data/sig/qube_sync/operations.rbs +147 -0
  260. metadata +255 -2
@@ -0,0 +1,245 @@
1
+ # Generated from operations.json by bin/generate-operations: don't edit.
2
+ # frozen_string_literal: true
3
+
4
+ module QubeSync
5
+ module Operations
6
+ # QuickBooks other name operations, reached as `client.other_name`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class OtherName < Base
9
+ # Create other name: POST /connections/{connection_id}/other-names (`other_name.create`).
10
+ #
11
+ # QuickBooks answers in one webhook.
12
+ #
13
+ # Params, sent as the JSON body:
14
+ # - `account_number` (String): Account numbers appear in the QuickBooks chart of accounts,
15
+ # Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false
16
+ # (that is, if the QuickBooks user has the account numbers Preference turned off), you can
17
+ # still set account numbers through the SDK, but the numbers won’t be visible in the user
18
+ # interface.
19
+ # - `alt_contact` (String): The name of an alternate contact person for a vendor, customer, or
20
+ # “other name” entry.
21
+ # - `alt_phone` (String): A telephone number given as an alternative to Phone.
22
+ # - `company_name` (String): The name of the QuickBooks user’s business, as specified in
23
+ # QuickBooks. `company_name` and Address are used on invoices, checks, and other forms.
24
+ # (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms
25
+ # and pay stubs.)
26
+ # - `contact` (String): The name of a contact person for a customer or vendor.
27
+ # - `email` (String): E-mail address.
28
+ # - `external_guid` (String): Allows for the attachment of a user defined GUID value.
29
+ # - `fax` (String): Fax number.
30
+ # - `first_name` (String): The first name of a customer, vendor, employee, or person on the
31
+ # “other names” list.
32
+ # - `include_ret_element` (Array<one of "AccountNumber", "AltContact", "AltPhone",
33
+ # "CompanyName", "Contact", "DataExtRet", "EditSequence", "Email", "ExternalGUID", "Fax",
34
+ # "FirstName", "IsActive", "LastName", "ListID", "MiddleName", "Name", "Notes",
35
+ # "OtherNameAddress", "OtherNameAddressBlock", "OwnerID", "Phone", "Salutation",
36
+ # "TimeCreated", "TimeModified", "TxnID", "TxnNumber">)
37
+ # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
38
+ # QuickBooks. The default value is true.
39
+ # - `last_name` (String): The last name of a customer, vendor, employee, or person on the
40
+ # “other names” list.
41
+ # - `middle_name` (String): The middle name of a customer, vendor, employee, or person on the
42
+ # “other names” list.
43
+ # - `name` (String, required): Name is the case-insensitive short name of a list object
44
+ # (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can
45
+ # reuse the same Name in different branches because FullName remains distinct.
46
+ # - `notes` (String): Additional information.
47
+ # - `other_name_address` (Hash): If an address request fails, some combination of address
48
+ # fields might be too long.
49
+ # - `addr1` (String): The first line of an address.
50
+ # - `addr2` (String): The second line of an address (if a second line is needed).
51
+ # - `addr3` (String): The third line of an address (if a third line is needed).
52
+ # - `addr4` (String): The fourth line of an address (if a fourth line is needed).
53
+ # - `addr5` (String): The fifth line of an address (if a fifth line is needed).
54
+ # - `city` (String): The city name in an address.
55
+ # - `country` (String): The country name in an address, or, in returned Host information
56
+ # (HostRet or HostInfo), the country for which this edition of QuickBooks was designed.
57
+ # (Possible values are US, CA, UK, and AU.)
58
+ # - `note` (String): In a BillAddress or ShipAddress aggregate, the Note field value is
59
+ # written at the bottom of the address in the form in which it appears, such as the
60
+ # invoice form.
61
+ # - `postal_code` (String): The postal code in an address.
62
+ # - `state` (String): The state name in an address.
63
+ # - `phone` (String): The telephone number.
64
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
65
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
66
+ # webhook already carries the request's `id`.
67
+ # - `salutation` (String): A formal reference, such as Mr. or Dr., that precedes a name.
68
+ #
69
+ # @param connection_id [String]
70
+ # @param params [Hash] the fields above
71
+ # @param webhook_url [String] where QuBe Sync sends the answer
72
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
73
+ # @return [Hash] the queued request
74
+ # @see https://docs.qubesync.com/api-reference/v2/other-names/create-other-name
75
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
76
+ queue("other_name.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
77
+ end
78
+
79
+ # List other names: GET /connections/{connection_id}/other-names (`other_name.query`).
80
+ #
81
+ # QuickBooks answers in one webhook.
82
+ #
83
+ # Params, sent as the query string:
84
+ # - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): Used in filters to select
85
+ # list objects based on whether or not they are currently enabled for use by QuickBooks. The
86
+ # default value is asActiveOnly, which selects only list objects that are active. Choose at
87
+ # most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
88
+ # `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
89
+ # combine with each other, not with the other choices.
90
+ # - `from_modified_date` (String): Filters results to objects modified on or after this
91
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
92
+ # date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or
93
+ # `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`,
94
+ # `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set combine with
95
+ # each other, not with the other choices.
96
+ # - `full_name` (Array<String>): Choose at most one of: `list_id`, or `full_name`, or the set
97
+ # (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
98
+ # `name_range_filter`, `to_modified_date`). Members of a set combine with each other, not
99
+ # with the other choices.
100
+ # - `include_ret_element` (Array<one of "AccountNumber", "AltContact", "AltPhone",
101
+ # "CompanyName", "Contact", "DataExtRet", "EditSequence", "Email", "ExternalGUID", "Fax",
102
+ # "FirstName", "IsActive", "LastName", "ListID", "MiddleName", "Name", "Notes",
103
+ # "OtherNameAddress", "OtherNameAddressBlock", "Phone", "Salutation", "TimeCreated",
104
+ # "TimeModified">)
105
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
106
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
107
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
108
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`. Choose at most
109
+ # one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
110
+ # `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
111
+ # combine with each other, not with the other choices.
112
+ # - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
113
+ # count of how many objects could possibly be returned, use the `meta_data` query
114
+ # attribute.) If you include a `max_returned` value, it must be at least 1. QuickBooks
115
+ # doesn't page this query: at most this many records come back, in one answer, with no sign
116
+ # of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the
117
+ # Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type`
118
+ # `response_too_large`), so narrow a large one with its filters. Choose at most one of:
119
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
120
+ # `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
121
+ # combine with each other, not with the other choices.
122
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
123
+ # `meta_data` attribute to control whether query responses include counts. Options are
124
+ # NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
125
+ # objects). Counts are approximate and may vary slightly if records are created or deleted
126
+ # during processing.
127
+ # - `name_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
128
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
129
+ # `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
130
+ # combine with each other, not with the other choices.
131
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
132
+ # to match.
133
+ # - `name` (String, required): The string to match.
134
+ # - `name_range_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
135
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
136
+ # `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
137
+ # combine with each other, not with the other choices.
138
+ # - `from_name` (String): The first name or item in the search range. If `from_name` is
139
+ # omitted, the range will begin with first name on the list.
140
+ # - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
141
+ # the range will end with last name on the list.
142
+ # - `owner_id` (Array<String>): `owner_id` identifies who owns the data extension. Use 0 for
143
+ # QuickBooks custom fields that appear in the UI, or use a GUID for private extensions owned
144
+ # by an app. Keep private GUIDs confidential unless you intentionally share extensions
145
+ # across apps. If you do share them, both apps must use the same `owner_id` and
146
+ # `data_ext_name`, because that pair uniquely identifies the extension.
147
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
148
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
149
+ # webhook already carries the request's `id`.
150
+ # - `to_modified_date` (String): Filters results to objects modified on or before this
151
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
152
+ # date is provided, time defaults to end-of-day (23:59:59). Choose at most one of:
153
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
154
+ # `max_returned`, `name_filter`, `name_range_filter`, `to_modified_date`). Members of a set
155
+ # combine with each other, not with the other choices.
156
+ #
157
+ # @param connection_id [String]
158
+ # @param params [Hash] the fields above
159
+ # @param webhook_url [String] where QuBe Sync sends the answer
160
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
161
+ # @return [Hash] the queued request
162
+ # @see https://docs.qubesync.com/api-reference/v2/other-names/list-other-names
163
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
164
+ queue("other_name.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
165
+ end
166
+
167
+ # Update other name: PUT /connections/{connection_id}/other-names (`other_name.update`).
168
+ #
169
+ # QuickBooks answers in one webhook.
170
+ #
171
+ # Params, sent as the JSON body:
172
+ # - `account_number` (String): Account numbers appear in the QuickBooks chart of accounts,
173
+ # Account fields, and reports and graphs. If the IsUsingAccountNumber preference is false
174
+ # (that is, if the QuickBooks user has the account numbers Preference turned off), you can
175
+ # still set account numbers through the SDK, but the numbers won’t be visible in the user
176
+ # interface.
177
+ # - `alt_contact` (String): The name of an alternate contact person for a vendor, customer, or
178
+ # “other name” entry.
179
+ # - `alt_phone` (String): A telephone number given as an alternative to Phone.
180
+ # - `company_name` (String): The name of the QuickBooks user’s business, as specified in
181
+ # QuickBooks. `company_name` and Address are used on invoices, checks, and other forms.
182
+ # (LegalCompanyName and LegalAddress, on the other hand, are used on a company’s tax forms
183
+ # and pay stubs.)
184
+ # - `contact` (String): The name of a contact person for a customer or vendor.
185
+ # - `edit_sequence` (String, required): `edit_sequence` is a server-generated revision token.
186
+ # It changes each time the object is updated. To modify an existing object, you must send
187
+ # the current `edit_sequence`. If your value is stale, the update is rejected to prevent
188
+ # overwriting newer changes.
189
+ # - `email` (String): E-mail address.
190
+ # - `fax` (String): Fax number.
191
+ # - `first_name` (String): The first name of a customer, vendor, employee, or person on the
192
+ # “other names” list.
193
+ # - `include_ret_element` (Array<one of "AccountNumber", "AltContact", "AltPhone",
194
+ # "CompanyName", "Contact", "DataExtRet", "EditSequence", "Email", "ExternalGUID", "Fax",
195
+ # "FirstName", "IsActive", "LastName", "ListID", "MiddleName", "Name", "Notes",
196
+ # "OtherNameAddress", "OtherNameAddressBlock", "OwnerID", "Phone", "Salutation",
197
+ # "TimeCreated", "TimeModified", "TxnID", "TxnNumber">)
198
+ # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
199
+ # QuickBooks. The default value is true.
200
+ # - `last_name` (String): The last name of a customer, vendor, employee, or person on the
201
+ # “other names” list.
202
+ # - `list_id` (String, required): `list_id` and FullName both identify a list object.
203
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
204
+ # within a list type, not globally across all lists. If both FullName and `list_id` are
205
+ # supplied in a request, QuickBooks uses `list_id` and ignores FullName.
206
+ # - `middle_name` (String): The middle name of a customer, vendor, employee, or person on the
207
+ # “other names” list.
208
+ # - `name` (String): Name is the case-insensitive short name of a list object (without
209
+ # ancestors). It must be unique within its hierarchy scope. Hierarchical lists can reuse the
210
+ # same Name in different branches because FullName remains distinct.
211
+ # - `notes` (String): Additional information.
212
+ # - `other_name_address` (Hash): If an address request fails, some combination of address
213
+ # fields might be too long.
214
+ # - `addr1` (String): The first line of an address.
215
+ # - `addr2` (String): The second line of an address (if a second line is needed).
216
+ # - `addr3` (String): The third line of an address (if a third line is needed).
217
+ # - `addr4` (String): The fourth line of an address (if a fourth line is needed).
218
+ # - `addr5` (String): The fifth line of an address (if a fifth line is needed).
219
+ # - `city` (String): The city name in an address.
220
+ # - `country` (String): The country name in an address, or, in returned Host information
221
+ # (HostRet or HostInfo), the country for which this edition of QuickBooks was designed.
222
+ # (Possible values are US, CA, UK, and AU.)
223
+ # - `note` (String): In a BillAddress or ShipAddress aggregate, the Note field value is
224
+ # written at the bottom of the address in the form in which it appears, such as the
225
+ # invoice form.
226
+ # - `postal_code` (String): The postal code in an address.
227
+ # - `state` (String): The state name in an address.
228
+ # - `phone` (String): The telephone number.
229
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
230
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
231
+ # webhook already carries the request's `id`.
232
+ # - `salutation` (String): A formal reference, such as Mr. or Dr., that precedes a name.
233
+ #
234
+ # @param connection_id [String]
235
+ # @param params [Hash] the fields above
236
+ # @param webhook_url [String] where QuBe Sync sends the answer
237
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
238
+ # @return [Hash] the queued request
239
+ # @see https://docs.qubesync.com/api-reference/v2/other-names/update-other-name
240
+ def update(connection_id, params = {}, webhook_url:, idempotency_key: nil)
241
+ queue("other_name.update", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
242
+ end
243
+ end
244
+ end
245
+ end
@@ -0,0 +1,139 @@
1
+ # Generated from operations.json by bin/generate-operations: don't edit.
2
+ # frozen_string_literal: true
3
+
4
+ module QubeSync
5
+ module Operations
6
+ # QuickBooks paycheck operations, reached as `client.paycheck`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class Paycheck < Base
9
+ # List paychecks: GET /connections/{connection_id}/paychecks (`paycheck.query`).
10
+ #
11
+ # QuickBooks answers in one webhook.
12
+ #
13
+ # Params, sent as the query string:
14
+ # - `account_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
15
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
16
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
17
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
18
+ # combine with each other, not with the other choices.
19
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
20
+ # `full_name_with_children`.
21
+ # - `full_name` (Array<String>)
22
+ # - `full_name_with_children` (String)
23
+ # - `list_id` (Array<String>)
24
+ # - `list_id_with_children` (String)
25
+ # - `entity_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
26
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
27
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
28
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
29
+ # combine with each other, not with the other choices.
30
+ # Give at most one of: `list_id`, or `full_name`, or `list_id_with_children`, or
31
+ # `full_name_with_children`.
32
+ # - `full_name` (Array<String>)
33
+ # - `full_name_with_children` (String)
34
+ # - `list_id` (Array<String>)
35
+ # - `list_id_with_children` (String)
36
+ # - `include_line_items` (Boolean)
37
+ # - `include_ret_element` (Array<one of "AccountRef", "Address", "Amount", "ClassRef",
38
+ # "EditSequence", "EmployeeRef", "IsAccruingTime", "IsToBePrinted", "Memo",
39
+ # "PayPeriodBeginDate", "PayPeriodEndDate", "PaycheckLineRet", "PayrollDate", "RefNumber",
40
+ # "SickHoursAccrued", "SickHoursAvailable", "TaxTableVersion", "TimeCreated",
41
+ # "TimeModified", "TxnDate", "TxnID", "TxnNumber", "VacationHoursAccrued",
42
+ # "VacationHoursAvailable">)
43
+ # - `max_returned` (Integer): QuickBooks doesn't page this query: at most this many records
44
+ # come back, in one answer, with no sign of whether more matched. Leave it out for every
45
+ # match, in one answer; one over 4 MB as the Web Connector sends it, about 3 MB of qbXML
46
+ # isn't kept (`error_type` `response_too_large`), so narrow a large one with its filters.
47
+ # Choose at most one of: `txn_id`, or `ref_number`, or `ref_number_case_sensitive`, or the
48
+ # set (`account_filter`, `entity_filter`, `max_returned`, `modified_date_range_filter`,
49
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
50
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
51
+ # choices.
52
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData")
53
+ # - `modified_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
54
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
55
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
56
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
57
+ # combine with each other, not with the other choices.
58
+ # - `from_modified_date` (String)
59
+ # - `to_modified_date` (String)
60
+ # - `payroll_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
61
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
62
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
63
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
64
+ # combine with each other, not with the other choices.
65
+ # Give at most one of: `from_payroll_date` with `to_payroll_date`, or `date_macro`.
66
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
67
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
68
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
69
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
70
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
71
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
72
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
73
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
74
+ # "ThisWeekToDate", "Today", "Yesterday")
75
+ # - `from_payroll_date` (String)
76
+ # - `to_payroll_date` (String)
77
+ # - `ref_number` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
78
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
79
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
80
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
81
+ # combine with each other, not with the other choices.
82
+ # - `ref_number_case_sensitive` (Array<String>): Choose at most one of: `txn_id`, or
83
+ # `ref_number`, or `ref_number_case_sensitive`, or the set (`account_filter`,
84
+ # `entity_filter`, `max_returned`, `modified_date_range_filter`,
85
+ # `payroll_date_range_filter`, `ref_number_filter`, `ref_number_range_filter`,
86
+ # `txn_date_range_filter`). Members of a set combine with each other, not with the other
87
+ # choices.
88
+ # - `ref_number_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
89
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
90
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
91
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
92
+ # combine with each other, not with the other choices.
93
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required)
94
+ # - `ref_number` (String, required)
95
+ # - `ref_number_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
96
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
97
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
98
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
99
+ # combine with each other, not with the other choices.
100
+ # - `from_ref_number` (String)
101
+ # - `to_ref_number` (String)
102
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
103
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
104
+ # webhook already carries the request's `id`.
105
+ # - `txn_date_range_filter` (Hash): Choose at most one of: `txn_id`, or `ref_number`, or
106
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
107
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
108
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
109
+ # combine with each other, not with the other choices.
110
+ # Give at most one of: `from_txn_date` with `to_txn_date`, or `date_macro`.
111
+ # - `date_macro` (one of "All", "LastCalendarQuarter", "LastCalendarQuarterToDate",
112
+ # "LastCalendarYear", "LastCalendarYearToDate", "LastFiscalQuarter",
113
+ # "LastFiscalQuarterToDate", "LastFiscalYear", "LastFiscalYearToDate", "LastMonth",
114
+ # "LastMonthToDate", "LastWeek", "LastWeekToDate", "NextCalendarQuarter",
115
+ # "NextCalendarYear", "NextFiscalQuarter", "NextFiscalYear", "NextFourWeeks", "NextMonth",
116
+ # "NextWeek", "ThisCalendarQuarter", "ThisCalendarQuarterToDate", "ThisCalendarYear",
117
+ # "ThisCalendarYearToDate", "ThisFiscalQuarter", "ThisFiscalQuarterToDate",
118
+ # "ThisFiscalYear", "ThisFiscalYearToDate", "ThisMonth", "ThisMonthToDate", "ThisWeek",
119
+ # "ThisWeekToDate", "Today", "Yesterday")
120
+ # - `from_txn_date` (String)
121
+ # - `to_txn_date` (String)
122
+ # - `txn_id` (Array<String>): Choose at most one of: `txn_id`, or `ref_number`, or
123
+ # `ref_number_case_sensitive`, or the set (`account_filter`, `entity_filter`,
124
+ # `max_returned`, `modified_date_range_filter`, `payroll_date_range_filter`,
125
+ # `ref_number_filter`, `ref_number_range_filter`, `txn_date_range_filter`). Members of a set
126
+ # combine with each other, not with the other choices.
127
+ #
128
+ # @param connection_id [String]
129
+ # @param params [Hash] the fields above
130
+ # @param webhook_url [String] where QuBe Sync sends the answer
131
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
132
+ # @return [Hash] the queued request
133
+ # @see https://docs.qubesync.com/api-reference/v2/paychecks/list-paychecks
134
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
135
+ queue("paycheck.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
136
+ end
137
+ end
138
+ end
139
+ end
@@ -0,0 +1,128 @@
1
+ # Generated from operations.json by bin/generate-operations: don't edit.
2
+ # frozen_string_literal: true
3
+
4
+ module QubeSync
5
+ module Operations
6
+ # QuickBooks payment method operations, reached as `client.payment_method`. Each queues a request and
7
+ # returns it (the response's `data`); the answer comes to `webhook_url`.
8
+ class PaymentMethod < Base
9
+ # Create payment method: POST /connections/{connection_id}/payment-methods
10
+ # (`payment_method.create`).
11
+ #
12
+ # QuickBooks answers in one webhook.
13
+ #
14
+ # Params, sent as the JSON body:
15
+ # - `include_ret_element` (Array<one of "EditSequence", "ExternalGUID", "IsActive", "ListID",
16
+ # "Name", "OwnerID", "PaymentMethodType", "TimeCreated", "TimeModified", "TxnID",
17
+ # "TxnNumber">)
18
+ # - `is_active` (Boolean): If `is_active` is true, this object is currently enabled for use by
19
+ # QuickBooks. The default value is true.
20
+ # - `name` (String, required): Name is the case-insensitive short name of a list object
21
+ # (without ancestors). It must be unique within its hierarchy scope. Hierarchical lists can
22
+ # reuse the same Name in different branches because FullName remains distinct.
23
+ # - `payment_method_type` (one of "AmericanExpress", "Cash", "Check", "DebitCard", "Discover",
24
+ # "ECheck", "GiftCard", "MasterCard", "Other", "OtherCreditCard", "Visa"): The payment
25
+ # method, such as check, cash, debit card, Visa, etc.
26
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
27
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
28
+ # webhook already carries the request's `id`.
29
+ #
30
+ # @param connection_id [String]
31
+ # @param params [Hash] the fields above
32
+ # @param webhook_url [String] where QuBe Sync sends the answer
33
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
34
+ # @return [Hash] the queued request
35
+ # @see https://docs.qubesync.com/api-reference/v2/payment-methods/create-payment-method
36
+ def create(connection_id, params = {}, webhook_url:, idempotency_key: nil)
37
+ queue("payment_method.create", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
38
+ end
39
+
40
+ # List payment methods: GET /connections/{connection_id}/payment-methods
41
+ # (`payment_method.query`).
42
+ #
43
+ # QuickBooks answers in one webhook.
44
+ #
45
+ # Params, sent as the query string:
46
+ # - `active_status` (one of "ActiveOnly", "All", "InactiveOnly"): Used in filters to select
47
+ # list objects based on whether or not they are currently enabled for use by QuickBooks. The
48
+ # default value is asActiveOnly, which selects only list objects that are active. Choose at
49
+ # most one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
50
+ # `max_returned`, `name_filter`, `name_range_filter`, `payment_method_type`,
51
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
52
+ # - `from_modified_date` (String): Filters results to objects modified on or after this
53
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
54
+ # date is provided, time defaults to 00:00:00. Choose at most one of: `list_id`, or
55
+ # `full_name`, or the set (`active_status`, `from_modified_date`, `max_returned`,
56
+ # `name_filter`, `name_range_filter`, `payment_method_type`, `to_modified_date`). Members of
57
+ # a set combine with each other, not with the other choices.
58
+ # - `full_name` (Array<String>): Choose at most one of: `list_id`, or `full_name`, or the set
59
+ # (`active_status`, `from_modified_date`, `max_returned`, `name_filter`,
60
+ # `name_range_filter`, `payment_method_type`, `to_modified_date`). Members of a set combine
61
+ # with each other, not with the other choices.
62
+ # - `include_ret_element` (Array<one of "EditSequence", "IsActive", "ListID", "Name",
63
+ # "PaymentMethodType", "TimeCreated", "TimeModified">)
64
+ # - `list_id` (Array<String>): `list_id` and `full_name` both identify a list object.
65
+ # QuickBooks assigns `list_id` when the object is created. `list_id` values are unique
66
+ # within a list type, not globally across all lists. If both `full_name` and `list_id` are
67
+ # supplied in a request, QuickBooks uses `list_id` and ignores `full_name`. Choose at most
68
+ # one of: `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
69
+ # `max_returned`, `name_filter`, `name_range_filter`, `payment_method_type`,
70
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
71
+ # - `max_returned` (Integer): Limits the number of objects that a query returns. (To get a
72
+ # count of how many objects could possibly be returned, use the `meta_data` query
73
+ # attribute.) If you include a `max_returned` value, it must be at least 1. QuickBooks
74
+ # doesn't page this query: at most this many records come back, in one answer, with no sign
75
+ # of whether more matched. Leave it out for every match, in one answer; one over 4 MB as the
76
+ # Web Connector sends it, about 3 MB of qbXML isn't kept (`error_type`
77
+ # `response_too_large`), so narrow a large one with its filters. Choose at most one of:
78
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
79
+ # `max_returned`, `name_filter`, `name_range_filter`, `payment_method_type`,
80
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
81
+ # - `meta_data` (one of "MetaDataAndResponseData", "MetaDataOnly", "NoMetaData"): Use the
82
+ # `meta_data` attribute to control whether query responses include counts. Options are
83
+ # NoMetaData (default), MetaDataOnly (count only), and MetaDataAndResponseData (count plus
84
+ # objects). Counts are approximate and may vary slightly if records are created or deleted
85
+ # during processing.
86
+ # - `name_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
87
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
88
+ # `max_returned`, `name_filter`, `name_range_filter`, `payment_method_type`,
89
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
90
+ # - `match_criterion` (one of "Contains", "EndsWith", "StartsWith", required): The criterion
91
+ # to match.
92
+ # - `name` (String, required): The string to match.
93
+ # - `name_range_filter` (Hash): Filters according to the object’s Name. Choose at most one of:
94
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
95
+ # `max_returned`, `name_filter`, `name_range_filter`, `payment_method_type`,
96
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
97
+ # - `from_name` (String): The first name or item in the search range. If `from_name` is
98
+ # omitted, the range will begin with first name on the list.
99
+ # - `to_name` (String): The final name or item in the search range. If `to_name` is omitted,
100
+ # the range will end with last name on the list.
101
+ # - `payment_method_type` (Array<one of "AmericanExpress", "Cash", "Check", "DebitCard",
102
+ # "Discover", "ECheck", "GiftCard", "MasterCard", "Other", "OtherCreditCard", "Visa">): The
103
+ # payment method, such as check, cash, debit card, Visa, etc. Choose at most one of:
104
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
105
+ # `max_returned`, `name_filter`, `name_range_filter`, `payment_method_type`,
106
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
107
+ # - `request_id` (String): Your own label for the request, sent to QuickBooks as its qbXML
108
+ # `requestID` and echoed in the raw answer (`response_xml`); optional, since the answer's
109
+ # webhook already carries the request's `id`.
110
+ # - `to_modified_date` (String): Filters results to objects modified on or before this
111
+ # timestamp. QuickBooks Desktop accepts 1970-01-01 through 2038-01-19T03:14:07. If only a
112
+ # date is provided, time defaults to end-of-day (23:59:59). Choose at most one of:
113
+ # `list_id`, or `full_name`, or the set (`active_status`, `from_modified_date`,
114
+ # `max_returned`, `name_filter`, `name_range_filter`, `payment_method_type`,
115
+ # `to_modified_date`). Members of a set combine with each other, not with the other choices.
116
+ #
117
+ # @param connection_id [String]
118
+ # @param params [Hash] the fields above
119
+ # @param webhook_url [String] where QuBe Sync sends the answer
120
+ # @param idempotency_key [String, nil] made for the call when nil, and reused on its retries
121
+ # @return [Hash] the queued request
122
+ # @see https://docs.qubesync.com/api-reference/v2/payment-methods/list-payment-methods
123
+ def query(connection_id, params = {}, webhook_url:, idempotency_key: nil)
124
+ queue("payment_method.query", connection_id, params, webhook_url: webhook_url, idempotency_key: idempotency_key)
125
+ end
126
+ end
127
+ end
128
+ end