subskribe_sandbox 1.0.0 → 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (436) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +7 -6
  3. data/docs/AccountsApi.md +2 -2
  4. data/docs/AutomatedInvoiceRule.md +5 -5
  5. data/docs/BillingApi.md +23 -23
  6. data/docs/BulkPaymentUploadData.md +7 -7
  7. data/docs/ChargeJson.md +2 -2
  8. data/docs/PaginatedAccountsResponse.md +10 -0
  9. data/docs/TaxJarIntegration.md +4 -4
  10. data/lib/subskribe_dev/api/accounts_api.rb +3 -3
  11. data/lib/subskribe_dev/api/entities_api.rb +158 -0
  12. data/lib/subskribe_dev/api/erp_api.rb +20 -20
  13. data/lib/subskribe_dev/api/product_catalog_api.rb +58 -0
  14. data/lib/subskribe_dev/api/revenue_recognition_api.rb +22 -22
  15. data/lib/subskribe_dev/models/automated_invoice_rule.rb +22 -22
  16. data/lib/subskribe_dev/models/bulk_invoice_run_item.rb +22 -22
  17. data/lib/subskribe_dev/models/bulk_payment_upload_data.rb +31 -31
  18. data/lib/subskribe_dev/models/bulk_payment_upload_result.rb +13 -13
  19. data/lib/subskribe_dev/models/charge_json.rb +19 -19
  20. data/lib/subskribe_dev/models/order_line_item_json.rb +10 -1
  21. data/lib/subskribe_dev/models/order_line_item_request_json.rb +10 -1
  22. data/lib/subskribe_dev/models/paginated_accounts_response.rb +204 -0
  23. data/lib/subskribe_dev/models/plan_metadata_json.rb +187 -0
  24. data/lib/subskribe_dev/models/tax_jar_integration.rb +10 -10
  25. data/lib/subskribe_dev/version.rb +1 -1
  26. data/lib/subskribe_dev.rb +2 -1
  27. data/lib/subskribe_dev2/api/accounting_api.rb +193 -0
  28. data/lib/subskribe_dev2/api/accounts_api.rb +858 -0
  29. data/lib/subskribe_dev2/api/approvals_api.rb +965 -0
  30. data/lib/subskribe_dev2/api/attachments_api.rb +299 -0
  31. data/lib/subskribe_dev2/api/authentication_api.rb +335 -0
  32. data/lib/subskribe_dev2/api/billing_api.rb +2098 -0
  33. data/lib/subskribe_dev2/api/credit_memo_api.rb +636 -0
  34. data/lib/subskribe_dev2/api/custom_field_api.rb +434 -0
  35. data/lib/subskribe_dev2/api/customization_api.rb +269 -0
  36. data/lib/subskribe_dev2/api/default_api.rb +223 -0
  37. data/lib/subskribe_dev2/api/discounts_api.rb +340 -0
  38. data/lib/subskribe_dev2/api/entities_api.rb +532 -0
  39. data/lib/subskribe_dev2/api/erp_api.rb +278 -0
  40. data/lib/subskribe_dev2/api/import_api.rb +568 -0
  41. data/lib/subskribe_dev2/api/integrations_api.rb +1678 -0
  42. data/lib/subskribe_dev2/api/metrics_reporting_api.rb +223 -0
  43. data/lib/subskribe_dev2/api/notifications_api.rb +245 -0
  44. data/lib/subskribe_dev2/api/opportunity_api.rb +177 -0
  45. data/lib/subskribe_dev2/api/orders_api.rb +1381 -0
  46. data/lib/subskribe_dev2/api/payments_api.rb +431 -0
  47. data/lib/subskribe_dev2/api/product_catalog_api.rb +1886 -0
  48. data/lib/subskribe_dev2/api/rate_card_api.rb +68 -0
  49. data/lib/subskribe_dev2/api/refunds_api.rb +189 -0
  50. data/lib/subskribe_dev2/api/reports_api.rb +227 -0
  51. data/lib/subskribe_dev2/api/revenue_recognition_api.rb +484 -0
  52. data/lib/subskribe_dev2/api/sales_room_api.rb +74 -0
  53. data/lib/subskribe_dev2/api/settings_api.rb +1321 -0
  54. data/lib/subskribe_dev2/api/subscriptions_api.rb +576 -0
  55. data/lib/subskribe_dev2/api/usage_api.rb +604 -0
  56. data/lib/subskribe_dev2/api/users_api.rb +728 -0
  57. data/lib/subskribe_dev2/api_client.rb +391 -0
  58. data/lib/subskribe_dev2/api_error.rb +38 -0
  59. data/lib/subskribe_dev2/configuration.rb +209 -0
  60. data/lib/subskribe_dev2/models/account_address.rb +265 -0
  61. data/lib/subskribe_dev2/models/account_address_json.rb +229 -0
  62. data/lib/subskribe_dev2/models/account_contact.rb +530 -0
  63. data/lib/subskribe_dev2/models/account_contact_json.rb +274 -0
  64. data/lib/subskribe_dev2/models/account_json.rb +395 -0
  65. data/lib/subskribe_dev2/models/account_payment_method_json.rb +268 -0
  66. data/lib/subskribe_dev2/models/account_receivable_contact_json.rb +225 -0
  67. data/lib/subskribe_dev2/models/accounting_event.rb +319 -0
  68. data/lib/subskribe_dev2/models/accounting_event_paginated_response.rb +204 -0
  69. data/lib/subskribe_dev2/models/accounting_period.rb +356 -0
  70. data/lib/subskribe_dev2/models/accounting_period_calculation.rb +229 -0
  71. data/lib/subskribe_dev2/models/add_and_apply_payment_application_json.rb +344 -0
  72. data/lib/subskribe_dev2/models/anrok_integration_input.rb +184 -0
  73. data/lib/subskribe_dev2/models/approval_matrix_import_data_json.rb +229 -0
  74. data/lib/subskribe_dev2/models/approval_matrix_import_preview.rb +226 -0
  75. data/lib/subskribe_dev2/models/approval_role_json.rb +220 -0
  76. data/lib/subskribe_dev2/models/approval_role_segment_change.rb +211 -0
  77. data/lib/subskribe_dev2/models/approval_segment_json.rb +220 -0
  78. data/lib/subskribe_dev2/models/attachment.rb +326 -0
  79. data/lib/subskribe_dev2/models/attribute_reference.rb +193 -0
  80. data/lib/subskribe_dev2/models/auth_saml_integration_json.rb +204 -0
  81. data/lib/subskribe_dev2/models/automated_invoice_rule.rb +328 -0
  82. data/lib/subskribe_dev2/models/automated_invoice_rule_request_json.rb +307 -0
  83. data/lib/subskribe_dev2/models/avalara_integration.rb +238 -0
  84. data/lib/subskribe_dev2/models/avalara_integration_input.rb +268 -0
  85. data/lib/subskribe_dev2/models/billing_event_entry.rb +211 -0
  86. data/lib/subskribe_dev2/models/billing_event_input.rb +216 -0
  87. data/lib/subskribe_dev2/models/bulk_invoice_run.rb +350 -0
  88. data/lib/subskribe_dev2/models/bulk_invoice_run_exclusions.rb +197 -0
  89. data/lib/subskribe_dev2/models/bulk_invoice_run_input.rb +263 -0
  90. data/lib/subskribe_dev2/models/bulk_invoice_run_item.rb +364 -0
  91. data/lib/subskribe_dev2/models/bulk_invoice_run_selector.rb +184 -0
  92. data/lib/subskribe_dev2/models/bulk_payment_upload_data.rb +274 -0
  93. data/lib/subskribe_dev2/models/bulk_payment_upload_result.rb +204 -0
  94. data/lib/subskribe_dev2/models/byte_buffer.rb +247 -0
  95. data/lib/subskribe_dev2/models/catalog_relationship.rb +364 -0
  96. data/lib/subskribe_dev2/models/charge_json.rb +631 -0
  97. data/lib/subskribe_dev2/models/charge_partial_json.rb +310 -0
  98. data/lib/subskribe_dev2/models/company_contact_json.rb +225 -0
  99. data/lib/subskribe_dev2/models/credit_memo_application_json.rb +239 -0
  100. data/lib/subskribe_dev2/models/credit_memo_balance_json.rb +211 -0
  101. data/lib/subskribe_dev2/models/credit_memo_json.rb +363 -0
  102. data/lib/subskribe_dev2/models/credit_memo_line_item_json.rb +252 -0
  103. data/lib/subskribe_dev2/models/credit_memo_line_item_request_json.rb +211 -0
  104. data/lib/subskribe_dev2/models/credit_memo_pagination_response_json.rb +204 -0
  105. data/lib/subskribe_dev2/models/crm_account_import_response.rb +193 -0
  106. data/lib/subskribe_dev2/models/custom_field_default.rb +195 -0
  107. data/lib/subskribe_dev2/models/custom_field_definition_create_input.rb +317 -0
  108. data/lib/subskribe_dev2/models/custom_field_definition_json.rb +313 -0
  109. data/lib/subskribe_dev2/models/custom_field_definition_update_input.rb +256 -0
  110. data/lib/subskribe_dev2/models/custom_field_entry.rb +325 -0
  111. data/lib/subskribe_dev2/models/custom_field_update_input.rb +195 -0
  112. data/lib/subskribe_dev2/models/custom_field_value.rb +316 -0
  113. data/lib/subskribe_dev2/models/data_import.rb +355 -0
  114. data/lib/subskribe_dev2/models/discount_detail_json.rb +263 -0
  115. data/lib/subskribe_dev2/models/discount_json.rb +254 -0
  116. data/lib/subskribe_dev2/models/docu_sign_integration_request_json.rb +236 -0
  117. data/lib/subskribe_dev2/models/docu_sign_integration_response_json.rb +245 -0
  118. data/lib/subskribe_dev2/models/document_custom_content.rb +211 -0
  119. data/lib/subskribe_dev2/models/document_section.rb +265 -0
  120. data/lib/subskribe_dev2/models/document_template_json.rb +300 -0
  121. data/lib/subskribe_dev2/models/dunning_setting_json.rb +200 -0
  122. data/lib/subskribe_dev2/models/email_notifiers_list.rb +208 -0
  123. data/lib/subskribe_dev2/models/entity.rb +356 -0
  124. data/lib/subskribe_dev2/models/entity_json.rb +347 -0
  125. data/lib/subskribe_dev2/models/entity_ref.rb +202 -0
  126. data/lib/subskribe_dev2/models/entry.rb +202 -0
  127. data/lib/subskribe_dev2/models/external_arr_schedule_json.rb +319 -0
  128. data/lib/subskribe_dev2/models/flatfile_workbook_response.rb +184 -0
  129. data/lib/subskribe_dev2/models/flatfile_workbook_response_data.rb +193 -0
  130. data/lib/subskribe_dev2/models/input_stream.rb +175 -0
  131. data/lib/subskribe_dev2/models/integration.rb +311 -0
  132. data/lib/subskribe_dev2/models/invoice_balance_json.rb +211 -0
  133. data/lib/subskribe_dev2/models/invoice_item_json.rb +355 -0
  134. data/lib/subskribe_dev2/models/invoice_item_preview_json.rb +229 -0
  135. data/lib/subskribe_dev2/models/invoice_json.rb +439 -0
  136. data/lib/subskribe_dev2/models/invoice_json_pagination_response.rb +204 -0
  137. data/lib/subskribe_dev2/models/invoice_number_prefix.rb +184 -0
  138. data/lib/subskribe_dev2/models/invoice_preview_json.rb +222 -0
  139. data/lib/subskribe_dev2/models/ledger_account.rb +316 -0
  140. data/lib/subskribe_dev2/models/ledger_account_mapping.rb +222 -0
  141. data/lib/subskribe_dev2/models/metrics_json.rb +267 -0
  142. data/lib/subskribe_dev2/models/notification_target_and_subscriptions.rb +265 -0
  143. data/lib/subskribe_dev2/models/number_config.rb +254 -0
  144. data/lib/subskribe_dev2/models/opportunity.rb +326 -0
  145. data/lib/subskribe_dev2/models/opportunity_json.rb +326 -0
  146. data/lib/subskribe_dev2/models/opportunity_pagination_response.rb +204 -0
  147. data/lib/subskribe_dev2/models/opportunity_rest_json.rb +317 -0
  148. data/lib/subskribe_dev2/models/order_json.rb +754 -0
  149. data/lib/subskribe_dev2/models/order_json_pagination_response.rb +204 -0
  150. data/lib/subskribe_dev2/models/order_line_item_json.rb +474 -0
  151. data/lib/subskribe_dev2/models/order_line_item_request_json.rb +384 -0
  152. data/lib/subskribe_dev2/models/order_request_json.rb +616 -0
  153. data/lib/subskribe_dev2/models/order_terms.rb +265 -0
  154. data/lib/subskribe_dev2/models/paginated_accounts_response.rb +204 -0
  155. data/lib/subskribe_dev2/models/paginated_response.rb +204 -0
  156. data/lib/subskribe_dev2/models/payment_balance_json.rb +211 -0
  157. data/lib/subskribe_dev2/models/payment_configuration.rb +208 -0
  158. data/lib/subskribe_dev2/models/payment_json.rb +300 -0
  159. data/lib/subskribe_dev2/models/payment_json_pagination_response.rb +204 -0
  160. data/lib/subskribe_dev2/models/payment_term_settings_json.rb +219 -0
  161. data/lib/subskribe_dev2/models/plan_json.rb +339 -0
  162. data/lib/subskribe_dev2/models/plan_json_pagination_response.rb +204 -0
  163. data/lib/subskribe_dev2/models/plan_metadata_json.rb +187 -0
  164. data/lib/subskribe_dev2/models/predefined_report_def_chart_json.rb +265 -0
  165. data/lib/subskribe_dev2/models/predefined_report_def_json.rb +222 -0
  166. data/lib/subskribe_dev2/models/predefined_report_defs_json.rb +186 -0
  167. data/lib/subskribe_dev2/models/predefined_report_json.rb +213 -0
  168. data/lib/subskribe_dev2/models/predefined_report_param.rb +296 -0
  169. data/lib/subskribe_dev2/models/predefined_report_param_object.rb +296 -0
  170. data/lib/subskribe_dev2/models/prepaid_stats.rb +310 -0
  171. data/lib/subskribe_dev2/models/price_tier_json.rb +212 -0
  172. data/lib/subskribe_dev2/models/product_category.rb +264 -0
  173. data/lib/subskribe_dev2/models/product_category_pagination_response.rb +204 -0
  174. data/lib/subskribe_dev2/models/product_input_json.rb +249 -0
  175. data/lib/subskribe_dev2/models/product_json.rb +276 -0
  176. data/lib/subskribe_dev2/models/product_json_pagination_response.rb +204 -0
  177. data/lib/subskribe_dev2/models/purchase_order.rb +226 -0
  178. data/lib/subskribe_dev2/models/raw_usage.rb +247 -0
  179. data/lib/subskribe_dev2/models/raw_usages_data.rb +192 -0
  180. data/lib/subskribe_dev2/models/recognition_event_completion.rb +322 -0
  181. data/lib/subskribe_dev2/models/recognition_rule.rb +376 -0
  182. data/lib/subskribe_dev2/models/recurrence_json.rb +256 -0
  183. data/lib/subskribe_dev2/models/refund.rb +301 -0
  184. data/lib/subskribe_dev2/models/refund_detail.rb +322 -0
  185. data/lib/subskribe_dev2/models/refund_request_json.rb +272 -0
  186. data/lib/subskribe_dev2/models/report_duration.rb +193 -0
  187. data/lib/subskribe_dev2/models/report_job_response.rb +245 -0
  188. data/lib/subskribe_dev2/models/salesforce_account.rb +229 -0
  189. data/lib/subskribe_dev2/models/salesforce_account_billing_address.rb +220 -0
  190. data/lib/subskribe_dev2/models/salesforce_client_integration_request_json.rb +211 -0
  191. data/lib/subskribe_dev2/models/settlement_application.rb +329 -0
  192. data/lib/subskribe_dev2/models/standalone_credit_memo_request.rb +353 -0
  193. data/lib/subskribe_dev2/models/subscription_charge_alias.rb +283 -0
  194. data/lib/subskribe_dev2/models/subscription_charge_json.rb +362 -0
  195. data/lib/subskribe_dev2/models/subscription_json.rb +583 -0
  196. data/lib/subskribe_dev2/models/subscription_update_json.rb +280 -0
  197. data/lib/subskribe_dev2/models/tax_jar_integration.rb +238 -0
  198. data/lib/subskribe_dev2/models/tax_jar_integration_input.rb +193 -0
  199. data/lib/subskribe_dev2/models/tax_rate_json.rb +286 -0
  200. data/lib/subskribe_dev2/models/tax_rate_pagination_response_json.rb +204 -0
  201. data/lib/subskribe_dev2/models/tenant_credit_memo_configuration_json.rb +211 -0
  202. data/lib/subskribe_dev2/models/tenant_discount_json.rb +193 -0
  203. data/lib/subskribe_dev2/models/tenant_discount_line_item_json.rb +202 -0
  204. data/lib/subskribe_dev2/models/tenant_invoice_config.rb +254 -0
  205. data/lib/subskribe_dev2/models/tenant_json.rb +283 -0
  206. data/lib/subskribe_dev2/models/tenant_setting_json.rb +307 -0
  207. data/lib/subskribe_dev2/models/time_series_amount_json.rb +193 -0
  208. data/lib/subskribe_dev2/models/time_zone.rb +211 -0
  209. data/lib/subskribe_dev2/models/unit_of_measure_json.rb +250 -0
  210. data/lib/subskribe_dev2/models/unit_of_measure_pagination_response_json.rb +204 -0
  211. data/lib/subskribe_dev2/models/update_invoice_request.rb +282 -0
  212. data/lib/subskribe_dev2/models/usage_aggregate_output.rb +258 -0
  213. data/lib/subskribe_dev2/models/usage_batch_insert_result.rb +213 -0
  214. data/lib/subskribe_dev2/models/user_group_json.rb +224 -0
  215. data/lib/subskribe_dev2/models/user_group_request_json.rb +224 -0
  216. data/lib/subskribe_dev2/models/user_input.rb +304 -0
  217. data/lib/subskribe_dev2/models/user_json.rb +376 -0
  218. data/lib/subskribe_dev2/models/user_pagination_response_json.rb +204 -0
  219. data/lib/subskribe_dev2/models/void_invoice_request.rb +203 -0
  220. data/lib/subskribe_dev2/models/void_payment_json.rb +235 -0
  221. data/lib/subskribe_dev2/version.rb +15 -0
  222. data/lib/subskribe_dev2.rb +230 -0
  223. data/lib/subskribe_sandbox/api/accounts_api.rb +3 -3
  224. data/lib/subskribe_sandbox/api/billing_api.rb +35 -35
  225. data/lib/subskribe_sandbox/models/automated_invoice_rule.rb +49 -49
  226. data/lib/subskribe_sandbox/models/bulk_payment_upload_data.rb +46 -46
  227. data/lib/subskribe_sandbox/models/charge_json.rb +16 -16
  228. data/lib/subskribe_sandbox/models/paginated_accounts_response.rb +204 -0
  229. data/lib/subskribe_sandbox/models/tax_jar_integration.rb +31 -31
  230. data/lib/subskribe_sandbox/version.rb +1 -1
  231. data/lib/subskribe_sandbox.rb +1 -0
  232. data/lib/swagger_client/api/accounting_api.rb +193 -0
  233. data/lib/swagger_client/api/accounts_api.rb +858 -0
  234. data/lib/swagger_client/api/approvals_api.rb +965 -0
  235. data/lib/swagger_client/api/attachments_api.rb +299 -0
  236. data/lib/swagger_client/api/authentication_api.rb +335 -0
  237. data/lib/swagger_client/api/billing_api.rb +2098 -0
  238. data/lib/swagger_client/api/credit_memo_api.rb +636 -0
  239. data/lib/swagger_client/api/custom_field_api.rb +434 -0
  240. data/lib/swagger_client/api/customization_api.rb +269 -0
  241. data/lib/swagger_client/api/default_api.rb +223 -0
  242. data/lib/swagger_client/api/discounts_api.rb +340 -0
  243. data/lib/swagger_client/api/entities_api.rb +532 -0
  244. data/lib/swagger_client/api/erp_api.rb +278 -0
  245. data/lib/swagger_client/api/import_api.rb +568 -0
  246. data/lib/swagger_client/api/integrations_api.rb +1678 -0
  247. data/lib/swagger_client/api/metrics_reporting_api.rb +223 -0
  248. data/lib/swagger_client/api/notifications_api.rb +245 -0
  249. data/lib/swagger_client/api/opportunity_api.rb +177 -0
  250. data/lib/swagger_client/api/orders_api.rb +1381 -0
  251. data/lib/swagger_client/api/payments_api.rb +431 -0
  252. data/lib/swagger_client/api/product_catalog_api.rb +1886 -0
  253. data/lib/swagger_client/api/rate_card_api.rb +68 -0
  254. data/lib/swagger_client/api/refunds_api.rb +189 -0
  255. data/lib/swagger_client/api/reports_api.rb +227 -0
  256. data/lib/swagger_client/api/revenue_recognition_api.rb +484 -0
  257. data/lib/swagger_client/api/sales_room_api.rb +74 -0
  258. data/lib/swagger_client/api/settings_api.rb +1321 -0
  259. data/lib/swagger_client/api/subscriptions_api.rb +576 -0
  260. data/lib/swagger_client/api/usage_api.rb +604 -0
  261. data/lib/swagger_client/api/users_api.rb +728 -0
  262. data/lib/swagger_client/api_client.rb +391 -0
  263. data/lib/swagger_client/api_error.rb +38 -0
  264. data/lib/swagger_client/configuration.rb +209 -0
  265. data/lib/swagger_client/models/account_address.rb +265 -0
  266. data/lib/swagger_client/models/account_address_json.rb +229 -0
  267. data/lib/swagger_client/models/account_contact.rb +530 -0
  268. data/lib/swagger_client/models/account_contact_json.rb +274 -0
  269. data/lib/swagger_client/models/account_json.rb +395 -0
  270. data/lib/swagger_client/models/account_payment_method_json.rb +268 -0
  271. data/lib/swagger_client/models/account_receivable_contact_json.rb +225 -0
  272. data/lib/swagger_client/models/accounting_event.rb +319 -0
  273. data/lib/swagger_client/models/accounting_event_paginated_response.rb +204 -0
  274. data/lib/swagger_client/models/accounting_period.rb +356 -0
  275. data/lib/swagger_client/models/accounting_period_calculation.rb +229 -0
  276. data/lib/swagger_client/models/add_and_apply_payment_application_json.rb +344 -0
  277. data/lib/swagger_client/models/anrok_integration_input.rb +184 -0
  278. data/lib/swagger_client/models/approval_matrix_import_data_json.rb +229 -0
  279. data/lib/swagger_client/models/approval_matrix_import_preview.rb +226 -0
  280. data/lib/swagger_client/models/approval_role_json.rb +220 -0
  281. data/lib/swagger_client/models/approval_role_segment_change.rb +211 -0
  282. data/lib/swagger_client/models/approval_segment_json.rb +220 -0
  283. data/lib/swagger_client/models/attachment.rb +326 -0
  284. data/lib/swagger_client/models/attribute_reference.rb +193 -0
  285. data/lib/swagger_client/models/auth_saml_integration_json.rb +204 -0
  286. data/lib/swagger_client/models/automated_invoice_rule.rb +328 -0
  287. data/lib/swagger_client/models/automated_invoice_rule_request_json.rb +307 -0
  288. data/lib/swagger_client/models/avalara_integration.rb +238 -0
  289. data/lib/swagger_client/models/avalara_integration_input.rb +268 -0
  290. data/lib/swagger_client/models/billing_event_entry.rb +211 -0
  291. data/lib/swagger_client/models/billing_event_input.rb +216 -0
  292. data/lib/swagger_client/models/bulk_invoice_run.rb +350 -0
  293. data/lib/swagger_client/models/bulk_invoice_run_exclusions.rb +197 -0
  294. data/lib/swagger_client/models/bulk_invoice_run_input.rb +263 -0
  295. data/lib/swagger_client/models/bulk_invoice_run_item.rb +364 -0
  296. data/lib/swagger_client/models/bulk_invoice_run_selector.rb +184 -0
  297. data/lib/swagger_client/models/bulk_payment_upload_data.rb +274 -0
  298. data/lib/swagger_client/models/bulk_payment_upload_result.rb +204 -0
  299. data/lib/swagger_client/models/byte_buffer.rb +247 -0
  300. data/lib/swagger_client/models/catalog_relationship.rb +364 -0
  301. data/lib/swagger_client/models/charge_json.rb +631 -0
  302. data/lib/swagger_client/models/charge_partial_json.rb +310 -0
  303. data/lib/swagger_client/models/company_contact_json.rb +225 -0
  304. data/lib/swagger_client/models/credit_memo_application_json.rb +239 -0
  305. data/lib/swagger_client/models/credit_memo_balance_json.rb +211 -0
  306. data/lib/swagger_client/models/credit_memo_json.rb +363 -0
  307. data/lib/swagger_client/models/credit_memo_line_item_json.rb +252 -0
  308. data/lib/swagger_client/models/credit_memo_line_item_request_json.rb +211 -0
  309. data/lib/swagger_client/models/credit_memo_pagination_response_json.rb +204 -0
  310. data/lib/swagger_client/models/crm_account_import_response.rb +193 -0
  311. data/lib/swagger_client/models/custom_field_default.rb +195 -0
  312. data/lib/swagger_client/models/custom_field_definition_create_input.rb +317 -0
  313. data/lib/swagger_client/models/custom_field_definition_json.rb +313 -0
  314. data/lib/swagger_client/models/custom_field_definition_update_input.rb +256 -0
  315. data/lib/swagger_client/models/custom_field_entry.rb +325 -0
  316. data/lib/swagger_client/models/custom_field_update_input.rb +195 -0
  317. data/lib/swagger_client/models/custom_field_value.rb +316 -0
  318. data/lib/swagger_client/models/data_import.rb +355 -0
  319. data/lib/swagger_client/models/discount_detail_json.rb +263 -0
  320. data/lib/swagger_client/models/discount_json.rb +254 -0
  321. data/lib/swagger_client/models/docu_sign_integration_request_json.rb +236 -0
  322. data/lib/swagger_client/models/docu_sign_integration_response_json.rb +245 -0
  323. data/lib/swagger_client/models/document_custom_content.rb +211 -0
  324. data/lib/swagger_client/models/document_section.rb +265 -0
  325. data/lib/swagger_client/models/document_template_json.rb +300 -0
  326. data/lib/swagger_client/models/dunning_setting_json.rb +200 -0
  327. data/lib/swagger_client/models/email_notifiers_list.rb +208 -0
  328. data/lib/swagger_client/models/entity.rb +356 -0
  329. data/lib/swagger_client/models/entity_json.rb +347 -0
  330. data/lib/swagger_client/models/entity_ref.rb +202 -0
  331. data/lib/swagger_client/models/entry.rb +202 -0
  332. data/lib/swagger_client/models/external_arr_schedule_json.rb +319 -0
  333. data/lib/swagger_client/models/flatfile_workbook_response.rb +184 -0
  334. data/lib/swagger_client/models/flatfile_workbook_response_data.rb +193 -0
  335. data/lib/swagger_client/models/input_stream.rb +175 -0
  336. data/lib/swagger_client/models/integration.rb +311 -0
  337. data/lib/swagger_client/models/invoice_balance_json.rb +211 -0
  338. data/lib/swagger_client/models/invoice_item_json.rb +355 -0
  339. data/lib/swagger_client/models/invoice_item_preview_json.rb +229 -0
  340. data/lib/swagger_client/models/invoice_json.rb +439 -0
  341. data/lib/swagger_client/models/invoice_json_pagination_response.rb +204 -0
  342. data/lib/swagger_client/models/invoice_number_prefix.rb +184 -0
  343. data/lib/swagger_client/models/invoice_preview_json.rb +222 -0
  344. data/lib/swagger_client/models/ledger_account.rb +316 -0
  345. data/lib/swagger_client/models/ledger_account_mapping.rb +222 -0
  346. data/lib/swagger_client/models/metrics_json.rb +267 -0
  347. data/lib/swagger_client/models/notification_target_and_subscriptions.rb +265 -0
  348. data/lib/swagger_client/models/number_config.rb +254 -0
  349. data/lib/swagger_client/models/opportunity.rb +326 -0
  350. data/lib/swagger_client/models/opportunity_json.rb +326 -0
  351. data/lib/swagger_client/models/opportunity_pagination_response.rb +204 -0
  352. data/lib/swagger_client/models/opportunity_rest_json.rb +317 -0
  353. data/lib/swagger_client/models/order_json.rb +754 -0
  354. data/lib/swagger_client/models/order_json_pagination_response.rb +204 -0
  355. data/lib/swagger_client/models/order_line_item_json.rb +474 -0
  356. data/lib/swagger_client/models/order_line_item_request_json.rb +384 -0
  357. data/lib/swagger_client/models/order_request_json.rb +616 -0
  358. data/lib/swagger_client/models/order_terms.rb +265 -0
  359. data/lib/swagger_client/models/paginated_accounts_response.rb +204 -0
  360. data/lib/swagger_client/models/paginated_response.rb +204 -0
  361. data/lib/swagger_client/models/payment_balance_json.rb +211 -0
  362. data/lib/swagger_client/models/payment_configuration.rb +208 -0
  363. data/lib/swagger_client/models/payment_json.rb +300 -0
  364. data/lib/swagger_client/models/payment_json_pagination_response.rb +204 -0
  365. data/lib/swagger_client/models/payment_term_settings_json.rb +219 -0
  366. data/lib/swagger_client/models/plan_json.rb +339 -0
  367. data/lib/swagger_client/models/plan_json_pagination_response.rb +204 -0
  368. data/lib/swagger_client/models/plan_metadata_json.rb +187 -0
  369. data/lib/swagger_client/models/predefined_report_def_chart_json.rb +265 -0
  370. data/lib/swagger_client/models/predefined_report_def_json.rb +222 -0
  371. data/lib/swagger_client/models/predefined_report_defs_json.rb +186 -0
  372. data/lib/swagger_client/models/predefined_report_json.rb +213 -0
  373. data/lib/swagger_client/models/predefined_report_param.rb +296 -0
  374. data/lib/swagger_client/models/predefined_report_param_object.rb +296 -0
  375. data/lib/swagger_client/models/prepaid_stats.rb +310 -0
  376. data/lib/swagger_client/models/price_tier_json.rb +212 -0
  377. data/lib/swagger_client/models/product_category.rb +264 -0
  378. data/lib/swagger_client/models/product_category_pagination_response.rb +204 -0
  379. data/lib/swagger_client/models/product_input_json.rb +249 -0
  380. data/lib/swagger_client/models/product_json.rb +276 -0
  381. data/lib/swagger_client/models/product_json_pagination_response.rb +204 -0
  382. data/lib/swagger_client/models/purchase_order.rb +226 -0
  383. data/lib/swagger_client/models/raw_usage.rb +247 -0
  384. data/lib/swagger_client/models/raw_usages_data.rb +192 -0
  385. data/lib/swagger_client/models/recognition_event_completion.rb +322 -0
  386. data/lib/swagger_client/models/recognition_rule.rb +376 -0
  387. data/lib/swagger_client/models/recurrence_json.rb +256 -0
  388. data/lib/swagger_client/models/refund.rb +301 -0
  389. data/lib/swagger_client/models/refund_detail.rb +322 -0
  390. data/lib/swagger_client/models/refund_request_json.rb +272 -0
  391. data/lib/swagger_client/models/report_duration.rb +193 -0
  392. data/lib/swagger_client/models/report_job_response.rb +245 -0
  393. data/lib/swagger_client/models/salesforce_account.rb +229 -0
  394. data/lib/swagger_client/models/salesforce_account_billing_address.rb +220 -0
  395. data/lib/swagger_client/models/salesforce_client_integration_request_json.rb +211 -0
  396. data/lib/swagger_client/models/settlement_application.rb +329 -0
  397. data/lib/swagger_client/models/standalone_credit_memo_request.rb +353 -0
  398. data/lib/swagger_client/models/subscription_charge_alias.rb +283 -0
  399. data/lib/swagger_client/models/subscription_charge_json.rb +362 -0
  400. data/lib/swagger_client/models/subscription_json.rb +583 -0
  401. data/lib/swagger_client/models/subscription_update_json.rb +280 -0
  402. data/lib/swagger_client/models/tax_jar_integration.rb +238 -0
  403. data/lib/swagger_client/models/tax_jar_integration_input.rb +193 -0
  404. data/lib/swagger_client/models/tax_rate_json.rb +286 -0
  405. data/lib/swagger_client/models/tax_rate_pagination_response_json.rb +204 -0
  406. data/lib/swagger_client/models/tenant_credit_memo_configuration_json.rb +211 -0
  407. data/lib/swagger_client/models/tenant_discount_json.rb +193 -0
  408. data/lib/swagger_client/models/tenant_discount_line_item_json.rb +202 -0
  409. data/lib/swagger_client/models/tenant_invoice_config.rb +254 -0
  410. data/lib/swagger_client/models/tenant_json.rb +283 -0
  411. data/lib/swagger_client/models/tenant_setting_json.rb +307 -0
  412. data/lib/swagger_client/models/time_series_amount_json.rb +193 -0
  413. data/lib/swagger_client/models/time_zone.rb +211 -0
  414. data/lib/swagger_client/models/unit_of_measure_json.rb +250 -0
  415. data/lib/swagger_client/models/unit_of_measure_pagination_response_json.rb +204 -0
  416. data/lib/swagger_client/models/update_invoice_request.rb +282 -0
  417. data/lib/swagger_client/models/usage_aggregate_output.rb +258 -0
  418. data/lib/swagger_client/models/usage_batch_insert_result.rb +213 -0
  419. data/lib/swagger_client/models/user_group_json.rb +224 -0
  420. data/lib/swagger_client/models/user_group_request_json.rb +224 -0
  421. data/lib/swagger_client/models/user_input.rb +304 -0
  422. data/lib/swagger_client/models/user_json.rb +376 -0
  423. data/lib/swagger_client/models/user_pagination_response_json.rb +204 -0
  424. data/lib/swagger_client/models/void_invoice_request.rb +203 -0
  425. data/lib/swagger_client/models/void_payment_json.rb +235 -0
  426. data/lib/swagger_client/version.rb +15 -0
  427. data/lib/swagger_client.rb +230 -0
  428. data/spec/models/paginated_accounts_response_spec.rb +53 -0
  429. data/spec/models/plan_metadata_json_spec.rb +3 -3
  430. data/subskribe_dev-1.3.1.gem +0 -0
  431. data/subskribe_dev.gemspec +4 -4
  432. data/subskribe_dev2-1.3.2.gem +0 -0
  433. data/subskribe_dev2.gemspec +46 -0
  434. data/subskribe_sandbox.gemspec +3 -3
  435. data/swagger_client.gemspec +46 -0
  436. metadata +589 -187
