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.
- checksums.yaml +4 -4
- data/README.md +7 -6
- data/docs/AccountsApi.md +2 -2
- data/docs/AutomatedInvoiceRule.md +5 -5
- data/docs/BillingApi.md +23 -23
- data/docs/BulkPaymentUploadData.md +7 -7
- data/docs/ChargeJson.md +2 -2
- data/docs/PaginatedAccountsResponse.md +10 -0
- data/docs/TaxJarIntegration.md +4 -4
- data/lib/subskribe_dev/api/accounts_api.rb +3 -3
- data/lib/subskribe_dev/api/entities_api.rb +158 -0
- data/lib/subskribe_dev/api/erp_api.rb +20 -20
- data/lib/subskribe_dev/api/product_catalog_api.rb +58 -0
- data/lib/subskribe_dev/api/revenue_recognition_api.rb +22 -22
- data/lib/subskribe_dev/models/automated_invoice_rule.rb +22 -22
- data/lib/subskribe_dev/models/bulk_invoice_run_item.rb +22 -22
- data/lib/subskribe_dev/models/bulk_payment_upload_data.rb +31 -31
- data/lib/subskribe_dev/models/bulk_payment_upload_result.rb +13 -13
- data/lib/subskribe_dev/models/charge_json.rb +19 -19
- data/lib/subskribe_dev/models/order_line_item_json.rb +10 -1
- data/lib/subskribe_dev/models/order_line_item_request_json.rb +10 -1
- data/lib/subskribe_dev/models/paginated_accounts_response.rb +204 -0
- data/lib/subskribe_dev/models/plan_metadata_json.rb +187 -0
- data/lib/subskribe_dev/models/tax_jar_integration.rb +10 -10
- data/lib/subskribe_dev/version.rb +1 -1
- data/lib/subskribe_dev.rb +2 -1
- data/lib/subskribe_dev2/api/accounting_api.rb +193 -0
- data/lib/subskribe_dev2/api/accounts_api.rb +858 -0
- data/lib/subskribe_dev2/api/approvals_api.rb +965 -0
- data/lib/subskribe_dev2/api/attachments_api.rb +299 -0
- data/lib/subskribe_dev2/api/authentication_api.rb +335 -0
- data/lib/subskribe_dev2/api/billing_api.rb +2098 -0
- data/lib/subskribe_dev2/api/credit_memo_api.rb +636 -0
- data/lib/subskribe_dev2/api/custom_field_api.rb +434 -0
- data/lib/subskribe_dev2/api/customization_api.rb +269 -0
- data/lib/subskribe_dev2/api/default_api.rb +223 -0
- data/lib/subskribe_dev2/api/discounts_api.rb +340 -0
- data/lib/subskribe_dev2/api/entities_api.rb +532 -0
- data/lib/subskribe_dev2/api/erp_api.rb +278 -0
- data/lib/subskribe_dev2/api/import_api.rb +568 -0
- data/lib/subskribe_dev2/api/integrations_api.rb +1678 -0
- data/lib/subskribe_dev2/api/metrics_reporting_api.rb +223 -0
- data/lib/subskribe_dev2/api/notifications_api.rb +245 -0
- data/lib/subskribe_dev2/api/opportunity_api.rb +177 -0
- data/lib/subskribe_dev2/api/orders_api.rb +1381 -0
- data/lib/subskribe_dev2/api/payments_api.rb +431 -0
- data/lib/subskribe_dev2/api/product_catalog_api.rb +1886 -0
- data/lib/subskribe_dev2/api/rate_card_api.rb +68 -0
- data/lib/subskribe_dev2/api/refunds_api.rb +189 -0
- data/lib/subskribe_dev2/api/reports_api.rb +227 -0
- data/lib/subskribe_dev2/api/revenue_recognition_api.rb +484 -0
- data/lib/subskribe_dev2/api/sales_room_api.rb +74 -0
- data/lib/subskribe_dev2/api/settings_api.rb +1321 -0
- data/lib/subskribe_dev2/api/subscriptions_api.rb +576 -0
- data/lib/subskribe_dev2/api/usage_api.rb +604 -0
- data/lib/subskribe_dev2/api/users_api.rb +728 -0
- data/lib/subskribe_dev2/api_client.rb +391 -0
- data/lib/subskribe_dev2/api_error.rb +38 -0
- data/lib/subskribe_dev2/configuration.rb +209 -0
- data/lib/subskribe_dev2/models/account_address.rb +265 -0
- data/lib/subskribe_dev2/models/account_address_json.rb +229 -0
- data/lib/subskribe_dev2/models/account_contact.rb +530 -0
- data/lib/subskribe_dev2/models/account_contact_json.rb +274 -0
- data/lib/subskribe_dev2/models/account_json.rb +395 -0
- data/lib/subskribe_dev2/models/account_payment_method_json.rb +268 -0
- data/lib/subskribe_dev2/models/account_receivable_contact_json.rb +225 -0
- data/lib/subskribe_dev2/models/accounting_event.rb +319 -0
- data/lib/subskribe_dev2/models/accounting_event_paginated_response.rb +204 -0
- data/lib/subskribe_dev2/models/accounting_period.rb +356 -0
- data/lib/subskribe_dev2/models/accounting_period_calculation.rb +229 -0
- data/lib/subskribe_dev2/models/add_and_apply_payment_application_json.rb +344 -0
- data/lib/subskribe_dev2/models/anrok_integration_input.rb +184 -0
- data/lib/subskribe_dev2/models/approval_matrix_import_data_json.rb +229 -0
- data/lib/subskribe_dev2/models/approval_matrix_import_preview.rb +226 -0
- data/lib/subskribe_dev2/models/approval_role_json.rb +220 -0
- data/lib/subskribe_dev2/models/approval_role_segment_change.rb +211 -0
- data/lib/subskribe_dev2/models/approval_segment_json.rb +220 -0
- data/lib/subskribe_dev2/models/attachment.rb +326 -0
- data/lib/subskribe_dev2/models/attribute_reference.rb +193 -0
- data/lib/subskribe_dev2/models/auth_saml_integration_json.rb +204 -0
- data/lib/subskribe_dev2/models/automated_invoice_rule.rb +328 -0
- data/lib/subskribe_dev2/models/automated_invoice_rule_request_json.rb +307 -0
- data/lib/subskribe_dev2/models/avalara_integration.rb +238 -0
- data/lib/subskribe_dev2/models/avalara_integration_input.rb +268 -0
- data/lib/subskribe_dev2/models/billing_event_entry.rb +211 -0
- data/lib/subskribe_dev2/models/billing_event_input.rb +216 -0
- data/lib/subskribe_dev2/models/bulk_invoice_run.rb +350 -0
- data/lib/subskribe_dev2/models/bulk_invoice_run_exclusions.rb +197 -0
- data/lib/subskribe_dev2/models/bulk_invoice_run_input.rb +263 -0
- data/lib/subskribe_dev2/models/bulk_invoice_run_item.rb +364 -0
- data/lib/subskribe_dev2/models/bulk_invoice_run_selector.rb +184 -0
- data/lib/subskribe_dev2/models/bulk_payment_upload_data.rb +274 -0
- data/lib/subskribe_dev2/models/bulk_payment_upload_result.rb +204 -0
- data/lib/subskribe_dev2/models/byte_buffer.rb +247 -0
- data/lib/subskribe_dev2/models/catalog_relationship.rb +364 -0
- data/lib/subskribe_dev2/models/charge_json.rb +631 -0
- data/lib/subskribe_dev2/models/charge_partial_json.rb +310 -0
- data/lib/subskribe_dev2/models/company_contact_json.rb +225 -0
- data/lib/subskribe_dev2/models/credit_memo_application_json.rb +239 -0
- data/lib/subskribe_dev2/models/credit_memo_balance_json.rb +211 -0
- data/lib/subskribe_dev2/models/credit_memo_json.rb +363 -0
- data/lib/subskribe_dev2/models/credit_memo_line_item_json.rb +252 -0
- data/lib/subskribe_dev2/models/credit_memo_line_item_request_json.rb +211 -0
- data/lib/subskribe_dev2/models/credit_memo_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev2/models/crm_account_import_response.rb +193 -0
- data/lib/subskribe_dev2/models/custom_field_default.rb +195 -0
- data/lib/subskribe_dev2/models/custom_field_definition_create_input.rb +317 -0
- data/lib/subskribe_dev2/models/custom_field_definition_json.rb +313 -0
- data/lib/subskribe_dev2/models/custom_field_definition_update_input.rb +256 -0
- data/lib/subskribe_dev2/models/custom_field_entry.rb +325 -0
- data/lib/subskribe_dev2/models/custom_field_update_input.rb +195 -0
- data/lib/subskribe_dev2/models/custom_field_value.rb +316 -0
- data/lib/subskribe_dev2/models/data_import.rb +355 -0
- data/lib/subskribe_dev2/models/discount_detail_json.rb +263 -0
- data/lib/subskribe_dev2/models/discount_json.rb +254 -0
- data/lib/subskribe_dev2/models/docu_sign_integration_request_json.rb +236 -0
- data/lib/subskribe_dev2/models/docu_sign_integration_response_json.rb +245 -0
- data/lib/subskribe_dev2/models/document_custom_content.rb +211 -0
- data/lib/subskribe_dev2/models/document_section.rb +265 -0
- data/lib/subskribe_dev2/models/document_template_json.rb +300 -0
- data/lib/subskribe_dev2/models/dunning_setting_json.rb +200 -0
- data/lib/subskribe_dev2/models/email_notifiers_list.rb +208 -0
- data/lib/subskribe_dev2/models/entity.rb +356 -0
- data/lib/subskribe_dev2/models/entity_json.rb +347 -0
- data/lib/subskribe_dev2/models/entity_ref.rb +202 -0
- data/lib/subskribe_dev2/models/entry.rb +202 -0
- data/lib/subskribe_dev2/models/external_arr_schedule_json.rb +319 -0
- data/lib/subskribe_dev2/models/flatfile_workbook_response.rb +184 -0
- data/lib/subskribe_dev2/models/flatfile_workbook_response_data.rb +193 -0
- data/lib/subskribe_dev2/models/input_stream.rb +175 -0
- data/lib/subskribe_dev2/models/integration.rb +311 -0
- data/lib/subskribe_dev2/models/invoice_balance_json.rb +211 -0
- data/lib/subskribe_dev2/models/invoice_item_json.rb +355 -0
- data/lib/subskribe_dev2/models/invoice_item_preview_json.rb +229 -0
- data/lib/subskribe_dev2/models/invoice_json.rb +439 -0
- data/lib/subskribe_dev2/models/invoice_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev2/models/invoice_number_prefix.rb +184 -0
- data/lib/subskribe_dev2/models/invoice_preview_json.rb +222 -0
- data/lib/subskribe_dev2/models/ledger_account.rb +316 -0
- data/lib/subskribe_dev2/models/ledger_account_mapping.rb +222 -0
- data/lib/subskribe_dev2/models/metrics_json.rb +267 -0
- data/lib/subskribe_dev2/models/notification_target_and_subscriptions.rb +265 -0
- data/lib/subskribe_dev2/models/number_config.rb +254 -0
- data/lib/subskribe_dev2/models/opportunity.rb +326 -0
- data/lib/subskribe_dev2/models/opportunity_json.rb +326 -0
- data/lib/subskribe_dev2/models/opportunity_pagination_response.rb +204 -0
- data/lib/subskribe_dev2/models/opportunity_rest_json.rb +317 -0
- data/lib/subskribe_dev2/models/order_json.rb +754 -0
- data/lib/subskribe_dev2/models/order_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev2/models/order_line_item_json.rb +474 -0
- data/lib/subskribe_dev2/models/order_line_item_request_json.rb +384 -0
- data/lib/subskribe_dev2/models/order_request_json.rb +616 -0
- data/lib/subskribe_dev2/models/order_terms.rb +265 -0
- data/lib/subskribe_dev2/models/paginated_accounts_response.rb +204 -0
- data/lib/subskribe_dev2/models/paginated_response.rb +204 -0
- data/lib/subskribe_dev2/models/payment_balance_json.rb +211 -0
- data/lib/subskribe_dev2/models/payment_configuration.rb +208 -0
- data/lib/subskribe_dev2/models/payment_json.rb +300 -0
- data/lib/subskribe_dev2/models/payment_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev2/models/payment_term_settings_json.rb +219 -0
- data/lib/subskribe_dev2/models/plan_json.rb +339 -0
- data/lib/subskribe_dev2/models/plan_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev2/models/plan_metadata_json.rb +187 -0
- data/lib/subskribe_dev2/models/predefined_report_def_chart_json.rb +265 -0
- data/lib/subskribe_dev2/models/predefined_report_def_json.rb +222 -0
- data/lib/subskribe_dev2/models/predefined_report_defs_json.rb +186 -0
- data/lib/subskribe_dev2/models/predefined_report_json.rb +213 -0
- data/lib/subskribe_dev2/models/predefined_report_param.rb +296 -0
- data/lib/subskribe_dev2/models/predefined_report_param_object.rb +296 -0
- data/lib/subskribe_dev2/models/prepaid_stats.rb +310 -0
- data/lib/subskribe_dev2/models/price_tier_json.rb +212 -0
- data/lib/subskribe_dev2/models/product_category.rb +264 -0
- data/lib/subskribe_dev2/models/product_category_pagination_response.rb +204 -0
- data/lib/subskribe_dev2/models/product_input_json.rb +249 -0
- data/lib/subskribe_dev2/models/product_json.rb +276 -0
- data/lib/subskribe_dev2/models/product_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev2/models/purchase_order.rb +226 -0
- data/lib/subskribe_dev2/models/raw_usage.rb +247 -0
- data/lib/subskribe_dev2/models/raw_usages_data.rb +192 -0
- data/lib/subskribe_dev2/models/recognition_event_completion.rb +322 -0
- data/lib/subskribe_dev2/models/recognition_rule.rb +376 -0
- data/lib/subskribe_dev2/models/recurrence_json.rb +256 -0
- data/lib/subskribe_dev2/models/refund.rb +301 -0
- data/lib/subskribe_dev2/models/refund_detail.rb +322 -0
- data/lib/subskribe_dev2/models/refund_request_json.rb +272 -0
- data/lib/subskribe_dev2/models/report_duration.rb +193 -0
- data/lib/subskribe_dev2/models/report_job_response.rb +245 -0
- data/lib/subskribe_dev2/models/salesforce_account.rb +229 -0
- data/lib/subskribe_dev2/models/salesforce_account_billing_address.rb +220 -0
- data/lib/subskribe_dev2/models/salesforce_client_integration_request_json.rb +211 -0
- data/lib/subskribe_dev2/models/settlement_application.rb +329 -0
- data/lib/subskribe_dev2/models/standalone_credit_memo_request.rb +353 -0
- data/lib/subskribe_dev2/models/subscription_charge_alias.rb +283 -0
- data/lib/subskribe_dev2/models/subscription_charge_json.rb +362 -0
- data/lib/subskribe_dev2/models/subscription_json.rb +583 -0
- data/lib/subskribe_dev2/models/subscription_update_json.rb +280 -0
- data/lib/subskribe_dev2/models/tax_jar_integration.rb +238 -0
- data/lib/subskribe_dev2/models/tax_jar_integration_input.rb +193 -0
- data/lib/subskribe_dev2/models/tax_rate_json.rb +286 -0
- data/lib/subskribe_dev2/models/tax_rate_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev2/models/tenant_credit_memo_configuration_json.rb +211 -0
- data/lib/subskribe_dev2/models/tenant_discount_json.rb +193 -0
- data/lib/subskribe_dev2/models/tenant_discount_line_item_json.rb +202 -0
- data/lib/subskribe_dev2/models/tenant_invoice_config.rb +254 -0
- data/lib/subskribe_dev2/models/tenant_json.rb +283 -0
- data/lib/subskribe_dev2/models/tenant_setting_json.rb +307 -0
- data/lib/subskribe_dev2/models/time_series_amount_json.rb +193 -0
- data/lib/subskribe_dev2/models/time_zone.rb +211 -0
- data/lib/subskribe_dev2/models/unit_of_measure_json.rb +250 -0
- data/lib/subskribe_dev2/models/unit_of_measure_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev2/models/update_invoice_request.rb +282 -0
- data/lib/subskribe_dev2/models/usage_aggregate_output.rb +258 -0
- data/lib/subskribe_dev2/models/usage_batch_insert_result.rb +213 -0
- data/lib/subskribe_dev2/models/user_group_json.rb +224 -0
- data/lib/subskribe_dev2/models/user_group_request_json.rb +224 -0
- data/lib/subskribe_dev2/models/user_input.rb +304 -0
- data/lib/subskribe_dev2/models/user_json.rb +376 -0
- data/lib/subskribe_dev2/models/user_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev2/models/void_invoice_request.rb +203 -0
- data/lib/subskribe_dev2/models/void_payment_json.rb +235 -0
- data/lib/subskribe_dev2/version.rb +15 -0
- data/lib/subskribe_dev2.rb +230 -0
- data/lib/subskribe_sandbox/api/accounts_api.rb +3 -3
- data/lib/subskribe_sandbox/api/billing_api.rb +35 -35
- data/lib/subskribe_sandbox/models/automated_invoice_rule.rb +49 -49
- data/lib/subskribe_sandbox/models/bulk_payment_upload_data.rb +46 -46
- data/lib/subskribe_sandbox/models/charge_json.rb +16 -16
- data/lib/subskribe_sandbox/models/paginated_accounts_response.rb +204 -0
- data/lib/subskribe_sandbox/models/tax_jar_integration.rb +31 -31
- data/lib/subskribe_sandbox/version.rb +1 -1
- data/lib/subskribe_sandbox.rb +1 -0
- data/lib/swagger_client/api/accounting_api.rb +193 -0
- data/lib/swagger_client/api/accounts_api.rb +858 -0
- data/lib/swagger_client/api/approvals_api.rb +965 -0
- data/lib/swagger_client/api/attachments_api.rb +299 -0
- data/lib/swagger_client/api/authentication_api.rb +335 -0
- data/lib/swagger_client/api/billing_api.rb +2098 -0
- data/lib/swagger_client/api/credit_memo_api.rb +636 -0
- data/lib/swagger_client/api/custom_field_api.rb +434 -0
- data/lib/swagger_client/api/customization_api.rb +269 -0
- data/lib/swagger_client/api/default_api.rb +223 -0
- data/lib/swagger_client/api/discounts_api.rb +340 -0
- data/lib/swagger_client/api/entities_api.rb +532 -0
- data/lib/swagger_client/api/erp_api.rb +278 -0
- data/lib/swagger_client/api/import_api.rb +568 -0
- data/lib/swagger_client/api/integrations_api.rb +1678 -0
- data/lib/swagger_client/api/metrics_reporting_api.rb +223 -0
- data/lib/swagger_client/api/notifications_api.rb +245 -0
- data/lib/swagger_client/api/opportunity_api.rb +177 -0
- data/lib/swagger_client/api/orders_api.rb +1381 -0
- data/lib/swagger_client/api/payments_api.rb +431 -0
- data/lib/swagger_client/api/product_catalog_api.rb +1886 -0
- data/lib/swagger_client/api/rate_card_api.rb +68 -0
- data/lib/swagger_client/api/refunds_api.rb +189 -0
- data/lib/swagger_client/api/reports_api.rb +227 -0
- data/lib/swagger_client/api/revenue_recognition_api.rb +484 -0
- data/lib/swagger_client/api/sales_room_api.rb +74 -0
- data/lib/swagger_client/api/settings_api.rb +1321 -0
- data/lib/swagger_client/api/subscriptions_api.rb +576 -0
- data/lib/swagger_client/api/usage_api.rb +604 -0
- data/lib/swagger_client/api/users_api.rb +728 -0
- data/lib/swagger_client/api_client.rb +391 -0
- data/lib/swagger_client/api_error.rb +38 -0
- data/lib/swagger_client/configuration.rb +209 -0
- data/lib/swagger_client/models/account_address.rb +265 -0
- data/lib/swagger_client/models/account_address_json.rb +229 -0
- data/lib/swagger_client/models/account_contact.rb +530 -0
- data/lib/swagger_client/models/account_contact_json.rb +274 -0
- data/lib/swagger_client/models/account_json.rb +395 -0
- data/lib/swagger_client/models/account_payment_method_json.rb +268 -0
- data/lib/swagger_client/models/account_receivable_contact_json.rb +225 -0
- data/lib/swagger_client/models/accounting_event.rb +319 -0
- data/lib/swagger_client/models/accounting_event_paginated_response.rb +204 -0
- data/lib/swagger_client/models/accounting_period.rb +356 -0
- data/lib/swagger_client/models/accounting_period_calculation.rb +229 -0
- data/lib/swagger_client/models/add_and_apply_payment_application_json.rb +344 -0
- data/lib/swagger_client/models/anrok_integration_input.rb +184 -0
- data/lib/swagger_client/models/approval_matrix_import_data_json.rb +229 -0
- data/lib/swagger_client/models/approval_matrix_import_preview.rb +226 -0
- data/lib/swagger_client/models/approval_role_json.rb +220 -0
- data/lib/swagger_client/models/approval_role_segment_change.rb +211 -0
- data/lib/swagger_client/models/approval_segment_json.rb +220 -0
- data/lib/swagger_client/models/attachment.rb +326 -0
- data/lib/swagger_client/models/attribute_reference.rb +193 -0
- data/lib/swagger_client/models/auth_saml_integration_json.rb +204 -0
- data/lib/swagger_client/models/automated_invoice_rule.rb +328 -0
- data/lib/swagger_client/models/automated_invoice_rule_request_json.rb +307 -0
- data/lib/swagger_client/models/avalara_integration.rb +238 -0
- data/lib/swagger_client/models/avalara_integration_input.rb +268 -0
- data/lib/swagger_client/models/billing_event_entry.rb +211 -0
- data/lib/swagger_client/models/billing_event_input.rb +216 -0
- data/lib/swagger_client/models/bulk_invoice_run.rb +350 -0
- data/lib/swagger_client/models/bulk_invoice_run_exclusions.rb +197 -0
- data/lib/swagger_client/models/bulk_invoice_run_input.rb +263 -0
- data/lib/swagger_client/models/bulk_invoice_run_item.rb +364 -0
- data/lib/swagger_client/models/bulk_invoice_run_selector.rb +184 -0
- data/lib/swagger_client/models/bulk_payment_upload_data.rb +274 -0
- data/lib/swagger_client/models/bulk_payment_upload_result.rb +204 -0
- data/lib/swagger_client/models/byte_buffer.rb +247 -0
- data/lib/swagger_client/models/catalog_relationship.rb +364 -0
- data/lib/swagger_client/models/charge_json.rb +631 -0
- data/lib/swagger_client/models/charge_partial_json.rb +310 -0
- data/lib/swagger_client/models/company_contact_json.rb +225 -0
- data/lib/swagger_client/models/credit_memo_application_json.rb +239 -0
- data/lib/swagger_client/models/credit_memo_balance_json.rb +211 -0
- data/lib/swagger_client/models/credit_memo_json.rb +363 -0
- data/lib/swagger_client/models/credit_memo_line_item_json.rb +252 -0
- data/lib/swagger_client/models/credit_memo_line_item_request_json.rb +211 -0
- data/lib/swagger_client/models/credit_memo_pagination_response_json.rb +204 -0
- data/lib/swagger_client/models/crm_account_import_response.rb +193 -0
- data/lib/swagger_client/models/custom_field_default.rb +195 -0
- data/lib/swagger_client/models/custom_field_definition_create_input.rb +317 -0
- data/lib/swagger_client/models/custom_field_definition_json.rb +313 -0
- data/lib/swagger_client/models/custom_field_definition_update_input.rb +256 -0
- data/lib/swagger_client/models/custom_field_entry.rb +325 -0
- data/lib/swagger_client/models/custom_field_update_input.rb +195 -0
- data/lib/swagger_client/models/custom_field_value.rb +316 -0
- data/lib/swagger_client/models/data_import.rb +355 -0
- data/lib/swagger_client/models/discount_detail_json.rb +263 -0
- data/lib/swagger_client/models/discount_json.rb +254 -0
- data/lib/swagger_client/models/docu_sign_integration_request_json.rb +236 -0
- data/lib/swagger_client/models/docu_sign_integration_response_json.rb +245 -0
- data/lib/swagger_client/models/document_custom_content.rb +211 -0
- data/lib/swagger_client/models/document_section.rb +265 -0
- data/lib/swagger_client/models/document_template_json.rb +300 -0
- data/lib/swagger_client/models/dunning_setting_json.rb +200 -0
- data/lib/swagger_client/models/email_notifiers_list.rb +208 -0
- data/lib/swagger_client/models/entity.rb +356 -0
- data/lib/swagger_client/models/entity_json.rb +347 -0
- data/lib/swagger_client/models/entity_ref.rb +202 -0
- data/lib/swagger_client/models/entry.rb +202 -0
- data/lib/swagger_client/models/external_arr_schedule_json.rb +319 -0
- data/lib/swagger_client/models/flatfile_workbook_response.rb +184 -0
- data/lib/swagger_client/models/flatfile_workbook_response_data.rb +193 -0
- data/lib/swagger_client/models/input_stream.rb +175 -0
- data/lib/swagger_client/models/integration.rb +311 -0
- data/lib/swagger_client/models/invoice_balance_json.rb +211 -0
- data/lib/swagger_client/models/invoice_item_json.rb +355 -0
- data/lib/swagger_client/models/invoice_item_preview_json.rb +229 -0
- data/lib/swagger_client/models/invoice_json.rb +439 -0
- data/lib/swagger_client/models/invoice_json_pagination_response.rb +204 -0
- data/lib/swagger_client/models/invoice_number_prefix.rb +184 -0
- data/lib/swagger_client/models/invoice_preview_json.rb +222 -0
- data/lib/swagger_client/models/ledger_account.rb +316 -0
- data/lib/swagger_client/models/ledger_account_mapping.rb +222 -0
- data/lib/swagger_client/models/metrics_json.rb +267 -0
- data/lib/swagger_client/models/notification_target_and_subscriptions.rb +265 -0
- data/lib/swagger_client/models/number_config.rb +254 -0
- data/lib/swagger_client/models/opportunity.rb +326 -0
- data/lib/swagger_client/models/opportunity_json.rb +326 -0
- data/lib/swagger_client/models/opportunity_pagination_response.rb +204 -0
- data/lib/swagger_client/models/opportunity_rest_json.rb +317 -0
- data/lib/swagger_client/models/order_json.rb +754 -0
- data/lib/swagger_client/models/order_json_pagination_response.rb +204 -0
- data/lib/swagger_client/models/order_line_item_json.rb +474 -0
- data/lib/swagger_client/models/order_line_item_request_json.rb +384 -0
- data/lib/swagger_client/models/order_request_json.rb +616 -0
- data/lib/swagger_client/models/order_terms.rb +265 -0
- data/lib/swagger_client/models/paginated_accounts_response.rb +204 -0
- data/lib/swagger_client/models/paginated_response.rb +204 -0
- data/lib/swagger_client/models/payment_balance_json.rb +211 -0
- data/lib/swagger_client/models/payment_configuration.rb +208 -0
- data/lib/swagger_client/models/payment_json.rb +300 -0
- data/lib/swagger_client/models/payment_json_pagination_response.rb +204 -0
- data/lib/swagger_client/models/payment_term_settings_json.rb +219 -0
- data/lib/swagger_client/models/plan_json.rb +339 -0
- data/lib/swagger_client/models/plan_json_pagination_response.rb +204 -0
- data/lib/swagger_client/models/plan_metadata_json.rb +187 -0
- data/lib/swagger_client/models/predefined_report_def_chart_json.rb +265 -0
- data/lib/swagger_client/models/predefined_report_def_json.rb +222 -0
- data/lib/swagger_client/models/predefined_report_defs_json.rb +186 -0
- data/lib/swagger_client/models/predefined_report_json.rb +213 -0
- data/lib/swagger_client/models/predefined_report_param.rb +296 -0
- data/lib/swagger_client/models/predefined_report_param_object.rb +296 -0
- data/lib/swagger_client/models/prepaid_stats.rb +310 -0
- data/lib/swagger_client/models/price_tier_json.rb +212 -0
- data/lib/swagger_client/models/product_category.rb +264 -0
- data/lib/swagger_client/models/product_category_pagination_response.rb +204 -0
- data/lib/swagger_client/models/product_input_json.rb +249 -0
- data/lib/swagger_client/models/product_json.rb +276 -0
- data/lib/swagger_client/models/product_json_pagination_response.rb +204 -0
- data/lib/swagger_client/models/purchase_order.rb +226 -0
- data/lib/swagger_client/models/raw_usage.rb +247 -0
- data/lib/swagger_client/models/raw_usages_data.rb +192 -0
- data/lib/swagger_client/models/recognition_event_completion.rb +322 -0
- data/lib/swagger_client/models/recognition_rule.rb +376 -0
- data/lib/swagger_client/models/recurrence_json.rb +256 -0
- data/lib/swagger_client/models/refund.rb +301 -0
- data/lib/swagger_client/models/refund_detail.rb +322 -0
- data/lib/swagger_client/models/refund_request_json.rb +272 -0
- data/lib/swagger_client/models/report_duration.rb +193 -0
- data/lib/swagger_client/models/report_job_response.rb +245 -0
- data/lib/swagger_client/models/salesforce_account.rb +229 -0
- data/lib/swagger_client/models/salesforce_account_billing_address.rb +220 -0
- data/lib/swagger_client/models/salesforce_client_integration_request_json.rb +211 -0
- data/lib/swagger_client/models/settlement_application.rb +329 -0
- data/lib/swagger_client/models/standalone_credit_memo_request.rb +353 -0
- data/lib/swagger_client/models/subscription_charge_alias.rb +283 -0
- data/lib/swagger_client/models/subscription_charge_json.rb +362 -0
- data/lib/swagger_client/models/subscription_json.rb +583 -0
- data/lib/swagger_client/models/subscription_update_json.rb +280 -0
- data/lib/swagger_client/models/tax_jar_integration.rb +238 -0
- data/lib/swagger_client/models/tax_jar_integration_input.rb +193 -0
- data/lib/swagger_client/models/tax_rate_json.rb +286 -0
- data/lib/swagger_client/models/tax_rate_pagination_response_json.rb +204 -0
- data/lib/swagger_client/models/tenant_credit_memo_configuration_json.rb +211 -0
- data/lib/swagger_client/models/tenant_discount_json.rb +193 -0
- data/lib/swagger_client/models/tenant_discount_line_item_json.rb +202 -0
- data/lib/swagger_client/models/tenant_invoice_config.rb +254 -0
- data/lib/swagger_client/models/tenant_json.rb +283 -0
- data/lib/swagger_client/models/tenant_setting_json.rb +307 -0
- data/lib/swagger_client/models/time_series_amount_json.rb +193 -0
- data/lib/swagger_client/models/time_zone.rb +211 -0
- data/lib/swagger_client/models/unit_of_measure_json.rb +250 -0
- data/lib/swagger_client/models/unit_of_measure_pagination_response_json.rb +204 -0
- data/lib/swagger_client/models/update_invoice_request.rb +282 -0
- data/lib/swagger_client/models/usage_aggregate_output.rb +258 -0
- data/lib/swagger_client/models/usage_batch_insert_result.rb +213 -0
- data/lib/swagger_client/models/user_group_json.rb +224 -0
- data/lib/swagger_client/models/user_group_request_json.rb +224 -0
- data/lib/swagger_client/models/user_input.rb +304 -0
- data/lib/swagger_client/models/user_json.rb +376 -0
- data/lib/swagger_client/models/user_pagination_response_json.rb +204 -0
- data/lib/swagger_client/models/void_invoice_request.rb +203 -0
- data/lib/swagger_client/models/void_payment_json.rb +235 -0
- data/lib/swagger_client/version.rb +15 -0
- data/lib/swagger_client.rb +230 -0
- data/spec/models/paginated_accounts_response_spec.rb +53 -0
- data/spec/models/plan_metadata_json_spec.rb +3 -3
- data/subskribe_dev-1.3.1.gem +0 -0
- data/subskribe_dev.gemspec +4 -4
- data/subskribe_dev2-1.3.2.gem +0 -0
- data/subskribe_dev2.gemspec +46 -0
- data/subskribe_sandbox.gemspec +3 -3
- data/swagger_client.gemspec +46 -0
- metadata +589 -187
@@ -0,0 +1,1381 @@
|
|
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 OrdersApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Add new predefined terms
|
23
|
+
# Add a new predefined terms that can be attached to an order as part of PDF document generation.
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [DocumentTemplateJson] :body
|
26
|
+
# @return [String]
|
27
|
+
def add_document_template(opts = {})
|
28
|
+
data, _status_code, _headers = add_document_template_with_http_info(opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Add new predefined terms
|
33
|
+
# Add a new predefined terms that can be attached to an order as part of PDF document generation.
|
34
|
+
# @param [Hash] opts the optional parameters
|
35
|
+
# @option opts [DocumentTemplateJson] :body
|
36
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
37
|
+
def add_document_template_with_http_info(opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.add_document_template ...'
|
40
|
+
end
|
41
|
+
# resource path
|
42
|
+
local_var_path = '/templates'
|
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
|
+
|
52
|
+
# form parameters
|
53
|
+
form_params = {}
|
54
|
+
|
55
|
+
# http body (model)
|
56
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
57
|
+
auth_names = ['ApiKeyAuth']
|
58
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
59
|
+
:header_params => header_params,
|
60
|
+
:query_params => query_params,
|
61
|
+
:form_params => form_params,
|
62
|
+
:body => post_body,
|
63
|
+
:auth_names => auth_names,
|
64
|
+
:return_type => 'String')
|
65
|
+
if @api_client.config.debugging
|
66
|
+
@api_client.config.logger.debug "API called: OrdersApi#add_document_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
67
|
+
end
|
68
|
+
return data, status_code, headers
|
69
|
+
end
|
70
|
+
# Create an order
|
71
|
+
# creates an order with the specified parameters. On success the order id is returned.
|
72
|
+
# @param body json representing the order details
|
73
|
+
# @param [Hash] opts the optional parameters
|
74
|
+
# @option opts [BOOLEAN] :is_dry_run indicates whether this order should be persisted
|
75
|
+
# @option opts [BOOLEAN] :populate_missing_lines indicates whether an amendment should populate missing lines not provided here
|
76
|
+
# @return [OrderJson]
|
77
|
+
def add_order(body, opts = {})
|
78
|
+
data, _status_code, _headers = add_order_with_http_info(body, opts)
|
79
|
+
data
|
80
|
+
end
|
81
|
+
|
82
|
+
# Create an order
|
83
|
+
# creates an order with the specified parameters. On success the order id is returned.
|
84
|
+
# @param body json representing the order details
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @option opts [BOOLEAN] :is_dry_run indicates whether this order should be persisted
|
87
|
+
# @option opts [BOOLEAN] :populate_missing_lines indicates whether an amendment should populate missing lines not provided here
|
88
|
+
# @return [Array<(OrderJson, Fixnum, Hash)>] OrderJson data, response status code and response headers
|
89
|
+
def add_order_with_http_info(body, opts = {})
|
90
|
+
if @api_client.config.debugging
|
91
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.add_order ...'
|
92
|
+
end
|
93
|
+
# verify the required parameter 'body' is set
|
94
|
+
if @api_client.config.client_side_validation && body.nil?
|
95
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling OrdersApi.add_order"
|
96
|
+
end
|
97
|
+
# resource path
|
98
|
+
local_var_path = '/orders'
|
99
|
+
|
100
|
+
# query parameters
|
101
|
+
query_params = {}
|
102
|
+
query_params[:'isDryRun'] = opts[:'is_dry_run'] if !opts[:'is_dry_run'].nil?
|
103
|
+
query_params[:'populateMissingLines'] = opts[:'populate_missing_lines'] if !opts[:'populate_missing_lines'].nil?
|
104
|
+
|
105
|
+
# header parameters
|
106
|
+
header_params = {}
|
107
|
+
# HTTP header 'Accept' (if needed)
|
108
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
109
|
+
# HTTP header 'Content-Type'
|
110
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
111
|
+
|
112
|
+
# form parameters
|
113
|
+
form_params = {}
|
114
|
+
|
115
|
+
# http body (model)
|
116
|
+
post_body = @api_client.object_to_http_body(body)
|
117
|
+
auth_names = ['ApiKeyAuth']
|
118
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
119
|
+
:header_params => header_params,
|
120
|
+
:query_params => query_params,
|
121
|
+
:form_params => form_params,
|
122
|
+
:body => post_body,
|
123
|
+
:auth_names => auth_names,
|
124
|
+
:return_type => 'OrderJson')
|
125
|
+
if @api_client.config.debugging
|
126
|
+
@api_client.config.logger.debug "API called: OrdersApi#add_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
127
|
+
end
|
128
|
+
return data, status_code, headers
|
129
|
+
end
|
130
|
+
# Generate a composite order PDF
|
131
|
+
# Generates a composite order form PDF. When completed this document can be downloaded via a get to /{id}/pdf.
|
132
|
+
# @param id id of the composite order
|
133
|
+
# @param [Hash] opts the optional parameters
|
134
|
+
# @return [nil]
|
135
|
+
def create_composite_order_document(id, opts = {})
|
136
|
+
create_composite_order_document_with_http_info(id, opts)
|
137
|
+
nil
|
138
|
+
end
|
139
|
+
|
140
|
+
# Generate a composite order PDF
|
141
|
+
# Generates a composite order form PDF. When completed this document can be downloaded via a get to /{id}/pdf.
|
142
|
+
# @param id id of the composite order
|
143
|
+
# @param [Hash] opts the optional parameters
|
144
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
145
|
+
def create_composite_order_document_with_http_info(id, opts = {})
|
146
|
+
if @api_client.config.debugging
|
147
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.create_composite_order_document ...'
|
148
|
+
end
|
149
|
+
# verify the required parameter 'id' is set
|
150
|
+
if @api_client.config.client_side_validation && id.nil?
|
151
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.create_composite_order_document"
|
152
|
+
end
|
153
|
+
# resource path
|
154
|
+
local_var_path = '/compositeOrders/{id}/pdf'.sub('{' + 'id' + '}', id.to_s)
|
155
|
+
|
156
|
+
# query parameters
|
157
|
+
query_params = {}
|
158
|
+
|
159
|
+
# header parameters
|
160
|
+
header_params = {}
|
161
|
+
# HTTP header 'Accept' (if needed)
|
162
|
+
header_params['Accept'] = @api_client.select_header_accept(['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(:POST, 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: OrdersApi#create_composite_order_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
178
|
+
end
|
179
|
+
return data, status_code, headers
|
180
|
+
end
|
181
|
+
# Generate an order PDF
|
182
|
+
# Generates an order form PDF. When completed this document can be downloaded via a get to /{id}/pdf.
|
183
|
+
# @param id id of the order
|
184
|
+
# @param [Hash] opts the optional parameters
|
185
|
+
# @option opts [BOOLEAN] :force force regeneration of the PDF document even if there has been no changes. Defaults to false
|
186
|
+
# @return [nil]
|
187
|
+
def create_order_document(id, opts = {})
|
188
|
+
create_order_document_with_http_info(id, opts)
|
189
|
+
nil
|
190
|
+
end
|
191
|
+
|
192
|
+
# Generate an order PDF
|
193
|
+
# Generates an order form PDF. When completed this document can be downloaded via a get to /{id}/pdf.
|
194
|
+
# @param id id of the order
|
195
|
+
# @param [Hash] opts the optional parameters
|
196
|
+
# @option opts [BOOLEAN] :force force regeneration of the PDF document even if there has been no changes. Defaults to false
|
197
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
198
|
+
def create_order_document_with_http_info(id, opts = {})
|
199
|
+
if @api_client.config.debugging
|
200
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.create_order_document ...'
|
201
|
+
end
|
202
|
+
# verify the required parameter 'id' is set
|
203
|
+
if @api_client.config.client_side_validation && id.nil?
|
204
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.create_order_document"
|
205
|
+
end
|
206
|
+
# resource path
|
207
|
+
local_var_path = '/orders/{id}/pdf'.sub('{' + 'id' + '}', id.to_s)
|
208
|
+
|
209
|
+
# query parameters
|
210
|
+
query_params = {}
|
211
|
+
query_params[:'force'] = opts[:'force'] if !opts[:'force'].nil?
|
212
|
+
|
213
|
+
# header parameters
|
214
|
+
header_params = {}
|
215
|
+
# HTTP header 'Accept' (if needed)
|
216
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
217
|
+
|
218
|
+
# form parameters
|
219
|
+
form_params = {}
|
220
|
+
|
221
|
+
# http body (model)
|
222
|
+
post_body = nil
|
223
|
+
auth_names = ['ApiKeyAuth']
|
224
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
225
|
+
:header_params => header_params,
|
226
|
+
:query_params => query_params,
|
227
|
+
:form_params => form_params,
|
228
|
+
:body => post_body,
|
229
|
+
:auth_names => auth_names)
|
230
|
+
if @api_client.config.debugging
|
231
|
+
@api_client.config.logger.debug "API called: OrdersApi#create_order_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
232
|
+
end
|
233
|
+
return data, status_code, headers
|
234
|
+
end
|
235
|
+
# Delete predefined terms
|
236
|
+
# Deletes the predefined terms specified.
|
237
|
+
# @param id
|
238
|
+
# @param [Hash] opts the optional parameters
|
239
|
+
# @return [DocumentTemplateJson]
|
240
|
+
def delete_document_template(id, opts = {})
|
241
|
+
data, _status_code, _headers = delete_document_template_with_http_info(id, opts)
|
242
|
+
data
|
243
|
+
end
|
244
|
+
|
245
|
+
# Delete predefined terms
|
246
|
+
# Deletes the predefined terms specified.
|
247
|
+
# @param id
|
248
|
+
# @param [Hash] opts the optional parameters
|
249
|
+
# @return [Array<(DocumentTemplateJson, Fixnum, Hash)>] DocumentTemplateJson data, response status code and response headers
|
250
|
+
def delete_document_template_with_http_info(id, opts = {})
|
251
|
+
if @api_client.config.debugging
|
252
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.delete_document_template ...'
|
253
|
+
end
|
254
|
+
# verify the required parameter 'id' is set
|
255
|
+
if @api_client.config.client_side_validation && id.nil?
|
256
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.delete_document_template"
|
257
|
+
end
|
258
|
+
# resource path
|
259
|
+
local_var_path = '/templates/{id}'.sub('{' + 'id' + '}', id.to_s)
|
260
|
+
|
261
|
+
# query parameters
|
262
|
+
query_params = {}
|
263
|
+
|
264
|
+
# header parameters
|
265
|
+
header_params = {}
|
266
|
+
# HTTP header 'Accept' (if needed)
|
267
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
268
|
+
|
269
|
+
# form parameters
|
270
|
+
form_params = {}
|
271
|
+
|
272
|
+
# http body (model)
|
273
|
+
post_body = nil
|
274
|
+
auth_names = ['ApiKeyAuth']
|
275
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
276
|
+
:header_params => header_params,
|
277
|
+
:query_params => query_params,
|
278
|
+
:form_params => form_params,
|
279
|
+
:body => post_body,
|
280
|
+
:auth_names => auth_names,
|
281
|
+
:return_type => 'DocumentTemplateJson')
|
282
|
+
if @api_client.config.debugging
|
283
|
+
@api_client.config.logger.debug "API called: OrdersApi#delete_document_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
284
|
+
end
|
285
|
+
return data, status_code, headers
|
286
|
+
end
|
287
|
+
# Delete an order
|
288
|
+
# Deletes the specified order
|
289
|
+
# @param id id of the order
|
290
|
+
# @param [Hash] opts the optional parameters
|
291
|
+
# @return [OrderJson]
|
292
|
+
def delete_order(id, opts = {})
|
293
|
+
data, _status_code, _headers = delete_order_with_http_info(id, opts)
|
294
|
+
data
|
295
|
+
end
|
296
|
+
|
297
|
+
# Delete an order
|
298
|
+
# Deletes the specified order
|
299
|
+
# @param id id of the order
|
300
|
+
# @param [Hash] opts the optional parameters
|
301
|
+
# @return [Array<(OrderJson, Fixnum, Hash)>] OrderJson data, response status code and response headers
|
302
|
+
def delete_order_with_http_info(id, opts = {})
|
303
|
+
if @api_client.config.debugging
|
304
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.delete_order ...'
|
305
|
+
end
|
306
|
+
# verify the required parameter 'id' is set
|
307
|
+
if @api_client.config.client_side_validation && id.nil?
|
308
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.delete_order"
|
309
|
+
end
|
310
|
+
# resource path
|
311
|
+
local_var_path = '/orders/{id}'.sub('{' + 'id' + '}', id.to_s)
|
312
|
+
|
313
|
+
# query parameters
|
314
|
+
query_params = {}
|
315
|
+
|
316
|
+
# header parameters
|
317
|
+
header_params = {}
|
318
|
+
# HTTP header 'Accept' (if needed)
|
319
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
320
|
+
|
321
|
+
# form parameters
|
322
|
+
form_params = {}
|
323
|
+
|
324
|
+
# http body (model)
|
325
|
+
post_body = nil
|
326
|
+
auth_names = ['ApiKeyAuth']
|
327
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
328
|
+
:header_params => header_params,
|
329
|
+
:query_params => query_params,
|
330
|
+
:form_params => form_params,
|
331
|
+
:body => post_body,
|
332
|
+
:auth_names => auth_names,
|
333
|
+
:return_type => 'OrderJson')
|
334
|
+
if @api_client.config.debugging
|
335
|
+
@api_client.config.logger.debug "API called: OrdersApi#delete_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
336
|
+
end
|
337
|
+
return data, status_code, headers
|
338
|
+
end
|
339
|
+
# Mark order as executed
|
340
|
+
# Marks the specified order as executed
|
341
|
+
# @param id id of the order
|
342
|
+
# @param [Hash] opts the optional parameters
|
343
|
+
# @option opts [Integer] :executed_on Order execution time
|
344
|
+
# @return [OrderJson]
|
345
|
+
def execute_order(id, opts = {})
|
346
|
+
data, _status_code, _headers = execute_order_with_http_info(id, opts)
|
347
|
+
data
|
348
|
+
end
|
349
|
+
|
350
|
+
# Mark order as executed
|
351
|
+
# Marks the specified order as executed
|
352
|
+
# @param id id of the order
|
353
|
+
# @param [Hash] opts the optional parameters
|
354
|
+
# @option opts [Integer] :executed_on Order execution time
|
355
|
+
# @return [Array<(OrderJson, Fixnum, Hash)>] OrderJson data, response status code and response headers
|
356
|
+
def execute_order_with_http_info(id, opts = {})
|
357
|
+
if @api_client.config.debugging
|
358
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.execute_order ...'
|
359
|
+
end
|
360
|
+
# verify the required parameter 'id' is set
|
361
|
+
if @api_client.config.client_side_validation && id.nil?
|
362
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.execute_order"
|
363
|
+
end
|
364
|
+
# resource path
|
365
|
+
local_var_path = '/orders/{id}/execute'.sub('{' + 'id' + '}', id.to_s)
|
366
|
+
|
367
|
+
# query parameters
|
368
|
+
query_params = {}
|
369
|
+
query_params[:'executedOn'] = opts[:'executed_on'] if !opts[:'executed_on'].nil?
|
370
|
+
|
371
|
+
# header parameters
|
372
|
+
header_params = {}
|
373
|
+
# HTTP header 'Accept' (if needed)
|
374
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
375
|
+
# HTTP header 'Content-Type'
|
376
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
377
|
+
|
378
|
+
# form parameters
|
379
|
+
form_params = {}
|
380
|
+
|
381
|
+
# http body (model)
|
382
|
+
post_body = nil
|
383
|
+
auth_names = ['ApiKeyAuth']
|
384
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
385
|
+
:header_params => header_params,
|
386
|
+
:query_params => query_params,
|
387
|
+
:form_params => form_params,
|
388
|
+
:body => post_body,
|
389
|
+
:auth_names => auth_names,
|
390
|
+
:return_type => 'OrderJson')
|
391
|
+
if @api_client.config.debugging
|
392
|
+
@api_client.config.logger.debug "API called: OrdersApi#execute_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
393
|
+
end
|
394
|
+
return data, status_code, headers
|
395
|
+
end
|
396
|
+
# Mark order as executed
|
397
|
+
# Marks the specified order as executed
|
398
|
+
# @param id id of the order
|
399
|
+
# @param [Hash] opts the optional parameters
|
400
|
+
# @option opts [Integer] :executed_on Order execution time
|
401
|
+
# @option opts [BOOLEAN] :skip_approval_check Skip approval check for imported orders. Defaults to false
|
402
|
+
# @return [OrderJson]
|
403
|
+
def force_execute_order(id, opts = {})
|
404
|
+
data, _status_code, _headers = force_execute_order_with_http_info(id, opts)
|
405
|
+
data
|
406
|
+
end
|
407
|
+
|
408
|
+
# Mark order as executed
|
409
|
+
# Marks the specified order as executed
|
410
|
+
# @param id id of the order
|
411
|
+
# @param [Hash] opts the optional parameters
|
412
|
+
# @option opts [Integer] :executed_on Order execution time
|
413
|
+
# @option opts [BOOLEAN] :skip_approval_check Skip approval check for imported orders. Defaults to false
|
414
|
+
# @return [Array<(OrderJson, Fixnum, Hash)>] OrderJson data, response status code and response headers
|
415
|
+
def force_execute_order_with_http_info(id, opts = {})
|
416
|
+
if @api_client.config.debugging
|
417
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.force_execute_order ...'
|
418
|
+
end
|
419
|
+
# verify the required parameter 'id' is set
|
420
|
+
if @api_client.config.client_side_validation && id.nil?
|
421
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.force_execute_order"
|
422
|
+
end
|
423
|
+
# resource path
|
424
|
+
local_var_path = '/orders/{id}/execute/force'.sub('{' + 'id' + '}', id.to_s)
|
425
|
+
|
426
|
+
# query parameters
|
427
|
+
query_params = {}
|
428
|
+
query_params[:'executedOn'] = opts[:'executed_on'] if !opts[:'executed_on'].nil?
|
429
|
+
query_params[:'skipApprovalCheck'] = opts[:'skip_approval_check'] if !opts[:'skip_approval_check'].nil?
|
430
|
+
|
431
|
+
# header parameters
|
432
|
+
header_params = {}
|
433
|
+
# HTTP header 'Accept' (if needed)
|
434
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
435
|
+
# HTTP header 'Content-Type'
|
436
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
437
|
+
|
438
|
+
# form parameters
|
439
|
+
form_params = {}
|
440
|
+
|
441
|
+
# http body (model)
|
442
|
+
post_body = nil
|
443
|
+
auth_names = ['ApiKeyAuth']
|
444
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
445
|
+
:header_params => header_params,
|
446
|
+
:query_params => query_params,
|
447
|
+
:form_params => form_params,
|
448
|
+
:body => post_body,
|
449
|
+
:auth_names => auth_names,
|
450
|
+
:return_type => 'OrderJson')
|
451
|
+
if @api_client.config.debugging
|
452
|
+
@api_client.config.logger.debug "API called: OrdersApi#force_execute_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
453
|
+
end
|
454
|
+
return data, status_code, headers
|
455
|
+
end
|
456
|
+
# Fetch composite order form PDF
|
457
|
+
# Downloads the order form PDF for the specified order. This PDF must have been generated via a POST to /{id}/pdf. The response is the PDF document.
|
458
|
+
# @param id id of the order
|
459
|
+
# @param [Hash] opts the optional parameters
|
460
|
+
# @return [nil]
|
461
|
+
def get_composite_order_document(id, opts = {})
|
462
|
+
get_composite_order_document_with_http_info(id, opts)
|
463
|
+
nil
|
464
|
+
end
|
465
|
+
|
466
|
+
# Fetch composite order form PDF
|
467
|
+
# Downloads the order form PDF for the specified order. This PDF must have been generated via a POST to /{id}/pdf. The response is the PDF document.
|
468
|
+
# @param id id of the order
|
469
|
+
# @param [Hash] opts the optional parameters
|
470
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
471
|
+
def get_composite_order_document_with_http_info(id, opts = {})
|
472
|
+
if @api_client.config.debugging
|
473
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_composite_order_document ...'
|
474
|
+
end
|
475
|
+
# verify the required parameter 'id' is set
|
476
|
+
if @api_client.config.client_side_validation && id.nil?
|
477
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_composite_order_document"
|
478
|
+
end
|
479
|
+
# resource path
|
480
|
+
local_var_path = '/compositeOrders/{id}/pdf'.sub('{' + 'id' + '}', id.to_s)
|
481
|
+
|
482
|
+
# query parameters
|
483
|
+
query_params = {}
|
484
|
+
|
485
|
+
# header parameters
|
486
|
+
header_params = {}
|
487
|
+
# HTTP header 'Accept' (if needed)
|
488
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
489
|
+
|
490
|
+
# form parameters
|
491
|
+
form_params = {}
|
492
|
+
|
493
|
+
# http body (model)
|
494
|
+
post_body = nil
|
495
|
+
auth_names = ['ApiKeyAuth']
|
496
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
497
|
+
:header_params => header_params,
|
498
|
+
:query_params => query_params,
|
499
|
+
:form_params => form_params,
|
500
|
+
:body => post_body,
|
501
|
+
:auth_names => auth_names)
|
502
|
+
if @api_client.config.debugging
|
503
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_composite_order_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
504
|
+
end
|
505
|
+
return data, status_code, headers
|
506
|
+
end
|
507
|
+
# Get predefined terms detail
|
508
|
+
# Returns a specific predefined terms by Id.
|
509
|
+
# @param id
|
510
|
+
# @param [Hash] opts the optional parameters
|
511
|
+
# @return [DocumentTemplateJson]
|
512
|
+
def get_document_template(id, opts = {})
|
513
|
+
data, _status_code, _headers = get_document_template_with_http_info(id, opts)
|
514
|
+
data
|
515
|
+
end
|
516
|
+
|
517
|
+
# Get predefined terms detail
|
518
|
+
# Returns a specific predefined terms by Id.
|
519
|
+
# @param id
|
520
|
+
# @param [Hash] opts the optional parameters
|
521
|
+
# @return [Array<(DocumentTemplateJson, Fixnum, Hash)>] DocumentTemplateJson data, response status code and response headers
|
522
|
+
def get_document_template_with_http_info(id, opts = {})
|
523
|
+
if @api_client.config.debugging
|
524
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_document_template ...'
|
525
|
+
end
|
526
|
+
# verify the required parameter 'id' is set
|
527
|
+
if @api_client.config.client_side_validation && id.nil?
|
528
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_document_template"
|
529
|
+
end
|
530
|
+
# resource path
|
531
|
+
local_var_path = '/templates/{id}'.sub('{' + 'id' + '}', id.to_s)
|
532
|
+
|
533
|
+
# query parameters
|
534
|
+
query_params = {}
|
535
|
+
|
536
|
+
# header parameters
|
537
|
+
header_params = {}
|
538
|
+
# HTTP header 'Accept' (if needed)
|
539
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
540
|
+
|
541
|
+
# form parameters
|
542
|
+
form_params = {}
|
543
|
+
|
544
|
+
# http body (model)
|
545
|
+
post_body = nil
|
546
|
+
auth_names = ['ApiKeyAuth']
|
547
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
548
|
+
:header_params => header_params,
|
549
|
+
:query_params => query_params,
|
550
|
+
:form_params => form_params,
|
551
|
+
:body => post_body,
|
552
|
+
:auth_names => auth_names,
|
553
|
+
:return_type => 'DocumentTemplateJson')
|
554
|
+
if @api_client.config.debugging
|
555
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_document_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
556
|
+
end
|
557
|
+
return data, status_code, headers
|
558
|
+
end
|
559
|
+
# Get predefined terms
|
560
|
+
# Returns predefined terms by type. These templates can be attached to orders as part of PDF document generation.
|
561
|
+
# @param [Hash] opts the optional parameters
|
562
|
+
# @option opts [String] :type
|
563
|
+
# @return [DocumentTemplateJson]
|
564
|
+
def get_document_templates(opts = {})
|
565
|
+
data, _status_code, _headers = get_document_templates_with_http_info(opts)
|
566
|
+
data
|
567
|
+
end
|
568
|
+
|
569
|
+
# Get predefined terms
|
570
|
+
# Returns predefined terms by type. These templates can be attached to orders as part of PDF document generation.
|
571
|
+
# @param [Hash] opts the optional parameters
|
572
|
+
# @option opts [String] :type
|
573
|
+
# @return [Array<(DocumentTemplateJson, Fixnum, Hash)>] DocumentTemplateJson data, response status code and response headers
|
574
|
+
def get_document_templates_with_http_info(opts = {})
|
575
|
+
if @api_client.config.debugging
|
576
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_document_templates ...'
|
577
|
+
end
|
578
|
+
if @api_client.config.client_side_validation && opts[:'type'] && !['ORDER', 'INVOICE', 'CREDIT_MEMO', 'EMAIL', 'UPSELL_EARLY_RENEWAL', 'DUNNING', 'CANCEL_AND_RESTRUCTURE'].include?(opts[:'type'])
|
579
|
+
fail ArgumentError, 'invalid value for "type", must be one of ORDER, INVOICE, CREDIT_MEMO, EMAIL, UPSELL_EARLY_RENEWAL, DUNNING, CANCEL_AND_RESTRUCTURE'
|
580
|
+
end
|
581
|
+
# resource path
|
582
|
+
local_var_path = '/templates'
|
583
|
+
|
584
|
+
# query parameters
|
585
|
+
query_params = {}
|
586
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
587
|
+
|
588
|
+
# header parameters
|
589
|
+
header_params = {}
|
590
|
+
# HTTP header 'Accept' (if needed)
|
591
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
592
|
+
|
593
|
+
# form parameters
|
594
|
+
form_params = {}
|
595
|
+
|
596
|
+
# http body (model)
|
597
|
+
post_body = nil
|
598
|
+
auth_names = ['ApiKeyAuth']
|
599
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
600
|
+
:header_params => header_params,
|
601
|
+
:query_params => query_params,
|
602
|
+
:form_params => form_params,
|
603
|
+
:body => post_body,
|
604
|
+
:auth_names => auth_names,
|
605
|
+
:return_type => 'DocumentTemplateJson')
|
606
|
+
if @api_client.config.debugging
|
607
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_document_templates\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
608
|
+
end
|
609
|
+
return data, status_code, headers
|
610
|
+
end
|
611
|
+
# Return all opportunities
|
612
|
+
# Returns all opportunities associated with the specified account. The results are paginated. To fetch all results, pass the cursor returned from a call to subsequent calls.
|
613
|
+
# @param account_id id of account
|
614
|
+
# @param [Hash] opts the optional parameters
|
615
|
+
# @option opts [String] :cursor pass the cursor returned from a call to to subsequent calls until all values are fetched
|
616
|
+
# @option opts [Integer] :limit number of results per page
|
617
|
+
# @option opts [String] :crm_id CRM ID of the opportunity
|
618
|
+
# @return [OpportunityPaginationResponse]
|
619
|
+
def get_opportunities(account_id, opts = {})
|
620
|
+
data, _status_code, _headers = get_opportunities_with_http_info(account_id, opts)
|
621
|
+
data
|
622
|
+
end
|
623
|
+
|
624
|
+
# Return all opportunities
|
625
|
+
# Returns all opportunities associated with the specified account. The results are paginated. To fetch all results, pass the cursor returned from a call to subsequent calls.
|
626
|
+
# @param account_id id of account
|
627
|
+
# @param [Hash] opts the optional parameters
|
628
|
+
# @option opts [String] :cursor pass the cursor returned from a call to to subsequent calls until all values are fetched
|
629
|
+
# @option opts [Integer] :limit number of results per page
|
630
|
+
# @option opts [String] :crm_id CRM ID of the opportunity
|
631
|
+
# @return [Array<(OpportunityPaginationResponse, Fixnum, Hash)>] OpportunityPaginationResponse data, response status code and response headers
|
632
|
+
def get_opportunities_with_http_info(account_id, opts = {})
|
633
|
+
if @api_client.config.debugging
|
634
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_opportunities ...'
|
635
|
+
end
|
636
|
+
# verify the required parameter 'account_id' is set
|
637
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
638
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling OrdersApi.get_opportunities"
|
639
|
+
end
|
640
|
+
# resource path
|
641
|
+
local_var_path = '/opportunity'
|
642
|
+
|
643
|
+
# query parameters
|
644
|
+
query_params = {}
|
645
|
+
query_params[:'accountId'] = account_id
|
646
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
647
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
648
|
+
query_params[:'crmId'] = opts[:'crm_id'] if !opts[:'crm_id'].nil?
|
649
|
+
|
650
|
+
# header parameters
|
651
|
+
header_params = {}
|
652
|
+
# HTTP header 'Accept' (if needed)
|
653
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
654
|
+
|
655
|
+
# form parameters
|
656
|
+
form_params = {}
|
657
|
+
|
658
|
+
# http body (model)
|
659
|
+
post_body = nil
|
660
|
+
auth_names = ['ApiKeyAuth']
|
661
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
662
|
+
:header_params => header_params,
|
663
|
+
:query_params => query_params,
|
664
|
+
:form_params => form_params,
|
665
|
+
:body => post_body,
|
666
|
+
:auth_names => auth_names,
|
667
|
+
:return_type => 'OpportunityPaginationResponse')
|
668
|
+
if @api_client.config.debugging
|
669
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_opportunities\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
670
|
+
end
|
671
|
+
return data, status_code, headers
|
672
|
+
end
|
673
|
+
# Return details of an opportunity
|
674
|
+
# Returns the details of a specified opportunity
|
675
|
+
# @param id id of the opportunity
|
676
|
+
# @param [Hash] opts the optional parameters
|
677
|
+
# @return [OpportunityJson]
|
678
|
+
def get_opportunity_by_crm_opportunity_id(id, opts = {})
|
679
|
+
data, _status_code, _headers = get_opportunity_by_crm_opportunity_id_with_http_info(id, opts)
|
680
|
+
data
|
681
|
+
end
|
682
|
+
|
683
|
+
# Return details of an opportunity
|
684
|
+
# Returns the details of a specified opportunity
|
685
|
+
# @param id id of the opportunity
|
686
|
+
# @param [Hash] opts the optional parameters
|
687
|
+
# @return [Array<(OpportunityJson, Fixnum, Hash)>] OpportunityJson data, response status code and response headers
|
688
|
+
def get_opportunity_by_crm_opportunity_id_with_http_info(id, opts = {})
|
689
|
+
if @api_client.config.debugging
|
690
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_opportunity_by_crm_opportunity_id ...'
|
691
|
+
end
|
692
|
+
# verify the required parameter 'id' is set
|
693
|
+
if @api_client.config.client_side_validation && id.nil?
|
694
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_opportunity_by_crm_opportunity_id"
|
695
|
+
end
|
696
|
+
# resource path
|
697
|
+
local_var_path = '/opportunity/{id}'.sub('{' + 'id' + '}', id.to_s)
|
698
|
+
|
699
|
+
# query parameters
|
700
|
+
query_params = {}
|
701
|
+
|
702
|
+
# header parameters
|
703
|
+
header_params = {}
|
704
|
+
# HTTP header 'Accept' (if needed)
|
705
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
706
|
+
|
707
|
+
# form parameters
|
708
|
+
form_params = {}
|
709
|
+
|
710
|
+
# http body (model)
|
711
|
+
post_body = nil
|
712
|
+
auth_names = ['ApiKeyAuth']
|
713
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
714
|
+
:header_params => header_params,
|
715
|
+
:query_params => query_params,
|
716
|
+
:form_params => form_params,
|
717
|
+
:body => post_body,
|
718
|
+
:auth_names => auth_names,
|
719
|
+
:return_type => 'OpportunityJson')
|
720
|
+
if @api_client.config.debugging
|
721
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_opportunity_by_crm_opportunity_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
722
|
+
end
|
723
|
+
return data, status_code, headers
|
724
|
+
end
|
725
|
+
# Get order details
|
726
|
+
# Get the details of the specified order
|
727
|
+
# @param id order id
|
728
|
+
# @param [Hash] opts the optional parameters
|
729
|
+
# @return [OrderJson]
|
730
|
+
def get_order(id, opts = {})
|
731
|
+
data, _status_code, _headers = get_order_with_http_info(id, opts)
|
732
|
+
data
|
733
|
+
end
|
734
|
+
|
735
|
+
# Get order details
|
736
|
+
# Get the details of the specified order
|
737
|
+
# @param id order id
|
738
|
+
# @param [Hash] opts the optional parameters
|
739
|
+
# @return [Array<(OrderJson, Fixnum, Hash)>] OrderJson data, response status code and response headers
|
740
|
+
def get_order_with_http_info(id, opts = {})
|
741
|
+
if @api_client.config.debugging
|
742
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_order ...'
|
743
|
+
end
|
744
|
+
# verify the required parameter 'id' is set
|
745
|
+
if @api_client.config.client_side_validation && id.nil?
|
746
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_order"
|
747
|
+
end
|
748
|
+
# resource path
|
749
|
+
local_var_path = '/orders/{id}'.sub('{' + 'id' + '}', id.to_s)
|
750
|
+
|
751
|
+
# query parameters
|
752
|
+
query_params = {}
|
753
|
+
|
754
|
+
# header parameters
|
755
|
+
header_params = {}
|
756
|
+
# HTTP header 'Accept' (if needed)
|
757
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
758
|
+
|
759
|
+
# form parameters
|
760
|
+
form_params = {}
|
761
|
+
|
762
|
+
# http body (model)
|
763
|
+
post_body = nil
|
764
|
+
auth_names = ['ApiKeyAuth']
|
765
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
766
|
+
:header_params => header_params,
|
767
|
+
:query_params => query_params,
|
768
|
+
:form_params => form_params,
|
769
|
+
:body => post_body,
|
770
|
+
:auth_names => auth_names,
|
771
|
+
:return_type => 'OrderJson')
|
772
|
+
if @api_client.config.debugging
|
773
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
774
|
+
end
|
775
|
+
return data, status_code, headers
|
776
|
+
end
|
777
|
+
# Fetch order form PDF
|
778
|
+
# Downloads the order form PDF for the specified order. This PDF must have been generated via a POST to /{id}/pdf. The response is the PDF document.
|
779
|
+
# @param id id of the order
|
780
|
+
# @param [Hash] opts the optional parameters
|
781
|
+
# @return [nil]
|
782
|
+
def get_order_document1(id, opts = {})
|
783
|
+
get_order_document1_with_http_info(id, opts)
|
784
|
+
nil
|
785
|
+
end
|
786
|
+
|
787
|
+
# Fetch order form PDF
|
788
|
+
# Downloads the order form PDF for the specified order. This PDF must have been generated via a POST to /{id}/pdf. The response is the PDF document.
|
789
|
+
# @param id id of the order
|
790
|
+
# @param [Hash] opts the optional parameters
|
791
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
792
|
+
def get_order_document1_with_http_info(id, opts = {})
|
793
|
+
if @api_client.config.debugging
|
794
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_order_document1 ...'
|
795
|
+
end
|
796
|
+
# verify the required parameter 'id' is set
|
797
|
+
if @api_client.config.client_side_validation && id.nil?
|
798
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_order_document1"
|
799
|
+
end
|
800
|
+
# resource path
|
801
|
+
local_var_path = '/orders/{id}/pdf'.sub('{' + 'id' + '}', id.to_s)
|
802
|
+
|
803
|
+
# query parameters
|
804
|
+
query_params = {}
|
805
|
+
|
806
|
+
# header parameters
|
807
|
+
header_params = {}
|
808
|
+
# HTTP header 'Accept' (if needed)
|
809
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
810
|
+
|
811
|
+
# form parameters
|
812
|
+
form_params = {}
|
813
|
+
|
814
|
+
# http body (model)
|
815
|
+
post_body = nil
|
816
|
+
auth_names = ['ApiKeyAuth']
|
817
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
818
|
+
:header_params => header_params,
|
819
|
+
:query_params => query_params,
|
820
|
+
:form_params => form_params,
|
821
|
+
:body => post_body,
|
822
|
+
:auth_names => auth_names)
|
823
|
+
if @api_client.config.debugging
|
824
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_order_document1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
825
|
+
end
|
826
|
+
return data, status_code, headers
|
827
|
+
end
|
828
|
+
# Download word doc version of order form
|
829
|
+
# Download the order form as a Microsoft Word document. This document must have been generated via a POST to /{id}/pdf. The response is the Word Document.
|
830
|
+
# @param id id of the document
|
831
|
+
# @param [Hash] opts the optional parameters
|
832
|
+
# @return [nil]
|
833
|
+
def get_order_document_doc(id, opts = {})
|
834
|
+
get_order_document_doc_with_http_info(id, opts)
|
835
|
+
nil
|
836
|
+
end
|
837
|
+
|
838
|
+
# Download word doc version of order form
|
839
|
+
# Download the order form as a Microsoft Word document. This document must have been generated via a POST to /{id}/pdf. The response is the Word Document.
|
840
|
+
# @param id id of the document
|
841
|
+
# @param [Hash] opts the optional parameters
|
842
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
843
|
+
def get_order_document_doc_with_http_info(id, opts = {})
|
844
|
+
if @api_client.config.debugging
|
845
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_order_document_doc ...'
|
846
|
+
end
|
847
|
+
# verify the required parameter 'id' is set
|
848
|
+
if @api_client.config.client_side_validation && id.nil?
|
849
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_order_document_doc"
|
850
|
+
end
|
851
|
+
# resource path
|
852
|
+
local_var_path = '/orders/{id}/doc'.sub('{' + 'id' + '}', id.to_s)
|
853
|
+
|
854
|
+
# query parameters
|
855
|
+
query_params = {}
|
856
|
+
|
857
|
+
# header parameters
|
858
|
+
header_params = {}
|
859
|
+
# HTTP header 'Accept' (if needed)
|
860
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
861
|
+
|
862
|
+
# form parameters
|
863
|
+
form_params = {}
|
864
|
+
|
865
|
+
# http body (model)
|
866
|
+
post_body = nil
|
867
|
+
auth_names = ['ApiKeyAuth']
|
868
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
869
|
+
:header_params => header_params,
|
870
|
+
:query_params => query_params,
|
871
|
+
:form_params => form_params,
|
872
|
+
:body => post_body,
|
873
|
+
:auth_names => auth_names)
|
874
|
+
if @api_client.config.debugging
|
875
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_order_document_doc\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
876
|
+
end
|
877
|
+
return data, status_code, headers
|
878
|
+
end
|
879
|
+
# Get order line metrics
|
880
|
+
# Returns the metrics associated with an order's line items. This includes ARR, TCV, etc.
|
881
|
+
# @param id id of the order
|
882
|
+
# @param [Hash] opts the optional parameters
|
883
|
+
# @return [Hash<String, MetricsJson>]
|
884
|
+
def get_order_line_metrics(id, opts = {})
|
885
|
+
data, _status_code, _headers = get_order_line_metrics_with_http_info(id, opts)
|
886
|
+
data
|
887
|
+
end
|
888
|
+
|
889
|
+
# Get order line metrics
|
890
|
+
# Returns the metrics associated with an order's line items. This includes ARR, TCV, etc.
|
891
|
+
# @param id id of the order
|
892
|
+
# @param [Hash] opts the optional parameters
|
893
|
+
# @return [Array<(Hash<String, MetricsJson>, Fixnum, Hash)>] Hash<String, MetricsJson> data, response status code and response headers
|
894
|
+
def get_order_line_metrics_with_http_info(id, opts = {})
|
895
|
+
if @api_client.config.debugging
|
896
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_order_line_metrics ...'
|
897
|
+
end
|
898
|
+
# verify the required parameter 'id' is set
|
899
|
+
if @api_client.config.client_side_validation && id.nil?
|
900
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_order_line_metrics"
|
901
|
+
end
|
902
|
+
# resource path
|
903
|
+
local_var_path = '/orders/{id}/lineItems/metrics'.sub('{' + 'id' + '}', id.to_s)
|
904
|
+
|
905
|
+
# query parameters
|
906
|
+
query_params = {}
|
907
|
+
|
908
|
+
# header parameters
|
909
|
+
header_params = {}
|
910
|
+
# HTTP header 'Accept' (if needed)
|
911
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
912
|
+
|
913
|
+
# form parameters
|
914
|
+
form_params = {}
|
915
|
+
|
916
|
+
# http body (model)
|
917
|
+
post_body = nil
|
918
|
+
auth_names = ['ApiKeyAuth']
|
919
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
920
|
+
:header_params => header_params,
|
921
|
+
:query_params => query_params,
|
922
|
+
:form_params => form_params,
|
923
|
+
:body => post_body,
|
924
|
+
:auth_names => auth_names,
|
925
|
+
:return_type => 'Hash<String, MetricsJson>')
|
926
|
+
if @api_client.config.debugging
|
927
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_order_line_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
928
|
+
end
|
929
|
+
return data, status_code, headers
|
930
|
+
end
|
931
|
+
# Get order metrics
|
932
|
+
# Returns the metrics associated with an order. This includes ARR, TCV, etc.
|
933
|
+
# @param id id of the order
|
934
|
+
# @param [Hash] opts the optional parameters
|
935
|
+
# @option opts [Integer] :target_date date to generate metrics as of. Defaults to now.
|
936
|
+
# @return [MetricsJson]
|
937
|
+
def get_order_metrics(id, opts = {})
|
938
|
+
data, _status_code, _headers = get_order_metrics_with_http_info(id, opts)
|
939
|
+
data
|
940
|
+
end
|
941
|
+
|
942
|
+
# Get order metrics
|
943
|
+
# Returns the metrics associated with an order. This includes ARR, TCV, etc.
|
944
|
+
# @param id id of the order
|
945
|
+
# @param [Hash] opts the optional parameters
|
946
|
+
# @option opts [Integer] :target_date date to generate metrics as of. Defaults to now.
|
947
|
+
# @return [Array<(MetricsJson, Fixnum, Hash)>] MetricsJson data, response status code and response headers
|
948
|
+
def get_order_metrics_with_http_info(id, opts = {})
|
949
|
+
if @api_client.config.debugging
|
950
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_order_metrics ...'
|
951
|
+
end
|
952
|
+
# verify the required parameter 'id' is set
|
953
|
+
if @api_client.config.client_side_validation && id.nil?
|
954
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_order_metrics"
|
955
|
+
end
|
956
|
+
# resource path
|
957
|
+
local_var_path = '/orders/{id}/metrics'.sub('{' + 'id' + '}', id.to_s)
|
958
|
+
|
959
|
+
# query parameters
|
960
|
+
query_params = {}
|
961
|
+
query_params[:'targetDate'] = opts[:'target_date'] if !opts[:'target_date'].nil?
|
962
|
+
|
963
|
+
# header parameters
|
964
|
+
header_params = {}
|
965
|
+
# HTTP header 'Accept' (if needed)
|
966
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
967
|
+
|
968
|
+
# form parameters
|
969
|
+
form_params = {}
|
970
|
+
|
971
|
+
# http body (model)
|
972
|
+
post_body = nil
|
973
|
+
auth_names = ['ApiKeyAuth']
|
974
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
975
|
+
:header_params => header_params,
|
976
|
+
:query_params => query_params,
|
977
|
+
:form_params => form_params,
|
978
|
+
:body => post_body,
|
979
|
+
:auth_names => auth_names,
|
980
|
+
:return_type => 'MetricsJson')
|
981
|
+
if @api_client.config.debugging
|
982
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_order_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
983
|
+
end
|
984
|
+
return data, status_code, headers
|
985
|
+
end
|
986
|
+
# Get all Orders
|
987
|
+
# Gets all orders for your tenant. The results are paginated. To fetch all results, take the cursor returned from a call and pass it to subsequent calls.
|
988
|
+
# @param [Hash] opts the optional parameters
|
989
|
+
# @option opts [String] :cursor cursor returned from previous call
|
990
|
+
# @option opts [Integer] :limit number of results per page
|
991
|
+
# @return [OrderJsonPaginationResponse]
|
992
|
+
def get_orders(opts = {})
|
993
|
+
data, _status_code, _headers = get_orders_with_http_info(opts)
|
994
|
+
data
|
995
|
+
end
|
996
|
+
|
997
|
+
# Get all Orders
|
998
|
+
# Gets all orders for your tenant. The results are paginated. To fetch all results, take the cursor returned from a call and pass it to subsequent calls.
|
999
|
+
# @param [Hash] opts the optional parameters
|
1000
|
+
# @option opts [String] :cursor cursor returned from previous call
|
1001
|
+
# @option opts [Integer] :limit number of results per page
|
1002
|
+
# @return [Array<(OrderJsonPaginationResponse, Fixnum, Hash)>] OrderJsonPaginationResponse data, response status code and response headers
|
1003
|
+
def get_orders_with_http_info(opts = {})
|
1004
|
+
if @api_client.config.debugging
|
1005
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_orders ...'
|
1006
|
+
end
|
1007
|
+
# resource path
|
1008
|
+
local_var_path = '/orders'
|
1009
|
+
|
1010
|
+
# query parameters
|
1011
|
+
query_params = {}
|
1012
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
1013
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
1014
|
+
|
1015
|
+
# header parameters
|
1016
|
+
header_params = {}
|
1017
|
+
# HTTP header 'Accept' (if needed)
|
1018
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1019
|
+
|
1020
|
+
# form parameters
|
1021
|
+
form_params = {}
|
1022
|
+
|
1023
|
+
# http body (model)
|
1024
|
+
post_body = nil
|
1025
|
+
auth_names = ['ApiKeyAuth']
|
1026
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1027
|
+
:header_params => header_params,
|
1028
|
+
:query_params => query_params,
|
1029
|
+
:form_params => form_params,
|
1030
|
+
:body => post_body,
|
1031
|
+
:auth_names => auth_names,
|
1032
|
+
:return_type => 'OrderJsonPaginationResponse')
|
1033
|
+
if @api_client.config.debugging
|
1034
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_orders\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1035
|
+
end
|
1036
|
+
return data, status_code, headers
|
1037
|
+
end
|
1038
|
+
# Return a list of orders associated with a CRM opportunity id
|
1039
|
+
# Returns the details of orders
|
1040
|
+
# @param id crm id of the opportunity
|
1041
|
+
# @param [Hash] opts the optional parameters
|
1042
|
+
# @return [Array<Object>]
|
1043
|
+
def get_orders_by_crm_opportunity_id(id, opts = {})
|
1044
|
+
data, _status_code, _headers = get_orders_by_crm_opportunity_id_with_http_info(id, opts)
|
1045
|
+
data
|
1046
|
+
end
|
1047
|
+
|
1048
|
+
# Return a list of orders associated with a CRM opportunity id
|
1049
|
+
# Returns the details of orders
|
1050
|
+
# @param id crm id of the opportunity
|
1051
|
+
# @param [Hash] opts the optional parameters
|
1052
|
+
# @return [Array<(Array<Object>, Fixnum, Hash)>] Array<Object> data, response status code and response headers
|
1053
|
+
def get_orders_by_crm_opportunity_id_with_http_info(id, opts = {})
|
1054
|
+
if @api_client.config.debugging
|
1055
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.get_orders_by_crm_opportunity_id ...'
|
1056
|
+
end
|
1057
|
+
# verify the required parameter 'id' is set
|
1058
|
+
if @api_client.config.client_side_validation && id.nil?
|
1059
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.get_orders_by_crm_opportunity_id"
|
1060
|
+
end
|
1061
|
+
# resource path
|
1062
|
+
local_var_path = '/opportunity/crm/{id}/orders'.sub('{' + 'id' + '}', id.to_s)
|
1063
|
+
|
1064
|
+
# query parameters
|
1065
|
+
query_params = {}
|
1066
|
+
|
1067
|
+
# header parameters
|
1068
|
+
header_params = {}
|
1069
|
+
# HTTP header 'Accept' (if needed)
|
1070
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1071
|
+
|
1072
|
+
# form parameters
|
1073
|
+
form_params = {}
|
1074
|
+
|
1075
|
+
# http body (model)
|
1076
|
+
post_body = nil
|
1077
|
+
auth_names = ['ApiKeyAuth']
|
1078
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1079
|
+
:header_params => header_params,
|
1080
|
+
:query_params => query_params,
|
1081
|
+
:form_params => form_params,
|
1082
|
+
:body => post_body,
|
1083
|
+
:auth_names => auth_names,
|
1084
|
+
:return_type => 'Array<Object>')
|
1085
|
+
if @api_client.config.debugging
|
1086
|
+
@api_client.config.logger.debug "API called: OrdersApi#get_orders_by_crm_opportunity_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1087
|
+
end
|
1088
|
+
return data, status_code, headers
|
1089
|
+
end
|
1090
|
+
# Mark order as executed
|
1091
|
+
# Rebase the given amendment order onto the latest subscription version
|
1092
|
+
# @param order_id id of the order
|
1093
|
+
# @param [Hash] opts the optional parameters
|
1094
|
+
# @return [OrderJson]
|
1095
|
+
def rebase_amendment(order_id, opts = {})
|
1096
|
+
data, _status_code, _headers = rebase_amendment_with_http_info(order_id, opts)
|
1097
|
+
data
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
# Mark order as executed
|
1101
|
+
# Rebase the given amendment order onto the latest subscription version
|
1102
|
+
# @param order_id id of the order
|
1103
|
+
# @param [Hash] opts the optional parameters
|
1104
|
+
# @return [Array<(OrderJson, Fixnum, Hash)>] OrderJson data, response status code and response headers
|
1105
|
+
def rebase_amendment_with_http_info(order_id, opts = {})
|
1106
|
+
if @api_client.config.debugging
|
1107
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.rebase_amendment ...'
|
1108
|
+
end
|
1109
|
+
# verify the required parameter 'order_id' is set
|
1110
|
+
if @api_client.config.client_side_validation && order_id.nil?
|
1111
|
+
fail ArgumentError, "Missing the required parameter 'order_id' when calling OrdersApi.rebase_amendment"
|
1112
|
+
end
|
1113
|
+
# resource path
|
1114
|
+
local_var_path = '/orders/{orderId}/rebase'.sub('{' + 'orderId' + '}', order_id.to_s)
|
1115
|
+
|
1116
|
+
# query parameters
|
1117
|
+
query_params = {}
|
1118
|
+
|
1119
|
+
# header parameters
|
1120
|
+
header_params = {}
|
1121
|
+
# HTTP header 'Accept' (if needed)
|
1122
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1123
|
+
|
1124
|
+
# form parameters
|
1125
|
+
form_params = {}
|
1126
|
+
|
1127
|
+
# http body (model)
|
1128
|
+
post_body = nil
|
1129
|
+
auth_names = ['ApiKeyAuth']
|
1130
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1131
|
+
:header_params => header_params,
|
1132
|
+
:query_params => query_params,
|
1133
|
+
:form_params => form_params,
|
1134
|
+
:body => post_body,
|
1135
|
+
:auth_names => auth_names,
|
1136
|
+
:return_type => 'OrderJson')
|
1137
|
+
if @api_client.config.debugging
|
1138
|
+
@api_client.config.logger.debug "API called: OrdersApi#rebase_amendment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1139
|
+
end
|
1140
|
+
return data, status_code, headers
|
1141
|
+
end
|
1142
|
+
# Update predefined terms
|
1143
|
+
# Updates a predefined terms
|
1144
|
+
# @param id
|
1145
|
+
# @param [Hash] opts the optional parameters
|
1146
|
+
# @option opts [DocumentTemplateJson] :body
|
1147
|
+
# @return [nil]
|
1148
|
+
def update_document_template(id, opts = {})
|
1149
|
+
update_document_template_with_http_info(id, opts)
|
1150
|
+
nil
|
1151
|
+
end
|
1152
|
+
|
1153
|
+
# Update predefined terms
|
1154
|
+
# Updates a predefined terms
|
1155
|
+
# @param id
|
1156
|
+
# @param [Hash] opts the optional parameters
|
1157
|
+
# @option opts [DocumentTemplateJson] :body
|
1158
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1159
|
+
def update_document_template_with_http_info(id, opts = {})
|
1160
|
+
if @api_client.config.debugging
|
1161
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.update_document_template ...'
|
1162
|
+
end
|
1163
|
+
# verify the required parameter 'id' is set
|
1164
|
+
if @api_client.config.client_side_validation && id.nil?
|
1165
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.update_document_template"
|
1166
|
+
end
|
1167
|
+
# resource path
|
1168
|
+
local_var_path = '/templates/{id}'.sub('{' + 'id' + '}', id.to_s)
|
1169
|
+
|
1170
|
+
# query parameters
|
1171
|
+
query_params = {}
|
1172
|
+
|
1173
|
+
# header parameters
|
1174
|
+
header_params = {}
|
1175
|
+
# HTTP header 'Accept' (if needed)
|
1176
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1177
|
+
|
1178
|
+
# form parameters
|
1179
|
+
form_params = {}
|
1180
|
+
|
1181
|
+
# http body (model)
|
1182
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
1183
|
+
auth_names = ['ApiKeyAuth']
|
1184
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1185
|
+
:header_params => header_params,
|
1186
|
+
:query_params => query_params,
|
1187
|
+
:form_params => form_params,
|
1188
|
+
:body => post_body,
|
1189
|
+
:auth_names => auth_names)
|
1190
|
+
if @api_client.config.debugging
|
1191
|
+
@api_client.config.logger.debug "API called: OrdersApi#update_document_template\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1192
|
+
end
|
1193
|
+
return data, status_code, headers
|
1194
|
+
end
|
1195
|
+
# Update predefined terms status
|
1196
|
+
# Updates the status of a predefined terms
|
1197
|
+
# @param id id of the predefined terms
|
1198
|
+
# @param status new status to set
|
1199
|
+
# @param [Hash] opts the optional parameters
|
1200
|
+
# @return [nil]
|
1201
|
+
def update_document_template_status(id, status, opts = {})
|
1202
|
+
update_document_template_status_with_http_info(id, status, opts)
|
1203
|
+
nil
|
1204
|
+
end
|
1205
|
+
|
1206
|
+
# Update predefined terms status
|
1207
|
+
# Updates the status of a predefined terms
|
1208
|
+
# @param id id of the predefined terms
|
1209
|
+
# @param status new status to set
|
1210
|
+
# @param [Hash] opts the optional parameters
|
1211
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1212
|
+
def update_document_template_status_with_http_info(id, status, opts = {})
|
1213
|
+
if @api_client.config.debugging
|
1214
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.update_document_template_status ...'
|
1215
|
+
end
|
1216
|
+
# verify the required parameter 'id' is set
|
1217
|
+
if @api_client.config.client_side_validation && id.nil?
|
1218
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.update_document_template_status"
|
1219
|
+
end
|
1220
|
+
# verify the required parameter 'status' is set
|
1221
|
+
if @api_client.config.client_side_validation && status.nil?
|
1222
|
+
fail ArgumentError, "Missing the required parameter 'status' when calling OrdersApi.update_document_template_status"
|
1223
|
+
end
|
1224
|
+
# verify enum value
|
1225
|
+
if @api_client.config.client_side_validation && !['DRAFT', 'ACTIVE', 'DEPRECATED'].include?(status)
|
1226
|
+
fail ArgumentError, "invalid value for 'status', must be one of DRAFT, ACTIVE, DEPRECATED"
|
1227
|
+
end
|
1228
|
+
# resource path
|
1229
|
+
local_var_path = '/templates/{id}/status/{status}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'status' + '}', status.to_s)
|
1230
|
+
|
1231
|
+
# query parameters
|
1232
|
+
query_params = {}
|
1233
|
+
|
1234
|
+
# header parameters
|
1235
|
+
header_params = {}
|
1236
|
+
# HTTP header 'Accept' (if needed)
|
1237
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1238
|
+
# HTTP header 'Content-Type'
|
1239
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1240
|
+
|
1241
|
+
# form parameters
|
1242
|
+
form_params = {}
|
1243
|
+
|
1244
|
+
# http body (model)
|
1245
|
+
post_body = nil
|
1246
|
+
auth_names = ['ApiKeyAuth']
|
1247
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1248
|
+
:header_params => header_params,
|
1249
|
+
:query_params => query_params,
|
1250
|
+
:form_params => form_params,
|
1251
|
+
:body => post_body,
|
1252
|
+
:auth_names => auth_names)
|
1253
|
+
if @api_client.config.debugging
|
1254
|
+
@api_client.config.logger.debug "API called: OrdersApi#update_document_template_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1255
|
+
end
|
1256
|
+
return data, status_code, headers
|
1257
|
+
end
|
1258
|
+
# Update order details
|
1259
|
+
# Updates the details of the specified order
|
1260
|
+
# @param body json representing the order details
|
1261
|
+
# @param [Hash] opts the optional parameters
|
1262
|
+
# @option opts [BOOLEAN] :is_dry_run true if the order should not be persisted
|
1263
|
+
# @return [nil]
|
1264
|
+
def update_order(body, opts = {})
|
1265
|
+
update_order_with_http_info(body, opts)
|
1266
|
+
nil
|
1267
|
+
end
|
1268
|
+
|
1269
|
+
# Update order details
|
1270
|
+
# Updates the details of the specified order
|
1271
|
+
# @param body json representing the order details
|
1272
|
+
# @param [Hash] opts the optional parameters
|
1273
|
+
# @option opts [BOOLEAN] :is_dry_run true if the order should not be persisted
|
1274
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1275
|
+
def update_order_with_http_info(body, opts = {})
|
1276
|
+
if @api_client.config.debugging
|
1277
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.update_order ...'
|
1278
|
+
end
|
1279
|
+
# verify the required parameter 'body' is set
|
1280
|
+
if @api_client.config.client_side_validation && body.nil?
|
1281
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling OrdersApi.update_order"
|
1282
|
+
end
|
1283
|
+
# resource path
|
1284
|
+
local_var_path = '/orders'
|
1285
|
+
|
1286
|
+
# query parameters
|
1287
|
+
query_params = {}
|
1288
|
+
query_params[:'isDryRun'] = opts[:'is_dry_run'] if !opts[:'is_dry_run'].nil?
|
1289
|
+
|
1290
|
+
# header parameters
|
1291
|
+
header_params = {}
|
1292
|
+
# HTTP header 'Accept' (if needed)
|
1293
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1294
|
+
# HTTP header 'Content-Type'
|
1295
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1296
|
+
|
1297
|
+
# form parameters
|
1298
|
+
form_params = {}
|
1299
|
+
|
1300
|
+
# http body (model)
|
1301
|
+
post_body = @api_client.object_to_http_body(body)
|
1302
|
+
auth_names = ['ApiKeyAuth']
|
1303
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1304
|
+
:header_params => header_params,
|
1305
|
+
:query_params => query_params,
|
1306
|
+
:form_params => form_params,
|
1307
|
+
:body => post_body,
|
1308
|
+
:auth_names => auth_names)
|
1309
|
+
if @api_client.config.debugging
|
1310
|
+
@api_client.config.logger.debug "API called: OrdersApi#update_order\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1311
|
+
end
|
1312
|
+
return data, status_code, headers
|
1313
|
+
end
|
1314
|
+
# Update order status
|
1315
|
+
# Updates the status of the specified order to the specified value
|
1316
|
+
# @param id id of the order
|
1317
|
+
# @param status new status
|
1318
|
+
# @param [Hash] opts the optional parameters
|
1319
|
+
# @option opts [Integer] :status_updated_on Order status update time
|
1320
|
+
# @return [nil]
|
1321
|
+
def update_order_status(id, status, opts = {})
|
1322
|
+
update_order_status_with_http_info(id, status, opts)
|
1323
|
+
nil
|
1324
|
+
end
|
1325
|
+
|
1326
|
+
# Update order status
|
1327
|
+
# Updates the status of the specified order to the specified value
|
1328
|
+
# @param id id of the order
|
1329
|
+
# @param status new status
|
1330
|
+
# @param [Hash] opts the optional parameters
|
1331
|
+
# @option opts [Integer] :status_updated_on Order status update time
|
1332
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1333
|
+
def update_order_status_with_http_info(id, status, opts = {})
|
1334
|
+
if @api_client.config.debugging
|
1335
|
+
@api_client.config.logger.debug 'Calling API: OrdersApi.update_order_status ...'
|
1336
|
+
end
|
1337
|
+
# verify the required parameter 'id' is set
|
1338
|
+
if @api_client.config.client_side_validation && id.nil?
|
1339
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OrdersApi.update_order_status"
|
1340
|
+
end
|
1341
|
+
# verify the required parameter 'status' is set
|
1342
|
+
if @api_client.config.client_side_validation && status.nil?
|
1343
|
+
fail ArgumentError, "Missing the required parameter 'status' when calling OrdersApi.update_order_status"
|
1344
|
+
end
|
1345
|
+
# verify enum value
|
1346
|
+
if @api_client.config.client_side_validation && !['DRAFT', 'SUBMITTED', 'EXECUTED', 'CANCELLED'].include?(status)
|
1347
|
+
fail ArgumentError, "invalid value for 'status', must be one of DRAFT, SUBMITTED, EXECUTED, CANCELLED"
|
1348
|
+
end
|
1349
|
+
# resource path
|
1350
|
+
local_var_path = '/orders/{id}/status/{status}'.sub('{' + 'id' + '}', id.to_s).sub('{' + 'status' + '}', status.to_s)
|
1351
|
+
|
1352
|
+
# query parameters
|
1353
|
+
query_params = {}
|
1354
|
+
query_params[:'statusUpdatedOn'] = opts[:'status_updated_on'] if !opts[:'status_updated_on'].nil?
|
1355
|
+
|
1356
|
+
# header parameters
|
1357
|
+
header_params = {}
|
1358
|
+
# HTTP header 'Accept' (if needed)
|
1359
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1360
|
+
# HTTP header 'Content-Type'
|
1361
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1362
|
+
|
1363
|
+
# form parameters
|
1364
|
+
form_params = {}
|
1365
|
+
|
1366
|
+
# http body (model)
|
1367
|
+
post_body = nil
|
1368
|
+
auth_names = ['ApiKeyAuth']
|
1369
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1370
|
+
:header_params => header_params,
|
1371
|
+
:query_params => query_params,
|
1372
|
+
:form_params => form_params,
|
1373
|
+
:body => post_body,
|
1374
|
+
:auth_names => auth_names)
|
1375
|
+
if @api_client.config.debugging
|
1376
|
+
@api_client.config.logger.debug "API called: OrdersApi#update_order_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1377
|
+
end
|
1378
|
+
return data, status_code, headers
|
1379
|
+
end
|
1380
|
+
end
|
1381
|
+
end
|