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,299 @@
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 SubskribeDevClient
16
+ class AttachmentsApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Add an attachment
23
+ # Attaches a document to the specified account. The post body should contain the body of the document that is to be attached. On success the Id of the attachment is returned.
24
+ # @param account_id id of the account to attach the document to
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [File] :file
27
+ # @option opts [String] :file_name name to associate with the attachment
28
+ # @option opts [String] :description description of the document
29
+ # @option opts [Integer] :size size in bytes of the document
30
+ # @option opts [String] :tag tag to apply to the attachment
31
+ # @return [Attachment]
32
+ def add_attachment_to_account(account_id, opts = {})
33
+ data, _status_code, _headers = add_attachment_to_account_with_http_info(account_id, opts)
34
+ data
35
+ end
36
+
37
+ # Add an attachment
38
+ # Attaches a document to the specified account. The post body should contain the body of the document that is to be attached. On success the Id of the attachment is returned.
39
+ # @param account_id id of the account to attach the document to
40
+ # @param [Hash] opts the optional parameters
41
+ # @option opts [File] :file
42
+ # @option opts [String] :file_name name to associate with the attachment
43
+ # @option opts [String] :description description of the document
44
+ # @option opts [Integer] :size size in bytes of the document
45
+ # @option opts [String] :tag tag to apply to the attachment
46
+ # @return [Array<(Attachment, Fixnum, Hash)>] Attachment data, response status code and response headers
47
+ def add_attachment_to_account_with_http_info(account_id, opts = {})
48
+ if @api_client.config.debugging
49
+ @api_client.config.logger.debug 'Calling API: AttachmentsApi.add_attachment_to_account ...'
50
+ end
51
+ # verify the required parameter 'account_id' is set
52
+ if @api_client.config.client_side_validation && account_id.nil?
53
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AttachmentsApi.add_attachment_to_account"
54
+ end
55
+ if @api_client.config.client_side_validation && opts[:'tag'] && !['MASTER_SUBSCRIPTION_AGREEMENT', 'STATEMENT_OF_WORK', 'ORDER_FORM', 'OTHER'].include?(opts[:'tag'])
56
+ fail ArgumentError, 'invalid value for "tag", must be one of MASTER_SUBSCRIPTION_AGREEMENT, STATEMENT_OF_WORK, ORDER_FORM, OTHER'
57
+ end
58
+ # resource path
59
+ local_var_path = '/attachments/account/{accountId}'.sub('{' + 'accountId' + '}', account_id.to_s)
60
+
61
+ # query parameters
62
+ query_params = {}
63
+ query_params[:'fileName'] = opts[:'file_name'] if !opts[:'file_name'].nil?
64
+ query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
65
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
66
+ query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
67
+
68
+ # header parameters
69
+ header_params = {}
70
+ # HTTP header 'Accept' (if needed)
71
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
72
+ # HTTP header 'Content-Type'
73
+ header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
74
+
75
+ # form parameters
76
+ form_params = {}
77
+ form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
78
+
79
+ # http body (model)
80
+ post_body = nil
81
+ auth_names = ['ApiKeyAuth']
82
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
83
+ :header_params => header_params,
84
+ :query_params => query_params,
85
+ :form_params => form_params,
86
+ :body => post_body,
87
+ :auth_names => auth_names,
88
+ :return_type => 'Attachment')
89
+ if @api_client.config.debugging
90
+ @api_client.config.logger.debug "API called: AttachmentsApi#add_attachment_to_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
91
+ end
92
+ return data, status_code, headers
93
+ end
94
+ # Delete an attachment
95
+ # Unattaches and deletes the specified document
96
+ # @param attachment_id id of the attachment
97
+ # @param [Hash] opts the optional parameters
98
+ # @return [nil]
99
+ def delete_attachment_from_account(attachment_id, opts = {})
100
+ delete_attachment_from_account_with_http_info(attachment_id, opts)
101
+ nil
102
+ end
103
+
104
+ # Delete an attachment
105
+ # Unattaches and deletes the specified document
106
+ # @param attachment_id id of the attachment
107
+ # @param [Hash] opts the optional parameters
108
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
109
+ def delete_attachment_from_account_with_http_info(attachment_id, opts = {})
110
+ if @api_client.config.debugging
111
+ @api_client.config.logger.debug 'Calling API: AttachmentsApi.delete_attachment_from_account ...'
112
+ end
113
+ # verify the required parameter 'attachment_id' is set
114
+ if @api_client.config.client_side_validation && attachment_id.nil?
115
+ fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentsApi.delete_attachment_from_account"
116
+ end
117
+ # resource path
118
+ local_var_path = '/attachments/{attachmentId}'.sub('{' + 'attachmentId' + '}', attachment_id.to_s)
119
+
120
+ # query parameters
121
+ query_params = {}
122
+
123
+ # header parameters
124
+ header_params = {}
125
+ # HTTP header 'Accept' (if needed)
126
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
127
+
128
+ # form parameters
129
+ form_params = {}
130
+
131
+ # http body (model)
132
+ post_body = nil
133
+ auth_names = ['ApiKeyAuth']
134
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
135
+ :header_params => header_params,
136
+ :query_params => query_params,
137
+ :form_params => form_params,
138
+ :body => post_body,
139
+ :auth_names => auth_names)
140
+ if @api_client.config.debugging
141
+ @api_client.config.logger.debug "API called: AttachmentsApi#delete_attachment_from_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
142
+ end
143
+ return data, status_code, headers
144
+ end
145
+ # Get attachment contents
146
+ # Gets the contents of the specified attachment
147
+ # @param attachment_id id of the attachment
148
+ # @param [Hash] opts the optional parameters
149
+ # @return [nil]
150
+ def get_attachment(attachment_id, opts = {})
151
+ get_attachment_with_http_info(attachment_id, opts)
152
+ nil
153
+ end
154
+
155
+ # Get attachment contents
156
+ # Gets the contents of the specified attachment
157
+ # @param attachment_id id of the attachment
158
+ # @param [Hash] opts the optional parameters
159
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
160
+ def get_attachment_with_http_info(attachment_id, opts = {})
161
+ if @api_client.config.debugging
162
+ @api_client.config.logger.debug 'Calling API: AttachmentsApi.get_attachment ...'
163
+ end
164
+ # verify the required parameter 'attachment_id' is set
165
+ if @api_client.config.client_side_validation && attachment_id.nil?
166
+ fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentsApi.get_attachment"
167
+ end
168
+ # resource path
169
+ local_var_path = '/attachments/{attachmentId}'.sub('{' + 'attachmentId' + '}', attachment_id.to_s)
170
+
171
+ # query parameters
172
+ query_params = {}
173
+
174
+ # header parameters
175
+ header_params = {}
176
+ # HTTP header 'Accept' (if needed)
177
+ header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
178
+
179
+ # form parameters
180
+ form_params = {}
181
+
182
+ # http body (model)
183
+ post_body = nil
184
+ auth_names = ['ApiKeyAuth']
185
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
186
+ :header_params => header_params,
187
+ :query_params => query_params,
188
+ :form_params => form_params,
189
+ :body => post_body,
190
+ :auth_names => auth_names)
191
+ if @api_client.config.debugging
192
+ @api_client.config.logger.debug "API called: AttachmentsApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
193
+ end
194
+ return data, status_code, headers
195
+ end
196
+ # Get attachments for an account
197
+ # Lists all the documents attached to an account
198
+ # @param account_id id of the attachment
199
+ # @param [Hash] opts the optional parameters
200
+ # @return [Array<Attachment>]
201
+ def list_account_attachments(account_id, opts = {})
202
+ data, _status_code, _headers = list_account_attachments_with_http_info(account_id, opts)
203
+ data
204
+ end
205
+
206
+ # Get attachments for an account
207
+ # Lists all the documents attached to an account
208
+ # @param account_id id of the attachment
209
+ # @param [Hash] opts the optional parameters
210
+ # @return [Array<(Array<Attachment>, Fixnum, Hash)>] Array<Attachment> data, response status code and response headers
211
+ def list_account_attachments_with_http_info(account_id, opts = {})
212
+ if @api_client.config.debugging
213
+ @api_client.config.logger.debug 'Calling API: AttachmentsApi.list_account_attachments ...'
214
+ end
215
+ # verify the required parameter 'account_id' is set
216
+ if @api_client.config.client_side_validation && account_id.nil?
217
+ fail ArgumentError, "Missing the required parameter 'account_id' when calling AttachmentsApi.list_account_attachments"
218
+ end
219
+ # resource path
220
+ local_var_path = '/attachments/account/{accountId}'.sub('{' + 'accountId' + '}', account_id.to_s)
221
+
222
+ # query parameters
223
+ query_params = {}
224
+
225
+ # header parameters
226
+ header_params = {}
227
+ # HTTP header 'Accept' (if needed)
228
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
229
+
230
+ # form parameters
231
+ form_params = {}
232
+
233
+ # http body (model)
234
+ post_body = nil
235
+ auth_names = ['ApiKeyAuth']
236
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
237
+ :header_params => header_params,
238
+ :query_params => query_params,
239
+ :form_params => form_params,
240
+ :body => post_body,
241
+ :auth_names => auth_names,
242
+ :return_type => 'Array<Attachment>')
243
+ if @api_client.config.debugging
244
+ @api_client.config.logger.debug "API called: AttachmentsApi#list_account_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
245
+ end
246
+ return data, status_code, headers
247
+ end
248
+ # Update the details of an attachment
249
+ # Updates the details of the specified document
250
+ # @param [Hash] opts the optional parameters
251
+ # @option opts [Attachment] :body json representing the attachment
252
+ # @return [Attachment]
253
+ def modify_attachment(opts = {})
254
+ data, _status_code, _headers = modify_attachment_with_http_info(opts)
255
+ data
256
+ end
257
+
258
+ # Update the details of an attachment
259
+ # Updates the details of the specified document
260
+ # @param [Hash] opts the optional parameters
261
+ # @option opts [Attachment] :body json representing the attachment
262
+ # @return [Array<(Attachment, Fixnum, Hash)>] Attachment data, response status code and response headers
263
+ def modify_attachment_with_http_info(opts = {})
264
+ if @api_client.config.debugging
265
+ @api_client.config.logger.debug 'Calling API: AttachmentsApi.modify_attachment ...'
266
+ end
267
+ # resource path
268
+ local_var_path = '/attachments'
269
+
270
+ # query parameters
271
+ query_params = {}
272
+
273
+ # header parameters
274
+ header_params = {}
275
+ # HTTP header 'Accept' (if needed)
276
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
277
+ # HTTP header 'Content-Type'
278
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
279
+
280
+ # form parameters
281
+ form_params = {}
282
+
283
+ # http body (model)
284
+ post_body = @api_client.object_to_http_body(opts[:'body'])
285
+ auth_names = ['ApiKeyAuth']
286
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
287
+ :header_params => header_params,
288
+ :query_params => query_params,
289
+ :form_params => form_params,
290
+ :body => post_body,
291
+ :auth_names => auth_names,
292
+ :return_type => 'Attachment')
293
+ if @api_client.config.debugging
294
+ @api_client.config.logger.debug "API called: AttachmentsApi#modify_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
295
+ end
296
+ return data, status_code, headers
297
+ end
298
+ end
299
+ end
@@ -0,0 +1,335 @@
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 SubskribeDevClient
16
+ class AuthenticationApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Add a saml integration
23
+ # Adds a saml integration
24
+ # @param [Hash] opts the optional parameters
25
+ # @option opts [AuthSamlIntegrationJson] :body saml representing the integration
26
+ # @return [nil]
27
+ def add_saml_integration(opts = {})
28
+ add_saml_integration_with_http_info(opts)
29
+ nil
30
+ end
31
+
32
+ # Add a saml integration
33
+ # Adds a saml integration
34
+ # @param [Hash] opts the optional parameters
35
+ # @option opts [AuthSamlIntegrationJson] :body saml representing the integration
36
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
37
+ def add_saml_integration_with_http_info(opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: AuthenticationApi.add_saml_integration ...'
40
+ end
41
+ # resource path
42
+ local_var_path = '/auth/saml'
43
+
44
+ # query parameters
45
+ query_params = {}
46
+
47
+ # header parameters
48
+ header_params = {}
49
+ # HTTP header 'Accept' (if needed)
50
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
51
+ # HTTP header 'Content-Type'
52
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
53
+
54
+ # form parameters
55
+ form_params = {}
56
+
57
+ # http body (model)
58
+ post_body = @api_client.object_to_http_body(opts[:'body'])
59
+ auth_names = ['ApiKeyAuth']
60
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
61
+ :header_params => header_params,
62
+ :query_params => query_params,
63
+ :form_params => form_params,
64
+ :body => post_body,
65
+ :auth_names => auth_names)
66
+ if @api_client.config.debugging
67
+ @api_client.config.logger.debug "API called: AuthenticationApi#add_saml_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
68
+ end
69
+ return data, status_code, headers
70
+ end
71
+ # Create a new api key
72
+ # Create a new api key with the specified parameters. The new key is returned
73
+ # @param [Hash] opts the optional parameters
74
+ # @option opts [String] :role Role-based permissions to be associated with the key. Specify this OR userId.
75
+ # @option opts [Integer] :expiry Time of expiry in seconds since Epoch (GMT)
76
+ # @option opts [String] :user_id User to associate key with. Specify this OR role.
77
+ # @option opts [String] :entity_id Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).
78
+ # @return [String]
79
+ def create_api_key(opts = {})
80
+ data, _status_code, _headers = create_api_key_with_http_info(opts)
81
+ data
82
+ end
83
+
84
+ # Create a new api key
85
+ # Create a new api key with the specified parameters. The new key is returned
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [String] :role Role-based permissions to be associated with the key. Specify this OR userId.
88
+ # @option opts [Integer] :expiry Time of expiry in seconds since Epoch (GMT)
89
+ # @option opts [String] :user_id User to associate key with. Specify this OR role.
90
+ # @option opts [String] :entity_id Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).
91
+ # @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
92
+ def create_api_key_with_http_info(opts = {})
93
+ if @api_client.config.debugging
94
+ @api_client.config.logger.debug 'Calling API: AuthenticationApi.create_api_key ...'
95
+ end
96
+ if @api_client.config.client_side_validation && opts[:'role'] && !['ADMIN', 'FINANCE', 'SALES', 'DEAL_DESK', 'BILLING_CLERK', 'REVENUE_CLERK', 'READ_ONLY', 'EXECUTIVE', 'CRM', 'IMPORT'].include?(opts[:'role'])
97
+ fail ArgumentError, 'invalid value for "role", must be one of ADMIN, FINANCE, SALES, DEAL_DESK, BILLING_CLERK, REVENUE_CLERK, READ_ONLY, EXECUTIVE, CRM, IMPORT'
98
+ end
99
+ # resource path
100
+ local_var_path = '/apikey'
101
+
102
+ # query parameters
103
+ query_params = {}
104
+ query_params[:'role'] = opts[:'role'] if !opts[:'role'].nil?
105
+ query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?
106
+ query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
107
+ query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
108
+
109
+ # header parameters
110
+ header_params = {}
111
+ # HTTP header 'Accept' (if needed)
112
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
113
+ # HTTP header 'Content-Type'
114
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
115
+
116
+ # form parameters
117
+ form_params = {}
118
+
119
+ # http body (model)
120
+ post_body = nil
121
+ auth_names = ['ApiKeyAuth']
122
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path,
123
+ :header_params => header_params,
124
+ :query_params => query_params,
125
+ :form_params => form_params,
126
+ :body => post_body,
127
+ :auth_names => auth_names,
128
+ :return_type => 'String')
129
+ if @api_client.config.debugging
130
+ @api_client.config.logger.debug "API called: AuthenticationApi#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
131
+ end
132
+ return data, status_code, headers
133
+ end
134
+ # Retrieves all API keys
135
+ # Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)
136
+ # @param [Hash] opts the optional parameters
137
+ # @return [nil]
138
+ def get_all_api_keys(opts = {})
139
+ get_all_api_keys_with_http_info(opts)
140
+ nil
141
+ end
142
+
143
+ # Retrieves all API keys
144
+ # Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)
145
+ # @param [Hash] opts the optional parameters
146
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
147
+ def get_all_api_keys_with_http_info(opts = {})
148
+ if @api_client.config.debugging
149
+ @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_all_api_keys ...'
150
+ end
151
+ # resource path
152
+ local_var_path = '/apikey'
153
+
154
+ # query parameters
155
+ query_params = {}
156
+
157
+ # header parameters
158
+ header_params = {}
159
+ # HTTP header 'Accept' (if needed)
160
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
161
+ # HTTP header 'Content-Type'
162
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
163
+
164
+ # form parameters
165
+ form_params = {}
166
+
167
+ # http body (model)
168
+ post_body = nil
169
+ auth_names = ['ApiKeyAuth']
170
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
171
+ :header_params => header_params,
172
+ :query_params => query_params,
173
+ :form_params => form_params,
174
+ :body => post_body,
175
+ :auth_names => auth_names)
176
+ if @api_client.config.debugging
177
+ @api_client.config.logger.debug "API called: AuthenticationApi#get_all_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
178
+ end
179
+ return data, status_code, headers
180
+ end
181
+ # Retrieve an API key by id
182
+ # Retrieve an api key referenced by its id
183
+ # @param id
184
+ # @param [Hash] opts the optional parameters
185
+ # @return [nil]
186
+ def get_api_key_by_id(id, opts = {})
187
+ get_api_key_by_id_with_http_info(id, opts)
188
+ nil
189
+ end
190
+
191
+ # Retrieve an API key by id
192
+ # Retrieve an api key referenced by its id
193
+ # @param id
194
+ # @param [Hash] opts the optional parameters
195
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
196
+ def get_api_key_by_id_with_http_info(id, opts = {})
197
+ if @api_client.config.debugging
198
+ @api_client.config.logger.debug 'Calling API: AuthenticationApi.get_api_key_by_id ...'
199
+ end
200
+ # verify the required parameter 'id' is set
201
+ if @api_client.config.client_side_validation && id.nil?
202
+ fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticationApi.get_api_key_by_id"
203
+ end
204
+ # resource path
205
+ local_var_path = '/apikey/{id}'.sub('{' + 'id' + '}', id.to_s)
206
+
207
+ # query parameters
208
+ query_params = {}
209
+
210
+ # header parameters
211
+ header_params = {}
212
+ # HTTP header 'Accept' (if needed)
213
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
214
+ # HTTP header 'Content-Type'
215
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
216
+
217
+ # form parameters
218
+ form_params = {}
219
+
220
+ # http body (model)
221
+ post_body = nil
222
+ auth_names = ['ApiKeyAuth']
223
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path,
224
+ :header_params => header_params,
225
+ :query_params => query_params,
226
+ :form_params => form_params,
227
+ :body => post_body,
228
+ :auth_names => auth_names)
229
+ if @api_client.config.debugging
230
+ @api_client.config.logger.debug "API called: AuthenticationApi#get_api_key_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
231
+ end
232
+ return data, status_code, headers
233
+ end
234
+ # revoke all keys
235
+ # Revokes all keys for your tenant
236
+ # @param [Hash] opts the optional parameters
237
+ # @return [nil]
238
+ def revoke_api_key(opts = {})
239
+ revoke_api_key_with_http_info(opts)
240
+ nil
241
+ end
242
+
243
+ # revoke all keys
244
+ # Revokes all keys for your tenant
245
+ # @param [Hash] opts the optional parameters
246
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
247
+ def revoke_api_key_with_http_info(opts = {})
248
+ if @api_client.config.debugging
249
+ @api_client.config.logger.debug 'Calling API: AuthenticationApi.revoke_api_key ...'
250
+ end
251
+ # resource path
252
+ local_var_path = '/apikey/revoke'
253
+
254
+ # query parameters
255
+ query_params = {}
256
+
257
+ # header parameters
258
+ header_params = {}
259
+ # HTTP header 'Accept' (if needed)
260
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
261
+ # HTTP header 'Content-Type'
262
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
263
+
264
+ # form parameters
265
+ form_params = {}
266
+
267
+ # http body (model)
268
+ post_body = nil
269
+ auth_names = ['ApiKeyAuth']
270
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
271
+ :header_params => header_params,
272
+ :query_params => query_params,
273
+ :form_params => form_params,
274
+ :body => post_body,
275
+ :auth_names => auth_names)
276
+ if @api_client.config.debugging
277
+ @api_client.config.logger.debug "API called: AuthenticationApi#revoke_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
278
+ end
279
+ return data, status_code, headers
280
+ end
281
+ # revoke an API key by id
282
+ # Revoke an api key referenced by its id
283
+ # @param id
284
+ # @param [Hash] opts the optional parameters
285
+ # @return [nil]
286
+ def revoke_api_key_by_id(id, opts = {})
287
+ revoke_api_key_by_id_with_http_info(id, opts)
288
+ nil
289
+ end
290
+
291
+ # revoke an API key by id
292
+ # Revoke an api key referenced by its id
293
+ # @param id
294
+ # @param [Hash] opts the optional parameters
295
+ # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
296
+ def revoke_api_key_by_id_with_http_info(id, opts = {})
297
+ if @api_client.config.debugging
298
+ @api_client.config.logger.debug 'Calling API: AuthenticationApi.revoke_api_key_by_id ...'
299
+ end
300
+ # verify the required parameter 'id' is set
301
+ if @api_client.config.client_side_validation && id.nil?
302
+ fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticationApi.revoke_api_key_by_id"
303
+ end
304
+ # resource path
305
+ local_var_path = '/apikey/revoke/{id}'.sub('{' + 'id' + '}', id.to_s)
306
+
307
+ # query parameters
308
+ query_params = {}
309
+
310
+ # header parameters
311
+ header_params = {}
312
+ # HTTP header 'Accept' (if needed)
313
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
314
+ # HTTP header 'Content-Type'
315
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
316
+
317
+ # form parameters
318
+ form_params = {}
319
+
320
+ # http body (model)
321
+ post_body = nil
322
+ auth_names = ['ApiKeyAuth']
323
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
324
+ :header_params => header_params,
325
+ :query_params => query_params,
326
+ :form_params => form_params,
327
+ :body => post_body,
328
+ :auth_names => auth_names)
329
+ if @api_client.config.debugging
330
+ @api_client.config.logger.debug "API called: AuthenticationApi#revoke_api_key_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
331
+ end
332
+ return data, status_code, headers
333
+ end
334
+ end
335
+ end