subskribe_dev 1.1.0 → 1.3.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/README.md +505 -10
- 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 +561 -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 +35 -0
- data/docs/OrderLineItemRequestJson.md +25 -0
- data/docs/OrderRequestJson.md +46 -0
- data/docs/OrderTerms.md +13 -0
- data/docs/OrdersApi.md +1429 -0
- data/docs/PaginatedAccountsResponse.md +10 -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/PlanMetadataJson.md +8 -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 +1924 -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 +1102 -31
- 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/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/subskribe_dev/api/discounts_api.rb +340 -0
- data/lib/subskribe_dev/api/entities_api.rb +532 -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 +1886 -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 +1027 -39
- 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/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 +474 -0
- data/lib/subskribe_dev/models/order_line_item_request_json.rb +384 -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_accounts_response.rb +204 -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/plan_metadata_json.rb +187 -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/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/subskribe_dev/version.rb +1 -1
- data/lib/subskribe_dev.rb +188 -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/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/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_accounts_response_spec.rb +53 -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/plan_metadata_json_spec.rb +41 -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/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/subskribe_dev.gemspec +4 -4
- metadata +784 -28
@@ -0,0 +1,223 @@
|
|
1
|
+
=begin
|
2
|
+
#Subskribe API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.41
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module SubskribeDevClient
|
16
|
+
class MetricsReportingApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# submit request to generate external arr metrics
|
23
|
+
# returns the request with its captured id. Arr metrics will be generated as a backend job
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [ExternalArrScheduleJson] :body
|
26
|
+
# @return [nil]
|
27
|
+
def add_external_arr_metrics(opts = {})
|
28
|
+
add_external_arr_metrics_with_http_info(opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# submit request to generate external arr metrics
|
33
|
+
# returns the request with its captured id. Arr metrics will be generated as a backend job
|
34
|
+
# @param [Hash] opts the optional parameters
|
35
|
+
# @option opts [ExternalArrScheduleJson] :body
|
36
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
37
|
+
def add_external_arr_metrics_with_http_info(opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: MetricsReportingApi.add_external_arr_metrics ...'
|
40
|
+
end
|
41
|
+
# resource path
|
42
|
+
local_var_path = '/metricsReporting/externalArrMetrics'
|
43
|
+
|
44
|
+
# query parameters
|
45
|
+
query_params = {}
|
46
|
+
|
47
|
+
# header parameters
|
48
|
+
header_params = {}
|
49
|
+
# HTTP header 'Accept' (if needed)
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
51
|
+
|
52
|
+
# form parameters
|
53
|
+
form_params = {}
|
54
|
+
|
55
|
+
# http body (model)
|
56
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
57
|
+
auth_names = ['ApiKeyAuth']
|
58
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
59
|
+
:header_params => header_params,
|
60
|
+
:query_params => query_params,
|
61
|
+
:form_params => form_params,
|
62
|
+
:body => post_body,
|
63
|
+
:auth_names => auth_names)
|
64
|
+
if @api_client.config.debugging
|
65
|
+
@api_client.config.logger.debug "API called: MetricsReportingApi#add_external_arr_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
66
|
+
end
|
67
|
+
return data, status_code, headers
|
68
|
+
end
|
69
|
+
# gets external arr metrics request for the provided id
|
70
|
+
# returns the external arr metrics request for the provided id
|
71
|
+
# @param id id of the externalArrMetrics request
|
72
|
+
# @param [Hash] opts the optional parameters
|
73
|
+
# @return [nil]
|
74
|
+
def get_external_arr_metrics(id, opts = {})
|
75
|
+
get_external_arr_metrics_with_http_info(id, opts)
|
76
|
+
nil
|
77
|
+
end
|
78
|
+
|
79
|
+
# gets external arr metrics request for the provided id
|
80
|
+
# returns the external arr metrics request for the provided id
|
81
|
+
# @param id id of the externalArrMetrics request
|
82
|
+
# @param [Hash] opts the optional parameters
|
83
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
84
|
+
def get_external_arr_metrics_with_http_info(id, opts = {})
|
85
|
+
if @api_client.config.debugging
|
86
|
+
@api_client.config.logger.debug 'Calling API: MetricsReportingApi.get_external_arr_metrics ...'
|
87
|
+
end
|
88
|
+
# verify the required parameter 'id' is set
|
89
|
+
if @api_client.config.client_side_validation && id.nil?
|
90
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling MetricsReportingApi.get_external_arr_metrics"
|
91
|
+
end
|
92
|
+
# resource path
|
93
|
+
local_var_path = '/metricsReporting/externalArrMetrics/{id}'.sub('{' + 'id' + '}', id.to_s)
|
94
|
+
|
95
|
+
# query parameters
|
96
|
+
query_params = {}
|
97
|
+
|
98
|
+
# header parameters
|
99
|
+
header_params = {}
|
100
|
+
# HTTP header 'Accept' (if needed)
|
101
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
102
|
+
|
103
|
+
# form parameters
|
104
|
+
form_params = {}
|
105
|
+
|
106
|
+
# http body (model)
|
107
|
+
post_body = nil
|
108
|
+
auth_names = ['ApiKeyAuth']
|
109
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
110
|
+
:header_params => header_params,
|
111
|
+
:query_params => query_params,
|
112
|
+
:form_params => form_params,
|
113
|
+
:body => post_body,
|
114
|
+
:auth_names => auth_names)
|
115
|
+
if @api_client.config.debugging
|
116
|
+
@api_client.config.logger.debug "API called: MetricsReportingApi#get_external_arr_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
117
|
+
end
|
118
|
+
return data, status_code, headers
|
119
|
+
end
|
120
|
+
# gets external arr metrics requests submitted
|
121
|
+
# returns the paginated list of external arr metrics requests
|
122
|
+
# @param [Hash] opts the optional parameters
|
123
|
+
# @option opts [String] :cursor
|
124
|
+
# @option opts [Integer] :limit
|
125
|
+
# @return [nil]
|
126
|
+
def get_external_arr_metrics1(opts = {})
|
127
|
+
get_external_arr_metrics1_with_http_info(opts)
|
128
|
+
nil
|
129
|
+
end
|
130
|
+
|
131
|
+
# gets external arr metrics requests submitted
|
132
|
+
# returns the paginated list of external arr metrics requests
|
133
|
+
# @param [Hash] opts the optional parameters
|
134
|
+
# @option opts [String] :cursor
|
135
|
+
# @option opts [Integer] :limit
|
136
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
137
|
+
def get_external_arr_metrics1_with_http_info(opts = {})
|
138
|
+
if @api_client.config.debugging
|
139
|
+
@api_client.config.logger.debug 'Calling API: MetricsReportingApi.get_external_arr_metrics1 ...'
|
140
|
+
end
|
141
|
+
# resource path
|
142
|
+
local_var_path = '/metricsReporting/externalArrMetrics'
|
143
|
+
|
144
|
+
# query parameters
|
145
|
+
query_params = {}
|
146
|
+
query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
|
147
|
+
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
148
|
+
|
149
|
+
# header parameters
|
150
|
+
header_params = {}
|
151
|
+
# HTTP header 'Accept' (if needed)
|
152
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
153
|
+
|
154
|
+
# form parameters
|
155
|
+
form_params = {}
|
156
|
+
|
157
|
+
# http body (model)
|
158
|
+
post_body = nil
|
159
|
+
auth_names = ['ApiKeyAuth']
|
160
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
161
|
+
:header_params => header_params,
|
162
|
+
:query_params => query_params,
|
163
|
+
:form_params => form_params,
|
164
|
+
:body => post_body,
|
165
|
+
:auth_names => auth_names)
|
166
|
+
if @api_client.config.debugging
|
167
|
+
@api_client.config.logger.debug "API called: MetricsReportingApi#get_external_arr_metrics1\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
168
|
+
end
|
169
|
+
return data, status_code, headers
|
170
|
+
end
|
171
|
+
# submit request to generate/regenerate arr metrics for a subscription
|
172
|
+
# returns 200 if the result is successfully submitted to a background task
|
173
|
+
# @param subscription_id id of the subscription
|
174
|
+
# @param [Hash] opts the optional parameters
|
175
|
+
# @return [nil]
|
176
|
+
def populate_arr_metrics_for_subscription(subscription_id, opts = {})
|
177
|
+
populate_arr_metrics_for_subscription_with_http_info(subscription_id, opts)
|
178
|
+
nil
|
179
|
+
end
|
180
|
+
|
181
|
+
# submit request to generate/regenerate arr metrics for a subscription
|
182
|
+
# returns 200 if the result is successfully submitted to a background task
|
183
|
+
# @param subscription_id id of the subscription
|
184
|
+
# @param [Hash] opts the optional parameters
|
185
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
186
|
+
def populate_arr_metrics_for_subscription_with_http_info(subscription_id, opts = {})
|
187
|
+
if @api_client.config.debugging
|
188
|
+
@api_client.config.logger.debug 'Calling API: MetricsReportingApi.populate_arr_metrics_for_subscription ...'
|
189
|
+
end
|
190
|
+
# verify the required parameter 'subscription_id' is set
|
191
|
+
if @api_client.config.client_side_validation && subscription_id.nil?
|
192
|
+
fail ArgumentError, "Missing the required parameter 'subscription_id' when calling MetricsReportingApi.populate_arr_metrics_for_subscription"
|
193
|
+
end
|
194
|
+
# resource path
|
195
|
+
local_var_path = '/metricsReporting/populateArrMetrics/subscriptions/{subscriptionId}'.sub('{' + 'subscriptionId' + '}', subscription_id.to_s)
|
196
|
+
|
197
|
+
# query parameters
|
198
|
+
query_params = {}
|
199
|
+
|
200
|
+
# header parameters
|
201
|
+
header_params = {}
|
202
|
+
# HTTP header 'Accept' (if needed)
|
203
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
204
|
+
|
205
|
+
# form parameters
|
206
|
+
form_params = {}
|
207
|
+
|
208
|
+
# http body (model)
|
209
|
+
post_body = nil
|
210
|
+
auth_names = ['ApiKeyAuth']
|
211
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
212
|
+
:header_params => header_params,
|
213
|
+
:query_params => query_params,
|
214
|
+
:form_params => form_params,
|
215
|
+
:body => post_body,
|
216
|
+
:auth_names => auth_names)
|
217
|
+
if @api_client.config.debugging
|
218
|
+
@api_client.config.logger.debug "API called: MetricsReportingApi#populate_arr_metrics_for_subscription\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
219
|
+
end
|
220
|
+
return data, status_code, headers
|
221
|
+
end
|
222
|
+
end
|
223
|
+
end
|
@@ -0,0 +1,245 @@
|
|
1
|
+
=begin
|
2
|
+
#Subskribe API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.41
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module SubskribeDevClient
|
16
|
+
class NotificationsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Add a notification target
|
23
|
+
# Adds a notification target and events according to the specified parameters
|
24
|
+
# @param body json representing the notification details
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @return [NotificationTargetAndSubscriptions]
|
27
|
+
def add_target_and_events_subscriptions(body, opts = {})
|
28
|
+
data, _status_code, _headers = add_target_and_events_subscriptions_with_http_info(body, opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Add a notification target
|
33
|
+
# Adds a notification target and events according to the specified parameters
|
34
|
+
# @param body json representing the notification details
|
35
|
+
# @param [Hash] opts the optional parameters
|
36
|
+
# @return [Array<(NotificationTargetAndSubscriptions, Fixnum, Hash)>] NotificationTargetAndSubscriptions data, response status code and response headers
|
37
|
+
def add_target_and_events_subscriptions_with_http_info(body, opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: NotificationsApi.add_target_and_events_subscriptions ...'
|
40
|
+
end
|
41
|
+
# verify the required parameter 'body' is set
|
42
|
+
if @api_client.config.client_side_validation && body.nil?
|
43
|
+
fail ArgumentError, "Missing the required parameter 'body' when calling NotificationsApi.add_target_and_events_subscriptions"
|
44
|
+
end
|
45
|
+
# resource path
|
46
|
+
local_var_path = '/notifications'
|
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 = @api_client.object_to_http_body(body)
|
61
|
+
auth_names = ['ApiKeyAuth']
|
62
|
+
data, status_code, headers = @api_client.call_api(:POST, 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 => 'NotificationTargetAndSubscriptions')
|
69
|
+
if @api_client.config.debugging
|
70
|
+
@api_client.config.logger.debug "API called: NotificationsApi#add_target_and_events_subscriptions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
71
|
+
end
|
72
|
+
return data, status_code, headers
|
73
|
+
end
|
74
|
+
# Get all notifications
|
75
|
+
# Returns all notification subscriptions for your tenant
|
76
|
+
# @param [Hash] opts the optional parameters
|
77
|
+
# @return [Array<NotificationTargetAndSubscriptions>]
|
78
|
+
def get_all_notification_subscriptions_for_tenant(opts = {})
|
79
|
+
data, _status_code, _headers = get_all_notification_subscriptions_for_tenant_with_http_info(opts)
|
80
|
+
data
|
81
|
+
end
|
82
|
+
|
83
|
+
# Get all notifications
|
84
|
+
# Returns all notification subscriptions for your tenant
|
85
|
+
# @param [Hash] opts the optional parameters
|
86
|
+
# @return [Array<(Array<NotificationTargetAndSubscriptions>, Fixnum, Hash)>] Array<NotificationTargetAndSubscriptions> data, response status code and response headers
|
87
|
+
def get_all_notification_subscriptions_for_tenant_with_http_info(opts = {})
|
88
|
+
if @api_client.config.debugging
|
89
|
+
@api_client.config.logger.debug 'Calling API: NotificationsApi.get_all_notification_subscriptions_for_tenant ...'
|
90
|
+
end
|
91
|
+
# resource path
|
92
|
+
local_var_path = '/notifications'
|
93
|
+
|
94
|
+
# query parameters
|
95
|
+
query_params = {}
|
96
|
+
|
97
|
+
# header parameters
|
98
|
+
header_params = {}
|
99
|
+
# HTTP header 'Accept' (if needed)
|
100
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
101
|
+
|
102
|
+
# form parameters
|
103
|
+
form_params = {}
|
104
|
+
|
105
|
+
# http body (model)
|
106
|
+
post_body = nil
|
107
|
+
auth_names = ['ApiKeyAuth']
|
108
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
109
|
+
:header_params => header_params,
|
110
|
+
:query_params => query_params,
|
111
|
+
:form_params => form_params,
|
112
|
+
:body => post_body,
|
113
|
+
:auth_names => auth_names,
|
114
|
+
:return_type => 'Array<NotificationTargetAndSubscriptions>')
|
115
|
+
if @api_client.config.debugging
|
116
|
+
@api_client.config.logger.debug "API called: NotificationsApi#get_all_notification_subscriptions_for_tenant\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
117
|
+
end
|
118
|
+
return data, status_code, headers
|
119
|
+
end
|
120
|
+
# Attach an event to a notification
|
121
|
+
# Attaches a notification event to the target specified by the notification id
|
122
|
+
# @param notification_id id of the notification target
|
123
|
+
# @param notification_event_type type of event
|
124
|
+
# @param [Hash] opts the optional parameters
|
125
|
+
# @return [nil]
|
126
|
+
def subscribe_existing_notification_target_to_event(notification_id, notification_event_type, opts = {})
|
127
|
+
subscribe_existing_notification_target_to_event_with_http_info(notification_id, notification_event_type, opts)
|
128
|
+
nil
|
129
|
+
end
|
130
|
+
|
131
|
+
# Attach an event to a notification
|
132
|
+
# Attaches a notification event to the target specified by the notification id
|
133
|
+
# @param notification_id id of the notification target
|
134
|
+
# @param notification_event_type type of event
|
135
|
+
# @param [Hash] opts the optional parameters
|
136
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
137
|
+
def subscribe_existing_notification_target_to_event_with_http_info(notification_id, notification_event_type, opts = {})
|
138
|
+
if @api_client.config.debugging
|
139
|
+
@api_client.config.logger.debug 'Calling API: NotificationsApi.subscribe_existing_notification_target_to_event ...'
|
140
|
+
end
|
141
|
+
# verify the required parameter 'notification_id' is set
|
142
|
+
if @api_client.config.client_side_validation && notification_id.nil?
|
143
|
+
fail ArgumentError, "Missing the required parameter 'notification_id' when calling NotificationsApi.subscribe_existing_notification_target_to_event"
|
144
|
+
end
|
145
|
+
# verify the required parameter 'notification_event_type' is set
|
146
|
+
if @api_client.config.client_side_validation && notification_event_type.nil?
|
147
|
+
fail ArgumentError, "Missing the required parameter 'notification_event_type' when calling NotificationsApi.subscribe_existing_notification_target_to_event"
|
148
|
+
end
|
149
|
+
# verify enum value
|
150
|
+
if @api_client.config.client_side_validation && !['INVOICE_POSTED', 'SUBSCRIPTION_CREATED', 'ORDER_SUBMITTED', 'ORDER_EXECUTED'].include?(notification_event_type)
|
151
|
+
fail ArgumentError, "invalid value for 'notification_event_type', must be one of INVOICE_POSTED, SUBSCRIPTION_CREATED, ORDER_SUBMITTED, ORDER_EXECUTED"
|
152
|
+
end
|
153
|
+
# resource path
|
154
|
+
local_var_path = '/notifications/{notificationId}'.sub('{' + 'notificationId' + '}', notification_id.to_s)
|
155
|
+
|
156
|
+
# query parameters
|
157
|
+
query_params = {}
|
158
|
+
query_params[:'notificationEventType'] = notification_event_type
|
159
|
+
|
160
|
+
# header parameters
|
161
|
+
header_params = {}
|
162
|
+
# HTTP header 'Accept' (if needed)
|
163
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
164
|
+
|
165
|
+
# form parameters
|
166
|
+
form_params = {}
|
167
|
+
|
168
|
+
# http body (model)
|
169
|
+
post_body = nil
|
170
|
+
auth_names = ['ApiKeyAuth']
|
171
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
172
|
+
:header_params => header_params,
|
173
|
+
:query_params => query_params,
|
174
|
+
:form_params => form_params,
|
175
|
+
:body => post_body,
|
176
|
+
:auth_names => auth_names)
|
177
|
+
if @api_client.config.debugging
|
178
|
+
@api_client.config.logger.debug "API called: NotificationsApi#subscribe_existing_notification_target_to_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
179
|
+
end
|
180
|
+
return data, status_code, headers
|
181
|
+
end
|
182
|
+
# Unsubscribe from an event
|
183
|
+
# Unsubscribes the specified notification target from the specified event
|
184
|
+
# @param notification_id id of the notification target
|
185
|
+
# @param notification_event_type type of event
|
186
|
+
# @param [Hash] opts the optional parameters
|
187
|
+
# @return [nil]
|
188
|
+
def unsubscribe_target_or_event(notification_id, notification_event_type, opts = {})
|
189
|
+
unsubscribe_target_or_event_with_http_info(notification_id, notification_event_type, opts)
|
190
|
+
nil
|
191
|
+
end
|
192
|
+
|
193
|
+
# Unsubscribe from an event
|
194
|
+
# Unsubscribes the specified notification target from the specified event
|
195
|
+
# @param notification_id id of the notification target
|
196
|
+
# @param notification_event_type type of event
|
197
|
+
# @param [Hash] opts the optional parameters
|
198
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
199
|
+
def unsubscribe_target_or_event_with_http_info(notification_id, notification_event_type, opts = {})
|
200
|
+
if @api_client.config.debugging
|
201
|
+
@api_client.config.logger.debug 'Calling API: NotificationsApi.unsubscribe_target_or_event ...'
|
202
|
+
end
|
203
|
+
# verify the required parameter 'notification_id' is set
|
204
|
+
if @api_client.config.client_side_validation && notification_id.nil?
|
205
|
+
fail ArgumentError, "Missing the required parameter 'notification_id' when calling NotificationsApi.unsubscribe_target_or_event"
|
206
|
+
end
|
207
|
+
# verify the required parameter 'notification_event_type' is set
|
208
|
+
if @api_client.config.client_side_validation && notification_event_type.nil?
|
209
|
+
fail ArgumentError, "Missing the required parameter 'notification_event_type' when calling NotificationsApi.unsubscribe_target_or_event"
|
210
|
+
end
|
211
|
+
# verify enum value
|
212
|
+
if @api_client.config.client_side_validation && !['INVOICE_POSTED', 'SUBSCRIPTION_CREATED', 'ORDER_SUBMITTED', 'ORDER_EXECUTED'].include?(notification_event_type)
|
213
|
+
fail ArgumentError, "invalid value for 'notification_event_type', must be one of INVOICE_POSTED, SUBSCRIPTION_CREATED, ORDER_SUBMITTED, ORDER_EXECUTED"
|
214
|
+
end
|
215
|
+
# resource path
|
216
|
+
local_var_path = '/notifications/unsubscribe/{notificationId}'.sub('{' + 'notificationId' + '}', notification_id.to_s)
|
217
|
+
|
218
|
+
# query parameters
|
219
|
+
query_params = {}
|
220
|
+
query_params[:'notificationEventType'] = notification_event_type
|
221
|
+
|
222
|
+
# header parameters
|
223
|
+
header_params = {}
|
224
|
+
# HTTP header 'Accept' (if needed)
|
225
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
226
|
+
|
227
|
+
# form parameters
|
228
|
+
form_params = {}
|
229
|
+
|
230
|
+
# http body (model)
|
231
|
+
post_body = nil
|
232
|
+
auth_names = ['ApiKeyAuth']
|
233
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
234
|
+
:header_params => header_params,
|
235
|
+
:query_params => query_params,
|
236
|
+
:form_params => form_params,
|
237
|
+
:body => post_body,
|
238
|
+
:auth_names => auth_names)
|
239
|
+
if @api_client.config.debugging
|
240
|
+
@api_client.config.logger.debug "API called: NotificationsApi#unsubscribe_target_or_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
241
|
+
end
|
242
|
+
return data, status_code, headers
|
243
|
+
end
|
244
|
+
end
|
245
|
+
end
|
@@ -0,0 +1,177 @@
|
|
1
|
+
=begin
|
2
|
+
#Subskribe API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.41
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module SubskribeDevClient
|
16
|
+
class OpportunityApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Creates a standalone opportunity
|
23
|
+
# Returns the details of a specified opportunity
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [OpportunityRestJson] :body
|
26
|
+
# @return [OpportunityJson]
|
27
|
+
def create_opportunity(opts = {})
|
28
|
+
data, _status_code, _headers = create_opportunity_with_http_info(opts)
|
29
|
+
data
|
30
|
+
end
|
31
|
+
|
32
|
+
# Creates a standalone opportunity
|
33
|
+
# Returns the details of a specified opportunity
|
34
|
+
# @param [Hash] opts the optional parameters
|
35
|
+
# @option opts [OpportunityRestJson] :body
|
36
|
+
# @return [Array<(OpportunityJson, Fixnum, Hash)>] OpportunityJson data, response status code and response headers
|
37
|
+
def create_opportunity_with_http_info(opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: OpportunityApi.create_opportunity ...'
|
40
|
+
end
|
41
|
+
# resource path
|
42
|
+
local_var_path = '/opportunity'
|
43
|
+
|
44
|
+
# query parameters
|
45
|
+
query_params = {}
|
46
|
+
|
47
|
+
# header parameters
|
48
|
+
header_params = {}
|
49
|
+
# HTTP header 'Accept' (if needed)
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
51
|
+
|
52
|
+
# form parameters
|
53
|
+
form_params = {}
|
54
|
+
|
55
|
+
# http body (model)
|
56
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
57
|
+
auth_names = ['ApiKeyAuth']
|
58
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
59
|
+
:header_params => header_params,
|
60
|
+
:query_params => query_params,
|
61
|
+
:form_params => form_params,
|
62
|
+
:body => post_body,
|
63
|
+
:auth_names => auth_names,
|
64
|
+
:return_type => 'OpportunityJson')
|
65
|
+
if @api_client.config.debugging
|
66
|
+
@api_client.config.logger.debug "API called: OpportunityApi#create_opportunity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
67
|
+
end
|
68
|
+
return data, status_code, headers
|
69
|
+
end
|
70
|
+
# Opens an opportunity
|
71
|
+
# Returns the details of the updated opportunity
|
72
|
+
# @param id crm id or native id of the opportunity
|
73
|
+
# @param [Hash] opts the optional parameters
|
74
|
+
# @return [OpportunityJson]
|
75
|
+
def reset_opportunity_closed_state(id, opts = {})
|
76
|
+
data, _status_code, _headers = reset_opportunity_closed_state_with_http_info(id, opts)
|
77
|
+
data
|
78
|
+
end
|
79
|
+
|
80
|
+
# Opens an opportunity
|
81
|
+
# Returns the details of the updated opportunity
|
82
|
+
# @param id crm id or native id of the opportunity
|
83
|
+
# @param [Hash] opts the optional parameters
|
84
|
+
# @return [Array<(OpportunityJson, Fixnum, Hash)>] OpportunityJson data, response status code and response headers
|
85
|
+
def reset_opportunity_closed_state_with_http_info(id, opts = {})
|
86
|
+
if @api_client.config.debugging
|
87
|
+
@api_client.config.logger.debug 'Calling API: OpportunityApi.reset_opportunity_closed_state ...'
|
88
|
+
end
|
89
|
+
# verify the required parameter 'id' is set
|
90
|
+
if @api_client.config.client_side_validation && id.nil?
|
91
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OpportunityApi.reset_opportunity_closed_state"
|
92
|
+
end
|
93
|
+
# resource path
|
94
|
+
local_var_path = '/opportunity/{id}/open'.sub('{' + 'id' + '}', id.to_s)
|
95
|
+
|
96
|
+
# query parameters
|
97
|
+
query_params = {}
|
98
|
+
|
99
|
+
# header parameters
|
100
|
+
header_params = {}
|
101
|
+
# HTTP header 'Accept' (if needed)
|
102
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
103
|
+
|
104
|
+
# form parameters
|
105
|
+
form_params = {}
|
106
|
+
|
107
|
+
# http body (model)
|
108
|
+
post_body = nil
|
109
|
+
auth_names = ['ApiKeyAuth']
|
110
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
111
|
+
:header_params => header_params,
|
112
|
+
:query_params => query_params,
|
113
|
+
:form_params => form_params,
|
114
|
+
:body => post_body,
|
115
|
+
:auth_names => auth_names,
|
116
|
+
:return_type => 'OpportunityJson')
|
117
|
+
if @api_client.config.debugging
|
118
|
+
@api_client.config.logger.debug "API called: OpportunityApi#reset_opportunity_closed_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
119
|
+
end
|
120
|
+
return data, status_code, headers
|
121
|
+
end
|
122
|
+
# Updates a standalone opportunity
|
123
|
+
# Returns the details of the updated opportunity
|
124
|
+
# @param id id of the opportunity
|
125
|
+
# @param [Hash] opts the optional parameters
|
126
|
+
# @option opts [OpportunityRestJson] :body
|
127
|
+
# @return [OpportunityJson]
|
128
|
+
def update_opportunity(id, opts = {})
|
129
|
+
data, _status_code, _headers = update_opportunity_with_http_info(id, opts)
|
130
|
+
data
|
131
|
+
end
|
132
|
+
|
133
|
+
# Updates a standalone opportunity
|
134
|
+
# Returns the details of the updated opportunity
|
135
|
+
# @param id id of the opportunity
|
136
|
+
# @param [Hash] opts the optional parameters
|
137
|
+
# @option opts [OpportunityRestJson] :body
|
138
|
+
# @return [Array<(OpportunityJson, Fixnum, Hash)>] OpportunityJson data, response status code and response headers
|
139
|
+
def update_opportunity_with_http_info(id, opts = {})
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug 'Calling API: OpportunityApi.update_opportunity ...'
|
142
|
+
end
|
143
|
+
# verify the required parameter 'id' is set
|
144
|
+
if @api_client.config.client_side_validation && id.nil?
|
145
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling OpportunityApi.update_opportunity"
|
146
|
+
end
|
147
|
+
# resource path
|
148
|
+
local_var_path = '/opportunity/{id}'.sub('{' + 'id' + '}', id.to_s)
|
149
|
+
|
150
|
+
# query parameters
|
151
|
+
query_params = {}
|
152
|
+
|
153
|
+
# header parameters
|
154
|
+
header_params = {}
|
155
|
+
# HTTP header 'Accept' (if needed)
|
156
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
157
|
+
|
158
|
+
# form parameters
|
159
|
+
form_params = {}
|
160
|
+
|
161
|
+
# http body (model)
|
162
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
163
|
+
auth_names = ['ApiKeyAuth']
|
164
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
165
|
+
:header_params => header_params,
|
166
|
+
:query_params => query_params,
|
167
|
+
:form_params => form_params,
|
168
|
+
:body => post_body,
|
169
|
+
:auth_names => auth_names,
|
170
|
+
:return_type => 'OpportunityJson')
|
171
|
+
if @api_client.config.debugging
|
172
|
+
@api_client.config.logger.debug "API called: OpportunityApi#update_opportunity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
173
|
+
end
|
174
|
+
return data, status_code, headers
|
175
|
+
end
|
176
|
+
end
|
177
|
+
end
|