subskribe_sandbox 1.0.0 → 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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,1886 @@
|
|
1
|
+
=begin
|
2
|
+
#Subskribe API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.41
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module SwaggerClient
|
16
|
+
class ProductCatalogApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Activate a plan
|
23
|
+
# Marks a plan as active
|
24
|
+
# @param plan_id id of the plan
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [PlanJson]
|
27
|
+
def activate_plan(plan_id, opts = {})
|
28
|
+
data, _status_code, _headers = activate_plan_with_http_info(plan_id, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Activate a plan
|
33
|
+
# Marks a plan as active
|
34
|
+
# @param plan_id id of the plan
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
37
|
+
def activate_plan_with_http_info(plan_id, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.activate_plan ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'plan_id' is set
|
42
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.activate_plan"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/plans/{planId}/activate'.sub('{' + 'planId' + '}', plan_id.to_s)
|
47
|
+
|
48
|
+
# query parameters
|
49
|
+
query_params = {}
|
50
|
+
|
51
|
+
# header parameters
|
52
|
+
header_params = {}
|
53
|
+
# HTTP header 'Accept' (if needed)
|
54
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
55
|
+
|
56
|
+
# form parameters
|
57
|
+
form_params = {}
|
58
|
+
|
59
|
+
# http body (model)
|
60
|
+
post_body = nil
|
61
|
+
auth_names = ['ApiKeyAuth']
|
62
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
63
|
+
:header_params => header_params,
|
64
|
+
:query_params => query_params,
|
65
|
+
:form_params => form_params,
|
66
|
+
:body => post_body,
|
67
|
+
:auth_names => auth_names,
|
68
|
+
:return_type => 'PlanJson')
|
69
|
+
if @api_client.config.debugging
|
70
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#activate_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
71
|
+
end
|
72
|
+
return data, status_code, headers
|
73
|
+
end
|
74
|
+
# Add charge to plan
|
75
|
+
# Adds a charge to the specified plan. On success the id of the new charge is returned
|
76
|
+
# @param plan_id id of the plan
|
77
|
+
# @param body json representing the charge details
|
78
|
+
# @param [Hash] opts the optional parameters
|
79
|
+
# @return [ChargeJson]
|
80
|
+
def add_charge(plan_id, body, opts = {})
|
81
|
+
data, _status_code, _headers = add_charge_with_http_info(plan_id, body, opts)
|
82
|
+
data
|
83
|
+
end
|
84
|
+
|
85
|
+
# Add charge to plan
|
86
|
+
# Adds a charge to the specified plan. On success the id of the new charge is returned
|
87
|
+
# @param plan_id id of the plan
|
88
|
+
# @param body json representing the charge details
|
89
|
+
# @param [Hash] opts the optional parameters
|
90
|
+
# @return [Array<(ChargeJson, Fixnum, Hash)>] ChargeJson data, response status code and response headers
|
91
|
+
def add_charge_with_http_info(plan_id, body, opts = {})
|
92
|
+
if @api_client.config.debugging
|
93
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.add_charge ...'
|
94
|
+
end
|
95
|
+
# verify the required parameter 'plan_id' is set
|
96
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
97
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.add_charge"
|
98
|
+
end
|
99
|
+
# verify the required parameter 'body' is set
|
100
|
+
if @api_client.config.client_side_validation && body.nil?
|
101
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.add_charge"
|
102
|
+
end
|
103
|
+
# resource path
|
104
|
+
local_var_path = '/plans/{planId}/charges'.sub('{' + 'planId' + '}', plan_id.to_s)
|
105
|
+
|
106
|
+
# query parameters
|
107
|
+
query_params = {}
|
108
|
+
|
109
|
+
# header parameters
|
110
|
+
header_params = {}
|
111
|
+
# HTTP header 'Accept' (if needed)
|
112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
113
|
+
# HTTP header 'Content-Type'
|
114
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
115
|
+
|
116
|
+
# form parameters
|
117
|
+
form_params = {}
|
118
|
+
|
119
|
+
# http body (model)
|
120
|
+
post_body = @api_client.object_to_http_body(body)
|
121
|
+
auth_names = ['ApiKeyAuth']
|
122
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
123
|
+
:header_params => header_params,
|
124
|
+
:query_params => query_params,
|
125
|
+
:form_params => form_params,
|
126
|
+
:body => post_body,
|
127
|
+
:auth_names => auth_names,
|
128
|
+
:return_type => 'ChargeJson')
|
129
|
+
if @api_client.config.debugging
|
130
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#add_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
131
|
+
end
|
132
|
+
return data, status_code, headers
|
133
|
+
end
|
134
|
+
# Create percent of relationship
|
135
|
+
# Creates a percent of relationship between a charge and plan. On success the id of the relationship is returned.
|
136
|
+
# @param body json representing the relationship
|
137
|
+
# @param [Hash] opts the optional parameters
|
138
|
+
# @return [nil]
|
139
|
+
def add_percent_of_plan_relationship(body, opts = {})
|
140
|
+
add_percent_of_plan_relationship_with_http_info(body, opts)
|
141
|
+
nil
|
142
|
+
end
|
143
|
+
|
144
|
+
# Create percent of relationship
|
145
|
+
# Creates a percent of relationship between a charge and plan. On success the id of the relationship is returned.
|
146
|
+
# @param body json representing the relationship
|
147
|
+
# @param [Hash] opts the optional parameters
|
148
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
149
|
+
def add_percent_of_plan_relationship_with_http_info(body, opts = {})
|
150
|
+
if @api_client.config.debugging
|
151
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.add_percent_of_plan_relationship ...'
|
152
|
+
end
|
153
|
+
# verify the required parameter 'body' is set
|
154
|
+
if @api_client.config.client_side_validation && body.nil?
|
155
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.add_percent_of_plan_relationship"
|
156
|
+
end
|
157
|
+
# resource path
|
158
|
+
local_var_path = '/plans/relationships/percentOf'
|
159
|
+
|
160
|
+
# query parameters
|
161
|
+
query_params = {}
|
162
|
+
|
163
|
+
# header parameters
|
164
|
+
header_params = {}
|
165
|
+
# HTTP header 'Accept' (if needed)
|
166
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
167
|
+
|
168
|
+
# form parameters
|
169
|
+
form_params = {}
|
170
|
+
|
171
|
+
# http body (model)
|
172
|
+
post_body = @api_client.object_to_http_body(body)
|
173
|
+
auth_names = ['ApiKeyAuth']
|
174
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
175
|
+
:header_params => header_params,
|
176
|
+
:query_params => query_params,
|
177
|
+
:form_params => form_params,
|
178
|
+
:body => post_body,
|
179
|
+
:auth_names => auth_names)
|
180
|
+
if @api_client.config.debugging
|
181
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#add_percent_of_plan_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
182
|
+
end
|
183
|
+
return data, status_code, headers
|
184
|
+
end
|
185
|
+
# Create a plan
|
186
|
+
# Creates a plan. On success the id of the new plan is returned.
|
187
|
+
# @param body json of the plan details
|
188
|
+
# @param [Hash] opts the optional parameters
|
189
|
+
# @return [PlanJson]
|
190
|
+
def add_plan(body, opts = {})
|
191
|
+
data, _status_code, _headers = add_plan_with_http_info(body, opts)
|
192
|
+
data
|
193
|
+
end
|
194
|
+
|
195
|
+
# Create a plan
|
196
|
+
# Creates a plan. On success the id of the new plan is returned.
|
197
|
+
# @param body json of the plan details
|
198
|
+
# @param [Hash] opts the optional parameters
|
199
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
200
|
+
def add_plan_with_http_info(body, opts = {})
|
201
|
+
if @api_client.config.debugging
|
202
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.add_plan ...'
|
203
|
+
end
|
204
|
+
# verify the required parameter 'body' is set
|
205
|
+
if @api_client.config.client_side_validation && body.nil?
|
206
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.add_plan"
|
207
|
+
end
|
208
|
+
# resource path
|
209
|
+
local_var_path = '/plans'
|
210
|
+
|
211
|
+
# query parameters
|
212
|
+
query_params = {}
|
213
|
+
|
214
|
+
# header parameters
|
215
|
+
header_params = {}
|
216
|
+
# HTTP header 'Accept' (if needed)
|
217
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
218
|
+
# HTTP header 'Content-Type'
|
219
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
220
|
+
|
221
|
+
# form parameters
|
222
|
+
form_params = {}
|
223
|
+
|
224
|
+
# http body (model)
|
225
|
+
post_body = @api_client.object_to_http_body(body)
|
226
|
+
auth_names = ['ApiKeyAuth']
|
227
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
228
|
+
:header_params => header_params,
|
229
|
+
:query_params => query_params,
|
230
|
+
:form_params => form_params,
|
231
|
+
:body => post_body,
|
232
|
+
:auth_names => auth_names,
|
233
|
+
:return_type => 'PlanJson')
|
234
|
+
if @api_client.config.debugging
|
235
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#add_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
236
|
+
end
|
237
|
+
return data, status_code, headers
|
238
|
+
end
|
239
|
+
# Create a product
|
240
|
+
# Creates a product for your tenant. On success the id of the product is returned.
|
241
|
+
# @param body product details json
|
242
|
+
# @param [Hash] opts the optional parameters
|
243
|
+
# @return [ProductJson]
|
244
|
+
def add_product(body, opts = {})
|
245
|
+
data, _status_code, _headers = add_product_with_http_info(body, opts)
|
246
|
+
data
|
247
|
+
end
|
248
|
+
|
249
|
+
# Create a product
|
250
|
+
# Creates a product for your tenant. On success the id of the product is returned.
|
251
|
+
# @param body product details json
|
252
|
+
# @param [Hash] opts the optional parameters
|
253
|
+
# @return [Array<(ProductJson, Fixnum, Hash)>] ProductJson data, response status code and response headers
|
254
|
+
def add_product_with_http_info(body, opts = {})
|
255
|
+
if @api_client.config.debugging
|
256
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.add_product ...'
|
257
|
+
end
|
258
|
+
# verify the required parameter 'body' is set
|
259
|
+
if @api_client.config.client_side_validation && body.nil?
|
260
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.add_product"
|
261
|
+
end
|
262
|
+
# resource path
|
263
|
+
local_var_path = '/products'
|
264
|
+
|
265
|
+
# query parameters
|
266
|
+
query_params = {}
|
267
|
+
|
268
|
+
# header parameters
|
269
|
+
header_params = {}
|
270
|
+
# HTTP header 'Accept' (if needed)
|
271
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
272
|
+
# HTTP header 'Content-Type'
|
273
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
274
|
+
|
275
|
+
# form parameters
|
276
|
+
form_params = {}
|
277
|
+
|
278
|
+
# http body (model)
|
279
|
+
post_body = @api_client.object_to_http_body(body)
|
280
|
+
auth_names = ['ApiKeyAuth']
|
281
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
282
|
+
:header_params => header_params,
|
283
|
+
:query_params => query_params,
|
284
|
+
:form_params => form_params,
|
285
|
+
:body => post_body,
|
286
|
+
:auth_names => auth_names,
|
287
|
+
:return_type => 'ProductJson')
|
288
|
+
if @api_client.config.debugging
|
289
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#add_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
290
|
+
end
|
291
|
+
return data, status_code, headers
|
292
|
+
end
|
293
|
+
# Create a product category
|
294
|
+
# Creates a product category. On success the id of the category is returned.
|
295
|
+
# @param body product category details json
|
296
|
+
# @param [Hash] opts the optional parameters
|
297
|
+
# @return [ProductCategory]
|
298
|
+
def add_product_category(body, opts = {})
|
299
|
+
data, _status_code, _headers = add_product_category_with_http_info(body, opts)
|
300
|
+
data
|
301
|
+
end
|
302
|
+
|
303
|
+
# Create a product category
|
304
|
+
# Creates a product category. On success the id of the category is returned.
|
305
|
+
# @param body product category details json
|
306
|
+
# @param [Hash] opts the optional parameters
|
307
|
+
# @return [Array<(ProductCategory, Fixnum, Hash)>] ProductCategory data, response status code and response headers
|
308
|
+
def add_product_category_with_http_info(body, opts = {})
|
309
|
+
if @api_client.config.debugging
|
310
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.add_product_category ...'
|
311
|
+
end
|
312
|
+
# verify the required parameter 'body' is set
|
313
|
+
if @api_client.config.client_side_validation && body.nil?
|
314
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.add_product_category"
|
315
|
+
end
|
316
|
+
# resource path
|
317
|
+
local_var_path = '/product/categories'
|
318
|
+
|
319
|
+
# query parameters
|
320
|
+
query_params = {}
|
321
|
+
|
322
|
+
# header parameters
|
323
|
+
header_params = {}
|
324
|
+
# HTTP header 'Accept' (if needed)
|
325
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
326
|
+
# HTTP header 'Content-Type'
|
327
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
328
|
+
|
329
|
+
# form parameters
|
330
|
+
form_params = {}
|
331
|
+
|
332
|
+
# http body (model)
|
333
|
+
post_body = @api_client.object_to_http_body(body)
|
334
|
+
auth_names = ['ApiKeyAuth']
|
335
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
336
|
+
:header_params => header_params,
|
337
|
+
:query_params => query_params,
|
338
|
+
:form_params => form_params,
|
339
|
+
:body => post_body,
|
340
|
+
:auth_names => auth_names,
|
341
|
+
:return_type => 'ProductCategory')
|
342
|
+
if @api_client.config.debugging
|
343
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#add_product_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
344
|
+
end
|
345
|
+
return data, status_code, headers
|
346
|
+
end
|
347
|
+
# Revert a plan to draft
|
348
|
+
# Marks a plan as draft
|
349
|
+
# @param plan_id id of the plan
|
350
|
+
# @param [Hash] opts the optional parameters
|
351
|
+
# @return [PlanJson]
|
352
|
+
def deactivate_plan(plan_id, opts = {})
|
353
|
+
data, _status_code, _headers = deactivate_plan_with_http_info(plan_id, opts)
|
354
|
+
data
|
355
|
+
end
|
356
|
+
|
357
|
+
# Revert a plan to draft
|
358
|
+
# Marks a plan as draft
|
359
|
+
# @param plan_id id of the plan
|
360
|
+
# @param [Hash] opts the optional parameters
|
361
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
362
|
+
def deactivate_plan_with_http_info(plan_id, opts = {})
|
363
|
+
if @api_client.config.debugging
|
364
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.deactivate_plan ...'
|
365
|
+
end
|
366
|
+
# verify the required parameter 'plan_id' is set
|
367
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
368
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.deactivate_plan"
|
369
|
+
end
|
370
|
+
# resource path
|
371
|
+
local_var_path = '/plans/{planId}/revertToDraft'.sub('{' + 'planId' + '}', plan_id.to_s)
|
372
|
+
|
373
|
+
# query parameters
|
374
|
+
query_params = {}
|
375
|
+
|
376
|
+
# header parameters
|
377
|
+
header_params = {}
|
378
|
+
# HTTP header 'Accept' (if needed)
|
379
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
380
|
+
|
381
|
+
# form parameters
|
382
|
+
form_params = {}
|
383
|
+
|
384
|
+
# http body (model)
|
385
|
+
post_body = nil
|
386
|
+
auth_names = ['ApiKeyAuth']
|
387
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
388
|
+
:header_params => header_params,
|
389
|
+
:query_params => query_params,
|
390
|
+
:form_params => form_params,
|
391
|
+
:body => post_body,
|
392
|
+
:auth_names => auth_names,
|
393
|
+
:return_type => 'PlanJson')
|
394
|
+
if @api_client.config.debugging
|
395
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#deactivate_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
396
|
+
end
|
397
|
+
return data, status_code, headers
|
398
|
+
end
|
399
|
+
# Delete a catalog relationship
|
400
|
+
# Deletes the specified catalog relationship
|
401
|
+
# @param relationship_id id of the relationship
|
402
|
+
# @param [Hash] opts the optional parameters
|
403
|
+
# @return [CatalogRelationship]
|
404
|
+
def delete_catalog_relationship_by_id(relationship_id, opts = {})
|
405
|
+
data, _status_code, _headers = delete_catalog_relationship_by_id_with_http_info(relationship_id, opts)
|
406
|
+
data
|
407
|
+
end
|
408
|
+
|
409
|
+
# Delete a catalog relationship
|
410
|
+
# Deletes the specified catalog relationship
|
411
|
+
# @param relationship_id id of the relationship
|
412
|
+
# @param [Hash] opts the optional parameters
|
413
|
+
# @return [Array<(CatalogRelationship, Fixnum, Hash)>] CatalogRelationship data, response status code and response headers
|
414
|
+
def delete_catalog_relationship_by_id_with_http_info(relationship_id, opts = {})
|
415
|
+
if @api_client.config.debugging
|
416
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.delete_catalog_relationship_by_id ...'
|
417
|
+
end
|
418
|
+
# verify the required parameter 'relationship_id' is set
|
419
|
+
if @api_client.config.client_side_validation && relationship_id.nil?
|
420
|
+
fail ArgumentError, "Missing the required parameter 'relationship_id' when calling ProductCatalogApi.delete_catalog_relationship_by_id"
|
421
|
+
end
|
422
|
+
# resource path
|
423
|
+
local_var_path = '/plans/relationships/{relationshipId}'.sub('{' + 'relationshipId' + '}', relationship_id.to_s)
|
424
|
+
|
425
|
+
# query parameters
|
426
|
+
query_params = {}
|
427
|
+
|
428
|
+
# header parameters
|
429
|
+
header_params = {}
|
430
|
+
# HTTP header 'Accept' (if needed)
|
431
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
432
|
+
|
433
|
+
# form parameters
|
434
|
+
form_params = {}
|
435
|
+
|
436
|
+
# http body (model)
|
437
|
+
post_body = nil
|
438
|
+
auth_names = ['ApiKeyAuth']
|
439
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
440
|
+
:header_params => header_params,
|
441
|
+
:query_params => query_params,
|
442
|
+
:form_params => form_params,
|
443
|
+
:body => post_body,
|
444
|
+
:auth_names => auth_names,
|
445
|
+
:return_type => 'CatalogRelationship')
|
446
|
+
if @api_client.config.debugging
|
447
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#delete_catalog_relationship_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
448
|
+
end
|
449
|
+
return data, status_code, headers
|
450
|
+
end
|
451
|
+
# Delete a charge
|
452
|
+
# Removes a charge from a plan.
|
453
|
+
# @param plan_id id of the plan
|
454
|
+
# @param charge_id id of the charge
|
455
|
+
# @param [Hash] opts the optional parameters
|
456
|
+
# @return [ChargeJson]
|
457
|
+
def delete_charge(plan_id, charge_id, opts = {})
|
458
|
+
data, _status_code, _headers = delete_charge_with_http_info(plan_id, charge_id, opts)
|
459
|
+
data
|
460
|
+
end
|
461
|
+
|
462
|
+
# Delete a charge
|
463
|
+
# Removes a charge from a plan.
|
464
|
+
# @param plan_id id of the plan
|
465
|
+
# @param charge_id id of the charge
|
466
|
+
# @param [Hash] opts the optional parameters
|
467
|
+
# @return [Array<(ChargeJson, Fixnum, Hash)>] ChargeJson data, response status code and response headers
|
468
|
+
def delete_charge_with_http_info(plan_id, charge_id, opts = {})
|
469
|
+
if @api_client.config.debugging
|
470
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.delete_charge ...'
|
471
|
+
end
|
472
|
+
# verify the required parameter 'plan_id' is set
|
473
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
474
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.delete_charge"
|
475
|
+
end
|
476
|
+
# verify the required parameter 'charge_id' is set
|
477
|
+
if @api_client.config.client_side_validation && charge_id.nil?
|
478
|
+
fail ArgumentError, "Missing the required parameter 'charge_id' when calling ProductCatalogApi.delete_charge"
|
479
|
+
end
|
480
|
+
# resource path
|
481
|
+
local_var_path = '/plans/{planId}/charges/{chargeId}'.sub('{' + 'planId' + '}', plan_id.to_s).sub('{' + 'chargeId' + '}', charge_id.to_s)
|
482
|
+
|
483
|
+
# query parameters
|
484
|
+
query_params = {}
|
485
|
+
|
486
|
+
# header parameters
|
487
|
+
header_params = {}
|
488
|
+
# HTTP header 'Accept' (if needed)
|
489
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
490
|
+
# HTTP header 'Content-Type'
|
491
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
492
|
+
|
493
|
+
# form parameters
|
494
|
+
form_params = {}
|
495
|
+
|
496
|
+
# http body (model)
|
497
|
+
post_body = nil
|
498
|
+
auth_names = ['ApiKeyAuth']
|
499
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
500
|
+
:header_params => header_params,
|
501
|
+
:query_params => query_params,
|
502
|
+
:form_params => form_params,
|
503
|
+
:body => post_body,
|
504
|
+
:auth_names => auth_names,
|
505
|
+
:return_type => 'ChargeJson')
|
506
|
+
if @api_client.config.debugging
|
507
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#delete_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
508
|
+
end
|
509
|
+
return data, status_code, headers
|
510
|
+
end
|
511
|
+
# Delete a plan
|
512
|
+
# Deletes a plan. Note you can't delete a plan that's in use.
|
513
|
+
# @param plan_id id of the plan
|
514
|
+
# @param [Hash] opts the optional parameters
|
515
|
+
# @return [PlanJson]
|
516
|
+
def delete_plan(plan_id, opts = {})
|
517
|
+
data, _status_code, _headers = delete_plan_with_http_info(plan_id, opts)
|
518
|
+
data
|
519
|
+
end
|
520
|
+
|
521
|
+
# Delete a plan
|
522
|
+
# Deletes a plan. Note you can't delete a plan that's in use.
|
523
|
+
# @param plan_id id of the plan
|
524
|
+
# @param [Hash] opts the optional parameters
|
525
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
526
|
+
def delete_plan_with_http_info(plan_id, opts = {})
|
527
|
+
if @api_client.config.debugging
|
528
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.delete_plan ...'
|
529
|
+
end
|
530
|
+
# verify the required parameter 'plan_id' is set
|
531
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
532
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.delete_plan"
|
533
|
+
end
|
534
|
+
# resource path
|
535
|
+
local_var_path = '/plans/{planId}'.sub('{' + 'planId' + '}', plan_id.to_s)
|
536
|
+
|
537
|
+
# query parameters
|
538
|
+
query_params = {}
|
539
|
+
|
540
|
+
# header parameters
|
541
|
+
header_params = {}
|
542
|
+
# HTTP header 'Accept' (if needed)
|
543
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
544
|
+
|
545
|
+
# form parameters
|
546
|
+
form_params = {}
|
547
|
+
|
548
|
+
# http body (model)
|
549
|
+
post_body = nil
|
550
|
+
auth_names = ['ApiKeyAuth']
|
551
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
552
|
+
:header_params => header_params,
|
553
|
+
:query_params => query_params,
|
554
|
+
:form_params => form_params,
|
555
|
+
:body => post_body,
|
556
|
+
:auth_names => auth_names,
|
557
|
+
:return_type => 'PlanJson')
|
558
|
+
if @api_client.config.debugging
|
559
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#delete_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
560
|
+
end
|
561
|
+
return data, status_code, headers
|
562
|
+
end
|
563
|
+
# Delete a product
|
564
|
+
# Delete the specified product.
|
565
|
+
# @param id id of the product
|
566
|
+
# @param [Hash] opts the optional parameters
|
567
|
+
# @return [ProductJson]
|
568
|
+
def delete_product(id, opts = {})
|
569
|
+
data, _status_code, _headers = delete_product_with_http_info(id, opts)
|
570
|
+
data
|
571
|
+
end
|
572
|
+
|
573
|
+
# Delete a product
|
574
|
+
# Delete the specified product.
|
575
|
+
# @param id id of the product
|
576
|
+
# @param [Hash] opts the optional parameters
|
577
|
+
# @return [Array<(ProductJson, Fixnum, Hash)>] ProductJson data, response status code and response headers
|
578
|
+
def delete_product_with_http_info(id, opts = {})
|
579
|
+
if @api_client.config.debugging
|
580
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.delete_product ...'
|
581
|
+
end
|
582
|
+
# verify the required parameter 'id' is set
|
583
|
+
if @api_client.config.client_side_validation && id.nil?
|
584
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProductCatalogApi.delete_product"
|
585
|
+
end
|
586
|
+
# resource path
|
587
|
+
local_var_path = '/products/{id}'.sub('{' + 'id' + '}', id.to_s)
|
588
|
+
|
589
|
+
# query parameters
|
590
|
+
query_params = {}
|
591
|
+
|
592
|
+
# header parameters
|
593
|
+
header_params = {}
|
594
|
+
# HTTP header 'Accept' (if needed)
|
595
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
596
|
+
|
597
|
+
# form parameters
|
598
|
+
form_params = {}
|
599
|
+
|
600
|
+
# http body (model)
|
601
|
+
post_body = nil
|
602
|
+
auth_names = ['ApiKeyAuth']
|
603
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
604
|
+
:header_params => header_params,
|
605
|
+
:query_params => query_params,
|
606
|
+
:form_params => form_params,
|
607
|
+
:body => post_body,
|
608
|
+
:auth_names => auth_names,
|
609
|
+
:return_type => 'ProductJson')
|
610
|
+
if @api_client.config.debugging
|
611
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#delete_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
612
|
+
end
|
613
|
+
return data, status_code, headers
|
614
|
+
end
|
615
|
+
# Delete a product category
|
616
|
+
# Deletes the specified product category. Note that a product category can't be delete once it's in use.
|
617
|
+
# @param id id of the category
|
618
|
+
# @param [Hash] opts the optional parameters
|
619
|
+
# @return [ProductCategory]
|
620
|
+
def delete_product_category(id, opts = {})
|
621
|
+
data, _status_code, _headers = delete_product_category_with_http_info(id, opts)
|
622
|
+
data
|
623
|
+
end
|
624
|
+
|
625
|
+
# Delete a product category
|
626
|
+
# Deletes the specified product category. Note that a product category can't be delete once it's in use.
|
627
|
+
# @param id id of the category
|
628
|
+
# @param [Hash] opts the optional parameters
|
629
|
+
# @return [Array<(ProductCategory, Fixnum, Hash)>] ProductCategory data, response status code and response headers
|
630
|
+
def delete_product_category_with_http_info(id, opts = {})
|
631
|
+
if @api_client.config.debugging
|
632
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.delete_product_category ...'
|
633
|
+
end
|
634
|
+
# verify the required parameter 'id' is set
|
635
|
+
if @api_client.config.client_side_validation && id.nil?
|
636
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProductCatalogApi.delete_product_category"
|
637
|
+
end
|
638
|
+
# resource path
|
639
|
+
local_var_path = '/product/categories/{id}'.sub('{' + 'id' + '}', id.to_s)
|
640
|
+
|
641
|
+
# query parameters
|
642
|
+
query_params = {}
|
643
|
+
|
644
|
+
# header parameters
|
645
|
+
header_params = {}
|
646
|
+
# HTTP header 'Accept' (if needed)
|
647
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
648
|
+
|
649
|
+
# form parameters
|
650
|
+
form_params = {}
|
651
|
+
|
652
|
+
# http body (model)
|
653
|
+
post_body = nil
|
654
|
+
auth_names = ['ApiKeyAuth']
|
655
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
656
|
+
:header_params => header_params,
|
657
|
+
:query_params => query_params,
|
658
|
+
:form_params => form_params,
|
659
|
+
:body => post_body,
|
660
|
+
:auth_names => auth_names,
|
661
|
+
:return_type => 'ProductCategory')
|
662
|
+
if @api_client.config.debugging
|
663
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#delete_product_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
664
|
+
end
|
665
|
+
return data, status_code, headers
|
666
|
+
end
|
667
|
+
# Deprecate a plan
|
668
|
+
# Marks a plan as deprecated. Once deprecated a plan may not be attached to new orders.
|
669
|
+
# @param plan_id id of the plan
|
670
|
+
# @param [Hash] opts the optional parameters
|
671
|
+
# @return [PlanJson]
|
672
|
+
def deprecate_plan(plan_id, opts = {})
|
673
|
+
data, _status_code, _headers = deprecate_plan_with_http_info(plan_id, opts)
|
674
|
+
data
|
675
|
+
end
|
676
|
+
|
677
|
+
# Deprecate a plan
|
678
|
+
# Marks a plan as deprecated. Once deprecated a plan may not be attached to new orders.
|
679
|
+
# @param plan_id id of the plan
|
680
|
+
# @param [Hash] opts the optional parameters
|
681
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
682
|
+
def deprecate_plan_with_http_info(plan_id, opts = {})
|
683
|
+
if @api_client.config.debugging
|
684
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.deprecate_plan ...'
|
685
|
+
end
|
686
|
+
# verify the required parameter 'plan_id' is set
|
687
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
688
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.deprecate_plan"
|
689
|
+
end
|
690
|
+
# resource path
|
691
|
+
local_var_path = '/plans/{planId}/deprecate'.sub('{' + 'planId' + '}', plan_id.to_s)
|
692
|
+
|
693
|
+
# query parameters
|
694
|
+
query_params = {}
|
695
|
+
|
696
|
+
# header parameters
|
697
|
+
header_params = {}
|
698
|
+
# HTTP header 'Accept' (if needed)
|
699
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
700
|
+
|
701
|
+
# form parameters
|
702
|
+
form_params = {}
|
703
|
+
|
704
|
+
# http body (model)
|
705
|
+
post_body = nil
|
706
|
+
auth_names = ['ApiKeyAuth']
|
707
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
708
|
+
:header_params => header_params,
|
709
|
+
:query_params => query_params,
|
710
|
+
:form_params => form_params,
|
711
|
+
:body => post_body,
|
712
|
+
:auth_names => auth_names,
|
713
|
+
:return_type => 'PlanJson')
|
714
|
+
if @api_client.config.debugging
|
715
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#deprecate_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
716
|
+
end
|
717
|
+
return data, status_code, headers
|
718
|
+
end
|
719
|
+
# Duplicate a plan
|
720
|
+
# Duplicates the specified plan. On success the new plan id is returned.
|
721
|
+
# @param plan_id id of the plan to duplicate
|
722
|
+
# @param [Hash] opts the optional parameters
|
723
|
+
# @return [PlanJson]
|
724
|
+
def duplicate_plan(plan_id, opts = {})
|
725
|
+
data, _status_code, _headers = duplicate_plan_with_http_info(plan_id, opts)
|
726
|
+
data
|
727
|
+
end
|
728
|
+
|
729
|
+
# Duplicate a plan
|
730
|
+
# Duplicates the specified plan. On success the new plan id is returned.
|
731
|
+
# @param plan_id id of the plan to duplicate
|
732
|
+
# @param [Hash] opts the optional parameters
|
733
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
734
|
+
def duplicate_plan_with_http_info(plan_id, opts = {})
|
735
|
+
if @api_client.config.debugging
|
736
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.duplicate_plan ...'
|
737
|
+
end
|
738
|
+
# verify the required parameter 'plan_id' is set
|
739
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
740
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.duplicate_plan"
|
741
|
+
end
|
742
|
+
# resource path
|
743
|
+
local_var_path = '/plans/{planId}/duplicate'.sub('{' + 'planId' + '}', plan_id.to_s)
|
744
|
+
|
745
|
+
# query parameters
|
746
|
+
query_params = {}
|
747
|
+
|
748
|
+
# header parameters
|
749
|
+
header_params = {}
|
750
|
+
# HTTP header 'Accept' (if needed)
|
751
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
752
|
+
|
753
|
+
# form parameters
|
754
|
+
form_params = {}
|
755
|
+
|
756
|
+
# http body (model)
|
757
|
+
post_body = nil
|
758
|
+
auth_names = ['ApiKeyAuth']
|
759
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
760
|
+
:header_params => header_params,
|
761
|
+
:query_params => query_params,
|
762
|
+
:form_params => form_params,
|
763
|
+
:body => post_body,
|
764
|
+
:auth_names => auth_names,
|
765
|
+
:return_type => 'PlanJson')
|
766
|
+
if @api_client.config.debugging
|
767
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#duplicate_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
768
|
+
end
|
769
|
+
return data, status_code, headers
|
770
|
+
end
|
771
|
+
# Export product catalog
|
772
|
+
# Export the product catalog in CSV format.
|
773
|
+
# @param [Hash] opts the optional parameters
|
774
|
+
# @return [nil]
|
775
|
+
def export_product_catalog(opts = {})
|
776
|
+
export_product_catalog_with_http_info(opts)
|
777
|
+
nil
|
778
|
+
end
|
779
|
+
|
780
|
+
# Export product catalog
|
781
|
+
# Export the product catalog in CSV format.
|
782
|
+
# @param [Hash] opts the optional parameters
|
783
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
784
|
+
def export_product_catalog_with_http_info(opts = {})
|
785
|
+
if @api_client.config.debugging
|
786
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.export_product_catalog ...'
|
787
|
+
end
|
788
|
+
# resource path
|
789
|
+
local_var_path = '/products/export'
|
790
|
+
|
791
|
+
# query parameters
|
792
|
+
query_params = {}
|
793
|
+
|
794
|
+
# header parameters
|
795
|
+
header_params = {}
|
796
|
+
# HTTP header 'Accept' (if needed)
|
797
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
798
|
+
|
799
|
+
# form parameters
|
800
|
+
form_params = {}
|
801
|
+
|
802
|
+
# http body (model)
|
803
|
+
post_body = nil
|
804
|
+
auth_names = ['ApiKeyAuth']
|
805
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
806
|
+
:header_params => header_params,
|
807
|
+
:query_params => query_params,
|
808
|
+
:form_params => form_params,
|
809
|
+
:body => post_body,
|
810
|
+
:auth_names => auth_names)
|
811
|
+
if @api_client.config.debugging
|
812
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#export_product_catalog\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
813
|
+
end
|
814
|
+
return data, status_code, headers
|
815
|
+
end
|
816
|
+
# Get relationship details
|
817
|
+
# Gets the details of the specified catalog relationship.
|
818
|
+
# @param relationship_id id of the relationship
|
819
|
+
# @param [Hash] opts the optional parameters
|
820
|
+
# @return [CatalogRelationship]
|
821
|
+
def get_catalog_relationship_by_id(relationship_id, opts = {})
|
822
|
+
data, _status_code, _headers = get_catalog_relationship_by_id_with_http_info(relationship_id, opts)
|
823
|
+
data
|
824
|
+
end
|
825
|
+
|
826
|
+
# Get relationship details
|
827
|
+
# Gets the details of the specified catalog relationship.
|
828
|
+
# @param relationship_id id of the relationship
|
829
|
+
# @param [Hash] opts the optional parameters
|
830
|
+
# @return [Array<(CatalogRelationship, Fixnum, Hash)>] CatalogRelationship data, response status code and response headers
|
831
|
+
def get_catalog_relationship_by_id_with_http_info(relationship_id, opts = {})
|
832
|
+
if @api_client.config.debugging
|
833
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_catalog_relationship_by_id ...'
|
834
|
+
end
|
835
|
+
# verify the required parameter 'relationship_id' is set
|
836
|
+
if @api_client.config.client_side_validation && relationship_id.nil?
|
837
|
+
fail ArgumentError, "Missing the required parameter 'relationship_id' when calling ProductCatalogApi.get_catalog_relationship_by_id"
|
838
|
+
end
|
839
|
+
# resource path
|
840
|
+
local_var_path = '/plans/relationships/{relationshipId}'.sub('{' + 'relationshipId' + '}', relationship_id.to_s)
|
841
|
+
|
842
|
+
# query parameters
|
843
|
+
query_params = {}
|
844
|
+
|
845
|
+
# header parameters
|
846
|
+
header_params = {}
|
847
|
+
# HTTP header 'Accept' (if needed)
|
848
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
849
|
+
|
850
|
+
# form parameters
|
851
|
+
form_params = {}
|
852
|
+
|
853
|
+
# http body (model)
|
854
|
+
post_body = nil
|
855
|
+
auth_names = ['ApiKeyAuth']
|
856
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
857
|
+
:header_params => header_params,
|
858
|
+
:query_params => query_params,
|
859
|
+
:form_params => form_params,
|
860
|
+
:body => post_body,
|
861
|
+
:auth_names => auth_names,
|
862
|
+
:return_type => 'CatalogRelationship')
|
863
|
+
if @api_client.config.debugging
|
864
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_catalog_relationship_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
865
|
+
end
|
866
|
+
return data, status_code, headers
|
867
|
+
end
|
868
|
+
# Get charge details
|
869
|
+
# Gets the details of the specified charge on the specified plan.
|
870
|
+
# @param plan_id id of the plan
|
871
|
+
# @param charge_id id of the charge
|
872
|
+
# @param [Hash] opts the optional parameters
|
873
|
+
# @return [ChargeJson]
|
874
|
+
def get_charge(plan_id, charge_id, opts = {})
|
875
|
+
data, _status_code, _headers = get_charge_with_http_info(plan_id, charge_id, opts)
|
876
|
+
data
|
877
|
+
end
|
878
|
+
|
879
|
+
# Get charge details
|
880
|
+
# Gets the details of the specified charge on the specified plan.
|
881
|
+
# @param plan_id id of the plan
|
882
|
+
# @param charge_id id of the charge
|
883
|
+
# @param [Hash] opts the optional parameters
|
884
|
+
# @return [Array<(ChargeJson, Fixnum, Hash)>] ChargeJson data, response status code and response headers
|
885
|
+
def get_charge_with_http_info(plan_id, charge_id, opts = {})
|
886
|
+
if @api_client.config.debugging
|
887
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_charge ...'
|
888
|
+
end
|
889
|
+
# verify the required parameter 'plan_id' is set
|
890
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
891
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.get_charge"
|
892
|
+
end
|
893
|
+
# verify the required parameter 'charge_id' is set
|
894
|
+
if @api_client.config.client_side_validation && charge_id.nil?
|
895
|
+
fail ArgumentError, "Missing the required parameter 'charge_id' when calling ProductCatalogApi.get_charge"
|
896
|
+
end
|
897
|
+
# resource path
|
898
|
+
local_var_path = '/plans/{planId}/charges/{chargeId}'.sub('{' + 'planId' + '}', plan_id.to_s).sub('{' + 'chargeId' + '}', charge_id.to_s)
|
899
|
+
|
900
|
+
# query parameters
|
901
|
+
query_params = {}
|
902
|
+
|
903
|
+
# header parameters
|
904
|
+
header_params = {}
|
905
|
+
# HTTP header 'Accept' (if needed)
|
906
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
907
|
+
|
908
|
+
# form parameters
|
909
|
+
form_params = {}
|
910
|
+
|
911
|
+
# http body (model)
|
912
|
+
post_body = nil
|
913
|
+
auth_names = ['ApiKeyAuth']
|
914
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
915
|
+
:header_params => header_params,
|
916
|
+
:query_params => query_params,
|
917
|
+
:form_params => form_params,
|
918
|
+
:body => post_body,
|
919
|
+
:auth_names => auth_names,
|
920
|
+
:return_type => 'ChargeJson')
|
921
|
+
if @api_client.config.debugging
|
922
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
923
|
+
end
|
924
|
+
return data, status_code, headers
|
925
|
+
end
|
926
|
+
# Get ledger accounts
|
927
|
+
# Gets the ledger accounts mapped to the specified charge
|
928
|
+
# @param plan_id id of the plan
|
929
|
+
# @param charge_id id of the charge
|
930
|
+
# @param [Hash] opts the optional parameters
|
931
|
+
# @return [Array<LedgerAccount>]
|
932
|
+
def get_charge_ledger_accounts(plan_id, charge_id, opts = {})
|
933
|
+
data, _status_code, _headers = get_charge_ledger_accounts_with_http_info(plan_id, charge_id, opts)
|
934
|
+
data
|
935
|
+
end
|
936
|
+
|
937
|
+
# Get ledger accounts
|
938
|
+
# Gets the ledger accounts mapped to the specified charge
|
939
|
+
# @param plan_id id of the plan
|
940
|
+
# @param charge_id id of the charge
|
941
|
+
# @param [Hash] opts the optional parameters
|
942
|
+
# @return [Array<(Array<LedgerAccount>, Fixnum, Hash)>] Array<LedgerAccount> data, response status code and response headers
|
943
|
+
def get_charge_ledger_accounts_with_http_info(plan_id, charge_id, opts = {})
|
944
|
+
if @api_client.config.debugging
|
945
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_charge_ledger_accounts ...'
|
946
|
+
end
|
947
|
+
# verify the required parameter 'plan_id' is set
|
948
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
949
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.get_charge_ledger_accounts"
|
950
|
+
end
|
951
|
+
# verify the required parameter 'charge_id' is set
|
952
|
+
if @api_client.config.client_side_validation && charge_id.nil?
|
953
|
+
fail ArgumentError, "Missing the required parameter 'charge_id' when calling ProductCatalogApi.get_charge_ledger_accounts"
|
954
|
+
end
|
955
|
+
# resource path
|
956
|
+
local_var_path = '/plans/{planId}/charges/{chargeId}/ledgerAccounts'.sub('{' + 'planId' + '}', plan_id.to_s).sub('{' + 'chargeId' + '}', charge_id.to_s)
|
957
|
+
|
958
|
+
# query parameters
|
959
|
+
query_params = {}
|
960
|
+
|
961
|
+
# header parameters
|
962
|
+
header_params = {}
|
963
|
+
# HTTP header 'Accept' (if needed)
|
964
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
965
|
+
|
966
|
+
# form parameters
|
967
|
+
form_params = {}
|
968
|
+
|
969
|
+
# http body (model)
|
970
|
+
post_body = nil
|
971
|
+
auth_names = ['ApiKeyAuth']
|
972
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
973
|
+
:header_params => header_params,
|
974
|
+
:query_params => query_params,
|
975
|
+
:form_params => form_params,
|
976
|
+
:body => post_body,
|
977
|
+
:auth_names => auth_names,
|
978
|
+
:return_type => 'Array<LedgerAccount>')
|
979
|
+
if @api_client.config.debugging
|
980
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_charge_ledger_accounts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
981
|
+
end
|
982
|
+
return data, status_code, headers
|
983
|
+
end
|
984
|
+
# Get percent of relationships for a plan
|
985
|
+
# Gets the percent of relationships for the specified plan.
|
986
|
+
# @param from_plan_id id of the plan
|
987
|
+
# @param [Hash] opts the optional parameters
|
988
|
+
# @return [Array<CatalogRelationship>]
|
989
|
+
def get_percent_of_relationships(from_plan_id, opts = {})
|
990
|
+
data, _status_code, _headers = get_percent_of_relationships_with_http_info(from_plan_id, opts)
|
991
|
+
data
|
992
|
+
end
|
993
|
+
|
994
|
+
# Get percent of relationships for a plan
|
995
|
+
# Gets the percent of relationships for the specified plan.
|
996
|
+
# @param from_plan_id id of the plan
|
997
|
+
# @param [Hash] opts the optional parameters
|
998
|
+
# @return [Array<(Array<CatalogRelationship>, Fixnum, Hash)>] Array<CatalogRelationship> data, response status code and response headers
|
999
|
+
def get_percent_of_relationships_with_http_info(from_plan_id, opts = {})
|
1000
|
+
if @api_client.config.debugging
|
1001
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_percent_of_relationships ...'
|
1002
|
+
end
|
1003
|
+
# verify the required parameter 'from_plan_id' is set
|
1004
|
+
if @api_client.config.client_side_validation && from_plan_id.nil?
|
1005
|
+
fail ArgumentError, "Missing the required parameter 'from_plan_id' when calling ProductCatalogApi.get_percent_of_relationships"
|
1006
|
+
end
|
1007
|
+
# resource path
|
1008
|
+
local_var_path = '/plans/relationships/percentOf'
|
1009
|
+
|
1010
|
+
# query parameters
|
1011
|
+
query_params = {}
|
1012
|
+
query_params[:'fromPlanId'] = from_plan_id
|
1013
|
+
|
1014
|
+
# header parameters
|
1015
|
+
header_params = {}
|
1016
|
+
# HTTP header 'Accept' (if needed)
|
1017
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1018
|
+
|
1019
|
+
# form parameters
|
1020
|
+
form_params = {}
|
1021
|
+
|
1022
|
+
# http body (model)
|
1023
|
+
post_body = nil
|
1024
|
+
auth_names = ['ApiKeyAuth']
|
1025
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1026
|
+
:header_params => header_params,
|
1027
|
+
:query_params => query_params,
|
1028
|
+
:form_params => form_params,
|
1029
|
+
:body => post_body,
|
1030
|
+
:auth_names => auth_names,
|
1031
|
+
:return_type => 'Array<CatalogRelationship>')
|
1032
|
+
if @api_client.config.debugging
|
1033
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_percent_of_relationships\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1034
|
+
end
|
1035
|
+
return data, status_code, headers
|
1036
|
+
end
|
1037
|
+
# Get plan details
|
1038
|
+
# Returns the details of the specified plan.
|
1039
|
+
# @param plan_id id of the plan
|
1040
|
+
# @param [Hash] opts the optional parameters
|
1041
|
+
# @return [PlanJson]
|
1042
|
+
def get_plan(plan_id, opts = {})
|
1043
|
+
data, _status_code, _headers = get_plan_with_http_info(plan_id, opts)
|
1044
|
+
data
|
1045
|
+
end
|
1046
|
+
|
1047
|
+
# Get plan details
|
1048
|
+
# Returns the details of the specified plan.
|
1049
|
+
# @param plan_id id of the plan
|
1050
|
+
# @param [Hash] opts the optional parameters
|
1051
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
1052
|
+
def get_plan_with_http_info(plan_id, opts = {})
|
1053
|
+
if @api_client.config.debugging
|
1054
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_plan ...'
|
1055
|
+
end
|
1056
|
+
# verify the required parameter 'plan_id' is set
|
1057
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1058
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.get_plan"
|
1059
|
+
end
|
1060
|
+
# resource path
|
1061
|
+
local_var_path = '/plans/{planId}'.sub('{' + 'planId' + '}', plan_id.to_s)
|
1062
|
+
|
1063
|
+
# query parameters
|
1064
|
+
query_params = {}
|
1065
|
+
|
1066
|
+
# header parameters
|
1067
|
+
header_params = {}
|
1068
|
+
# HTTP header 'Accept' (if needed)
|
1069
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1070
|
+
|
1071
|
+
# form parameters
|
1072
|
+
form_params = {}
|
1073
|
+
|
1074
|
+
# http body (model)
|
1075
|
+
post_body = nil
|
1076
|
+
auth_names = ['ApiKeyAuth']
|
1077
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1078
|
+
:header_params => header_params,
|
1079
|
+
:query_params => query_params,
|
1080
|
+
:form_params => form_params,
|
1081
|
+
:body => post_body,
|
1082
|
+
:auth_names => auth_names,
|
1083
|
+
:return_type => 'PlanJson')
|
1084
|
+
if @api_client.config.debugging
|
1085
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1086
|
+
end
|
1087
|
+
return data, status_code, headers
|
1088
|
+
end
|
1089
|
+
# Get plans
|
1090
|
+
# Returns all plans for a product. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned.
|
1091
|
+
# @param [Hash] opts the optional parameters
|
1092
|
+
# @option opts [String] :product_id id of the product
|
1093
|
+
# @option opts [String] :status filter by plan status
|
1094
|
+
# @option opts [String] :cursor cursor from the last call
|
1095
|
+
# @option opts [Integer] :limit number of results per page
|
1096
|
+
# @return [PlanJsonPaginationResponse]
|
1097
|
+
def get_plans(opts = {})
|
1098
|
+
data, _status_code, _headers = get_plans_with_http_info(opts)
|
1099
|
+
data
|
1100
|
+
end
|
1101
|
+
|
1102
|
+
# Get plans
|
1103
|
+
# Returns all plans for a product. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned.
|
1104
|
+
# @param [Hash] opts the optional parameters
|
1105
|
+
# @option opts [String] :product_id id of the product
|
1106
|
+
# @option opts [String] :status filter by plan status
|
1107
|
+
# @option opts [String] :cursor cursor from the last call
|
1108
|
+
# @option opts [Integer] :limit number of results per page
|
1109
|
+
# @return [Array<(PlanJsonPaginationResponse, Fixnum, Hash)>] PlanJsonPaginationResponse data, response status code and response headers
|
1110
|
+
def get_plans_with_http_info(opts = {})
|
1111
|
+
if @api_client.config.debugging
|
1112
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_plans ...'
|
1113
|
+
end
|
1114
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !['DRAFT', 'ACTIVE', 'GRANDFATHERED', 'ARCHIVED', 'DEPRECATED'].include?(opts[:'status'])
|
1115
|
+
fail ArgumentError, 'invalid value for "status", must be one of DRAFT, ACTIVE, GRANDFATHERED, ARCHIVED, DEPRECATED'
|
1116
|
+
end
|
1117
|
+
# resource path
|
1118
|
+
local_var_path = '/plans'
|
1119
|
+
|
1120
|
+
# query parameters
|
1121
|
+
query_params = {}
|
1122
|
+
query_params[:'productId'] = opts[:'product_id'] if !opts[:'product_id'].nil?
|
1123
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
1124
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
1125
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
1126
|
+
|
1127
|
+
# header parameters
|
1128
|
+
header_params = {}
|
1129
|
+
# HTTP header 'Accept' (if needed)
|
1130
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1131
|
+
|
1132
|
+
# form parameters
|
1133
|
+
form_params = {}
|
1134
|
+
|
1135
|
+
# http body (model)
|
1136
|
+
post_body = nil
|
1137
|
+
auth_names = ['ApiKeyAuth']
|
1138
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1139
|
+
:header_params => header_params,
|
1140
|
+
:query_params => query_params,
|
1141
|
+
:form_params => form_params,
|
1142
|
+
:body => post_body,
|
1143
|
+
:auth_names => auth_names,
|
1144
|
+
:return_type => 'PlanJsonPaginationResponse')
|
1145
|
+
if @api_client.config.debugging
|
1146
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_plans\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1147
|
+
end
|
1148
|
+
return data, status_code, headers
|
1149
|
+
end
|
1150
|
+
# Get product details.
|
1151
|
+
# Gets the details of the specified product.
|
1152
|
+
# @param id id of the product
|
1153
|
+
# @param [Hash] opts the optional parameters
|
1154
|
+
# @return [ProductJson]
|
1155
|
+
def get_product(id, opts = {})
|
1156
|
+
data, _status_code, _headers = get_product_with_http_info(id, opts)
|
1157
|
+
data
|
1158
|
+
end
|
1159
|
+
|
1160
|
+
# Get product details.
|
1161
|
+
# Gets the details of the specified product.
|
1162
|
+
# @param id id of the product
|
1163
|
+
# @param [Hash] opts the optional parameters
|
1164
|
+
# @return [Array<(ProductJson, Fixnum, Hash)>] ProductJson data, response status code and response headers
|
1165
|
+
def get_product_with_http_info(id, opts = {})
|
1166
|
+
if @api_client.config.debugging
|
1167
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_product ...'
|
1168
|
+
end
|
1169
|
+
# verify the required parameter 'id' is set
|
1170
|
+
if @api_client.config.client_side_validation && id.nil?
|
1171
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProductCatalogApi.get_product"
|
1172
|
+
end
|
1173
|
+
# resource path
|
1174
|
+
local_var_path = '/products/{id}'.sub('{' + 'id' + '}', id.to_s)
|
1175
|
+
|
1176
|
+
# query parameters
|
1177
|
+
query_params = {}
|
1178
|
+
|
1179
|
+
# header parameters
|
1180
|
+
header_params = {}
|
1181
|
+
# HTTP header 'Accept' (if needed)
|
1182
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1183
|
+
|
1184
|
+
# form parameters
|
1185
|
+
form_params = {}
|
1186
|
+
|
1187
|
+
# http body (model)
|
1188
|
+
post_body = nil
|
1189
|
+
auth_names = ['ApiKeyAuth']
|
1190
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1191
|
+
:header_params => header_params,
|
1192
|
+
:query_params => query_params,
|
1193
|
+
:form_params => form_params,
|
1194
|
+
:body => post_body,
|
1195
|
+
:auth_names => auth_names,
|
1196
|
+
:return_type => 'ProductJson')
|
1197
|
+
if @api_client.config.debugging
|
1198
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1199
|
+
end
|
1200
|
+
return data, status_code, headers
|
1201
|
+
end
|
1202
|
+
# Get product Categories
|
1203
|
+
# Gets all product categories for your tenant. The results are paginated. To fetch all results pass the cursor returned from a call to the subsequent calls until all results are returned. Initially the cursor should not be specified.
|
1204
|
+
# @param [Hash] opts the optional parameters
|
1205
|
+
# @option opts [String] :cursor cursor from prior call
|
1206
|
+
# @option opts [Integer] :limit number of results per page
|
1207
|
+
# @return [ProductCategoryPaginationResponse]
|
1208
|
+
def get_product_categories(opts = {})
|
1209
|
+
data, _status_code, _headers = get_product_categories_with_http_info(opts)
|
1210
|
+
data
|
1211
|
+
end
|
1212
|
+
|
1213
|
+
# Get product Categories
|
1214
|
+
# Gets all product categories for your tenant. The results are paginated. To fetch all results pass the cursor returned from a call to the subsequent calls until all results are returned. Initially the cursor should not be specified.
|
1215
|
+
# @param [Hash] opts the optional parameters
|
1216
|
+
# @option opts [String] :cursor cursor from prior call
|
1217
|
+
# @option opts [Integer] :limit number of results per page
|
1218
|
+
# @return [Array<(ProductCategoryPaginationResponse, Fixnum, Hash)>] ProductCategoryPaginationResponse data, response status code and response headers
|
1219
|
+
def get_product_categories_with_http_info(opts = {})
|
1220
|
+
if @api_client.config.debugging
|
1221
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_product_categories ...'
|
1222
|
+
end
|
1223
|
+
# resource path
|
1224
|
+
local_var_path = '/product/categories'
|
1225
|
+
|
1226
|
+
# query parameters
|
1227
|
+
query_params = {}
|
1228
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
1229
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
1230
|
+
|
1231
|
+
# header parameters
|
1232
|
+
header_params = {}
|
1233
|
+
# HTTP header 'Accept' (if needed)
|
1234
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1235
|
+
|
1236
|
+
# form parameters
|
1237
|
+
form_params = {}
|
1238
|
+
|
1239
|
+
# http body (model)
|
1240
|
+
post_body = nil
|
1241
|
+
auth_names = ['ApiKeyAuth']
|
1242
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1243
|
+
:header_params => header_params,
|
1244
|
+
:query_params => query_params,
|
1245
|
+
:form_params => form_params,
|
1246
|
+
:body => post_body,
|
1247
|
+
:auth_names => auth_names,
|
1248
|
+
:return_type => 'ProductCategoryPaginationResponse')
|
1249
|
+
if @api_client.config.debugging
|
1250
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_product_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1251
|
+
end
|
1252
|
+
return data, status_code, headers
|
1253
|
+
end
|
1254
|
+
# Get product category details
|
1255
|
+
# Gets the details of the specified product category
|
1256
|
+
# @param id id of the category
|
1257
|
+
# @param [Hash] opts the optional parameters
|
1258
|
+
# @return [ProductCategory]
|
1259
|
+
def get_product_category(id, opts = {})
|
1260
|
+
data, _status_code, _headers = get_product_category_with_http_info(id, opts)
|
1261
|
+
data
|
1262
|
+
end
|
1263
|
+
|
1264
|
+
# Get product category details
|
1265
|
+
# Gets the details of the specified product category
|
1266
|
+
# @param id id of the category
|
1267
|
+
# @param [Hash] opts the optional parameters
|
1268
|
+
# @return [Array<(ProductCategory, Fixnum, Hash)>] ProductCategory data, response status code and response headers
|
1269
|
+
def get_product_category_with_http_info(id, opts = {})
|
1270
|
+
if @api_client.config.debugging
|
1271
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_product_category ...'
|
1272
|
+
end
|
1273
|
+
# verify the required parameter 'id' is set
|
1274
|
+
if @api_client.config.client_side_validation && id.nil?
|
1275
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProductCatalogApi.get_product_category"
|
1276
|
+
end
|
1277
|
+
# resource path
|
1278
|
+
local_var_path = '/product/categories/{id}'.sub('{' + 'id' + '}', id.to_s)
|
1279
|
+
|
1280
|
+
# query parameters
|
1281
|
+
query_params = {}
|
1282
|
+
|
1283
|
+
# header parameters
|
1284
|
+
header_params = {}
|
1285
|
+
# HTTP header 'Accept' (if needed)
|
1286
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1287
|
+
|
1288
|
+
# form parameters
|
1289
|
+
form_params = {}
|
1290
|
+
|
1291
|
+
# http body (model)
|
1292
|
+
post_body = nil
|
1293
|
+
auth_names = ['ApiKeyAuth']
|
1294
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1295
|
+
:header_params => header_params,
|
1296
|
+
:query_params => query_params,
|
1297
|
+
:form_params => form_params,
|
1298
|
+
:body => post_body,
|
1299
|
+
:auth_names => auth_names,
|
1300
|
+
:return_type => 'ProductCategory')
|
1301
|
+
if @api_client.config.debugging
|
1302
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_product_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1303
|
+
end
|
1304
|
+
return data, status_code, headers
|
1305
|
+
end
|
1306
|
+
# Get products
|
1307
|
+
# Returns all products for your tenant. The results on paginated. To fetch them all pass the cursor returned from a call to the subsequent call until all results are fetched. Initially the cursor should not be specified.
|
1308
|
+
# @param [Hash] opts the optional parameters
|
1309
|
+
# @option opts [String] :cursor cursor received from prior call
|
1310
|
+
# @option opts [Integer] :limit number of results per page
|
1311
|
+
# @return [ProductJsonPaginationResponse]
|
1312
|
+
def get_products(opts = {})
|
1313
|
+
data, _status_code, _headers = get_products_with_http_info(opts)
|
1314
|
+
data
|
1315
|
+
end
|
1316
|
+
|
1317
|
+
# Get products
|
1318
|
+
# Returns all products for your tenant. The results on paginated. To fetch them all pass the cursor returned from a call to the subsequent call until all results are fetched. Initially the cursor should not be specified.
|
1319
|
+
# @param [Hash] opts the optional parameters
|
1320
|
+
# @option opts [String] :cursor cursor received from prior call
|
1321
|
+
# @option opts [Integer] :limit number of results per page
|
1322
|
+
# @return [Array<(ProductJsonPaginationResponse, Fixnum, Hash)>] ProductJsonPaginationResponse data, response status code and response headers
|
1323
|
+
def get_products_with_http_info(opts = {})
|
1324
|
+
if @api_client.config.debugging
|
1325
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_products ...'
|
1326
|
+
end
|
1327
|
+
# resource path
|
1328
|
+
local_var_path = '/products'
|
1329
|
+
|
1330
|
+
# query parameters
|
1331
|
+
query_params = {}
|
1332
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
1333
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
1334
|
+
|
1335
|
+
# header parameters
|
1336
|
+
header_params = {}
|
1337
|
+
# HTTP header 'Accept' (if needed)
|
1338
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1339
|
+
|
1340
|
+
# form parameters
|
1341
|
+
form_params = {}
|
1342
|
+
|
1343
|
+
# http body (model)
|
1344
|
+
post_body = nil
|
1345
|
+
auth_names = ['ApiKeyAuth']
|
1346
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1347
|
+
:header_params => header_params,
|
1348
|
+
:query_params => query_params,
|
1349
|
+
:form_params => form_params,
|
1350
|
+
:body => post_body,
|
1351
|
+
:auth_names => auth_names,
|
1352
|
+
:return_type => 'ProductJsonPaginationResponse')
|
1353
|
+
if @api_client.config.debugging
|
1354
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_products\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1355
|
+
end
|
1356
|
+
return data, status_code, headers
|
1357
|
+
end
|
1358
|
+
# Get percent of target plans
|
1359
|
+
# Gets the list of percent of charge target plans.
|
1360
|
+
# @param plan_id
|
1361
|
+
# @param [Hash] opts the optional parameters
|
1362
|
+
# @return [CatalogRelationship]
|
1363
|
+
def get_target_plans_for_percent_of_plan_id(plan_id, opts = {})
|
1364
|
+
data, _status_code, _headers = get_target_plans_for_percent_of_plan_id_with_http_info(plan_id, opts)
|
1365
|
+
data
|
1366
|
+
end
|
1367
|
+
|
1368
|
+
# Get percent of target plans
|
1369
|
+
# Gets the list of percent of charge target plans.
|
1370
|
+
# @param plan_id
|
1371
|
+
# @param [Hash] opts the optional parameters
|
1372
|
+
# @return [Array<(CatalogRelationship, Fixnum, Hash)>] CatalogRelationship data, response status code and response headers
|
1373
|
+
def get_target_plans_for_percent_of_plan_id_with_http_info(plan_id, opts = {})
|
1374
|
+
if @api_client.config.debugging
|
1375
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.get_target_plans_for_percent_of_plan_id ...'
|
1376
|
+
end
|
1377
|
+
# verify the required parameter 'plan_id' is set
|
1378
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1379
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.get_target_plans_for_percent_of_plan_id"
|
1380
|
+
end
|
1381
|
+
# resource path
|
1382
|
+
local_var_path = '/plans/relationships/percentOf/{planId}'.sub('{' + 'planId' + '}', plan_id.to_s)
|
1383
|
+
|
1384
|
+
# query parameters
|
1385
|
+
query_params = {}
|
1386
|
+
|
1387
|
+
# header parameters
|
1388
|
+
header_params = {}
|
1389
|
+
# HTTP header 'Accept' (if needed)
|
1390
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1391
|
+
|
1392
|
+
# form parameters
|
1393
|
+
form_params = {}
|
1394
|
+
|
1395
|
+
# http body (model)
|
1396
|
+
post_body = nil
|
1397
|
+
auth_names = ['ApiKeyAuth']
|
1398
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1399
|
+
:header_params => header_params,
|
1400
|
+
:query_params => query_params,
|
1401
|
+
:form_params => form_params,
|
1402
|
+
:body => post_body,
|
1403
|
+
:auth_names => auth_names,
|
1404
|
+
:return_type => 'CatalogRelationship')
|
1405
|
+
if @api_client.config.debugging
|
1406
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#get_target_plans_for_percent_of_plan_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1407
|
+
end
|
1408
|
+
return data, status_code, headers
|
1409
|
+
end
|
1410
|
+
# Map ledger accounts
|
1411
|
+
# Map ledger accounts to the specified charge for the specified plan.
|
1412
|
+
# @param plan_id id of the plan
|
1413
|
+
# @param charge_id id of the charge
|
1414
|
+
# @param body list of the ledger account ids
|
1415
|
+
# @param [Hash] opts the optional parameters
|
1416
|
+
# @return [Array<LedgerAccount>]
|
1417
|
+
def map_ledger_accounts_to_charge(plan_id, charge_id, body, opts = {})
|
1418
|
+
data, _status_code, _headers = map_ledger_accounts_to_charge_with_http_info(plan_id, charge_id, body, opts)
|
1419
|
+
data
|
1420
|
+
end
|
1421
|
+
|
1422
|
+
# Map ledger accounts
|
1423
|
+
# Map ledger accounts to the specified charge for the specified plan.
|
1424
|
+
# @param plan_id id of the plan
|
1425
|
+
# @param charge_id id of the charge
|
1426
|
+
# @param body list of the ledger account ids
|
1427
|
+
# @param [Hash] opts the optional parameters
|
1428
|
+
# @return [Array<(Array<LedgerAccount>, Fixnum, Hash)>] Array<LedgerAccount> data, response status code and response headers
|
1429
|
+
def map_ledger_accounts_to_charge_with_http_info(plan_id, charge_id, body, opts = {})
|
1430
|
+
if @api_client.config.debugging
|
1431
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.map_ledger_accounts_to_charge ...'
|
1432
|
+
end
|
1433
|
+
# verify the required parameter 'plan_id' is set
|
1434
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1435
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.map_ledger_accounts_to_charge"
|
1436
|
+
end
|
1437
|
+
# verify the required parameter 'charge_id' is set
|
1438
|
+
if @api_client.config.client_side_validation && charge_id.nil?
|
1439
|
+
fail ArgumentError, "Missing the required parameter 'charge_id' when calling ProductCatalogApi.map_ledger_accounts_to_charge"
|
1440
|
+
end
|
1441
|
+
# verify the required parameter 'body' is set
|
1442
|
+
if @api_client.config.client_side_validation && body.nil?
|
1443
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.map_ledger_accounts_to_charge"
|
1444
|
+
end
|
1445
|
+
# resource path
|
1446
|
+
local_var_path = '/plans/{planId}/charges/{chargeId}/ledgerAccounts'.sub('{' + 'planId' + '}', plan_id.to_s).sub('{' + 'chargeId' + '}', charge_id.to_s)
|
1447
|
+
|
1448
|
+
# query parameters
|
1449
|
+
query_params = {}
|
1450
|
+
|
1451
|
+
# header parameters
|
1452
|
+
header_params = {}
|
1453
|
+
# HTTP header 'Accept' (if needed)
|
1454
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1455
|
+
# HTTP header 'Content-Type'
|
1456
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1457
|
+
|
1458
|
+
# form parameters
|
1459
|
+
form_params = {}
|
1460
|
+
|
1461
|
+
# http body (model)
|
1462
|
+
post_body = @api_client.object_to_http_body(body)
|
1463
|
+
auth_names = ['ApiKeyAuth']
|
1464
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1465
|
+
:header_params => header_params,
|
1466
|
+
:query_params => query_params,
|
1467
|
+
:form_params => form_params,
|
1468
|
+
:body => post_body,
|
1469
|
+
:auth_names => auth_names,
|
1470
|
+
:return_type => 'Array<LedgerAccount>')
|
1471
|
+
if @api_client.config.debugging
|
1472
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#map_ledger_accounts_to_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1473
|
+
end
|
1474
|
+
return data, status_code, headers
|
1475
|
+
end
|
1476
|
+
# Update non-financial charge details
|
1477
|
+
# Updates certain details of the specified charge which won't impact its financial treatment
|
1478
|
+
# @param plan_id id of the plan
|
1479
|
+
# @param charge_id id of the charge
|
1480
|
+
# @param [Hash] opts the optional parameters
|
1481
|
+
# @option opts [ChargePartialJson] :body
|
1482
|
+
# @return [ChargeJson]
|
1483
|
+
def patch_charge(plan_id, charge_id, opts = {})
|
1484
|
+
data, _status_code, _headers = patch_charge_with_http_info(plan_id, charge_id, opts)
|
1485
|
+
data
|
1486
|
+
end
|
1487
|
+
|
1488
|
+
# Update non-financial charge details
|
1489
|
+
# Updates certain details of the specified charge which won't impact its financial treatment
|
1490
|
+
# @param plan_id id of the plan
|
1491
|
+
# @param charge_id id of the charge
|
1492
|
+
# @param [Hash] opts the optional parameters
|
1493
|
+
# @option opts [ChargePartialJson] :body
|
1494
|
+
# @return [Array<(ChargeJson, Fixnum, Hash)>] ChargeJson data, response status code and response headers
|
1495
|
+
def patch_charge_with_http_info(plan_id, charge_id, opts = {})
|
1496
|
+
if @api_client.config.debugging
|
1497
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.patch_charge ...'
|
1498
|
+
end
|
1499
|
+
# verify the required parameter 'plan_id' is set
|
1500
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1501
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.patch_charge"
|
1502
|
+
end
|
1503
|
+
# verify the required parameter 'charge_id' is set
|
1504
|
+
if @api_client.config.client_side_validation && charge_id.nil?
|
1505
|
+
fail ArgumentError, "Missing the required parameter 'charge_id' when calling ProductCatalogApi.patch_charge"
|
1506
|
+
end
|
1507
|
+
# resource path
|
1508
|
+
local_var_path = '/plans/{planId}/charges/{chargeId}/partial'.sub('{' + 'planId' + '}', plan_id.to_s).sub('{' + 'chargeId' + '}', charge_id.to_s)
|
1509
|
+
|
1510
|
+
# query parameters
|
1511
|
+
query_params = {}
|
1512
|
+
|
1513
|
+
# header parameters
|
1514
|
+
header_params = {}
|
1515
|
+
# HTTP header 'Accept' (if needed)
|
1516
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1517
|
+
# HTTP header 'Content-Type'
|
1518
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1519
|
+
|
1520
|
+
# form parameters
|
1521
|
+
form_params = {}
|
1522
|
+
|
1523
|
+
# http body (model)
|
1524
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
1525
|
+
auth_names = ['ApiKeyAuth']
|
1526
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1527
|
+
:header_params => header_params,
|
1528
|
+
:query_params => query_params,
|
1529
|
+
:form_params => form_params,
|
1530
|
+
:body => post_body,
|
1531
|
+
:auth_names => auth_names,
|
1532
|
+
:return_type => 'ChargeJson')
|
1533
|
+
if @api_client.config.debugging
|
1534
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#patch_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1535
|
+
end
|
1536
|
+
return data, status_code, headers
|
1537
|
+
end
|
1538
|
+
# Reactivate a plan
|
1539
|
+
# Reactivates a deprecated plan.
|
1540
|
+
# @param plan_id id of the plan
|
1541
|
+
# @param [Hash] opts the optional parameters
|
1542
|
+
# @return [PlanJson]
|
1543
|
+
def reactivate_plan(plan_id, opts = {})
|
1544
|
+
data, _status_code, _headers = reactivate_plan_with_http_info(plan_id, opts)
|
1545
|
+
data
|
1546
|
+
end
|
1547
|
+
|
1548
|
+
# Reactivate a plan
|
1549
|
+
# Reactivates a deprecated plan.
|
1550
|
+
# @param plan_id id of the plan
|
1551
|
+
# @param [Hash] opts the optional parameters
|
1552
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
1553
|
+
def reactivate_plan_with_http_info(plan_id, opts = {})
|
1554
|
+
if @api_client.config.debugging
|
1555
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.reactivate_plan ...'
|
1556
|
+
end
|
1557
|
+
# verify the required parameter 'plan_id' is set
|
1558
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1559
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.reactivate_plan"
|
1560
|
+
end
|
1561
|
+
# resource path
|
1562
|
+
local_var_path = '/plans/{planId}/reactivate'.sub('{' + 'planId' + '}', plan_id.to_s)
|
1563
|
+
|
1564
|
+
# query parameters
|
1565
|
+
query_params = {}
|
1566
|
+
|
1567
|
+
# header parameters
|
1568
|
+
header_params = {}
|
1569
|
+
# HTTP header 'Accept' (if needed)
|
1570
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1571
|
+
|
1572
|
+
# form parameters
|
1573
|
+
form_params = {}
|
1574
|
+
|
1575
|
+
# http body (model)
|
1576
|
+
post_body = nil
|
1577
|
+
auth_names = ['ApiKeyAuth']
|
1578
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1579
|
+
:header_params => header_params,
|
1580
|
+
:query_params => query_params,
|
1581
|
+
:form_params => form_params,
|
1582
|
+
:body => post_body,
|
1583
|
+
:auth_names => auth_names,
|
1584
|
+
:return_type => 'PlanJson')
|
1585
|
+
if @api_client.config.debugging
|
1586
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#reactivate_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1587
|
+
end
|
1588
|
+
return data, status_code, headers
|
1589
|
+
end
|
1590
|
+
# Update charge details
|
1591
|
+
# Updates the details of the specified charge on the specified plan.
|
1592
|
+
# @param plan_id id of the plan associated with the charge
|
1593
|
+
# @param charge_id id of the charge
|
1594
|
+
# @param [Hash] opts the optional parameters
|
1595
|
+
# @option opts [ChargeJson] :body
|
1596
|
+
# @return [nil]
|
1597
|
+
def update_charge(plan_id, charge_id, opts = {})
|
1598
|
+
update_charge_with_http_info(plan_id, charge_id, opts)
|
1599
|
+
nil
|
1600
|
+
end
|
1601
|
+
|
1602
|
+
# Update charge details
|
1603
|
+
# Updates the details of the specified charge on the specified plan.
|
1604
|
+
# @param plan_id id of the plan associated with the charge
|
1605
|
+
# @param charge_id id of the charge
|
1606
|
+
# @param [Hash] opts the optional parameters
|
1607
|
+
# @option opts [ChargeJson] :body
|
1608
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1609
|
+
def update_charge_with_http_info(plan_id, charge_id, opts = {})
|
1610
|
+
if @api_client.config.debugging
|
1611
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.update_charge ...'
|
1612
|
+
end
|
1613
|
+
# verify the required parameter 'plan_id' is set
|
1614
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1615
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.update_charge"
|
1616
|
+
end
|
1617
|
+
# verify the required parameter 'charge_id' is set
|
1618
|
+
if @api_client.config.client_side_validation && charge_id.nil?
|
1619
|
+
fail ArgumentError, "Missing the required parameter 'charge_id' when calling ProductCatalogApi.update_charge"
|
1620
|
+
end
|
1621
|
+
# resource path
|
1622
|
+
local_var_path = '/plans/{planId}/charges/{chargeId}'.sub('{' + 'planId' + '}', plan_id.to_s).sub('{' + 'chargeId' + '}', charge_id.to_s)
|
1623
|
+
|
1624
|
+
# query parameters
|
1625
|
+
query_params = {}
|
1626
|
+
|
1627
|
+
# header parameters
|
1628
|
+
header_params = {}
|
1629
|
+
# HTTP header 'Accept' (if needed)
|
1630
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1631
|
+
# HTTP header 'Content-Type'
|
1632
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1633
|
+
|
1634
|
+
# form parameters
|
1635
|
+
form_params = {}
|
1636
|
+
|
1637
|
+
# http body (model)
|
1638
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
1639
|
+
auth_names = ['ApiKeyAuth']
|
1640
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1641
|
+
:header_params => header_params,
|
1642
|
+
:query_params => query_params,
|
1643
|
+
:form_params => form_params,
|
1644
|
+
:body => post_body,
|
1645
|
+
:auth_names => auth_names)
|
1646
|
+
if @api_client.config.debugging
|
1647
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#update_charge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1648
|
+
end
|
1649
|
+
return data, status_code, headers
|
1650
|
+
end
|
1651
|
+
# Update plan
|
1652
|
+
# Updates the details of the specified plan. Note you can't update the details of a plan once it's in use.
|
1653
|
+
# @param plan_id id of the plan
|
1654
|
+
# @param body json of the plan details
|
1655
|
+
# @param [Hash] opts the optional parameters
|
1656
|
+
# @return [PlanJson]
|
1657
|
+
def update_plan(plan_id, body, opts = {})
|
1658
|
+
data, _status_code, _headers = update_plan_with_http_info(plan_id, body, opts)
|
1659
|
+
data
|
1660
|
+
end
|
1661
|
+
|
1662
|
+
# Update plan
|
1663
|
+
# Updates the details of the specified plan. Note you can't update the details of a plan once it's in use.
|
1664
|
+
# @param plan_id id of the plan
|
1665
|
+
# @param body json of the plan details
|
1666
|
+
# @param [Hash] opts the optional parameters
|
1667
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
1668
|
+
def update_plan_with_http_info(plan_id, body, opts = {})
|
1669
|
+
if @api_client.config.debugging
|
1670
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.update_plan ...'
|
1671
|
+
end
|
1672
|
+
# verify the required parameter 'plan_id' is set
|
1673
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1674
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.update_plan"
|
1675
|
+
end
|
1676
|
+
# verify the required parameter 'body' is set
|
1677
|
+
if @api_client.config.client_side_validation && body.nil?
|
1678
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.update_plan"
|
1679
|
+
end
|
1680
|
+
# resource path
|
1681
|
+
local_var_path = '/plans/{planId}'.sub('{' + 'planId' + '}', plan_id.to_s)
|
1682
|
+
|
1683
|
+
# query parameters
|
1684
|
+
query_params = {}
|
1685
|
+
|
1686
|
+
# header parameters
|
1687
|
+
header_params = {}
|
1688
|
+
# HTTP header 'Accept' (if needed)
|
1689
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1690
|
+
|
1691
|
+
# form parameters
|
1692
|
+
form_params = {}
|
1693
|
+
|
1694
|
+
# http body (model)
|
1695
|
+
post_body = @api_client.object_to_http_body(body)
|
1696
|
+
auth_names = ['ApiKeyAuth']
|
1697
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1698
|
+
:header_params => header_params,
|
1699
|
+
:query_params => query_params,
|
1700
|
+
:form_params => form_params,
|
1701
|
+
:body => post_body,
|
1702
|
+
:auth_names => auth_names,
|
1703
|
+
:return_type => 'PlanJson')
|
1704
|
+
if @api_client.config.debugging
|
1705
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#update_plan\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1706
|
+
end
|
1707
|
+
return data, status_code, headers
|
1708
|
+
end
|
1709
|
+
# Update plan metadata
|
1710
|
+
# Update plan metadata. For now, this can be used only to change the entities assigned to a plan
|
1711
|
+
# @param plan_id plan id
|
1712
|
+
# @param body plan metadata to be updated
|
1713
|
+
# @param [Hash] opts the optional parameters
|
1714
|
+
# @return [PlanJson]
|
1715
|
+
def update_plan_metadata(plan_id, body, opts = {})
|
1716
|
+
data, _status_code, _headers = update_plan_metadata_with_http_info(plan_id, body, opts)
|
1717
|
+
data
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
# Update plan metadata
|
1721
|
+
# Update plan metadata. For now, this can be used only to change the entities assigned to a plan
|
1722
|
+
# @param plan_id plan id
|
1723
|
+
# @param body plan metadata to be updated
|
1724
|
+
# @param [Hash] opts the optional parameters
|
1725
|
+
# @return [Array<(PlanJson, Fixnum, Hash)>] PlanJson data, response status code and response headers
|
1726
|
+
def update_plan_metadata_with_http_info(plan_id, body, opts = {})
|
1727
|
+
if @api_client.config.debugging
|
1728
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.update_plan_metadata ...'
|
1729
|
+
end
|
1730
|
+
# verify the required parameter 'plan_id' is set
|
1731
|
+
if @api_client.config.client_side_validation && plan_id.nil?
|
1732
|
+
fail ArgumentError, "Missing the required parameter 'plan_id' when calling ProductCatalogApi.update_plan_metadata"
|
1733
|
+
end
|
1734
|
+
# verify the required parameter 'body' is set
|
1735
|
+
if @api_client.config.client_side_validation && body.nil?
|
1736
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.update_plan_metadata"
|
1737
|
+
end
|
1738
|
+
# resource path
|
1739
|
+
local_var_path = '/plans/{planId}/metadata'.sub('{' + 'planId' + '}', plan_id.to_s)
|
1740
|
+
|
1741
|
+
# query parameters
|
1742
|
+
query_params = {}
|
1743
|
+
|
1744
|
+
# header parameters
|
1745
|
+
header_params = {}
|
1746
|
+
# HTTP header 'Accept' (if needed)
|
1747
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1748
|
+
|
1749
|
+
# form parameters
|
1750
|
+
form_params = {}
|
1751
|
+
|
1752
|
+
# http body (model)
|
1753
|
+
post_body = @api_client.object_to_http_body(body)
|
1754
|
+
auth_names = ['ApiKeyAuth']
|
1755
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1756
|
+
:header_params => header_params,
|
1757
|
+
:query_params => query_params,
|
1758
|
+
:form_params => form_params,
|
1759
|
+
:body => post_body,
|
1760
|
+
:auth_names => auth_names,
|
1761
|
+
:return_type => 'PlanJson')
|
1762
|
+
if @api_client.config.debugging
|
1763
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#update_plan_metadata\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1764
|
+
end
|
1765
|
+
return data, status_code, headers
|
1766
|
+
end
|
1767
|
+
# Update product details
|
1768
|
+
# Updates the details of the specified product
|
1769
|
+
# @param id id of the product
|
1770
|
+
# @param body product details json
|
1771
|
+
# @param [Hash] opts the optional parameters
|
1772
|
+
# @return [nil]
|
1773
|
+
def update_product(id, body, opts = {})
|
1774
|
+
update_product_with_http_info(id, body, opts)
|
1775
|
+
nil
|
1776
|
+
end
|
1777
|
+
|
1778
|
+
# Update product details
|
1779
|
+
# Updates the details of the specified product
|
1780
|
+
# @param id id of the product
|
1781
|
+
# @param body product details json
|
1782
|
+
# @param [Hash] opts the optional parameters
|
1783
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1784
|
+
def update_product_with_http_info(id, body, opts = {})
|
1785
|
+
if @api_client.config.debugging
|
1786
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.update_product ...'
|
1787
|
+
end
|
1788
|
+
# verify the required parameter 'id' is set
|
1789
|
+
if @api_client.config.client_side_validation && id.nil?
|
1790
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProductCatalogApi.update_product"
|
1791
|
+
end
|
1792
|
+
# verify the required parameter 'body' is set
|
1793
|
+
if @api_client.config.client_side_validation && body.nil?
|
1794
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.update_product"
|
1795
|
+
end
|
1796
|
+
# resource path
|
1797
|
+
local_var_path = '/products/{id}'.sub('{' + 'id' + '}', id.to_s)
|
1798
|
+
|
1799
|
+
# query parameters
|
1800
|
+
query_params = {}
|
1801
|
+
|
1802
|
+
# header parameters
|
1803
|
+
header_params = {}
|
1804
|
+
# HTTP header 'Accept' (if needed)
|
1805
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1806
|
+
# HTTP header 'Content-Type'
|
1807
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1808
|
+
|
1809
|
+
# form parameters
|
1810
|
+
form_params = {}
|
1811
|
+
|
1812
|
+
# http body (model)
|
1813
|
+
post_body = @api_client.object_to_http_body(body)
|
1814
|
+
auth_names = ['ApiKeyAuth']
|
1815
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1816
|
+
:header_params => header_params,
|
1817
|
+
:query_params => query_params,
|
1818
|
+
:form_params => form_params,
|
1819
|
+
:body => post_body,
|
1820
|
+
:auth_names => auth_names)
|
1821
|
+
if @api_client.config.debugging
|
1822
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#update_product\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1823
|
+
end
|
1824
|
+
return data, status_code, headers
|
1825
|
+
end
|
1826
|
+
# Update product category details
|
1827
|
+
# Updates the details of a product category
|
1828
|
+
# @param id id of the category
|
1829
|
+
# @param body product category details json
|
1830
|
+
# @param [Hash] opts the optional parameters
|
1831
|
+
# @return [nil]
|
1832
|
+
def update_product_category(id, body, opts = {})
|
1833
|
+
update_product_category_with_http_info(id, body, opts)
|
1834
|
+
nil
|
1835
|
+
end
|
1836
|
+
|
1837
|
+
# Update product category details
|
1838
|
+
# Updates the details of a product category
|
1839
|
+
# @param id id of the category
|
1840
|
+
# @param body product category details json
|
1841
|
+
# @param [Hash] opts the optional parameters
|
1842
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
1843
|
+
def update_product_category_with_http_info(id, body, opts = {})
|
1844
|
+
if @api_client.config.debugging
|
1845
|
+
@api_client.config.logger.debug 'Calling API: ProductCatalogApi.update_product_category ...'
|
1846
|
+
end
|
1847
|
+
# verify the required parameter 'id' is set
|
1848
|
+
if @api_client.config.client_side_validation && id.nil?
|
1849
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling ProductCatalogApi.update_product_category"
|
1850
|
+
end
|
1851
|
+
# verify the required parameter 'body' is set
|
1852
|
+
if @api_client.config.client_side_validation && body.nil?
|
1853
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling ProductCatalogApi.update_product_category"
|
1854
|
+
end
|
1855
|
+
# resource path
|
1856
|
+
local_var_path = '/product/categories/{id}'.sub('{' + 'id' + '}', id.to_s)
|
1857
|
+
|
1858
|
+
# query parameters
|
1859
|
+
query_params = {}
|
1860
|
+
|
1861
|
+
# header parameters
|
1862
|
+
header_params = {}
|
1863
|
+
# HTTP header 'Accept' (if needed)
|
1864
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1865
|
+
# HTTP header 'Content-Type'
|
1866
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1867
|
+
|
1868
|
+
# form parameters
|
1869
|
+
form_params = {}
|
1870
|
+
|
1871
|
+
# http body (model)
|
1872
|
+
post_body = @api_client.object_to_http_body(body)
|
1873
|
+
auth_names = ['ApiKeyAuth']
|
1874
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
1875
|
+
:header_params => header_params,
|
1876
|
+
:query_params => query_params,
|
1877
|
+
:form_params => form_params,
|
1878
|
+
:body => post_body,
|
1879
|
+
:auth_names => auth_names)
|
1880
|
+
if @api_client.config.debugging
|
1881
|
+
@api_client.config.logger.debug "API called: ProductCatalogApi#update_product_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1882
|
+
end
|
1883
|
+
return data, status_code, headers
|
1884
|
+
end
|
1885
|
+
end
|
1886
|
+
end
|