subskribe_dev 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +0 -1
- data/README.md +514 -24
- data/docs/AccountAddress.md +17 -0
- data/docs/AccountAddressJson.md +13 -0
- data/docs/AccountContact.md +24 -0
- data/docs/AccountContactJson.md +18 -0
- data/docs/AccountJson.md +27 -0
- data/docs/AccountPaymentMethodJson.md +13 -0
- data/docs/AccountReceivableContactJson.md +12 -0
- data/docs/AccountingApi.md +182 -0
- data/docs/AccountingEvent.md +19 -0
- data/docs/AccountingEventPaginatedResponse.md +10 -0
- data/docs/AccountingPeriod.md +22 -0
- data/docs/AccountingPeriodCalculation.md +13 -0
- data/docs/AccountsApi.md +884 -0
- data/docs/AddAndApplyPaymentApplicationJson.md +19 -0
- data/docs/AnrokIntegrationInput.md +8 -0
- data/docs/ApprovalMatrixImportDataJson.md +13 -0
- data/docs/ApprovalMatrixImportPreview.md +12 -0
- data/docs/ApprovalRoleJson.md +12 -0
- data/docs/ApprovalRoleSegmentChange.md +11 -0
- data/docs/ApprovalSegmentJson.md +12 -0
- data/docs/ApprovalsApi.md +1028 -0
- data/docs/Attachment.md +17 -0
- data/docs/AttachmentsApi.md +294 -0
- data/docs/AttributeReference.md +9 -0
- data/docs/AuthSamlIntegrationJson.md +10 -0
- data/docs/AuthenticationApi.md +329 -0
- data/docs/AutomatedInvoiceRule.md +24 -0
- data/docs/AutomatedInvoiceRuleRequestJson.md +20 -0
- data/docs/AvalaraIntegration.md +14 -0
- data/docs/AvalaraIntegrationInput.md +12 -0
- data/docs/BillingApi.md +2173 -0
- data/docs/BillingEventEntry.md +11 -0
- data/docs/BillingEventInput.md +11 -0
- data/docs/BulkInvoiceRun.md +20 -0
- data/docs/BulkInvoiceRunExclusions.md +9 -0
- data/docs/BulkInvoiceRunInput.md +13 -0
- data/docs/BulkInvoiceRunItem.md +28 -0
- data/docs/BulkInvoiceRunSelector.md +8 -0
- data/docs/BulkPaymentUploadData.md +18 -0
- data/docs/BulkPaymentUploadResult.md +10 -0
- data/docs/ByteBuffer.md +15 -0
- data/docs/CatalogRelationship.md +13 -0
- data/docs/ChargeJson.md +47 -0
- data/docs/ChargePartialJson.md +22 -0
- data/docs/CompanyContactJson.md +12 -0
- data/docs/CreditMemoApi.md +671 -0
- data/docs/CreditMemoApplicationJson.md +13 -0
- data/docs/CreditMemoBalanceJson.md +11 -0
- data/docs/CreditMemoJson.md +20 -0
- data/docs/CreditMemoLineItemJson.md +15 -0
- data/docs/CreditMemoLineItemRequestJson.md +11 -0
- data/docs/CreditMemoPaginationResponseJson.md +10 -0
- data/docs/CrmAccountImportResponse.md +9 -0
- data/docs/CustomFieldApi.md +411 -0
- data/docs/CustomFieldDefault.md +9 -0
- data/docs/CustomFieldDefinitionCreateInput.md +15 -0
- data/docs/CustomFieldDefinitionJson.md +17 -0
- data/docs/CustomFieldDefinitionUpdateInput.md +12 -0
- data/docs/CustomFieldEntry.md +17 -0
- data/docs/CustomFieldUpdateInput.md +9 -0
- data/docs/CustomFieldValue.md +16 -0
- data/docs/CustomizationApi.md +244 -0
- data/docs/DataImport.md +19 -0
- data/docs/DefaultApi.md +225 -0
- data/docs/DiscountDetailJson.md +13 -0
- data/docs/DiscountJson.md +12 -0
- data/docs/DiscountsApi.md +337 -0
- data/docs/DocuSignIntegrationRequestJson.md +10 -0
- data/docs/DocuSignIntegrationResponseJson.md +11 -0
- data/docs/DocumentCustomContent.md +11 -0
- data/docs/DocumentSection.md +13 -0
- data/docs/DocumentTemplateJson.md +15 -0
- data/docs/DunningSettingJson.md +9 -0
- data/docs/ERPApi.md +278 -0
- data/docs/EmailNotifiersList.md +10 -0
- data/docs/EntitiesApi.md +389 -0
- data/docs/Entity.md +22 -0
- data/docs/EntityApi.md +66 -0
- data/docs/EntityJson.md +21 -0
- data/docs/EntityRef.md +10 -0
- data/docs/Entry.md +10 -0
- data/docs/ExternalArrScheduleJson.md +17 -0
- data/docs/FlatfileWorkbookResponse.md +8 -0
- data/docs/FlatfileWorkbookResponseData.md +9 -0
- data/docs/ImportApi.md +589 -0
- data/docs/InputStream.md +7 -0
- data/docs/Integration.md +17 -0
- data/docs/IntegrationsApi.md +1747 -0
- data/docs/InvoiceBalanceJson.md +11 -0
- data/docs/InvoiceItemJson.md +27 -0
- data/docs/InvoiceItemPreviewJson.md +13 -0
- data/docs/InvoiceJson.md +31 -0
- data/docs/InvoiceJsonPaginationResponse.md +10 -0
- data/docs/InvoiceNumberPrefix.md +8 -0
- data/docs/InvoicePreviewJson.md +12 -0
- data/docs/LedgerAccount.md +16 -0
- data/docs/LedgerAccountMapping.md +12 -0
- data/docs/MetricsJson.md +17 -0
- data/docs/MetricsReportingApi.md +228 -0
- data/docs/NotificationTargetAndSubscriptions.md +13 -0
- data/docs/NotificationsApi.md +226 -0
- data/docs/NumberConfig.md +12 -0
- data/docs/Opportunity.md +20 -0
- data/docs/OpportunityApi.md +178 -0
- data/docs/OpportunityJson.md +20 -0
- data/docs/OpportunityPaginationResponse.md +10 -0
- data/docs/OpportunityRestJson.md +19 -0
- data/docs/OrderJson.md +59 -0
- data/docs/OrderJsonPaginationResponse.md +10 -0
- data/docs/OrderLineItemJson.md +34 -0
- data/docs/OrderLineItemRequestJson.md +24 -0
- data/docs/OrderRequestJson.md +46 -0
- data/docs/OrderTerms.md +13 -0
- data/docs/OrdersApi.md +1429 -0
- data/docs/PaginatedResponse.md +10 -0
- data/docs/PaymentBalanceJson.md +11 -0
- data/docs/PaymentConfiguration.md +8 -0
- data/docs/PaymentJson.md +16 -0
- data/docs/PaymentJsonPaginationResponse.md +10 -0
- data/docs/PaymentTermSettingsJson.md +10 -0
- data/docs/PaymentsApi.md +450 -0
- data/docs/PlanJson.md +20 -0
- data/docs/PlanJsonPaginationResponse.md +10 -0
- data/docs/PredefinedReportDefChartJson.md +17 -0
- data/docs/PredefinedReportDefJson.md +12 -0
- data/docs/PredefinedReportDefsJson.md +8 -0
- data/docs/PredefinedReportJson.md +11 -0
- data/docs/PredefinedReportParam.md +14 -0
- data/docs/PredefinedReportParamObject.md +14 -0
- data/docs/PrepaidStats.md +22 -0
- data/docs/PriceTierJson.md +10 -0
- data/docs/ProductCatalogApi.md +1866 -0
- data/docs/ProductCategory.md +14 -0
- data/docs/ProductCategoryPaginationResponse.md +10 -0
- data/docs/ProductInputJson.md +15 -0
- data/docs/ProductJson.md +18 -0
- data/docs/ProductJsonPaginationResponse.md +10 -0
- data/docs/PurchaseOrder.md +10 -0
- data/docs/RateCardApi.md +56 -0
- data/docs/RawUsage.md +14 -0
- data/docs/RawUsagesData.md +8 -0
- data/docs/RecognitionEventCompletion.md +19 -0
- data/docs/RecognitionRule.md +20 -0
- data/docs/RecurrenceJson.md +9 -0
- data/docs/Refund.md +21 -0
- data/docs/RefundDetail.md +20 -0
- data/docs/RefundRequestJson.md +15 -0
- data/docs/RefundsApi.md +179 -0
- data/docs/ReportDuration.md +9 -0
- data/docs/ReportJobResponse.md +11 -0
- data/docs/ReportsApi.md +220 -0
- data/docs/RevenueRecognitionApi.md +495 -0
- data/docs/SalesRoomApi.md +62 -0
- data/docs/SalesforceAccount.md +13 -0
- data/docs/SalesforceAccountBillingAddress.md +12 -0
- data/docs/SalesforceClientIntegrationRequestJson.md +11 -0
- data/docs/SettingsApi.md +1127 -56
- data/docs/SettlementApplication.md +19 -0
- data/docs/StandaloneCreditMemoRequest.md +20 -0
- data/docs/SubscriptionChargeAlias.md +11 -0
- data/docs/SubscriptionChargeJson.md +23 -0
- data/docs/SubscriptionJson.md +40 -0
- data/docs/SubscriptionUpdateJson.md +16 -0
- data/docs/SubscriptionsApi.md +573 -0
- data/docs/TaxJarIntegration.md +14 -0
- data/docs/TaxJarIntegrationInput.md +9 -0
- data/docs/TaxRateJson.md +15 -0
- data/docs/TaxRatePaginationResponseJson.md +10 -0
- data/docs/TenantCreditMemoConfigurationJson.md +11 -0
- data/docs/TenantDiscountJson.md +9 -0
- data/docs/TenantDiscountLineItemJson.md +10 -0
- data/docs/TenantInvoiceConfig.md +12 -0
- data/docs/TenantJson.md +19 -0
- data/docs/TenantSettingJson.md +15 -0
- data/docs/TimeSeriesAmountJson.md +9 -0
- data/docs/TimeZone.md +11 -0
- data/docs/UnitOfMeasureJson.md +1 -1
- data/docs/UnitOfMeasurePaginationResponseJson.md +1 -1
- data/docs/UpdateInvoiceRequest.md +13 -0
- data/docs/UsageAggregateOutput.md +16 -0
- data/docs/UsageApi.md +611 -0
- data/docs/UsageBatchInsertResult.md +11 -0
- data/docs/UserGroupJson.md +12 -0
- data/docs/UserGroupRequestJson.md +12 -0
- data/docs/UserInput.md +16 -0
- data/docs/UserJson.md +22 -0
- data/docs/UserPaginationResponseJson.md +10 -0
- data/docs/UsersApi.md +774 -0
- data/docs/VoidInvoiceRequest.md +9 -0
- data/docs/VoidPaymentJson.md +12 -0
- data/lib/subskribe_dev/api/accounting_api.rb +193 -0
- data/lib/subskribe_dev/api/accounts_api.rb +858 -0
- data/lib/subskribe_dev/api/approvals_api.rb +965 -0
- data/lib/subskribe_dev/api/attachments_api.rb +299 -0
- data/lib/subskribe_dev/api/authentication_api.rb +335 -0
- data/lib/subskribe_dev/api/billing_api.rb +2098 -0
- data/lib/subskribe_dev/api/credit_memo_api.rb +636 -0
- data/lib/subskribe_dev/api/custom_field_api.rb +434 -0
- data/lib/subskribe_dev/api/customization_api.rb +269 -0
- data/lib/subskribe_dev/api/default_api.rb +223 -0
- data/lib/{swagger_client/api/settings_api.rb → subskribe_dev/api/discounts_api.rb} +133 -126
- data/lib/subskribe_dev/api/entities_api.rb +374 -0
- data/lib/subskribe_dev/api/entity_api.rb +79 -0
- data/lib/subskribe_dev/api/erp_api.rb +278 -0
- data/lib/subskribe_dev/api/import_api.rb +568 -0
- data/lib/subskribe_dev/api/integrations_api.rb +1678 -0
- data/lib/subskribe_dev/api/metrics_reporting_api.rb +223 -0
- data/lib/subskribe_dev/api/notifications_api.rb +245 -0
- data/lib/subskribe_dev/api/opportunity_api.rb +177 -0
- data/lib/subskribe_dev/api/orders_api.rb +1381 -0
- data/lib/subskribe_dev/api/payments_api.rb +431 -0
- data/lib/subskribe_dev/api/product_catalog_api.rb +1828 -0
- data/lib/subskribe_dev/api/rate_card_api.rb +68 -0
- data/lib/subskribe_dev/api/refunds_api.rb +189 -0
- data/lib/subskribe_dev/api/reports_api.rb +227 -0
- data/lib/subskribe_dev/api/revenue_recognition_api.rb +484 -0
- data/lib/subskribe_dev/api/sales_room_api.rb +74 -0
- data/lib/subskribe_dev/api/settings_api.rb +1321 -0
- data/lib/subskribe_dev/api/subscriptions_api.rb +576 -0
- data/lib/subskribe_dev/api/usage_api.rb +604 -0
- data/lib/subskribe_dev/api/users_api.rb +728 -0
- data/lib/{swagger_client → subskribe_dev}/api_client.rb +2 -2
- data/lib/{swagger_client → subskribe_dev}/api_error.rb +1 -1
- data/lib/{swagger_client → subskribe_dev}/configuration.rb +1 -1
- data/lib/subskribe_dev/models/account_address.rb +265 -0
- data/lib/subskribe_dev/models/account_address_json.rb +229 -0
- data/lib/subskribe_dev/models/account_contact.rb +530 -0
- data/lib/subskribe_dev/models/account_contact_json.rb +274 -0
- data/lib/subskribe_dev/models/account_json.rb +395 -0
- data/lib/subskribe_dev/models/account_payment_method_json.rb +268 -0
- data/lib/subskribe_dev/models/account_receivable_contact_json.rb +225 -0
- data/lib/subskribe_dev/models/accounting_event.rb +319 -0
- data/lib/subskribe_dev/models/accounting_event_paginated_response.rb +204 -0
- data/lib/subskribe_dev/models/accounting_period.rb +356 -0
- data/lib/subskribe_dev/models/accounting_period_calculation.rb +229 -0
- data/lib/subskribe_dev/models/add_and_apply_payment_application_json.rb +344 -0
- data/lib/subskribe_dev/models/anrok_integration_input.rb +184 -0
- data/lib/subskribe_dev/models/approval_matrix_import_data_json.rb +229 -0
- data/lib/subskribe_dev/models/approval_matrix_import_preview.rb +226 -0
- data/lib/subskribe_dev/models/approval_role_json.rb +220 -0
- data/lib/subskribe_dev/models/approval_role_segment_change.rb +211 -0
- data/lib/subskribe_dev/models/approval_segment_json.rb +220 -0
- data/lib/subskribe_dev/models/attachment.rb +326 -0
- data/lib/subskribe_dev/models/attribute_reference.rb +193 -0
- data/lib/subskribe_dev/models/auth_saml_integration_json.rb +204 -0
- data/lib/subskribe_dev/models/automated_invoice_rule.rb +328 -0
- data/lib/subskribe_dev/models/automated_invoice_rule_request_json.rb +307 -0
- data/lib/subskribe_dev/models/avalara_integration.rb +238 -0
- data/lib/subskribe_dev/models/avalara_integration_input.rb +268 -0
- data/lib/subskribe_dev/models/billing_event_entry.rb +211 -0
- data/lib/subskribe_dev/models/billing_event_input.rb +216 -0
- data/lib/subskribe_dev/models/bulk_invoice_run.rb +350 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_exclusions.rb +197 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_input.rb +263 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_item.rb +364 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_selector.rb +184 -0
- data/lib/subskribe_dev/models/bulk_payment_upload_data.rb +274 -0
- data/lib/subskribe_dev/models/bulk_payment_upload_result.rb +204 -0
- data/lib/subskribe_dev/models/byte_buffer.rb +247 -0
- data/lib/subskribe_dev/models/catalog_relationship.rb +364 -0
- data/lib/subskribe_dev/models/charge_json.rb +631 -0
- data/lib/subskribe_dev/models/charge_partial_json.rb +310 -0
- data/lib/subskribe_dev/models/company_contact_json.rb +225 -0
- data/lib/subskribe_dev/models/credit_memo_application_json.rb +239 -0
- data/lib/subskribe_dev/models/credit_memo_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/credit_memo_json.rb +363 -0
- data/lib/subskribe_dev/models/credit_memo_line_item_json.rb +252 -0
- data/lib/subskribe_dev/models/credit_memo_line_item_request_json.rb +211 -0
- data/lib/subskribe_dev/models/credit_memo_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/crm_account_import_response.rb +193 -0
- data/lib/subskribe_dev/models/custom_field_default.rb +195 -0
- data/lib/subskribe_dev/models/custom_field_definition_create_input.rb +317 -0
- data/lib/subskribe_dev/models/custom_field_definition_json.rb +313 -0
- data/lib/subskribe_dev/models/custom_field_definition_update_input.rb +256 -0
- data/lib/subskribe_dev/models/custom_field_entry.rb +325 -0
- data/lib/subskribe_dev/models/custom_field_update_input.rb +195 -0
- data/lib/subskribe_dev/models/custom_field_value.rb +316 -0
- data/lib/subskribe_dev/models/data_import.rb +355 -0
- data/lib/subskribe_dev/models/discount_detail_json.rb +263 -0
- data/lib/subskribe_dev/models/discount_json.rb +254 -0
- data/lib/subskribe_dev/models/docu_sign_integration_request_json.rb +236 -0
- data/lib/subskribe_dev/models/docu_sign_integration_response_json.rb +245 -0
- data/lib/subskribe_dev/models/document_custom_content.rb +211 -0
- data/lib/subskribe_dev/models/document_section.rb +265 -0
- data/lib/subskribe_dev/models/document_template_json.rb +300 -0
- data/lib/subskribe_dev/models/dunning_setting_json.rb +200 -0
- data/lib/subskribe_dev/models/email_notifiers_list.rb +208 -0
- data/lib/subskribe_dev/models/entity.rb +356 -0
- data/lib/subskribe_dev/models/entity_json.rb +347 -0
- data/lib/subskribe_dev/models/entity_ref.rb +202 -0
- data/lib/subskribe_dev/models/entry.rb +202 -0
- data/lib/subskribe_dev/models/external_arr_schedule_json.rb +319 -0
- data/lib/subskribe_dev/models/flatfile_workbook_response.rb +184 -0
- data/lib/subskribe_dev/models/flatfile_workbook_response_data.rb +193 -0
- data/lib/subskribe_dev/models/input_stream.rb +175 -0
- data/lib/subskribe_dev/models/integration.rb +311 -0
- data/lib/subskribe_dev/models/invoice_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/invoice_item_json.rb +355 -0
- data/lib/subskribe_dev/models/invoice_item_preview_json.rb +229 -0
- data/lib/subskribe_dev/models/invoice_json.rb +439 -0
- data/lib/subskribe_dev/models/invoice_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/invoice_number_prefix.rb +184 -0
- data/lib/subskribe_dev/models/invoice_preview_json.rb +222 -0
- data/lib/subskribe_dev/models/ledger_account.rb +316 -0
- data/lib/subskribe_dev/models/ledger_account_mapping.rb +222 -0
- data/lib/subskribe_dev/models/metrics_json.rb +267 -0
- data/lib/subskribe_dev/models/notification_target_and_subscriptions.rb +265 -0
- data/lib/subskribe_dev/models/number_config.rb +254 -0
- data/lib/subskribe_dev/models/opportunity.rb +326 -0
- data/lib/subskribe_dev/models/opportunity_json.rb +326 -0
- data/lib/subskribe_dev/models/opportunity_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/opportunity_rest_json.rb +317 -0
- data/lib/subskribe_dev/models/order_json.rb +754 -0
- data/lib/subskribe_dev/models/order_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/order_line_item_json.rb +465 -0
- data/lib/subskribe_dev/models/order_line_item_request_json.rb +375 -0
- data/lib/subskribe_dev/models/order_request_json.rb +616 -0
- data/lib/subskribe_dev/models/order_terms.rb +265 -0
- data/lib/subskribe_dev/models/paginated_response.rb +204 -0
- data/lib/subskribe_dev/models/payment_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/payment_configuration.rb +208 -0
- data/lib/subskribe_dev/models/payment_json.rb +300 -0
- data/lib/subskribe_dev/models/payment_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/payment_term_settings_json.rb +219 -0
- data/lib/subskribe_dev/models/plan_json.rb +339 -0
- data/lib/subskribe_dev/models/plan_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/predefined_report_def_chart_json.rb +265 -0
- data/lib/subskribe_dev/models/predefined_report_def_json.rb +222 -0
- data/lib/subskribe_dev/models/predefined_report_defs_json.rb +186 -0
- data/lib/subskribe_dev/models/predefined_report_json.rb +213 -0
- data/lib/subskribe_dev/models/predefined_report_param.rb +296 -0
- data/lib/subskribe_dev/models/predefined_report_param_object.rb +296 -0
- data/lib/subskribe_dev/models/prepaid_stats.rb +310 -0
- data/lib/subskribe_dev/models/price_tier_json.rb +212 -0
- data/lib/subskribe_dev/models/product_category.rb +264 -0
- data/lib/subskribe_dev/models/product_category_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/product_input_json.rb +249 -0
- data/lib/subskribe_dev/models/product_json.rb +276 -0
- data/lib/subskribe_dev/models/product_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/purchase_order.rb +226 -0
- data/lib/subskribe_dev/models/raw_usage.rb +247 -0
- data/lib/subskribe_dev/models/raw_usages_data.rb +192 -0
- data/lib/subskribe_dev/models/recognition_event_completion.rb +322 -0
- data/lib/subskribe_dev/models/recognition_rule.rb +376 -0
- data/lib/subskribe_dev/models/recurrence_json.rb +256 -0
- data/lib/subskribe_dev/models/refund.rb +301 -0
- data/lib/subskribe_dev/models/refund_detail.rb +322 -0
- data/lib/subskribe_dev/models/refund_request_json.rb +272 -0
- data/lib/subskribe_dev/models/report_duration.rb +193 -0
- data/lib/subskribe_dev/models/report_job_response.rb +245 -0
- data/lib/subskribe_dev/models/salesforce_account.rb +229 -0
- data/lib/subskribe_dev/models/salesforce_account_billing_address.rb +220 -0
- data/lib/subskribe_dev/models/salesforce_client_integration_request_json.rb +211 -0
- data/lib/subskribe_dev/models/settlement_application.rb +329 -0
- data/lib/subskribe_dev/models/standalone_credit_memo_request.rb +353 -0
- data/lib/subskribe_dev/models/subscription_charge_alias.rb +283 -0
- data/lib/subskribe_dev/models/subscription_charge_json.rb +362 -0
- data/lib/subskribe_dev/models/subscription_json.rb +583 -0
- data/lib/subskribe_dev/models/subscription_update_json.rb +280 -0
- data/lib/subskribe_dev/models/tax_jar_integration.rb +238 -0
- data/lib/subskribe_dev/models/tax_jar_integration_input.rb +193 -0
- data/lib/subskribe_dev/models/tax_rate_json.rb +286 -0
- data/lib/subskribe_dev/models/tax_rate_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/tenant_credit_memo_configuration_json.rb +211 -0
- data/lib/subskribe_dev/models/tenant_discount_json.rb +193 -0
- data/lib/subskribe_dev/models/tenant_discount_line_item_json.rb +202 -0
- data/lib/subskribe_dev/models/tenant_invoice_config.rb +254 -0
- data/lib/subskribe_dev/models/tenant_json.rb +283 -0
- data/lib/subskribe_dev/models/tenant_setting_json.rb +307 -0
- data/lib/subskribe_dev/models/time_series_amount_json.rb +193 -0
- data/lib/subskribe_dev/models/time_zone.rb +211 -0
- data/lib/{swagger_client → subskribe_dev}/models/unit_of_measure_json.rb +2 -2
- data/lib/{swagger_client → subskribe_dev}/models/unit_of_measure_pagination_response_json.rb +2 -2
- data/lib/subskribe_dev/models/update_invoice_request.rb +282 -0
- data/lib/subskribe_dev/models/usage_aggregate_output.rb +258 -0
- data/lib/subskribe_dev/models/usage_batch_insert_result.rb +213 -0
- data/lib/subskribe_dev/models/user_group_json.rb +224 -0
- data/lib/subskribe_dev/models/user_group_request_json.rb +224 -0
- data/lib/subskribe_dev/models/user_input.rb +304 -0
- data/lib/subskribe_dev/models/user_json.rb +376 -0
- data/lib/subskribe_dev/models/user_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/void_invoice_request.rb +203 -0
- data/lib/subskribe_dev/models/void_payment_json.rb +235 -0
- data/lib/{swagger_client → subskribe_dev}/version.rb +2 -2
- data/lib/subskribe_dev.rb +229 -0
- data/spec/api/accounting_api_spec.rb +74 -0
- data/spec/api/accounts_api_spec.rb +232 -0
- data/spec/api/approvals_api_spec.rb +260 -0
- data/spec/api/attachments_api_spec.rb +100 -0
- data/spec/api/authentication_api_spec.rb +108 -0
- data/spec/api/billing_api_spec.rb +516 -0
- data/spec/api/credit_memo_api_spec.rb +181 -0
- data/spec/api/custom_field_api_spec.rb +126 -0
- data/spec/api/customization_api_spec.rb +89 -0
- data/spec/api/default_api_spec.rb +81 -0
- data/spec/api/discounts_api_spec.rb +108 -0
- data/spec/api/entities_api_spec.rb +120 -0
- data/spec/api/entity_api_spec.rb +48 -0
- data/spec/api/erp_api_spec.rb +95 -0
- data/spec/api/import_api_spec.rb +164 -0
- data/spec/api/integrations_api_spec.rb +420 -0
- data/spec/api/metrics_reporting_api_spec.rb +84 -0
- data/spec/api/notifications_api_spec.rb +84 -0
- data/spec/api/opportunity_api_spec.rb +72 -0
- data/spec/api/orders_api_spec.rb +351 -0
- data/spec/api/payments_api_spec.rb +132 -0
- data/spec/api/product_catalog_api_spec.rb +448 -0
- data/spec/api/rate_card_api_spec.rb +46 -0
- data/spec/api/refunds_api_spec.rb +73 -0
- data/spec/api/reports_api_spec.rb +82 -0
- data/spec/api/revenue_recognition_api_spec.rb +144 -0
- data/spec/api/sales_room_api_spec.rb +47 -0
- data/spec/api/settings_api_spec.rb +3 -3
- data/spec/api/subscriptions_api_spec.rb +162 -0
- data/spec/api/usage_api_spec.rb +169 -0
- data/spec/api/users_api_spec.rb +203 -0
- data/spec/api_client_spec.rb +31 -31
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/account_address_json_spec.rb +71 -0
- data/spec/models/account_address_spec.rb +95 -0
- data/spec/models/account_contact_json_spec.rb +101 -0
- data/spec/models/account_contact_spec.rb +141 -0
- data/spec/models/account_json_spec.rb +163 -0
- data/spec/models/account_payment_method_json_spec.rb +75 -0
- data/spec/models/account_receivable_contact_json_spec.rb +65 -0
- data/spec/models/accounting_event_paginated_response_spec.rb +53 -0
- data/spec/models/accounting_event_spec.rb +111 -0
- data/spec/models/accounting_period_calculation_spec.rb +71 -0
- data/spec/models/accounting_period_spec.rb +133 -0
- data/spec/models/add_and_apply_payment_application_json_spec.rb +115 -0
- data/spec/models/anrok_integration_input_spec.rb +41 -0
- data/spec/models/approval_matrix_import_data_json_spec.rb +71 -0
- data/spec/models/approval_matrix_import_preview_spec.rb +65 -0
- data/spec/models/approval_role_json_spec.rb +65 -0
- data/spec/models/approval_role_segment_change_spec.rb +59 -0
- data/spec/models/approval_segment_json_spec.rb +65 -0
- data/spec/models/attachment_spec.rb +103 -0
- data/spec/models/attribute_reference_spec.rb +47 -0
- data/spec/models/auth_saml_integration_json_spec.rb +53 -0
- data/spec/models/automated_invoice_rule_request_json_spec.rb +113 -0
- data/spec/models/automated_invoice_rule_spec.rb +137 -0
- data/spec/models/avalara_integration_input_spec.rb +65 -0
- data/spec/models/avalara_integration_spec.rb +77 -0
- data/spec/models/billing_event_entry_spec.rb +59 -0
- data/spec/models/billing_event_input_spec.rb +59 -0
- data/spec/models/bulk_invoice_run_exclusions_spec.rb +47 -0
- data/spec/models/bulk_invoice_run_input_spec.rb +75 -0
- data/spec/models/bulk_invoice_run_item_spec.rb +161 -0
- data/spec/models/bulk_invoice_run_selector_spec.rb +41 -0
- data/spec/models/bulk_invoice_run_spec.rb +125 -0
- data/spec/models/bulk_payment_upload_data_spec.rb +101 -0
- data/spec/models/bulk_payment_upload_result_spec.rb +53 -0
- data/spec/models/byte_buffer_spec.rb +83 -0
- data/spec/models/catalog_relationship_spec.rb +75 -0
- data/spec/models/charge_json_spec.rb +295 -0
- data/spec/models/charge_partial_json_spec.rb +125 -0
- data/spec/models/company_contact_json_spec.rb +65 -0
- data/spec/models/credit_memo_application_json_spec.rb +71 -0
- data/spec/models/credit_memo_balance_json_spec.rb +59 -0
- data/spec/models/credit_memo_json_spec.rb +117 -0
- data/spec/models/credit_memo_line_item_json_spec.rb +83 -0
- data/spec/models/credit_memo_line_item_request_json_spec.rb +59 -0
- data/spec/models/credit_memo_pagination_response_json_spec.rb +53 -0
- data/spec/models/crm_account_import_response_spec.rb +47 -0
- data/spec/models/custom_field_default_spec.rb +47 -0
- data/spec/models/custom_field_definition_create_input_spec.rb +95 -0
- data/spec/models/custom_field_definition_json_spec.rb +103 -0
- data/spec/models/custom_field_definition_update_input_spec.rb +69 -0
- data/spec/models/custom_field_entry_spec.rb +103 -0
- data/spec/models/custom_field_update_input_spec.rb +47 -0
- data/spec/models/custom_field_value_spec.rb +97 -0
- data/spec/models/data_import_spec.rb +123 -0
- data/spec/models/discount_detail_json_spec.rb +75 -0
- data/spec/models/discount_json_spec.rb +69 -0
- data/spec/models/docu_sign_integration_request_json_spec.rb +57 -0
- data/spec/models/docu_sign_integration_response_json_spec.rb +63 -0
- data/spec/models/document_custom_content_spec.rb +59 -0
- data/spec/models/document_section_spec.rb +75 -0
- data/spec/models/document_template_json_spec.rb +91 -0
- data/spec/models/dunning_setting_json_spec.rb +47 -0
- data/spec/models/email_notifiers_list_spec.rb +53 -0
- data/spec/models/entity_json_spec.rb +127 -0
- data/spec/models/entity_ref_spec.rb +53 -0
- data/spec/models/entity_spec.rb +133 -0
- data/spec/models/entry_spec.rb +53 -0
- data/spec/models/external_arr_schedule_json_spec.rb +99 -0
- data/spec/models/flatfile_workbook_response_data_spec.rb +47 -0
- data/spec/models/flatfile_workbook_response_spec.rb +41 -0
- data/spec/models/input_stream_spec.rb +35 -0
- data/spec/models/integration_spec.rb +103 -0
- data/spec/models/invoice_balance_json_spec.rb +59 -0
- data/spec/models/invoice_item_json_spec.rb +155 -0
- data/spec/models/invoice_item_preview_json_spec.rb +71 -0
- data/spec/models/invoice_json_pagination_response_spec.rb +53 -0
- data/spec/models/invoice_json_spec.rb +187 -0
- data/spec/models/invoice_number_prefix_spec.rb +41 -0
- data/spec/models/invoice_preview_json_spec.rb +65 -0
- data/spec/models/ledger_account_mapping_spec.rb +65 -0
- data/spec/models/ledger_account_spec.rb +93 -0
- data/spec/models/metrics_json_spec.rb +95 -0
- data/spec/models/notification_target_and_subscriptions_spec.rb +79 -0
- data/spec/models/number_config_spec.rb +69 -0
- data/spec/models/opportunity_json_spec.rb +117 -0
- data/spec/models/opportunity_pagination_response_spec.rb +53 -0
- data/spec/models/opportunity_rest_json_spec.rb +111 -0
- data/spec/models/opportunity_spec.rb +117 -0
- data/spec/models/order_json_pagination_response_spec.rb +53 -0
- data/spec/models/order_json_spec.rb +367 -0
- data/spec/models/order_line_item_json_spec.rb +201 -0
- data/spec/models/order_line_item_request_json_spec.rb +141 -0
- data/spec/models/order_request_json_spec.rb +285 -0
- data/spec/models/order_terms_spec.rb +75 -0
- data/spec/models/paginated_response_spec.rb +53 -0
- data/spec/models/payment_balance_json_spec.rb +59 -0
- data/spec/models/payment_configuration_spec.rb +45 -0
- data/spec/models/payment_json_pagination_response_spec.rb +53 -0
- data/spec/models/payment_json_spec.rb +93 -0
- data/spec/models/payment_term_settings_json_spec.rb +53 -0
- data/spec/models/plan_json_pagination_response_spec.rb +53 -0
- data/spec/models/plan_json_spec.rb +117 -0
- data/spec/models/predefined_report_def_chart_json_spec.rb +95 -0
- data/spec/models/predefined_report_def_json_spec.rb +65 -0
- data/spec/models/predefined_report_defs_json_spec.rb +41 -0
- data/spec/models/predefined_report_json_spec.rb +59 -0
- data/spec/models/predefined_report_param_object_spec.rb +85 -0
- data/spec/models/predefined_report_param_spec.rb +85 -0
- data/spec/models/prepaid_stats_spec.rb +125 -0
- data/spec/models/price_tier_json_spec.rb +53 -0
- data/spec/models/product_category_pagination_response_spec.rb +53 -0
- data/spec/models/product_category_spec.rb +77 -0
- data/spec/models/product_input_json_spec.rb +83 -0
- data/spec/models/product_json_pagination_response_spec.rb +53 -0
- data/spec/models/product_json_spec.rb +101 -0
- data/spec/models/purchase_order_spec.rb +53 -0
- data/spec/models/raw_usage_spec.rb +77 -0
- data/spec/models/raw_usages_data_spec.rb +41 -0
- data/spec/models/recognition_event_completion_spec.rb +111 -0
- data/spec/models/recognition_rule_spec.rb +133 -0
- data/spec/models/recurrence_json_spec.rb +51 -0
- data/spec/models/refund_detail_spec.rb +113 -0
- data/spec/models/refund_request_json_spec.rb +83 -0
- data/spec/models/refund_spec.rb +119 -0
- data/spec/models/report_duration_spec.rb +47 -0
- data/spec/models/report_job_response_spec.rb +63 -0
- data/spec/models/salesforce_account_billing_address_spec.rb +65 -0
- data/spec/models/salesforce_account_spec.rb +71 -0
- data/spec/models/salesforce_client_integration_request_json_spec.rb +59 -0
- data/spec/models/settlement_application_spec.rb +115 -0
- data/spec/models/standalone_credit_memo_request_spec.rb +117 -0
- data/spec/models/subscription_charge_alias_spec.rb +59 -0
- data/spec/models/subscription_charge_json_spec.rb +131 -0
- data/spec/models/subscription_json_spec.rb +241 -0
- data/spec/models/subscription_update_json_spec.rb +89 -0
- data/spec/models/tax_jar_integration_input_spec.rb +47 -0
- data/spec/models/tax_jar_integration_spec.rb +77 -0
- data/spec/models/tax_rate_json_spec.rb +87 -0
- data/spec/models/tax_rate_pagination_response_json_spec.rb +53 -0
- data/spec/models/tenant_credit_memo_configuration_json_spec.rb +59 -0
- data/spec/models/tenant_discount_json_spec.rb +47 -0
- data/spec/models/tenant_discount_line_item_json_spec.rb +53 -0
- data/spec/models/tenant_invoice_config_spec.rb +69 -0
- data/spec/models/tenant_json_spec.rb +107 -0
- data/spec/models/tenant_setting_json_spec.rb +95 -0
- data/spec/models/time_series_amount_json_spec.rb +47 -0
- data/spec/models/time_zone_spec.rb +59 -0
- data/spec/models/unit_of_measure_json_spec.rb +3 -3
- data/spec/models/unit_of_measure_pagination_response_json_spec.rb +3 -3
- data/spec/models/update_invoice_request_spec.rb +71 -0
- data/spec/models/usage_aggregate_output_spec.rb +89 -0
- data/spec/models/usage_batch_insert_result_spec.rb +59 -0
- data/spec/models/user_group_json_spec.rb +65 -0
- data/spec/models/user_group_request_json_spec.rb +65 -0
- data/spec/models/user_input_spec.rb +97 -0
- data/spec/models/user_json_spec.rb +137 -0
- data/spec/models/user_pagination_response_json_spec.rb +53 -0
- data/spec/models/void_invoice_request_spec.rb +47 -0
- data/spec/models/void_payment_json_spec.rb +65 -0
- data/spec/spec_helper.rb +1 -1
- data/{swagger_client.gemspec → subskribe_dev.gemspec} +6 -6
- metadata +762 -16
- data/lib/swagger_client.rb +0 -42
- data/swagger_client-1.0.0.gem +0 -0
- data/test1.rb +0 -24
data/docs/SettingsApi.md
CHANGED
@@ -1,15 +1,35 @@
|
|
1
|
-
#
|
1
|
+
# SubskribeDevClient::SettingsApi
|
2
2
|
|
3
3
|
All URIs are relative to *https://api.dev2.subskribe.net*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**activate_unit_of_measure**](SettingsApi.md#activate_unit_of_measure) | **POST** /unitsOfMeasure/{id}/activate | Activate unit of measure
|
8
|
+
[**add_tax_rate**](SettingsApi.md#add_tax_rate) | **POST** /taxrates | Add tax rate
|
9
|
+
[**add_term_section**](SettingsApi.md#add_term_section) | **POST** /termsections | Add predefined terms section
|
8
10
|
[**add_unit_of_measure**](SettingsApi.md#add_unit_of_measure) | **POST** /unitsOfMeasure | Add unit of measure
|
11
|
+
[**delete_tax_rate**](SettingsApi.md#delete_tax_rate) | **DELETE** /taxrates/{id} | Delete tax rate
|
12
|
+
[**delete_term_section**](SettingsApi.md#delete_term_section) | **DELETE** /termsections/{id} | Delete predefined terms section
|
9
13
|
[**delete_unit_of_measure**](SettingsApi.md#delete_unit_of_measure) | **DELETE** /unitsOfMeasure/{id} | Delete unit of measure
|
10
14
|
[**deprecate_unit_of_measure**](SettingsApi.md#deprecate_unit_of_measure) | **POST** /unitsOfMeasure/{id}/deprecate | Deprecate unit of measure
|
15
|
+
[**get_payment_term_settings**](SettingsApi.md#get_payment_term_settings) | **GET** /settings/paymentTerms | Get payment term settings
|
16
|
+
[**get_supported_currencies**](SettingsApi.md#get_supported_currencies) | **GET** /settings/supportedCurrencies | Get supported currencies
|
17
|
+
[**get_tax_rate**](SettingsApi.md#get_tax_rate) | **GET** /taxrates/{id} | Get tax rate by Id
|
18
|
+
[**get_tax_rates**](SettingsApi.md#get_tax_rates) | **GET** /taxrates | Get tax rates
|
19
|
+
[**get_tenant**](SettingsApi.md#get_tenant) | **GET** /tenants | Get tenant details
|
20
|
+
[**get_tenant_logo**](SettingsApi.md#get_tenant_logo) | **GET** /tenants/logo | Get tenant logo
|
21
|
+
[**get_tenant_setting**](SettingsApi.md#get_tenant_setting) | **GET** /settings | Get tenant settings
|
22
|
+
[**get_term_section**](SettingsApi.md#get_term_section) | **GET** /termsections/{id} | Get predefined terms section detail
|
23
|
+
[**get_term_sections**](SettingsApi.md#get_term_sections) | **GET** /termsections | Get predefined terms sections
|
11
24
|
[**get_units_of_measure**](SettingsApi.md#get_units_of_measure) | **GET** /unitsOfMeasure | Get units of measure
|
25
|
+
[**update_payment_term_settings**](SettingsApi.md#update_payment_term_settings) | **PUT** /settings/paymentTerms | Update payment term settings
|
26
|
+
[**update_supported_currencies**](SettingsApi.md#update_supported_currencies) | **PUT** /settings/supportedCurrencies | Update supported currencies
|
27
|
+
[**update_tax_rate**](SettingsApi.md#update_tax_rate) | **PUT** /taxrates/{id} | Update tax rate
|
28
|
+
[**update_tenant**](SettingsApi.md#update_tenant) | **PUT** /tenants | Update tenant details
|
29
|
+
[**update_tenant_setting**](SettingsApi.md#update_tenant_setting) | **PUT** /settings | Update tenant settings
|
30
|
+
[**update_term_section**](SettingsApi.md#update_term_section) | **PUT** /termsections/{id} | Update predefined terms section
|
12
31
|
[**update_unit_of_measure**](SettingsApi.md#update_unit_of_measure) | **PUT** /unitsOfMeasure/{id} | Update unit of measure
|
32
|
+
[**upload_tenant_logo**](SettingsApi.md#upload_tenant_logo) | **PUT** /tenants/logo | Update tenant logo
|
13
33
|
|
14
34
|
|
15
35
|
# **activate_unit_of_measure**
|
@@ -22,16 +42,16 @@ Activates the specified unit of measure making it available to be attached to ch
|
|
22
42
|
### Example
|
23
43
|
```ruby
|
24
44
|
# load the gem
|
25
|
-
require '
|
45
|
+
require 'subskribe_dev'
|
26
46
|
# setup authorization
|
27
|
-
|
47
|
+
SubskribeDevClient.configure do |config|
|
28
48
|
# Configure API key authorization: ApiKeyAuth
|
29
49
|
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
30
50
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
31
51
|
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
32
52
|
end
|
33
53
|
|
34
|
-
api_instance =
|
54
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
35
55
|
|
36
56
|
id = 'id_example' # String |
|
37
57
|
|
@@ -39,7 +59,7 @@ id = 'id_example' # String |
|
|
39
59
|
begin
|
40
60
|
#Activate unit of measure
|
41
61
|
api_instance.activate_unit_of_measure(id)
|
42
|
-
rescue
|
62
|
+
rescue SubskribeDevClient::ApiError => e
|
43
63
|
puts "Exception when calling SettingsApi->activate_unit_of_measure: #{e}"
|
44
64
|
end
|
45
65
|
```
|
@@ -65,6 +85,116 @@ nil (empty response body)
|
|
65
85
|
|
66
86
|
|
67
87
|
|
88
|
+
# **add_tax_rate**
|
89
|
+
> TaxRateJson add_tax_rate(opts)
|
90
|
+
|
91
|
+
Add tax rate
|
92
|
+
|
93
|
+
Add a new tax rate object
|
94
|
+
|
95
|
+
### Example
|
96
|
+
```ruby
|
97
|
+
# load the gem
|
98
|
+
require 'subskribe_dev'
|
99
|
+
# setup authorization
|
100
|
+
SubskribeDevClient.configure do |config|
|
101
|
+
# Configure API key authorization: ApiKeyAuth
|
102
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
103
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
104
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
105
|
+
end
|
106
|
+
|
107
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
108
|
+
|
109
|
+
opts = {
|
110
|
+
body: SubskribeDevClient::TaxRateJson.new # TaxRateJson |
|
111
|
+
}
|
112
|
+
|
113
|
+
begin
|
114
|
+
#Add tax rate
|
115
|
+
result = api_instance.add_tax_rate(opts)
|
116
|
+
p result
|
117
|
+
rescue SubskribeDevClient::ApiError => e
|
118
|
+
puts "Exception when calling SettingsApi->add_tax_rate: #{e}"
|
119
|
+
end
|
120
|
+
```
|
121
|
+
|
122
|
+
### Parameters
|
123
|
+
|
124
|
+
Name | Type | Description | Notes
|
125
|
+
------------- | ------------- | ------------- | -------------
|
126
|
+
**body** | [**TaxRateJson**](TaxRateJson.md)| | [optional]
|
127
|
+
|
128
|
+
### Return type
|
129
|
+
|
130
|
+
[**TaxRateJson**](TaxRateJson.md)
|
131
|
+
|
132
|
+
### Authorization
|
133
|
+
|
134
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
135
|
+
|
136
|
+
### HTTP request headers
|
137
|
+
|
138
|
+
- **Content-Type**: application/json
|
139
|
+
- **Accept**: application/json
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
# **add_term_section**
|
144
|
+
> DocumentSection add_term_section(opts)
|
145
|
+
|
146
|
+
Add predefined terms section
|
147
|
+
|
148
|
+
Adds a predefined terms section.
|
149
|
+
|
150
|
+
### Example
|
151
|
+
```ruby
|
152
|
+
# load the gem
|
153
|
+
require 'subskribe_dev'
|
154
|
+
# setup authorization
|
155
|
+
SubskribeDevClient.configure do |config|
|
156
|
+
# Configure API key authorization: ApiKeyAuth
|
157
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
158
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
159
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
160
|
+
end
|
161
|
+
|
162
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
163
|
+
|
164
|
+
opts = {
|
165
|
+
body: SubskribeDevClient::DocumentSection.new # DocumentSection |
|
166
|
+
}
|
167
|
+
|
168
|
+
begin
|
169
|
+
#Add predefined terms section
|
170
|
+
result = api_instance.add_term_section(opts)
|
171
|
+
p result
|
172
|
+
rescue SubskribeDevClient::ApiError => e
|
173
|
+
puts "Exception when calling SettingsApi->add_term_section: #{e}"
|
174
|
+
end
|
175
|
+
```
|
176
|
+
|
177
|
+
### Parameters
|
178
|
+
|
179
|
+
Name | Type | Description | Notes
|
180
|
+
------------- | ------------- | ------------- | -------------
|
181
|
+
**body** | [**DocumentSection**](DocumentSection.md)| | [optional]
|
182
|
+
|
183
|
+
### Return type
|
184
|
+
|
185
|
+
[**DocumentSection**](DocumentSection.md)
|
186
|
+
|
187
|
+
### Authorization
|
188
|
+
|
189
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
190
|
+
|
191
|
+
### HTTP request headers
|
192
|
+
|
193
|
+
- **Content-Type**: Not defined
|
194
|
+
- **Accept**: application/json
|
195
|
+
|
196
|
+
|
197
|
+
|
68
198
|
# **add_unit_of_measure**
|
69
199
|
> UnitOfMeasureJson add_unit_of_measure(opts)
|
70
200
|
|
@@ -75,26 +205,26 @@ Add a new instance of unit of measure as specified by the input
|
|
75
205
|
### Example
|
76
206
|
```ruby
|
77
207
|
# load the gem
|
78
|
-
require '
|
208
|
+
require 'subskribe_dev'
|
79
209
|
# setup authorization
|
80
|
-
|
210
|
+
SubskribeDevClient.configure do |config|
|
81
211
|
# Configure API key authorization: ApiKeyAuth
|
82
212
|
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
83
213
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
84
214
|
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
85
215
|
end
|
86
216
|
|
87
|
-
api_instance =
|
217
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
88
218
|
|
89
219
|
opts = {
|
90
|
-
body:
|
220
|
+
body: SubskribeDevClient::UnitOfMeasureJson.new # UnitOfMeasureJson |
|
91
221
|
}
|
92
222
|
|
93
223
|
begin
|
94
224
|
#Add unit of measure
|
95
225
|
result = api_instance.add_unit_of_measure(opts)
|
96
226
|
p result
|
97
|
-
rescue
|
227
|
+
rescue SubskribeDevClient::ApiError => e
|
98
228
|
puts "Exception when calling SettingsApi->add_unit_of_measure: #{e}"
|
99
229
|
end
|
100
230
|
```
|
@@ -120,6 +250,113 @@ Name | Type | Description | Notes
|
|
120
250
|
|
121
251
|
|
122
252
|
|
253
|
+
# **delete_tax_rate**
|
254
|
+
> TaxRateJson delete_tax_rate(id)
|
255
|
+
|
256
|
+
Delete tax rate
|
257
|
+
|
258
|
+
Deletes the tax rate object by Id. If successful the deleted tax rate object is returned
|
259
|
+
|
260
|
+
### Example
|
261
|
+
```ruby
|
262
|
+
# load the gem
|
263
|
+
require 'subskribe_dev'
|
264
|
+
# setup authorization
|
265
|
+
SubskribeDevClient.configure do |config|
|
266
|
+
# Configure API key authorization: ApiKeyAuth
|
267
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
268
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
269
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
270
|
+
end
|
271
|
+
|
272
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
273
|
+
|
274
|
+
id = 'id_example' # String |
|
275
|
+
|
276
|
+
|
277
|
+
begin
|
278
|
+
#Delete tax rate
|
279
|
+
result = api_instance.delete_tax_rate(id)
|
280
|
+
p result
|
281
|
+
rescue SubskribeDevClient::ApiError => e
|
282
|
+
puts "Exception when calling SettingsApi->delete_tax_rate: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
Name | Type | Description | Notes
|
289
|
+
------------- | ------------- | ------------- | -------------
|
290
|
+
**id** | [**String**](.md)| |
|
291
|
+
|
292
|
+
### Return type
|
293
|
+
|
294
|
+
[**TaxRateJson**](TaxRateJson.md)
|
295
|
+
|
296
|
+
### Authorization
|
297
|
+
|
298
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
299
|
+
|
300
|
+
### HTTP request headers
|
301
|
+
|
302
|
+
- **Content-Type**: Not defined
|
303
|
+
- **Accept**: application/json
|
304
|
+
|
305
|
+
|
306
|
+
|
307
|
+
# **delete_term_section**
|
308
|
+
> delete_term_section(id)
|
309
|
+
|
310
|
+
Delete predefined terms section
|
311
|
+
|
312
|
+
Deletes the predefined terms section specified.
|
313
|
+
|
314
|
+
### Example
|
315
|
+
```ruby
|
316
|
+
# load the gem
|
317
|
+
require 'subskribe_dev'
|
318
|
+
# setup authorization
|
319
|
+
SubskribeDevClient.configure do |config|
|
320
|
+
# Configure API key authorization: ApiKeyAuth
|
321
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
322
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
323
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
324
|
+
end
|
325
|
+
|
326
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
327
|
+
|
328
|
+
id = 'id_example' # String |
|
329
|
+
|
330
|
+
|
331
|
+
begin
|
332
|
+
#Delete predefined terms section
|
333
|
+
api_instance.delete_term_section(id)
|
334
|
+
rescue SubskribeDevClient::ApiError => e
|
335
|
+
puts "Exception when calling SettingsApi->delete_term_section: #{e}"
|
336
|
+
end
|
337
|
+
```
|
338
|
+
|
339
|
+
### Parameters
|
340
|
+
|
341
|
+
Name | Type | Description | Notes
|
342
|
+
------------- | ------------- | ------------- | -------------
|
343
|
+
**id** | **String**| |
|
344
|
+
|
345
|
+
### Return type
|
346
|
+
|
347
|
+
nil (empty response body)
|
348
|
+
|
349
|
+
### Authorization
|
350
|
+
|
351
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
352
|
+
|
353
|
+
### HTTP request headers
|
354
|
+
|
355
|
+
- **Content-Type**: Not defined
|
356
|
+
- **Accept**: application/json
|
357
|
+
|
358
|
+
|
359
|
+
|
123
360
|
# **delete_unit_of_measure**
|
124
361
|
> UnitOfMeasureJson delete_unit_of_measure(id)
|
125
362
|
|
@@ -130,16 +367,16 @@ Delete the unit of measure by Id provided. Returns the deleted unit of measure o
|
|
130
367
|
### Example
|
131
368
|
```ruby
|
132
369
|
# load the gem
|
133
|
-
require '
|
370
|
+
require 'subskribe_dev'
|
134
371
|
# setup authorization
|
135
|
-
|
372
|
+
SubskribeDevClient.configure do |config|
|
136
373
|
# Configure API key authorization: ApiKeyAuth
|
137
374
|
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
138
375
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
139
376
|
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
140
377
|
end
|
141
378
|
|
142
|
-
api_instance =
|
379
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
143
380
|
|
144
381
|
id = 'id_example' # String |
|
145
382
|
|
@@ -148,7 +385,7 @@ begin
|
|
148
385
|
#Delete unit of measure
|
149
386
|
result = api_instance.delete_unit_of_measure(id)
|
150
387
|
p result
|
151
|
-
rescue
|
388
|
+
rescue SubskribeDevClient::ApiError => e
|
152
389
|
puts "Exception when calling SettingsApi->delete_unit_of_measure: #{e}"
|
153
390
|
end
|
154
391
|
```
|
@@ -184,16 +421,16 @@ Deprecates the specified unit of measure making it unavailable to be attached to
|
|
184
421
|
### Example
|
185
422
|
```ruby
|
186
423
|
# load the gem
|
187
|
-
require '
|
424
|
+
require 'subskribe_dev'
|
188
425
|
# setup authorization
|
189
|
-
|
426
|
+
SubskribeDevClient.configure do |config|
|
190
427
|
# Configure API key authorization: ApiKeyAuth
|
191
428
|
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
192
429
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
193
430
|
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
194
431
|
end
|
195
432
|
|
196
|
-
api_instance =
|
433
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
197
434
|
|
198
435
|
id = 'id_example' # String |
|
199
436
|
|
@@ -201,7 +438,7 @@ id = 'id_example' # String |
|
|
201
438
|
begin
|
202
439
|
#Deprecate unit of measure
|
203
440
|
api_instance.deprecate_unit_of_measure(id)
|
204
|
-
rescue
|
441
|
+
rescue SubskribeDevClient::ApiError => e
|
205
442
|
puts "Exception when calling SettingsApi->deprecate_unit_of_measure: #{e}"
|
206
443
|
end
|
207
444
|
```
|
@@ -227,51 +464,88 @@ nil (empty response body)
|
|
227
464
|
|
228
465
|
|
229
466
|
|
230
|
-
# **
|
231
|
-
>
|
467
|
+
# **get_payment_term_settings**
|
468
|
+
> get_payment_term_settings
|
469
|
+
|
470
|
+
Get payment term settings
|
232
471
|
|
233
|
-
Get units of measure
|
234
472
|
|
235
|
-
Returns a paginated list of units of measure
|
236
473
|
|
237
474
|
### Example
|
238
475
|
```ruby
|
239
476
|
# load the gem
|
240
|
-
require '
|
477
|
+
require 'subskribe_dev'
|
241
478
|
# setup authorization
|
242
|
-
|
479
|
+
SubskribeDevClient.configure do |config|
|
243
480
|
# Configure API key authorization: ApiKeyAuth
|
244
481
|
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
245
482
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
246
483
|
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
247
484
|
end
|
248
485
|
|
249
|
-
api_instance =
|
250
|
-
|
251
|
-
opts = {
|
252
|
-
cursor: 'cursor_example', # String |
|
253
|
-
limit: 56 # Integer |
|
254
|
-
}
|
486
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
255
487
|
|
256
488
|
begin
|
257
|
-
#Get
|
258
|
-
|
259
|
-
|
260
|
-
|
261
|
-
puts "Exception when calling SettingsApi->get_units_of_measure: #{e}"
|
489
|
+
#Get payment term settings
|
490
|
+
api_instance.get_payment_term_settings
|
491
|
+
rescue SubskribeDevClient::ApiError => e
|
492
|
+
puts "Exception when calling SettingsApi->get_payment_term_settings: #{e}"
|
262
493
|
end
|
263
494
|
```
|
264
495
|
|
265
496
|
### Parameters
|
497
|
+
This endpoint does not need any parameter.
|
266
498
|
|
267
|
-
|
268
|
-
|
269
|
-
|
270
|
-
|
499
|
+
### Return type
|
500
|
+
|
501
|
+
nil (empty response body)
|
502
|
+
|
503
|
+
### Authorization
|
504
|
+
|
505
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
506
|
+
|
507
|
+
### HTTP request headers
|
508
|
+
|
509
|
+
- **Content-Type**: Not defined
|
510
|
+
- **Accept**: application/json
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
# **get_supported_currencies**
|
515
|
+
> get_supported_currencies
|
516
|
+
|
517
|
+
Get supported currencies
|
518
|
+
|
519
|
+
Get supported currencies for your tenant
|
520
|
+
|
521
|
+
### Example
|
522
|
+
```ruby
|
523
|
+
# load the gem
|
524
|
+
require 'subskribe_dev'
|
525
|
+
# setup authorization
|
526
|
+
SubskribeDevClient.configure do |config|
|
527
|
+
# Configure API key authorization: ApiKeyAuth
|
528
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
529
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
530
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
531
|
+
end
|
532
|
+
|
533
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
534
|
+
|
535
|
+
begin
|
536
|
+
#Get supported currencies
|
537
|
+
api_instance.get_supported_currencies
|
538
|
+
rescue SubskribeDevClient::ApiError => e
|
539
|
+
puts "Exception when calling SettingsApi->get_supported_currencies: #{e}"
|
540
|
+
end
|
541
|
+
```
|
542
|
+
|
543
|
+
### Parameters
|
544
|
+
This endpoint does not need any parameter.
|
271
545
|
|
272
546
|
### Return type
|
273
547
|
|
274
|
-
|
548
|
+
nil (empty response body)
|
275
549
|
|
276
550
|
### Authorization
|
277
551
|
|
@@ -284,39 +558,36 @@ Name | Type | Description | Notes
|
|
284
558
|
|
285
559
|
|
286
560
|
|
287
|
-
# **
|
288
|
-
>
|
561
|
+
# **get_tax_rate**
|
562
|
+
> TaxRatePaginationResponseJson get_tax_rate(id)
|
289
563
|
|
290
|
-
|
564
|
+
Get tax rate by Id
|
291
565
|
|
292
|
-
|
566
|
+
Retrieves the tax rate object by Id
|
293
567
|
|
294
568
|
### Example
|
295
569
|
```ruby
|
296
570
|
# load the gem
|
297
|
-
require '
|
571
|
+
require 'subskribe_dev'
|
298
572
|
# setup authorization
|
299
|
-
|
573
|
+
SubskribeDevClient.configure do |config|
|
300
574
|
# Configure API key authorization: ApiKeyAuth
|
301
575
|
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
302
576
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
303
577
|
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
304
578
|
end
|
305
579
|
|
306
|
-
api_instance =
|
580
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
307
581
|
|
308
582
|
id = 'id_example' # String |
|
309
583
|
|
310
|
-
opts = {
|
311
|
-
body: SwaggerClient::UnitOfMeasureJson.new # UnitOfMeasureJson |
|
312
|
-
}
|
313
584
|
|
314
585
|
begin
|
315
|
-
#
|
316
|
-
result = api_instance.
|
586
|
+
#Get tax rate by Id
|
587
|
+
result = api_instance.get_tax_rate(id)
|
317
588
|
p result
|
318
|
-
rescue
|
319
|
-
puts "Exception when calling SettingsApi->
|
589
|
+
rescue SubskribeDevClient::ApiError => e
|
590
|
+
puts "Exception when calling SettingsApi->get_tax_rate: #{e}"
|
320
591
|
end
|
321
592
|
```
|
322
593
|
|
@@ -325,11 +596,10 @@ end
|
|
325
596
|
Name | Type | Description | Notes
|
326
597
|
------------- | ------------- | ------------- | -------------
|
327
598
|
**id** | [**String**](.md)| |
|
328
|
-
**body** | [**UnitOfMeasureJson**](UnitOfMeasureJson.md)| | [optional]
|
329
599
|
|
330
600
|
### Return type
|
331
601
|
|
332
|
-
[**
|
602
|
+
[**TaxRatePaginationResponseJson**](TaxRatePaginationResponseJson.md)
|
333
603
|
|
334
604
|
### Authorization
|
335
605
|
|
@@ -342,3 +612,804 @@ Name | Type | Description | Notes
|
|
342
612
|
|
343
613
|
|
344
614
|
|
615
|
+
# **get_tax_rates**
|
616
|
+
> TaxRatePaginationResponseJson get_tax_rates(opts)
|
617
|
+
|
618
|
+
Get tax rates
|
619
|
+
|
620
|
+
Get all available tax rates. The result is paginated. To retrieve all results pass the cursor returned from a call to the next call until all results are returned.
|
621
|
+
|
622
|
+
### Example
|
623
|
+
```ruby
|
624
|
+
# load the gem
|
625
|
+
require 'subskribe_dev'
|
626
|
+
# setup authorization
|
627
|
+
SubskribeDevClient.configure do |config|
|
628
|
+
# Configure API key authorization: ApiKeyAuth
|
629
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
630
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
631
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
632
|
+
end
|
633
|
+
|
634
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
635
|
+
|
636
|
+
opts = {
|
637
|
+
cursor: 'cursor_example', # String |
|
638
|
+
limit: 56 # Integer |
|
639
|
+
}
|
640
|
+
|
641
|
+
begin
|
642
|
+
#Get tax rates
|
643
|
+
result = api_instance.get_tax_rates(opts)
|
644
|
+
p result
|
645
|
+
rescue SubskribeDevClient::ApiError => e
|
646
|
+
puts "Exception when calling SettingsApi->get_tax_rates: #{e}"
|
647
|
+
end
|
648
|
+
```
|
649
|
+
|
650
|
+
### Parameters
|
651
|
+
|
652
|
+
Name | Type | Description | Notes
|
653
|
+
------------- | ------------- | ------------- | -------------
|
654
|
+
**cursor** | [**String**](.md)| | [optional]
|
655
|
+
**limit** | **Integer**| | [optional]
|
656
|
+
|
657
|
+
### Return type
|
658
|
+
|
659
|
+
[**TaxRatePaginationResponseJson**](TaxRatePaginationResponseJson.md)
|
660
|
+
|
661
|
+
### Authorization
|
662
|
+
|
663
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
664
|
+
|
665
|
+
### HTTP request headers
|
666
|
+
|
667
|
+
- **Content-Type**: Not defined
|
668
|
+
- **Accept**: application/json
|
669
|
+
|
670
|
+
|
671
|
+
|
672
|
+
# **get_tenant**
|
673
|
+
> TenantJson get_tenant
|
674
|
+
|
675
|
+
Get tenant details
|
676
|
+
|
677
|
+
Get the details of the current tenant
|
678
|
+
|
679
|
+
### Example
|
680
|
+
```ruby
|
681
|
+
# load the gem
|
682
|
+
require 'subskribe_dev'
|
683
|
+
# setup authorization
|
684
|
+
SubskribeDevClient.configure do |config|
|
685
|
+
# Configure API key authorization: ApiKeyAuth
|
686
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
687
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
688
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
689
|
+
end
|
690
|
+
|
691
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
692
|
+
|
693
|
+
begin
|
694
|
+
#Get tenant details
|
695
|
+
result = api_instance.get_tenant
|
696
|
+
p result
|
697
|
+
rescue SubskribeDevClient::ApiError => e
|
698
|
+
puts "Exception when calling SettingsApi->get_tenant: #{e}"
|
699
|
+
end
|
700
|
+
```
|
701
|
+
|
702
|
+
### Parameters
|
703
|
+
This endpoint does not need any parameter.
|
704
|
+
|
705
|
+
### Return type
|
706
|
+
|
707
|
+
[**TenantJson**](TenantJson.md)
|
708
|
+
|
709
|
+
### Authorization
|
710
|
+
|
711
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
712
|
+
|
713
|
+
### HTTP request headers
|
714
|
+
|
715
|
+
- **Content-Type**: Not defined
|
716
|
+
- **Accept**: application/json
|
717
|
+
|
718
|
+
|
719
|
+
|
720
|
+
# **get_tenant_logo**
|
721
|
+
> get_tenant_logo
|
722
|
+
|
723
|
+
Get tenant logo
|
724
|
+
|
725
|
+
Get the current logo stored
|
726
|
+
|
727
|
+
### Example
|
728
|
+
```ruby
|
729
|
+
# load the gem
|
730
|
+
require 'subskribe_dev'
|
731
|
+
# setup authorization
|
732
|
+
SubskribeDevClient.configure do |config|
|
733
|
+
# Configure API key authorization: ApiKeyAuth
|
734
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
735
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
736
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
737
|
+
end
|
738
|
+
|
739
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
740
|
+
|
741
|
+
begin
|
742
|
+
#Get tenant logo
|
743
|
+
api_instance.get_tenant_logo
|
744
|
+
rescue SubskribeDevClient::ApiError => e
|
745
|
+
puts "Exception when calling SettingsApi->get_tenant_logo: #{e}"
|
746
|
+
end
|
747
|
+
```
|
748
|
+
|
749
|
+
### Parameters
|
750
|
+
This endpoint does not need any parameter.
|
751
|
+
|
752
|
+
### Return type
|
753
|
+
|
754
|
+
nil (empty response body)
|
755
|
+
|
756
|
+
### Authorization
|
757
|
+
|
758
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
759
|
+
|
760
|
+
### HTTP request headers
|
761
|
+
|
762
|
+
- **Content-Type**: Not defined
|
763
|
+
- **Accept**: image/png, application/json
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
# **get_tenant_setting**
|
768
|
+
> TenantSettingJson get_tenant_setting
|
769
|
+
|
770
|
+
Get tenant settings
|
771
|
+
|
772
|
+
Returns all tenant settings for your tenant.
|
773
|
+
|
774
|
+
### Example
|
775
|
+
```ruby
|
776
|
+
# load the gem
|
777
|
+
require 'subskribe_dev'
|
778
|
+
# setup authorization
|
779
|
+
SubskribeDevClient.configure do |config|
|
780
|
+
# Configure API key authorization: ApiKeyAuth
|
781
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
782
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
783
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
784
|
+
end
|
785
|
+
|
786
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
787
|
+
|
788
|
+
begin
|
789
|
+
#Get tenant settings
|
790
|
+
result = api_instance.get_tenant_setting
|
791
|
+
p result
|
792
|
+
rescue SubskribeDevClient::ApiError => e
|
793
|
+
puts "Exception when calling SettingsApi->get_tenant_setting: #{e}"
|
794
|
+
end
|
795
|
+
```
|
796
|
+
|
797
|
+
### Parameters
|
798
|
+
This endpoint does not need any parameter.
|
799
|
+
|
800
|
+
### Return type
|
801
|
+
|
802
|
+
[**TenantSettingJson**](TenantSettingJson.md)
|
803
|
+
|
804
|
+
### Authorization
|
805
|
+
|
806
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
807
|
+
|
808
|
+
### HTTP request headers
|
809
|
+
|
810
|
+
- **Content-Type**: Not defined
|
811
|
+
- **Accept**: application/json
|
812
|
+
|
813
|
+
|
814
|
+
|
815
|
+
# **get_term_section**
|
816
|
+
> DocumentSection get_term_section(id)
|
817
|
+
|
818
|
+
Get predefined terms section detail
|
819
|
+
|
820
|
+
Returns predefined terms section detail.
|
821
|
+
|
822
|
+
### Example
|
823
|
+
```ruby
|
824
|
+
# load the gem
|
825
|
+
require 'subskribe_dev'
|
826
|
+
# setup authorization
|
827
|
+
SubskribeDevClient.configure do |config|
|
828
|
+
# Configure API key authorization: ApiKeyAuth
|
829
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
830
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
831
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
832
|
+
end
|
833
|
+
|
834
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
835
|
+
|
836
|
+
id = 'id_example' # String |
|
837
|
+
|
838
|
+
|
839
|
+
begin
|
840
|
+
#Get predefined terms section detail
|
841
|
+
result = api_instance.get_term_section(id)
|
842
|
+
p result
|
843
|
+
rescue SubskribeDevClient::ApiError => e
|
844
|
+
puts "Exception when calling SettingsApi->get_term_section: #{e}"
|
845
|
+
end
|
846
|
+
```
|
847
|
+
|
848
|
+
### Parameters
|
849
|
+
|
850
|
+
Name | Type | Description | Notes
|
851
|
+
------------- | ------------- | ------------- | -------------
|
852
|
+
**id** | **String**| |
|
853
|
+
|
854
|
+
### Return type
|
855
|
+
|
856
|
+
[**DocumentSection**](DocumentSection.md)
|
857
|
+
|
858
|
+
### Authorization
|
859
|
+
|
860
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
861
|
+
|
862
|
+
### HTTP request headers
|
863
|
+
|
864
|
+
- **Content-Type**: Not defined
|
865
|
+
- **Accept**: application/json
|
866
|
+
|
867
|
+
|
868
|
+
|
869
|
+
# **get_term_sections**
|
870
|
+
> DocumentSection get_term_sections
|
871
|
+
|
872
|
+
Get predefined terms sections
|
873
|
+
|
874
|
+
Returns predefined terms sections.
|
875
|
+
|
876
|
+
### Example
|
877
|
+
```ruby
|
878
|
+
# load the gem
|
879
|
+
require 'subskribe_dev'
|
880
|
+
# setup authorization
|
881
|
+
SubskribeDevClient.configure do |config|
|
882
|
+
# Configure API key authorization: ApiKeyAuth
|
883
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
884
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
885
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
886
|
+
end
|
887
|
+
|
888
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
889
|
+
|
890
|
+
begin
|
891
|
+
#Get predefined terms sections
|
892
|
+
result = api_instance.get_term_sections
|
893
|
+
p result
|
894
|
+
rescue SubskribeDevClient::ApiError => e
|
895
|
+
puts "Exception when calling SettingsApi->get_term_sections: #{e}"
|
896
|
+
end
|
897
|
+
```
|
898
|
+
|
899
|
+
### Parameters
|
900
|
+
This endpoint does not need any parameter.
|
901
|
+
|
902
|
+
### Return type
|
903
|
+
|
904
|
+
[**DocumentSection**](DocumentSection.md)
|
905
|
+
|
906
|
+
### Authorization
|
907
|
+
|
908
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
909
|
+
|
910
|
+
### HTTP request headers
|
911
|
+
|
912
|
+
- **Content-Type**: Not defined
|
913
|
+
- **Accept**: application/json
|
914
|
+
|
915
|
+
|
916
|
+
|
917
|
+
# **get_units_of_measure**
|
918
|
+
> UnitOfMeasurePaginationResponseJson get_units_of_measure(opts)
|
919
|
+
|
920
|
+
Get units of measure
|
921
|
+
|
922
|
+
Returns a paginated list of units of measure
|
923
|
+
|
924
|
+
### Example
|
925
|
+
```ruby
|
926
|
+
# load the gem
|
927
|
+
require 'subskribe_dev'
|
928
|
+
# setup authorization
|
929
|
+
SubskribeDevClient.configure do |config|
|
930
|
+
# Configure API key authorization: ApiKeyAuth
|
931
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
932
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
933
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
934
|
+
end
|
935
|
+
|
936
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
937
|
+
|
938
|
+
opts = {
|
939
|
+
cursor: 'cursor_example', # String |
|
940
|
+
limit: 56 # Integer |
|
941
|
+
}
|
942
|
+
|
943
|
+
begin
|
944
|
+
#Get units of measure
|
945
|
+
result = api_instance.get_units_of_measure(opts)
|
946
|
+
p result
|
947
|
+
rescue SubskribeDevClient::ApiError => e
|
948
|
+
puts "Exception when calling SettingsApi->get_units_of_measure: #{e}"
|
949
|
+
end
|
950
|
+
```
|
951
|
+
|
952
|
+
### Parameters
|
953
|
+
|
954
|
+
Name | Type | Description | Notes
|
955
|
+
------------- | ------------- | ------------- | -------------
|
956
|
+
**cursor** | [**String**](.md)| | [optional]
|
957
|
+
**limit** | **Integer**| | [optional]
|
958
|
+
|
959
|
+
### Return type
|
960
|
+
|
961
|
+
[**UnitOfMeasurePaginationResponseJson**](UnitOfMeasurePaginationResponseJson.md)
|
962
|
+
|
963
|
+
### Authorization
|
964
|
+
|
965
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
966
|
+
|
967
|
+
### HTTP request headers
|
968
|
+
|
969
|
+
- **Content-Type**: Not defined
|
970
|
+
- **Accept**: application/json
|
971
|
+
|
972
|
+
|
973
|
+
|
974
|
+
# **update_payment_term_settings**
|
975
|
+
> update_payment_term_settings(body)
|
976
|
+
|
977
|
+
Update payment term settings
|
978
|
+
|
979
|
+
|
980
|
+
|
981
|
+
### Example
|
982
|
+
```ruby
|
983
|
+
# load the gem
|
984
|
+
require 'subskribe_dev'
|
985
|
+
# setup authorization
|
986
|
+
SubskribeDevClient.configure do |config|
|
987
|
+
# Configure API key authorization: ApiKeyAuth
|
988
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
989
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
990
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
991
|
+
end
|
992
|
+
|
993
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
994
|
+
|
995
|
+
body = SubskribeDevClient::PaymentTermSettingsJson.new # PaymentTermSettingsJson | json representation of the payment term settings
|
996
|
+
|
997
|
+
|
998
|
+
begin
|
999
|
+
#Update payment term settings
|
1000
|
+
api_instance.update_payment_term_settings(body)
|
1001
|
+
rescue SubskribeDevClient::ApiError => e
|
1002
|
+
puts "Exception when calling SettingsApi->update_payment_term_settings: #{e}"
|
1003
|
+
end
|
1004
|
+
```
|
1005
|
+
|
1006
|
+
### Parameters
|
1007
|
+
|
1008
|
+
Name | Type | Description | Notes
|
1009
|
+
------------- | ------------- | ------------- | -------------
|
1010
|
+
**body** | [**PaymentTermSettingsJson**](PaymentTermSettingsJson.md)| json representation of the payment term settings |
|
1011
|
+
|
1012
|
+
### Return type
|
1013
|
+
|
1014
|
+
nil (empty response body)
|
1015
|
+
|
1016
|
+
### Authorization
|
1017
|
+
|
1018
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1019
|
+
|
1020
|
+
### HTTP request headers
|
1021
|
+
|
1022
|
+
- **Content-Type**: Not defined
|
1023
|
+
- **Accept**: application/json
|
1024
|
+
|
1025
|
+
|
1026
|
+
|
1027
|
+
# **update_supported_currencies**
|
1028
|
+
> update_supported_currencies(opts)
|
1029
|
+
|
1030
|
+
Update supported currencies
|
1031
|
+
|
1032
|
+
Update supported currencies for your tenant
|
1033
|
+
|
1034
|
+
### Example
|
1035
|
+
```ruby
|
1036
|
+
# load the gem
|
1037
|
+
require 'subskribe_dev'
|
1038
|
+
# setup authorization
|
1039
|
+
SubskribeDevClient.configure do |config|
|
1040
|
+
# Configure API key authorization: ApiKeyAuth
|
1041
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1042
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1043
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1044
|
+
end
|
1045
|
+
|
1046
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
1047
|
+
|
1048
|
+
opts = {
|
1049
|
+
body: [SubskribeDevClient::Array<String>.new] # Array<String> |
|
1050
|
+
}
|
1051
|
+
|
1052
|
+
begin
|
1053
|
+
#Update supported currencies
|
1054
|
+
api_instance.update_supported_currencies(opts)
|
1055
|
+
rescue SubskribeDevClient::ApiError => e
|
1056
|
+
puts "Exception when calling SettingsApi->update_supported_currencies: #{e}"
|
1057
|
+
end
|
1058
|
+
```
|
1059
|
+
|
1060
|
+
### Parameters
|
1061
|
+
|
1062
|
+
Name | Type | Description | Notes
|
1063
|
+
------------- | ------------- | ------------- | -------------
|
1064
|
+
**body** | **Array<String>**| | [optional]
|
1065
|
+
|
1066
|
+
### Return type
|
1067
|
+
|
1068
|
+
nil (empty response body)
|
1069
|
+
|
1070
|
+
### Authorization
|
1071
|
+
|
1072
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1073
|
+
|
1074
|
+
### HTTP request headers
|
1075
|
+
|
1076
|
+
- **Content-Type**: Not defined
|
1077
|
+
- **Accept**: application/json
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
# **update_tax_rate**
|
1082
|
+
> update_tax_rate(id, opts)
|
1083
|
+
|
1084
|
+
Update tax rate
|
1085
|
+
|
1086
|
+
Updates the specific tax rate object
|
1087
|
+
|
1088
|
+
### Example
|
1089
|
+
```ruby
|
1090
|
+
# load the gem
|
1091
|
+
require 'subskribe_dev'
|
1092
|
+
# setup authorization
|
1093
|
+
SubskribeDevClient.configure do |config|
|
1094
|
+
# Configure API key authorization: ApiKeyAuth
|
1095
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1096
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1097
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1098
|
+
end
|
1099
|
+
|
1100
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
1101
|
+
|
1102
|
+
id = 'id_example' # String |
|
1103
|
+
|
1104
|
+
opts = {
|
1105
|
+
body: SubskribeDevClient::TaxRateJson.new # TaxRateJson |
|
1106
|
+
}
|
1107
|
+
|
1108
|
+
begin
|
1109
|
+
#Update tax rate
|
1110
|
+
api_instance.update_tax_rate(id, opts)
|
1111
|
+
rescue SubskribeDevClient::ApiError => e
|
1112
|
+
puts "Exception when calling SettingsApi->update_tax_rate: #{e}"
|
1113
|
+
end
|
1114
|
+
```
|
1115
|
+
|
1116
|
+
### Parameters
|
1117
|
+
|
1118
|
+
Name | Type | Description | Notes
|
1119
|
+
------------- | ------------- | ------------- | -------------
|
1120
|
+
**id** | [**String**](.md)| |
|
1121
|
+
**body** | [**TaxRateJson**](TaxRateJson.md)| | [optional]
|
1122
|
+
|
1123
|
+
### Return type
|
1124
|
+
|
1125
|
+
nil (empty response body)
|
1126
|
+
|
1127
|
+
### Authorization
|
1128
|
+
|
1129
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1130
|
+
|
1131
|
+
### HTTP request headers
|
1132
|
+
|
1133
|
+
- **Content-Type**: application/json
|
1134
|
+
- **Accept**: application/json
|
1135
|
+
|
1136
|
+
|
1137
|
+
|
1138
|
+
# **update_tenant**
|
1139
|
+
> update_tenant(opts)
|
1140
|
+
|
1141
|
+
Update tenant details
|
1142
|
+
|
1143
|
+
Updates the details of the current tenant based on the input
|
1144
|
+
|
1145
|
+
### Example
|
1146
|
+
```ruby
|
1147
|
+
# load the gem
|
1148
|
+
require 'subskribe_dev'
|
1149
|
+
# setup authorization
|
1150
|
+
SubskribeDevClient.configure do |config|
|
1151
|
+
# Configure API key authorization: ApiKeyAuth
|
1152
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1153
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1154
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1155
|
+
end
|
1156
|
+
|
1157
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
1158
|
+
|
1159
|
+
opts = {
|
1160
|
+
body: SubskribeDevClient::TenantJson.new # TenantJson |
|
1161
|
+
}
|
1162
|
+
|
1163
|
+
begin
|
1164
|
+
#Update tenant details
|
1165
|
+
api_instance.update_tenant(opts)
|
1166
|
+
rescue SubskribeDevClient::ApiError => e
|
1167
|
+
puts "Exception when calling SettingsApi->update_tenant: #{e}"
|
1168
|
+
end
|
1169
|
+
```
|
1170
|
+
|
1171
|
+
### Parameters
|
1172
|
+
|
1173
|
+
Name | Type | Description | Notes
|
1174
|
+
------------- | ------------- | ------------- | -------------
|
1175
|
+
**body** | [**TenantJson**](TenantJson.md)| | [optional]
|
1176
|
+
|
1177
|
+
### Return type
|
1178
|
+
|
1179
|
+
nil (empty response body)
|
1180
|
+
|
1181
|
+
### Authorization
|
1182
|
+
|
1183
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1184
|
+
|
1185
|
+
### HTTP request headers
|
1186
|
+
|
1187
|
+
- **Content-Type**: application/json
|
1188
|
+
- **Accept**: application/json
|
1189
|
+
|
1190
|
+
|
1191
|
+
|
1192
|
+
# **update_tenant_setting**
|
1193
|
+
> update_tenant_setting(body)
|
1194
|
+
|
1195
|
+
Update tenant settings
|
1196
|
+
|
1197
|
+
Updates settings for your tenant.
|
1198
|
+
|
1199
|
+
### Example
|
1200
|
+
```ruby
|
1201
|
+
# load the gem
|
1202
|
+
require 'subskribe_dev'
|
1203
|
+
# setup authorization
|
1204
|
+
SubskribeDevClient.configure do |config|
|
1205
|
+
# Configure API key authorization: ApiKeyAuth
|
1206
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1207
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1208
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1209
|
+
end
|
1210
|
+
|
1211
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
1212
|
+
|
1213
|
+
body = SubskribeDevClient::TenantSettingJson.new # TenantSettingJson | json representation of the settings
|
1214
|
+
|
1215
|
+
|
1216
|
+
begin
|
1217
|
+
#Update tenant settings
|
1218
|
+
api_instance.update_tenant_setting(body)
|
1219
|
+
rescue SubskribeDevClient::ApiError => e
|
1220
|
+
puts "Exception when calling SettingsApi->update_tenant_setting: #{e}"
|
1221
|
+
end
|
1222
|
+
```
|
1223
|
+
|
1224
|
+
### Parameters
|
1225
|
+
|
1226
|
+
Name | Type | Description | Notes
|
1227
|
+
------------- | ------------- | ------------- | -------------
|
1228
|
+
**body** | [**TenantSettingJson**](TenantSettingJson.md)| json representation of the settings |
|
1229
|
+
|
1230
|
+
### Return type
|
1231
|
+
|
1232
|
+
nil (empty response body)
|
1233
|
+
|
1234
|
+
### Authorization
|
1235
|
+
|
1236
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1237
|
+
|
1238
|
+
### HTTP request headers
|
1239
|
+
|
1240
|
+
- **Content-Type**: Not defined
|
1241
|
+
- **Accept**: application/json
|
1242
|
+
|
1243
|
+
|
1244
|
+
|
1245
|
+
# **update_term_section**
|
1246
|
+
> DocumentSection update_term_section(id, opts)
|
1247
|
+
|
1248
|
+
Update predefined terms section
|
1249
|
+
|
1250
|
+
Updates the predefined terms section specified.
|
1251
|
+
|
1252
|
+
### Example
|
1253
|
+
```ruby
|
1254
|
+
# load the gem
|
1255
|
+
require 'subskribe_dev'
|
1256
|
+
# setup authorization
|
1257
|
+
SubskribeDevClient.configure do |config|
|
1258
|
+
# Configure API key authorization: ApiKeyAuth
|
1259
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1260
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1261
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1262
|
+
end
|
1263
|
+
|
1264
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
1265
|
+
|
1266
|
+
id = 'id_example' # String |
|
1267
|
+
|
1268
|
+
opts = {
|
1269
|
+
body: SubskribeDevClient::DocumentSection.new # DocumentSection |
|
1270
|
+
}
|
1271
|
+
|
1272
|
+
begin
|
1273
|
+
#Update predefined terms section
|
1274
|
+
result = api_instance.update_term_section(id, opts)
|
1275
|
+
p result
|
1276
|
+
rescue SubskribeDevClient::ApiError => e
|
1277
|
+
puts "Exception when calling SettingsApi->update_term_section: #{e}"
|
1278
|
+
end
|
1279
|
+
```
|
1280
|
+
|
1281
|
+
### Parameters
|
1282
|
+
|
1283
|
+
Name | Type | Description | Notes
|
1284
|
+
------------- | ------------- | ------------- | -------------
|
1285
|
+
**id** | **String**| |
|
1286
|
+
**body** | [**DocumentSection**](DocumentSection.md)| | [optional]
|
1287
|
+
|
1288
|
+
### Return type
|
1289
|
+
|
1290
|
+
[**DocumentSection**](DocumentSection.md)
|
1291
|
+
|
1292
|
+
### Authorization
|
1293
|
+
|
1294
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1295
|
+
|
1296
|
+
### HTTP request headers
|
1297
|
+
|
1298
|
+
- **Content-Type**: Not defined
|
1299
|
+
- **Accept**: application/json
|
1300
|
+
|
1301
|
+
|
1302
|
+
|
1303
|
+
# **update_unit_of_measure**
|
1304
|
+
> UnitOfMeasureJson update_unit_of_measure(id, opts)
|
1305
|
+
|
1306
|
+
Update unit of measure
|
1307
|
+
|
1308
|
+
Update the unit of measure by Id provided.
|
1309
|
+
|
1310
|
+
### Example
|
1311
|
+
```ruby
|
1312
|
+
# load the gem
|
1313
|
+
require 'subskribe_dev'
|
1314
|
+
# setup authorization
|
1315
|
+
SubskribeDevClient.configure do |config|
|
1316
|
+
# Configure API key authorization: ApiKeyAuth
|
1317
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1318
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1319
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1320
|
+
end
|
1321
|
+
|
1322
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
1323
|
+
|
1324
|
+
id = 'id_example' # String |
|
1325
|
+
|
1326
|
+
opts = {
|
1327
|
+
body: SubskribeDevClient::UnitOfMeasureJson.new # UnitOfMeasureJson |
|
1328
|
+
}
|
1329
|
+
|
1330
|
+
begin
|
1331
|
+
#Update unit of measure
|
1332
|
+
result = api_instance.update_unit_of_measure(id, opts)
|
1333
|
+
p result
|
1334
|
+
rescue SubskribeDevClient::ApiError => e
|
1335
|
+
puts "Exception when calling SettingsApi->update_unit_of_measure: #{e}"
|
1336
|
+
end
|
1337
|
+
```
|
1338
|
+
|
1339
|
+
### Parameters
|
1340
|
+
|
1341
|
+
Name | Type | Description | Notes
|
1342
|
+
------------- | ------------- | ------------- | -------------
|
1343
|
+
**id** | [**String**](.md)| |
|
1344
|
+
**body** | [**UnitOfMeasureJson**](UnitOfMeasureJson.md)| | [optional]
|
1345
|
+
|
1346
|
+
### Return type
|
1347
|
+
|
1348
|
+
[**UnitOfMeasureJson**](UnitOfMeasureJson.md)
|
1349
|
+
|
1350
|
+
### Authorization
|
1351
|
+
|
1352
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1353
|
+
|
1354
|
+
### HTTP request headers
|
1355
|
+
|
1356
|
+
- **Content-Type**: Not defined
|
1357
|
+
- **Accept**: application/json
|
1358
|
+
|
1359
|
+
|
1360
|
+
|
1361
|
+
# **upload_tenant_logo**
|
1362
|
+
> TenantJson upload_tenant_logo(opts)
|
1363
|
+
|
1364
|
+
Update tenant logo
|
1365
|
+
|
1366
|
+
Updates the logo used in external facing communication such as order forms and invoices
|
1367
|
+
|
1368
|
+
### Example
|
1369
|
+
```ruby
|
1370
|
+
# load the gem
|
1371
|
+
require 'subskribe_dev'
|
1372
|
+
# setup authorization
|
1373
|
+
SubskribeDevClient.configure do |config|
|
1374
|
+
# Configure API key authorization: ApiKeyAuth
|
1375
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1376
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1377
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1378
|
+
end
|
1379
|
+
|
1380
|
+
api_instance = SubskribeDevClient::SettingsApi.new
|
1381
|
+
|
1382
|
+
opts = {
|
1383
|
+
file: File.new('/path/to/file.txt') # File |
|
1384
|
+
}
|
1385
|
+
|
1386
|
+
begin
|
1387
|
+
#Update tenant logo
|
1388
|
+
result = api_instance.upload_tenant_logo(opts)
|
1389
|
+
p result
|
1390
|
+
rescue SubskribeDevClient::ApiError => e
|
1391
|
+
puts "Exception when calling SettingsApi->upload_tenant_logo: #{e}"
|
1392
|
+
end
|
1393
|
+
```
|
1394
|
+
|
1395
|
+
### Parameters
|
1396
|
+
|
1397
|
+
Name | Type | Description | Notes
|
1398
|
+
------------- | ------------- | ------------- | -------------
|
1399
|
+
**file** | **File**| | [optional]
|
1400
|
+
|
1401
|
+
### Return type
|
1402
|
+
|
1403
|
+
[**TenantJson**](TenantJson.md)
|
1404
|
+
|
1405
|
+
### Authorization
|
1406
|
+
|
1407
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1408
|
+
|
1409
|
+
### HTTP request headers
|
1410
|
+
|
1411
|
+
- **Content-Type**: multipart/form-data
|
1412
|
+
- **Accept**: application/json
|
1413
|
+
|
1414
|
+
|
1415
|
+
|