@@ -0,0 +1,728 @@
1
+ =begin
2
+ #Subskribe API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 2.4.41
10
+
11
+ =end
12
+
13
+ require 'uri'
14
+
15
+ module SwaggerClient
16
+ class UsersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Accept terms and conditions
23
+ # Before a user gains access to the application, they must accept Subskribe's terms and conditions. This operation requires user bound access tokens.
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [nil]
26
+ def accept_terms_for_current_user(opts = {})
27
+ accept_terms_for_current_user_with_http_info(opts)
28
+ nil
29
+ end
30
+
31
+ # Accept terms and conditions
32
+ # Before a user gains access to the application, they must accept Subskribe's terms and conditions. This operation requires user bound access tokens.
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
35
+ def accept_terms_for_current_user_with_http_info(opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: UsersApi.accept_terms_for_current_user ...'
38
+ end
39
+ # resource path
40
+ local_var_path = '/users/terms-and-conditions'
41
+
42
+ # query parameters
43
+ query_params = {}
44
+
45
+ # header parameters
46
+ header_params = {}
47
+ # HTTP header 'Accept' (if needed)
48
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
49
+
50
+ # form parameters
51
+ form_params = {}
52
+
53
+ # http body (model)
54
+ post_body = nil
55
+ auth_names = ['ApiKeyAuth']
56
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
57
+ :header_params => header_params,
58
+ :query_params => query_params,
59
+ :form_params => form_params,
60
+ :body => post_body,
61
+ :auth_names => auth_names)
62
+ if @api_client.config.debugging
63
+ @api_client.config.logger.debug "API called: UsersApi#accept_terms_for_current_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
64
+ end
65
+ return data, status_code, headers
66
+ end
67
+ # Add a new user
68
+ # Add a new user to the system. Users in the system must have unique emails. If successful, the path to the new user object is returned and a welcome email containing a temporary password will be sent to the email associated with the user. The login credentials expires in 24 hours. If the user does not login to the system within that time, a new invitation is required.
69
+ # @param [Hash] opts the optional parameters
70
+ # @option opts [UserInput] :body
71
+ # @return [String]
72
+ def add_user(opts = {})
73
+ data, _status_code, _headers = add_user_with_http_info(opts)
74
+ data
75
+ end
76
+
77
+ # Add a new user
78
+ # Add a new user to the system. Users in the system must have unique emails. If successful, the path to the new user object is returned and a welcome email containing a temporary password will be sent to the email associated with the user. The login credentials expires in 24 hours. If the user does not login to the system within that time, a new invitation is required.
79
+ # @param [Hash] opts the optional parameters
80
+ # @option opts [UserInput] :body
81
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
82
+ def add_user_with_http_info(opts = {})
83
+ if @api_client.config.debugging
84
+ @api_client.config.logger.debug 'Calling API: UsersApi.add_user ...'
85
+ end
86
+ # resource path
87
+ local_var_path = '/users'
88
+
89
+ # query parameters
90
+ query_params = {}
91
+
92
+ # header parameters
93
+ header_params = {}
94
+ # HTTP header 'Accept' (if needed)
95
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
96
+ # HTTP header 'Content-Type'
97
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
98
+
99
+ # form parameters
100
+ form_params = {}
101
+
102
+ # http body (model)
103
+ post_body = @api_client.object_to_http_body(opts[:'body'])
104
+ auth_names = ['ApiKeyAuth']
105
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
106
+ :header_params => header_params,
107
+ :query_params => query_params,
108
+ :form_params => form_params,
109
+ :body => post_body,
110
+ :auth_names => auth_names,
111
+ :return_type => 'String')
112
+ if @api_client.config.debugging
113
+ @api_client.config.logger.debug "API called: UsersApi#add_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
114
+ end
115
+ return data, status_code, headers
116
+ end
117
+ # Add user group
118
+ # Create a new user group based on the parameters in the input
119
+ # @param [Hash] opts the optional parameters
120
+ # @option opts [UserGroupRequestJson] :body
121
+ # @return [UserGroupJson]
122
+ def add_user_group(opts = {})
123
+ data, _status_code, _headers = add_user_group_with_http_info(opts)
124
+ data
125
+ end
126
+
127
+ # Add user group
128
+ # Create a new user group based on the parameters in the input
129
+ # @param [Hash] opts the optional parameters
130
+ # @option opts [UserGroupRequestJson] :body
131
+ # @return [Array<(UserGroupJson, Fixnum, Hash)>] UserGroupJson data, response status code and response headers
132
+ def add_user_group_with_http_info(opts = {})
133
+ if @api_client.config.debugging
134
+ @api_client.config.logger.debug 'Calling API: UsersApi.add_user_group ...'
135
+ end
136
+ # resource path
137
+ local_var_path = '/userGroups'
138
+
139
+ # query parameters
140
+ query_params = {}
141
+
142
+ # header parameters
143
+ header_params = {}
144
+ # HTTP header 'Accept' (if needed)
145
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
146
+
147
+ # form parameters
148
+ form_params = {}
149
+
150
+ # http body (model)
151
+ post_body = @api_client.object_to_http_body(opts[:'body'])
152
+ auth_names = ['ApiKeyAuth']
153
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
154
+ :header_params => header_params,
155
+ :query_params => query_params,
156
+ :form_params => form_params,
157
+ :body => post_body,
158
+ :auth_names => auth_names,
159
+ :return_type => 'UserGroupJson')
160
+ if @api_client.config.debugging
161
+ @api_client.config.logger.debug "API called: UsersApi#add_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
162
+ end
163
+ return data, status_code, headers
164
+ end
165
+ # Delete user group
166
+ # Delete the user group by Id
167
+ # @param user_group_id
168
+ # @param [Hash] opts the optional parameters
169
+ # @return [UserGroupJson]
170
+ def delete_user_group(user_group_id, opts = {})
171
+ data, _status_code, _headers = delete_user_group_with_http_info(user_group_id, opts)
172
+ data
173
+ end
174
+
175
+ # Delete user group
176
+ # Delete the user group by Id
177
+ # @param user_group_id
178
+ # @param [Hash] opts the optional parameters
179
+ # @return [Array<(UserGroupJson, Fixnum, Hash)>] UserGroupJson data, response status code and response headers
180
+ def delete_user_group_with_http_info(user_group_id, opts = {})
181
+ if @api_client.config.debugging
182
+ @api_client.config.logger.debug 'Calling API: UsersApi.delete_user_group ...'
183
+ end
184
+ # verify the required parameter 'user_group_id' is set
185
+ if @api_client.config.client_side_validation && user_group_id.nil?
186
+ fail ArgumentError, "Missing the required parameter 'user_group_id' when calling UsersApi.delete_user_group"
187
+ end
188
+ # resource path
189
+ local_var_path = '/userGroups/{userGroupId}'.sub('{' + 'userGroupId' + '}', user_group_id.to_s)
190
+
191
+ # query parameters
192
+ query_params = {}
193
+
194
+ # header parameters
195
+ header_params = {}
196
+ # HTTP header 'Accept' (if needed)
197
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
198
+
199
+ # form parameters
200
+ form_params = {}
201
+
202
+ # http body (model)
203
+ post_body = nil
204
+ auth_names = ['ApiKeyAuth']
205
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
206
+ :header_params => header_params,
207
+ :query_params => query_params,
208
+ :form_params => form_params,
209
+ :body => post_body,
210
+ :auth_names => auth_names,
211
+ :return_type => 'UserGroupJson')
212
+ if @api_client.config.debugging
213
+ @api_client.config.logger.debug "API called: UsersApi#delete_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
214
+ end
215
+ return data, status_code, headers
216
+ end
217
+ # Disable user
218
+ # Disables a user by Id. If successful, returns the user just disabled
219
+ # @param id
220
+ # @param [Hash] opts the optional parameters
221
+ # @return [UserJson]
222
+ def disable_user(id, opts = {})
223
+ data, _status_code, _headers = disable_user_with_http_info(id, opts)
224
+ data
225
+ end
226
+
227
+ # Disable user
228
+ # Disables a user by Id. If successful, returns the user just disabled
229
+ # @param id
230
+ # @param [Hash] opts the optional parameters
231
+ # @return [Array<(UserJson, Fixnum, Hash)>] UserJson data, response status code and response headers
232
+ def disable_user_with_http_info(id, opts = {})
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug 'Calling API: UsersApi.disable_user ...'
235
+ end
236
+ # verify the required parameter 'id' is set
237
+ if @api_client.config.client_side_validation && id.nil?
238
+ fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.disable_user"
239
+ end
240
+ # resource path
241
+ local_var_path = '/users/disable/{id}'.sub('{' + 'id' + '}', id.to_s)
242
+
243
+ # query parameters
244
+ query_params = {}
245
+
246
+ # header parameters
247
+ header_params = {}
248
+ # HTTP header 'Accept' (if needed)
249
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
250
+
251
+ # form parameters
252
+ form_params = {}
253
+
254
+ # http body (model)
255
+ post_body = nil
256
+ auth_names = ['ApiKeyAuth']
257
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
258
+ :header_params => header_params,
259
+ :query_params => query_params,
260
+ :form_params => form_params,
261
+ :body => post_body,
262
+ :auth_names => auth_names,
263
+ :return_type => 'UserJson')
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug "API called: UsersApi#disable_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
266
+ end
267
+ return data, status_code, headers
268
+ end
269
+ # Enable user
270
+ # Enables a user by Id. If successful, returns the user just enabled
271
+ # @param id
272
+ # @param [Hash] opts the optional parameters
273
+ # @return [UserJson]
274
+ def enable_user(id, opts = {})
275
+ data, _status_code, _headers = enable_user_with_http_info(id, opts)
276
+ data
277
+ end
278
+
279
+ # Enable user
280
+ # Enables a user by Id. If successful, returns the user just enabled
281
+ # @param id
282
+ # @param [Hash] opts the optional parameters
283
+ # @return [Array<(UserJson, Fixnum, Hash)>] UserJson data, response status code and response headers
284
+ def enable_user_with_http_info(id, opts = {})
285
+ if @api_client.config.debugging
286
+ @api_client.config.logger.debug 'Calling API: UsersApi.enable_user ...'
287
+ end
288
+ # verify the required parameter 'id' is set
289
+ if @api_client.config.client_side_validation && id.nil?
290
+ fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.enable_user"
291
+ end
292
+ # resource path
293
+ local_var_path = '/users/enable/{id}'.sub('{' + 'id' + '}', id.to_s)
294
+
295
+ # query parameters
296
+ query_params = {}
297
+
298
+ # header parameters
299
+ header_params = {}
300
+ # HTTP header 'Accept' (if needed)
301
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
302
+
303
+ # form parameters
304
+ form_params = {}
305
+
306
+ # http body (model)
307
+ post_body = nil
308
+ auth_names = ['ApiKeyAuth']
309
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
310
+ :header_params => header_params,
311
+ :query_params => query_params,
312
+ :form_params => form_params,
313
+ :body => post_body,
314
+ :auth_names => auth_names,
315
+ :return_type => 'UserJson')
316
+ if @api_client.config.debugging
317
+ @api_client.config.logger.debug "API called: UsersApi#enable_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
318
+ end
319
+ return data, status_code, headers
320
+ end
321
+ # Get user by Id
322
+ # Returns a specific user by Id
323
+ # @param id
324
+ # @param [Hash] opts the optional parameters
325
+ # @return [UserJson]
326
+ def get_user(id, opts = {})
327
+ data, _status_code, _headers = get_user_with_http_info(id, opts)
328
+ data
329
+ end
330
+
331
+ # Get user by Id
332
+ # Returns a specific user by Id
333
+ # @param id
334
+ # @param [Hash] opts the optional parameters
335
+ # @return [Array<(UserJson, Fixnum, Hash)>] UserJson data, response status code and response headers
336
+ def get_user_with_http_info(id, opts = {})
337
+ if @api_client.config.debugging
338
+ @api_client.config.logger.debug 'Calling API: UsersApi.get_user ...'
339
+ end
340
+ # verify the required parameter 'id' is set
341
+ if @api_client.config.client_side_validation && id.nil?
342
+ fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.get_user"
343
+ end
344
+ # resource path
345
+ local_var_path = '/users/{id}'.sub('{' + 'id' + '}', id.to_s)
346
+
347
+ # query parameters
348
+ query_params = {}
349
+
350
+ # header parameters
351
+ header_params = {}
352
+ # HTTP header 'Accept' (if needed)
353
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
354
+
355
+ # form parameters
356
+ form_params = {}
357
+
358
+ # http body (model)
359
+ post_body = nil
360
+ auth_names = ['ApiKeyAuth']
361
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
362
+ :header_params => header_params,
363
+ :query_params => query_params,
364
+ :form_params => form_params,
365
+ :body => post_body,
366
+ :auth_names => auth_names,
367
+ :return_type => 'UserJson')
368
+ if @api_client.config.debugging
369
+ @api_client.config.logger.debug "API called: UsersApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
370
+ end
371
+ return data, status_code, headers
372
+ end
373
+ # Get user group
374
+ # Retrieve a user group by Id
375
+ # @param user_group_id
376
+ # @param [Hash] opts the optional parameters
377
+ # @return [UserGroupJson]
378
+ def get_user_group(user_group_id, opts = {})
379
+ data, _status_code, _headers = get_user_group_with_http_info(user_group_id, opts)
380
+ data
381
+ end
382
+
383
+ # Get user group
384
+ # Retrieve a user group by Id
385
+ # @param user_group_id
386
+ # @param [Hash] opts the optional parameters
387
+ # @return [Array<(UserGroupJson, Fixnum, Hash)>] UserGroupJson data, response status code and response headers
388
+ def get_user_group_with_http_info(user_group_id, opts = {})
389
+ if @api_client.config.debugging
390
+ @api_client.config.logger.debug 'Calling API: UsersApi.get_user_group ...'
391
+ end
392
+ # verify the required parameter 'user_group_id' is set
393
+ if @api_client.config.client_side_validation && user_group_id.nil?
394
+ fail ArgumentError, "Missing the required parameter 'user_group_id' when calling UsersApi.get_user_group"
395
+ end
396
+ # resource path
397
+ local_var_path = '/userGroups/{userGroupId}'.sub('{' + 'userGroupId' + '}', user_group_id.to_s)
398
+
399
+ # query parameters
400
+ query_params = {}
401
+
402
+ # header parameters
403
+ header_params = {}
404
+ # HTTP header 'Accept' (if needed)
405
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
406
+
407
+ # form parameters
408
+ form_params = {}
409
+
410
+ # http body (model)
411
+ post_body = nil
412
+ auth_names = ['ApiKeyAuth']
413
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
414
+ :header_params => header_params,
415
+ :query_params => query_params,
416
+ :form_params => form_params,
417
+ :body => post_body,
418
+ :auth_names => auth_names,
419
+ :return_type => 'UserGroupJson')
420
+ if @api_client.config.debugging
421
+ @api_client.config.logger.debug "API called: UsersApi#get_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
422
+ end
423
+ return data, status_code, headers
424
+ end
425
+ # Get user groups
426
+ # Get all available user groups
427
+ # @param [Hash] opts the optional parameters
428
+ # @return [Array<UserGroupJson>]
429
+ def get_user_groups(opts = {})
430
+ data, _status_code, _headers = get_user_groups_with_http_info(opts)
431
+ data
432
+ end
433
+
434
+ # Get user groups
435
+ # Get all available user groups
436
+ # @param [Hash] opts the optional parameters
437
+ # @return [Array<(Array<UserGroupJson>, Fixnum, Hash)>] Array<UserGroupJson> data, response status code and response headers
438
+ def get_user_groups_with_http_info(opts = {})
439
+ if @api_client.config.debugging
440
+ @api_client.config.logger.debug 'Calling API: UsersApi.get_user_groups ...'
441
+ end
442
+ # resource path
443
+ local_var_path = '/userGroups'
444
+
445
+ # query parameters
446
+ query_params = {}
447
+
448
+ # header parameters
449
+ header_params = {}
450
+ # HTTP header 'Accept' (if needed)
451
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
452
+
453
+ # form parameters
454
+ form_params = {}
455
+
456
+ # http body (model)
457
+ post_body = nil
458
+ auth_names = ['ApiKeyAuth']
459
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
460
+ :header_params => header_params,
461
+ :query_params => query_params,
462
+ :form_params => form_params,
463
+ :body => post_body,
464
+ :auth_names => auth_names,
465
+ :return_type => 'Array<UserGroupJson>')
466
+ if @api_client.config.debugging
467
+ @api_client.config.logger.debug "API called: UsersApi#get_user_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
468
+ end
469
+ return data, status_code, headers
470
+ end
471
+ # Get users list
472
+ # Returns a paginated list of users
473
+ # @param [Hash] opts the optional parameters
474
+ # @option opts [String] :cursor
475
+ # @option opts [Integer] :limit
476
+ # @return [UserPaginationResponseJson]
477
+ def get_users(opts = {})
478
+ data, _status_code, _headers = get_users_with_http_info(opts)
479
+ data
480
+ end
481
+
482
+ # Get users list
483
+ # Returns a paginated list of users
484
+ # @param [Hash] opts the optional parameters
485
+ # @option opts [String] :cursor
486
+ # @option opts [Integer] :limit
487
+ # @return [Array<(UserPaginationResponseJson, Fixnum, Hash)>] UserPaginationResponseJson data, response status code and response headers
488
+ def get_users_with_http_info(opts = {})
489
+ if @api_client.config.debugging
490
+ @api_client.config.logger.debug 'Calling API: UsersApi.get_users ...'
491
+ end
492
+ # resource path
493
+ local_var_path = '/users'
494
+
495
+ # query parameters
496
+ query_params = {}
497
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
498
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
499
+
500
+ # header parameters
501
+ header_params = {}
502
+ # HTTP header 'Accept' (if needed)
503
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
504
+
505
+ # form parameters
506
+ form_params = {}
507
+
508
+ # http body (model)
509
+ post_body = nil
510
+ auth_names = ['ApiKeyAuth']
511
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
512
+ :header_params => header_params,
513
+ :query_params => query_params,
514
+ :form_params => form_params,
515
+ :body => post_body,
516
+ :auth_names => auth_names,
517
+ :return_type => 'UserPaginationResponseJson')
518
+ if @api_client.config.debugging
519
+ @api_client.config.logger.debug "API called: UsersApi#get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
520
+ end
521
+ return data, status_code, headers
522
+ end
523
+ # Resend welcome email
524
+ # Resend welcome email conditioning temporary credentials. This is required if the user does not register within 24 hours of user activation
525
+ # @param email
526
+ # @param [Hash] opts the optional parameters
527
+ # @return [String]
528
+ def resend_email_for_existing_user(email, opts = {})
529
+ data, _status_code, _headers = resend_email_for_existing_user_with_http_info(email, opts)
530
+ data
531
+ end
532
+
533
+ # Resend welcome email
534
+ # Resend welcome email conditioning temporary credentials. This is required if the user does not register within 24 hours of user activation
535
+ # @param email
536
+ # @param [Hash] opts the optional parameters
537
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
538
+ def resend_email_for_existing_user_with_http_info(email, opts = {})
539
+ if @api_client.config.debugging
540
+ @api_client.config.logger.debug 'Calling API: UsersApi.resend_email_for_existing_user ...'
541
+ end
542
+ # verify the required parameter 'email' is set
543
+ if @api_client.config.client_side_validation && email.nil?
544
+ fail ArgumentError, "Missing the required parameter 'email' when calling UsersApi.resend_email_for_existing_user"
545
+ end
546
+ # resource path
547
+ local_var_path = '/users/resend-email/{email}'.sub('{' + 'email' + '}', email.to_s)
548
+
549
+ # query parameters
550
+ query_params = {}
551
+
552
+ # header parameters
553
+ header_params = {}
554
+ # HTTP header 'Accept' (if needed)
555
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
556
+
557
+ # form parameters
558
+ form_params = {}
559
+
560
+ # http body (model)
561
+ post_body = nil
562
+ auth_names = ['ApiKeyAuth']
563
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
564
+ :header_params => header_params,
565
+ :query_params => query_params,
566
+ :form_params => form_params,
567
+ :body => post_body,
568
+ :auth_names => auth_names,
569
+ :return_type => 'String')
570
+ if @api_client.config.debugging
571
+ @api_client.config.logger.debug "API called: UsersApi#resend_email_for_existing_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
572
+ end
573
+ return data, status_code, headers
574
+ end
575
+ # Update user
576
+ # Updates the user information. Email cannot be updated.
577
+ # @param id
578
+ # @param [Hash] opts the optional parameters
579
+ # @option opts [UserInput] :body
580
+ # @return [nil]
581
+ def update_user(id, opts = {})
582
+ update_user_with_http_info(id, opts)
583
+ nil
584
+ end
585
+
586
+ # Update user
587
+ # Updates the user information. Email cannot be updated.
588
+ # @param id
589
+ # @param [Hash] opts the optional parameters
590
+ # @option opts [UserInput] :body
591
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
592
+ def update_user_with_http_info(id, opts = {})
593
+ if @api_client.config.debugging
594
+ @api_client.config.logger.debug 'Calling API: UsersApi.update_user ...'
595
+ end
596
+ # verify the required parameter 'id' is set
597
+ if @api_client.config.client_side_validation && id.nil?
598
+ fail ArgumentError, "Missing the required parameter 'id' when calling UsersApi.update_user"
599
+ end
600
+ # resource path
601
+ local_var_path = '/users/{id}'.sub('{' + 'id' + '}', id.to_s)
602
+
603
+ # query parameters
604
+ query_params = {}
605
+
606
+ # header parameters
607
+ header_params = {}
608
+ # HTTP header 'Accept' (if needed)
609
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
610
+ # HTTP header 'Content-Type'
611
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
612
+
613
+ # form parameters
614
+ form_params = {}
615
+
616
+ # http body (model)
617
+ post_body = @api_client.object_to_http_body(opts[:'body'])
618
+ auth_names = ['ApiKeyAuth']
619
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
620
+ :header_params => header_params,
621
+ :query_params => query_params,
622
+ :form_params => form_params,
623
+ :body => post_body,
624
+ :auth_names => auth_names)
625
+ if @api_client.config.debugging
626
+ @api_client.config.logger.debug "API called: UsersApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
627
+ end
628
+ return data, status_code, headers
629
+ end
630
+ # Update user group
631
+ # Updates the specified user group according to the input
632
+ # @param [Hash] opts the optional parameters
633
+ # @option opts [UserGroupRequestJson] :body
634
+ # @return [UserGroupJson]
635
+ def update_user_group(opts = {})
636
+ data, _status_code, _headers = update_user_group_with_http_info(opts)
637
+ data
638
+ end
639
+
640
+ # Update user group
641
+ # Updates the specified user group according to the input
642
+ # @param [Hash] opts the optional parameters
643
+ # @option opts [UserGroupRequestJson] :body
644
+ # @return [Array<(UserGroupJson, Fixnum, Hash)>] UserGroupJson data, response status code and response headers
645
+ def update_user_group_with_http_info(opts = {})
646
+ if @api_client.config.debugging
647
+ @api_client.config.logger.debug 'Calling API: UsersApi.update_user_group ...'
648
+ end
649
+ # resource path
650
+ local_var_path = '/userGroups'
651
+
652
+ # query parameters
653
+ query_params = {}
654
+
655
+ # header parameters
656
+ header_params = {}
657
+ # HTTP header 'Accept' (if needed)
658
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
659
+
660
+ # form parameters
661
+ form_params = {}
662
+
663
+ # http body (model)
664
+ post_body = @api_client.object_to_http_body(opts[:'body'])
665
+ auth_names = ['ApiKeyAuth']
666
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
667
+ :header_params => header_params,
668
+ :query_params => query_params,
669
+ :form_params => form_params,
670
+ :body => post_body,
671
+ :auth_names => auth_names,
672
+ :return_type => 'UserGroupJson')
673
+ if @api_client.config.debugging
674
+ @api_client.config.logger.debug "API called: UsersApi#update_user_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
675
+ end
676
+ return data, status_code, headers
677
+ end
678
+ # Bulk user upload
679
+ # Loads a list of users to be added to in CSV format.
680
+ # @param [Hash] opts the optional parameters
681
+ # @option opts [InputStream] :body
682
+ # @return [nil]
683
+ def upload_csv(opts = {})
684
+ upload_csv_with_http_info(opts)
685
+ nil
686
+ end
687
+
688
+ # Bulk user upload
689
+ # Loads a list of users to be added to in CSV format.
690
+ # @param [Hash] opts the optional parameters
691
+ # @option opts [InputStream] :body
692
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
693
+ def upload_csv_with_http_info(opts = {})
694
+ if @api_client.config.debugging
695
+ @api_client.config.logger.debug 'Calling API: UsersApi.upload_csv ...'
696
+ end
697
+ # resource path
698
+ local_var_path = '/users/upload'
699
+
700
+ # query parameters
701
+ query_params = {}
702
+
703
+ # header parameters
704
+ header_params = {}
705
+ # HTTP header 'Accept' (if needed)
706
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
707
+ # HTTP header 'Content-Type'
708
+ header_params['Content-Type'] = @api_client.select_header_content_type(['text/csv'])
709
+
710
+ # form parameters
711
+ form_params = {}
712
+
713
+ # http body (model)
714
+ post_body = @api_client.object_to_http_body(opts[:'body'])
715
+ auth_names = ['ApiKeyAuth']
716
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
717
+ :header_params => header_params,
718
+ :query_params => query_params,
719
+ :form_params => form_params,
720
+ :body => post_body,
721
+ :auth_names => auth_names)
722
+ if @api_client.config.debugging
723
+ @api_client.config.logger.debug "API called: UsersApi#upload_csv\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
724
+ end
725
+ return data, status_code, headers
726
+ end
727
+ end
728
+ end