subskribe_sandbox 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +601 -0
- data/Rakefile +8 -0
- 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/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 +1415 -0
- 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 +11 -0
- data/docs/UnitOfMeasurePaginationResponseJson.md +10 -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/git_push.sh +55 -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 +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/subskribe_dev/api_client.rb +391 -0
- data/lib/subskribe_dev/api_error.rb +38 -0
- data/lib/subskribe_dev/configuration.rb +209 -0
- 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/subskribe_dev/models/unit_of_measure_json.rb +250 -0
- data/lib/subskribe_dev/models/unit_of_measure_pagination_response_json.rb +204 -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 +15 -0
- data/lib/subskribe_dev.rb +229 -0
- data/lib/subskribe_sandbox/api/accounting_api.rb +193 -0
- data/lib/subskribe_sandbox/api/accounts_api.rb +858 -0
- data/lib/subskribe_sandbox/api/approvals_api.rb +965 -0
- data/lib/subskribe_sandbox/api/attachments_api.rb +299 -0
- data/lib/subskribe_sandbox/api/authentication_api.rb +335 -0
- data/lib/subskribe_sandbox/api/billing_api.rb +2098 -0
- data/lib/subskribe_sandbox/api/credit_memo_api.rb +636 -0
- data/lib/subskribe_sandbox/api/custom_field_api.rb +434 -0
- data/lib/subskribe_sandbox/api/customization_api.rb +269 -0
- data/lib/subskribe_sandbox/api/default_api.rb +223 -0
- data/lib/subskribe_sandbox/api/discounts_api.rb +340 -0
- data/lib/subskribe_sandbox/api/entities_api.rb +532 -0
- data/lib/subskribe_sandbox/api/erp_api.rb +278 -0
- data/lib/subskribe_sandbox/api/import_api.rb +568 -0
- data/lib/subskribe_sandbox/api/integrations_api.rb +1678 -0
- data/lib/subskribe_sandbox/api/metrics_reporting_api.rb +223 -0
- data/lib/subskribe_sandbox/api/notifications_api.rb +245 -0
- data/lib/subskribe_sandbox/api/opportunity_api.rb +177 -0
- data/lib/subskribe_sandbox/api/orders_api.rb +1381 -0
- data/lib/subskribe_sandbox/api/payments_api.rb +431 -0
- data/lib/subskribe_sandbox/api/product_catalog_api.rb +1886 -0
- data/lib/subskribe_sandbox/api/rate_card_api.rb +68 -0
- data/lib/subskribe_sandbox/api/refunds_api.rb +189 -0
- data/lib/subskribe_sandbox/api/reports_api.rb +227 -0
- data/lib/subskribe_sandbox/api/revenue_recognition_api.rb +484 -0
- data/lib/subskribe_sandbox/api/sales_room_api.rb +74 -0
- data/lib/subskribe_sandbox/api/settings_api.rb +1321 -0
- data/lib/subskribe_sandbox/api/subscriptions_api.rb +576 -0
- data/lib/subskribe_sandbox/api/usage_api.rb +604 -0
- data/lib/subskribe_sandbox/api/users_api.rb +728 -0
- data/lib/subskribe_sandbox/api_client.rb +391 -0
- data/lib/subskribe_sandbox/api_error.rb +38 -0
- data/lib/subskribe_sandbox/configuration.rb +209 -0
- data/lib/subskribe_sandbox/models/account_address.rb +265 -0
- data/lib/subskribe_sandbox/models/account_address_json.rb +229 -0
- data/lib/subskribe_sandbox/models/account_contact.rb +530 -0
- data/lib/subskribe_sandbox/models/account_contact_json.rb +274 -0
- data/lib/subskribe_sandbox/models/account_json.rb +395 -0
- data/lib/subskribe_sandbox/models/account_payment_method_json.rb +268 -0
- data/lib/subskribe_sandbox/models/account_receivable_contact_json.rb +225 -0
- data/lib/subskribe_sandbox/models/accounting_event.rb +319 -0
- data/lib/subskribe_sandbox/models/accounting_event_paginated_response.rb +204 -0
- data/lib/subskribe_sandbox/models/accounting_period.rb +356 -0
- data/lib/subskribe_sandbox/models/accounting_period_calculation.rb +229 -0
- data/lib/subskribe_sandbox/models/add_and_apply_payment_application_json.rb +344 -0
- data/lib/subskribe_sandbox/models/anrok_integration_input.rb +184 -0
- data/lib/subskribe_sandbox/models/approval_matrix_import_data_json.rb +229 -0
- data/lib/subskribe_sandbox/models/approval_matrix_import_preview.rb +226 -0
- data/lib/subskribe_sandbox/models/approval_role_json.rb +220 -0
- data/lib/subskribe_sandbox/models/approval_role_segment_change.rb +211 -0
- data/lib/subskribe_sandbox/models/approval_segment_json.rb +220 -0
- data/lib/subskribe_sandbox/models/attachment.rb +326 -0
- data/lib/subskribe_sandbox/models/attribute_reference.rb +193 -0
- data/lib/subskribe_sandbox/models/auth_saml_integration_json.rb +204 -0
- data/lib/subskribe_sandbox/models/automated_invoice_rule.rb +328 -0
- data/lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb +307 -0
- data/lib/subskribe_sandbox/models/avalara_integration.rb +238 -0
- data/lib/subskribe_sandbox/models/avalara_integration_input.rb +268 -0
- data/lib/subskribe_sandbox/models/billing_event_entry.rb +211 -0
- data/lib/subskribe_sandbox/models/billing_event_input.rb +216 -0
- data/lib/subskribe_sandbox/models/bulk_invoice_run.rb +350 -0
- data/lib/subskribe_sandbox/models/bulk_invoice_run_exclusions.rb +197 -0
- data/lib/subskribe_sandbox/models/bulk_invoice_run_input.rb +263 -0
- data/lib/subskribe_sandbox/models/bulk_invoice_run_item.rb +364 -0
- data/lib/subskribe_sandbox/models/bulk_invoice_run_selector.rb +184 -0
- data/lib/subskribe_sandbox/models/bulk_payment_upload_data.rb +274 -0
- data/lib/subskribe_sandbox/models/bulk_payment_upload_result.rb +204 -0
- data/lib/subskribe_sandbox/models/byte_buffer.rb +247 -0
- data/lib/subskribe_sandbox/models/catalog_relationship.rb +364 -0
- data/lib/subskribe_sandbox/models/charge_json.rb +631 -0
- data/lib/subskribe_sandbox/models/charge_partial_json.rb +310 -0
- data/lib/subskribe_sandbox/models/company_contact_json.rb +225 -0
- data/lib/subskribe_sandbox/models/credit_memo_application_json.rb +239 -0
- data/lib/subskribe_sandbox/models/credit_memo_balance_json.rb +211 -0
- data/lib/subskribe_sandbox/models/credit_memo_json.rb +363 -0
- data/lib/subskribe_sandbox/models/credit_memo_line_item_json.rb +252 -0
- data/lib/subskribe_sandbox/models/credit_memo_line_item_request_json.rb +211 -0
- data/lib/subskribe_sandbox/models/credit_memo_pagination_response_json.rb +204 -0
- data/lib/subskribe_sandbox/models/crm_account_import_response.rb +193 -0
- data/lib/subskribe_sandbox/models/custom_field_default.rb +195 -0
- data/lib/subskribe_sandbox/models/custom_field_definition_create_input.rb +317 -0
- data/lib/subskribe_sandbox/models/custom_field_definition_json.rb +313 -0
- data/lib/subskribe_sandbox/models/custom_field_definition_update_input.rb +256 -0
- data/lib/subskribe_sandbox/models/custom_field_entry.rb +325 -0
- data/lib/subskribe_sandbox/models/custom_field_update_input.rb +195 -0
- data/lib/subskribe_sandbox/models/custom_field_value.rb +316 -0
- data/lib/subskribe_sandbox/models/data_import.rb +355 -0
- data/lib/subskribe_sandbox/models/discount_detail_json.rb +263 -0
- data/lib/subskribe_sandbox/models/discount_json.rb +254 -0
- data/lib/subskribe_sandbox/models/docu_sign_integration_request_json.rb +236 -0
- data/lib/subskribe_sandbox/models/docu_sign_integration_response_json.rb +245 -0
- data/lib/subskribe_sandbox/models/document_custom_content.rb +211 -0
- data/lib/subskribe_sandbox/models/document_section.rb +265 -0
- data/lib/subskribe_sandbox/models/document_template_json.rb +300 -0
- data/lib/subskribe_sandbox/models/dunning_setting_json.rb +200 -0
- data/lib/subskribe_sandbox/models/email_notifiers_list.rb +208 -0
- data/lib/subskribe_sandbox/models/entity.rb +356 -0
- data/lib/subskribe_sandbox/models/entity_json.rb +347 -0
- data/lib/subskribe_sandbox/models/entity_ref.rb +202 -0
- data/lib/subskribe_sandbox/models/entry.rb +202 -0
- data/lib/subskribe_sandbox/models/external_arr_schedule_json.rb +319 -0
- data/lib/subskribe_sandbox/models/flatfile_workbook_response.rb +184 -0
- data/lib/subskribe_sandbox/models/flatfile_workbook_response_data.rb +193 -0
- data/lib/subskribe_sandbox/models/input_stream.rb +175 -0
- data/lib/subskribe_sandbox/models/integration.rb +311 -0
- data/lib/subskribe_sandbox/models/invoice_balance_json.rb +211 -0
- data/lib/subskribe_sandbox/models/invoice_item_json.rb +355 -0
- data/lib/subskribe_sandbox/models/invoice_item_preview_json.rb +229 -0
- data/lib/subskribe_sandbox/models/invoice_json.rb +439 -0
- data/lib/subskribe_sandbox/models/invoice_json_pagination_response.rb +204 -0
- data/lib/subskribe_sandbox/models/invoice_number_prefix.rb +184 -0
- data/lib/subskribe_sandbox/models/invoice_preview_json.rb +222 -0
- data/lib/subskribe_sandbox/models/ledger_account.rb +316 -0
- data/lib/subskribe_sandbox/models/ledger_account_mapping.rb +222 -0
- data/lib/subskribe_sandbox/models/metrics_json.rb +267 -0
- data/lib/subskribe_sandbox/models/notification_target_and_subscriptions.rb +265 -0
- data/lib/subskribe_sandbox/models/number_config.rb +254 -0
- data/lib/subskribe_sandbox/models/opportunity.rb +326 -0
- data/lib/subskribe_sandbox/models/opportunity_json.rb +326 -0
- data/lib/subskribe_sandbox/models/opportunity_pagination_response.rb +204 -0
- data/lib/subskribe_sandbox/models/opportunity_rest_json.rb +317 -0
- data/lib/subskribe_sandbox/models/order_json.rb +754 -0
- data/lib/subskribe_sandbox/models/order_json_pagination_response.rb +204 -0
- data/lib/subskribe_sandbox/models/order_line_item_json.rb +474 -0
- data/lib/subskribe_sandbox/models/order_line_item_request_json.rb +384 -0
- data/lib/subskribe_sandbox/models/order_request_json.rb +616 -0
- data/lib/subskribe_sandbox/models/order_terms.rb +265 -0
- data/lib/subskribe_sandbox/models/paginated_response.rb +204 -0
- data/lib/subskribe_sandbox/models/payment_balance_json.rb +211 -0
- data/lib/subskribe_sandbox/models/payment_configuration.rb +208 -0
- data/lib/subskribe_sandbox/models/payment_json.rb +300 -0
- data/lib/subskribe_sandbox/models/payment_json_pagination_response.rb +204 -0
- data/lib/subskribe_sandbox/models/payment_term_settings_json.rb +219 -0
- data/lib/subskribe_sandbox/models/plan_json.rb +339 -0
- data/lib/subskribe_sandbox/models/plan_json_pagination_response.rb +204 -0
- data/lib/subskribe_sandbox/models/plan_metadata_json.rb +187 -0
- data/lib/subskribe_sandbox/models/predefined_report_def_chart_json.rb +265 -0
- data/lib/subskribe_sandbox/models/predefined_report_def_json.rb +222 -0
- data/lib/subskribe_sandbox/models/predefined_report_defs_json.rb +186 -0
- data/lib/subskribe_sandbox/models/predefined_report_json.rb +213 -0
- data/lib/subskribe_sandbox/models/predefined_report_param.rb +296 -0
- data/lib/subskribe_sandbox/models/predefined_report_param_object.rb +296 -0
- data/lib/subskribe_sandbox/models/prepaid_stats.rb +310 -0
- data/lib/subskribe_sandbox/models/price_tier_json.rb +212 -0
- data/lib/subskribe_sandbox/models/product_category.rb +264 -0
- data/lib/subskribe_sandbox/models/product_category_pagination_response.rb +204 -0
- data/lib/subskribe_sandbox/models/product_input_json.rb +249 -0
- data/lib/subskribe_sandbox/models/product_json.rb +276 -0
- data/lib/subskribe_sandbox/models/product_json_pagination_response.rb +204 -0
- data/lib/subskribe_sandbox/models/purchase_order.rb +226 -0
- data/lib/subskribe_sandbox/models/raw_usage.rb +247 -0
- data/lib/subskribe_sandbox/models/raw_usages_data.rb +192 -0
- data/lib/subskribe_sandbox/models/recognition_event_completion.rb +322 -0
- data/lib/subskribe_sandbox/models/recognition_rule.rb +376 -0
- data/lib/subskribe_sandbox/models/recurrence_json.rb +256 -0
- data/lib/subskribe_sandbox/models/refund.rb +301 -0
- data/lib/subskribe_sandbox/models/refund_detail.rb +322 -0
- data/lib/subskribe_sandbox/models/refund_request_json.rb +272 -0
- data/lib/subskribe_sandbox/models/report_duration.rb +193 -0
- data/lib/subskribe_sandbox/models/report_job_response.rb +245 -0
- data/lib/subskribe_sandbox/models/salesforce_account.rb +229 -0
- data/lib/subskribe_sandbox/models/salesforce_account_billing_address.rb +220 -0
- data/lib/subskribe_sandbox/models/salesforce_client_integration_request_json.rb +211 -0
- data/lib/subskribe_sandbox/models/settlement_application.rb +329 -0
- data/lib/subskribe_sandbox/models/standalone_credit_memo_request.rb +353 -0
- data/lib/subskribe_sandbox/models/subscription_charge_alias.rb +283 -0
- data/lib/subskribe_sandbox/models/subscription_charge_json.rb +362 -0
- data/lib/subskribe_sandbox/models/subscription_json.rb +583 -0
- data/lib/subskribe_sandbox/models/subscription_update_json.rb +280 -0
- data/lib/subskribe_sandbox/models/tax_jar_integration.rb +238 -0
- data/lib/subskribe_sandbox/models/tax_jar_integration_input.rb +193 -0
- data/lib/subskribe_sandbox/models/tax_rate_json.rb +286 -0
- data/lib/subskribe_sandbox/models/tax_rate_pagination_response_json.rb +204 -0
- data/lib/subskribe_sandbox/models/tenant_credit_memo_configuration_json.rb +211 -0
- data/lib/subskribe_sandbox/models/tenant_discount_json.rb +193 -0
- data/lib/subskribe_sandbox/models/tenant_discount_line_item_json.rb +202 -0
- data/lib/subskribe_sandbox/models/tenant_invoice_config.rb +254 -0
- data/lib/subskribe_sandbox/models/tenant_json.rb +283 -0
- data/lib/subskribe_sandbox/models/tenant_setting_json.rb +307 -0
- data/lib/subskribe_sandbox/models/time_series_amount_json.rb +193 -0
- data/lib/subskribe_sandbox/models/time_zone.rb +211 -0
- data/lib/subskribe_sandbox/models/unit_of_measure_json.rb +250 -0
- data/lib/subskribe_sandbox/models/unit_of_measure_pagination_response_json.rb +204 -0
- data/lib/subskribe_sandbox/models/update_invoice_request.rb +282 -0
- data/lib/subskribe_sandbox/models/usage_aggregate_output.rb +258 -0
- data/lib/subskribe_sandbox/models/usage_batch_insert_result.rb +213 -0
- data/lib/subskribe_sandbox/models/user_group_json.rb +224 -0
- data/lib/subskribe_sandbox/models/user_group_request_json.rb +224 -0
- data/lib/subskribe_sandbox/models/user_input.rb +304 -0
- data/lib/subskribe_sandbox/models/user_json.rb +376 -0
- data/lib/subskribe_sandbox/models/user_pagination_response_json.rb +204 -0
- data/lib/subskribe_sandbox/models/void_invoice_request.rb +203 -0
- data/lib/subskribe_sandbox/models/void_payment_json.rb +235 -0
- data/lib/subskribe_sandbox/version.rb +15 -0
- data/lib/subskribe_sandbox.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 +109 -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/api_client_spec.rb +243 -0
- data/spec/configuration_spec.rb +42 -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_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/unit_of_measure_json_spec.rb +63 -0
- data/spec/models/unit_of_measure_pagination_response_json_spec.rb +53 -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/spec/spec_helper.rb +111 -0
- data/subskribe_dev.gemspec +46 -0
- data/subskribe_sandbox.gemspec +46 -0
- metadata +1218 -0
@@ -0,0 +1,1747 @@
|
|
1
|
+
# SubskribeSandboxClient::IntegrationsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.sandbox.subskribe.net*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_integration**](IntegrationsApi.md#add_integration) | **POST** /anrok | Add a Anrok integration
|
8
|
+
[**add_integration1**](IntegrationsApi.md#add_integration1) | **POST** /taxjar | Add a TaxJar integration
|
9
|
+
[**authorization_code_callback**](IntegrationsApi.md#authorization_code_callback) | **GET** /hubspot | Handle HubSpot authorization code
|
10
|
+
[**authorization_code_callback1**](IntegrationsApi.md#authorization_code_callback1) | **GET** /sfdc | Callback for the authorization code
|
11
|
+
[**complete_integration**](IntegrationsApi.md#complete_integration) | **GET** /docusign | Complete Docusign integration
|
12
|
+
[**delete_integration**](IntegrationsApi.md#delete_integration) | **DELETE** /docusign | Delete Docusign integration
|
13
|
+
[**delete_integration1**](IntegrationsApi.md#delete_integration1) | **DELETE** /hubspot | Delete HubSpot Integration
|
14
|
+
[**delete_integration2**](IntegrationsApi.md#delete_integration2) | **DELETE** /sfdc | Delete Salesforce integration
|
15
|
+
[**get_account_by_id**](IntegrationsApi.md#get_account_by_id) | **GET** /sfdc/account/{id} | Get Salesforce account
|
16
|
+
[**get_accounts_by_name**](IntegrationsApi.md#get_accounts_by_name) | **GET** /sfdc/account | Get Salesforce accounts
|
17
|
+
[**get_integration**](IntegrationsApi.md#get_integration) | **GET** /anrok/{integrationId} | Get integration details
|
18
|
+
[**get_integration1**](IntegrationsApi.md#get_integration1) | **GET** /avalara/{integrationId} | Gets Avalara integration details
|
19
|
+
[**get_integration2**](IntegrationsApi.md#get_integration2) | **GET** /taxjar/{integrationId} | Get integration details
|
20
|
+
[**get_integration_by_tenant**](IntegrationsApi.md#get_integration_by_tenant) | **GET** /avalara | Gets Avalara integration details
|
21
|
+
[**get_opportunities_by_account_id**](IntegrationsApi.md#get_opportunities_by_account_id) | **GET** /sfdc/opportunity | Get Salesforce opportunities
|
22
|
+
[**import_account**](IntegrationsApi.md#import_account) | **POST** /sfdc/account | Import account from Salesforce
|
23
|
+
[**initiate_integration**](IntegrationsApi.md#initiate_integration) | **POST** /docusign | Create Docusign integration
|
24
|
+
[**initiate_integration1**](IntegrationsApi.md#initiate_integration1) | **POST** /hubspot | Initiate a HubSpot integration
|
25
|
+
[**initiate_integration2**](IntegrationsApi.md#initiate_integration2) | **POST** /sfdc | Initiate integration with Salesforce
|
26
|
+
[**integrate**](IntegrationsApi.md#integrate) | **POST** /avalara | Create an Avalara integration
|
27
|
+
[**ping**](IntegrationsApi.md#ping) | **PUT** /avalara/ping | Pings Avalara
|
28
|
+
[**setup_hub_spot**](IntegrationsApi.md#setup_hub_spot) | **POST** /hubspot/setup | Add custom properties to HubSpot
|
29
|
+
[**sync_account_to_salesforce**](IntegrationsApi.md#sync_account_to_salesforce) | **PUT** /sfdc/syncAccount/{id} | Sync an account to Salesforce
|
30
|
+
[**sync_deleted_orders_to_salesforce**](IntegrationsApi.md#sync_deleted_orders_to_salesforce) | **PUT** /sfdc/syncDeletedOrders | Sync orders to Salesforce
|
31
|
+
[**sync_esign_details_for_order_to_hub_spot**](IntegrationsApi.md#sync_esign_details_for_order_to_hub_spot) | **POST** /hubspot/esign/{orderId} | Sync esign details for order id
|
32
|
+
[**sync_order_to_salesforce**](IntegrationsApi.md#sync_order_to_salesforce) | **PUT** /sfdc/sync/{id} | Sync order to Salesforce
|
33
|
+
[**sync_orders_to_salesforce**](IntegrationsApi.md#sync_orders_to_salesforce) | **PUT** /sfdc/syncOrders | Sync orders to Salesforce
|
34
|
+
[**sync_tenant_to_salesforce**](IntegrationsApi.md#sync_tenant_to_salesforce) | **PUT** /sfdc/syncTenant | Sync whole tenant to Salesforce in a paginated fashion
|
35
|
+
[**test_integration**](IntegrationsApi.md#test_integration) | **PUT** /anrok/test | Test an integration is valid
|
36
|
+
[**test_integration1**](IntegrationsApi.md#test_integration1) | **PUT** /taxjar/test | Test an integration is valid
|
37
|
+
[**update_primary_order_id_for_opportunity**](IntegrationsApi.md#update_primary_order_id_for_opportunity) | **PUT** /sfdc/order/{id} | Make an order primary
|
38
|
+
[**verify_setup**](IntegrationsApi.md#verify_setup) | **POST** /hubspot/setup/verify | Verify HubSpot setup
|
39
|
+
|
40
|
+
|
41
|
+
# **add_integration**
|
42
|
+
> add_integration(opts)
|
43
|
+
|
44
|
+
Add a Anrok integration
|
45
|
+
|
46
|
+
Returns the integration ID if successful
|
47
|
+
|
48
|
+
### Example
|
49
|
+
```ruby
|
50
|
+
# load the gem
|
51
|
+
require 'subskribe_sandbox'
|
52
|
+
# setup authorization
|
53
|
+
SubskribeSandboxClient.configure do |config|
|
54
|
+
# Configure API key authorization: ApiKeyAuth
|
55
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
56
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
57
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
58
|
+
end
|
59
|
+
|
60
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
61
|
+
|
62
|
+
opts = {
|
63
|
+
body: SubskribeSandboxClient::AnrokIntegrationInput.new # AnrokIntegrationInput | Integration input as a JSON
|
64
|
+
}
|
65
|
+
|
66
|
+
begin
|
67
|
+
#Add a Anrok integration
|
68
|
+
api_instance.add_integration(opts)
|
69
|
+
rescue SubskribeSandboxClient::ApiError => e
|
70
|
+
puts "Exception when calling IntegrationsApi->add_integration: #{e}"
|
71
|
+
end
|
72
|
+
```
|
73
|
+
|
74
|
+
### Parameters
|
75
|
+
|
76
|
+
Name | Type | Description | Notes
|
77
|
+
------------- | ------------- | ------------- | -------------
|
78
|
+
**body** | [**AnrokIntegrationInput**](AnrokIntegrationInput.md)| Integration input as a JSON | [optional]
|
79
|
+
|
80
|
+
### Return type
|
81
|
+
|
82
|
+
nil (empty response body)
|
83
|
+
|
84
|
+
### Authorization
|
85
|
+
|
86
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
87
|
+
|
88
|
+
### HTTP request headers
|
89
|
+
|
90
|
+
- **Content-Type**: application/json
|
91
|
+
- **Accept**: application/json
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
# **add_integration1**
|
96
|
+
> add_integration1(opts)
|
97
|
+
|
98
|
+
Add a TaxJar integration
|
99
|
+
|
100
|
+
Returns the integration ID if successful
|
101
|
+
|
102
|
+
### Example
|
103
|
+
```ruby
|
104
|
+
# load the gem
|
105
|
+
require 'subskribe_sandbox'
|
106
|
+
# setup authorization
|
107
|
+
SubskribeSandboxClient.configure do |config|
|
108
|
+
# Configure API key authorization: ApiKeyAuth
|
109
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
110
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
111
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
112
|
+
end
|
113
|
+
|
114
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
115
|
+
|
116
|
+
opts = {
|
117
|
+
body: SubskribeSandboxClient::TaxJarIntegrationInput.new # TaxJarIntegrationInput | Integration input as a JSON
|
118
|
+
}
|
119
|
+
|
120
|
+
begin
|
121
|
+
#Add a TaxJar integration
|
122
|
+
api_instance.add_integration1(opts)
|
123
|
+
rescue SubskribeSandboxClient::ApiError => e
|
124
|
+
puts "Exception when calling IntegrationsApi->add_integration1: #{e}"
|
125
|
+
end
|
126
|
+
```
|
127
|
+
|
128
|
+
### Parameters
|
129
|
+
|
130
|
+
Name | Type | Description | Notes
|
131
|
+
------------- | ------------- | ------------- | -------------
|
132
|
+
**body** | [**TaxJarIntegrationInput**](TaxJarIntegrationInput.md)| Integration input as a JSON | [optional]
|
133
|
+
|
134
|
+
### Return type
|
135
|
+
|
136
|
+
nil (empty response body)
|
137
|
+
|
138
|
+
### Authorization
|
139
|
+
|
140
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
141
|
+
|
142
|
+
### HTTP request headers
|
143
|
+
|
144
|
+
- **Content-Type**: application/json
|
145
|
+
- **Accept**: application/json
|
146
|
+
|
147
|
+
|
148
|
+
|
149
|
+
# **authorization_code_callback**
|
150
|
+
> authorization_code_callback(code, state, redirect_uri)
|
151
|
+
|
152
|
+
Handle HubSpot authorization code
|
153
|
+
|
154
|
+
Endpoint to handle and process a HubSpot authorization code
|
155
|
+
|
156
|
+
### Example
|
157
|
+
```ruby
|
158
|
+
# load the gem
|
159
|
+
require 'subskribe_sandbox'
|
160
|
+
# setup authorization
|
161
|
+
SubskribeSandboxClient.configure do |config|
|
162
|
+
# Configure API key authorization: ApiKeyAuth
|
163
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
164
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
165
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
166
|
+
end
|
167
|
+
|
168
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
169
|
+
|
170
|
+
code = 'code_example' # String | authorization code
|
171
|
+
|
172
|
+
state = 'state_example' # String | HubSpot integration id
|
173
|
+
|
174
|
+
redirect_uri = 'redirect_uri_example' # String | uri to redirect to HubSpot
|
175
|
+
|
176
|
+
|
177
|
+
begin
|
178
|
+
#Handle HubSpot authorization code
|
179
|
+
api_instance.authorization_code_callback(code, state, redirect_uri)
|
180
|
+
rescue SubskribeSandboxClient::ApiError => e
|
181
|
+
puts "Exception when calling IntegrationsApi->authorization_code_callback: #{e}"
|
182
|
+
end
|
183
|
+
```
|
184
|
+
|
185
|
+
### Parameters
|
186
|
+
|
187
|
+
Name | Type | Description | Notes
|
188
|
+
------------- | ------------- | ------------- | -------------
|
189
|
+
**code** | **String**| authorization code |
|
190
|
+
**state** | **String**| HubSpot integration id |
|
191
|
+
**redirect_uri** | **String**| uri to redirect to HubSpot |
|
192
|
+
|
193
|
+
### Return type
|
194
|
+
|
195
|
+
nil (empty response body)
|
196
|
+
|
197
|
+
### Authorization
|
198
|
+
|
199
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
200
|
+
|
201
|
+
### HTTP request headers
|
202
|
+
|
203
|
+
- **Content-Type**: Not defined
|
204
|
+
- **Accept**: application/json
|
205
|
+
|
206
|
+
|
207
|
+
|
208
|
+
# **authorization_code_callback1**
|
209
|
+
> authorization_code_callback1(code, state, opts)
|
210
|
+
|
211
|
+
Callback for the authorization code
|
212
|
+
|
213
|
+
Handles the authorization code callback from Salesforce
|
214
|
+
|
215
|
+
### Example
|
216
|
+
```ruby
|
217
|
+
# load the gem
|
218
|
+
require 'subskribe_sandbox'
|
219
|
+
# setup authorization
|
220
|
+
SubskribeSandboxClient.configure do |config|
|
221
|
+
# Configure API key authorization: ApiKeyAuth
|
222
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
223
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
224
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
225
|
+
end
|
226
|
+
|
227
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
228
|
+
|
229
|
+
code = 'code_example' # String | authorization code
|
230
|
+
|
231
|
+
state = 'state_example' # String | id of the integration
|
232
|
+
|
233
|
+
opts = {
|
234
|
+
redirect_uri: 'redirect_uri_example' # String | uri to redirect to
|
235
|
+
}
|
236
|
+
|
237
|
+
begin
|
238
|
+
#Callback for the authorization code
|
239
|
+
api_instance.authorization_code_callback1(code, state, opts)
|
240
|
+
rescue SubskribeSandboxClient::ApiError => e
|
241
|
+
puts "Exception when calling IntegrationsApi->authorization_code_callback1: #{e}"
|
242
|
+
end
|
243
|
+
```
|
244
|
+
|
245
|
+
### Parameters
|
246
|
+
|
247
|
+
Name | Type | Description | Notes
|
248
|
+
------------- | ------------- | ------------- | -------------
|
249
|
+
**code** | **String**| authorization code |
|
250
|
+
**state** | **String**| id of the integration |
|
251
|
+
**redirect_uri** | **String**| uri to redirect to | [optional]
|
252
|
+
|
253
|
+
### Return type
|
254
|
+
|
255
|
+
nil (empty response body)
|
256
|
+
|
257
|
+
### Authorization
|
258
|
+
|
259
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
260
|
+
|
261
|
+
### HTTP request headers
|
262
|
+
|
263
|
+
- **Content-Type**: Not defined
|
264
|
+
- **Accept**: application/json
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
# **complete_integration**
|
269
|
+
> DocuSignIntegrationResponseJson complete_integration(opts)
|
270
|
+
|
271
|
+
Complete Docusign integration
|
272
|
+
|
273
|
+
Complete the docusign integration. This should be called after the integration has been created and an authorization code has been received from Docusign.
|
274
|
+
|
275
|
+
### Example
|
276
|
+
```ruby
|
277
|
+
# load the gem
|
278
|
+
require 'subskribe_sandbox'
|
279
|
+
# setup authorization
|
280
|
+
SubskribeSandboxClient.configure do |config|
|
281
|
+
# Configure API key authorization: ApiKeyAuth
|
282
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
283
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
284
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
285
|
+
end
|
286
|
+
|
287
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
288
|
+
|
289
|
+
opts = {
|
290
|
+
code: 'code_example', # String | authorization code received from Docusign
|
291
|
+
state: 'state_example' # String | id of the integration
|
292
|
+
}
|
293
|
+
|
294
|
+
begin
|
295
|
+
#Complete Docusign integration
|
296
|
+
result = api_instance.complete_integration(opts)
|
297
|
+
p result
|
298
|
+
rescue SubskribeSandboxClient::ApiError => e
|
299
|
+
puts "Exception when calling IntegrationsApi->complete_integration: #{e}"
|
300
|
+
end
|
301
|
+
```
|
302
|
+
|
303
|
+
### Parameters
|
304
|
+
|
305
|
+
Name | Type | Description | Notes
|
306
|
+
------------- | ------------- | ------------- | -------------
|
307
|
+
**code** | **String**| authorization code received from Docusign | [optional]
|
308
|
+
**state** | **String**| id of the integration | [optional]
|
309
|
+
|
310
|
+
### Return type
|
311
|
+
|
312
|
+
[**DocuSignIntegrationResponseJson**](DocuSignIntegrationResponseJson.md)
|
313
|
+
|
314
|
+
### Authorization
|
315
|
+
|
316
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
317
|
+
|
318
|
+
### HTTP request headers
|
319
|
+
|
320
|
+
- **Content-Type**: application/json
|
321
|
+
- **Accept**: application/json
|
322
|
+
|
323
|
+
|
324
|
+
|
325
|
+
# **delete_integration**
|
326
|
+
> DocuSignIntegrationResponseJson delete_integration
|
327
|
+
|
328
|
+
Delete Docusign integration
|
329
|
+
|
330
|
+
Removes integration with Docusign from your tenant
|
331
|
+
|
332
|
+
### Example
|
333
|
+
```ruby
|
334
|
+
# load the gem
|
335
|
+
require 'subskribe_sandbox'
|
336
|
+
# setup authorization
|
337
|
+
SubskribeSandboxClient.configure do |config|
|
338
|
+
# Configure API key authorization: ApiKeyAuth
|
339
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
340
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
341
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
342
|
+
end
|
343
|
+
|
344
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
345
|
+
|
346
|
+
begin
|
347
|
+
#Delete Docusign integration
|
348
|
+
result = api_instance.delete_integration
|
349
|
+
p result
|
350
|
+
rescue SubskribeSandboxClient::ApiError => e
|
351
|
+
puts "Exception when calling IntegrationsApi->delete_integration: #{e}"
|
352
|
+
end
|
353
|
+
```
|
354
|
+
|
355
|
+
### Parameters
|
356
|
+
This endpoint does not need any parameter.
|
357
|
+
|
358
|
+
### Return type
|
359
|
+
|
360
|
+
[**DocuSignIntegrationResponseJson**](DocuSignIntegrationResponseJson.md)
|
361
|
+
|
362
|
+
### Authorization
|
363
|
+
|
364
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
365
|
+
|
366
|
+
### HTTP request headers
|
367
|
+
|
368
|
+
- **Content-Type**: application/json
|
369
|
+
- **Accept**: application/json
|
370
|
+
|
371
|
+
|
372
|
+
|
373
|
+
# **delete_integration1**
|
374
|
+
> delete_integration1
|
375
|
+
|
376
|
+
Delete HubSpot Integration
|
377
|
+
|
378
|
+
Deletes your integration with HubSpot.
|
379
|
+
|
380
|
+
### Example
|
381
|
+
```ruby
|
382
|
+
# load the gem
|
383
|
+
require 'subskribe_sandbox'
|
384
|
+
# setup authorization
|
385
|
+
SubskribeSandboxClient.configure do |config|
|
386
|
+
# Configure API key authorization: ApiKeyAuth
|
387
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
388
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
389
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
390
|
+
end
|
391
|
+
|
392
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
393
|
+
|
394
|
+
begin
|
395
|
+
#Delete HubSpot Integration
|
396
|
+
api_instance.delete_integration1
|
397
|
+
rescue SubskribeSandboxClient::ApiError => e
|
398
|
+
puts "Exception when calling IntegrationsApi->delete_integration1: #{e}"
|
399
|
+
end
|
400
|
+
```
|
401
|
+
|
402
|
+
### Parameters
|
403
|
+
This endpoint does not need any parameter.
|
404
|
+
|
405
|
+
### Return type
|
406
|
+
|
407
|
+
nil (empty response body)
|
408
|
+
|
409
|
+
### Authorization
|
410
|
+
|
411
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
412
|
+
|
413
|
+
### HTTP request headers
|
414
|
+
|
415
|
+
- **Content-Type**: application/json
|
416
|
+
- **Accept**: application/json
|
417
|
+
|
418
|
+
|
419
|
+
|
420
|
+
# **delete_integration2**
|
421
|
+
> delete_integration2
|
422
|
+
|
423
|
+
Delete Salesforce integration
|
424
|
+
|
425
|
+
Removes the Salesforce integration for the tenant.
|
426
|
+
|
427
|
+
### Example
|
428
|
+
```ruby
|
429
|
+
# load the gem
|
430
|
+
require 'subskribe_sandbox'
|
431
|
+
# setup authorization
|
432
|
+
SubskribeSandboxClient.configure do |config|
|
433
|
+
# Configure API key authorization: ApiKeyAuth
|
434
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
435
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
436
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
437
|
+
end
|
438
|
+
|
439
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
440
|
+
|
441
|
+
begin
|
442
|
+
#Delete Salesforce integration
|
443
|
+
api_instance.delete_integration2
|
444
|
+
rescue SubskribeSandboxClient::ApiError => e
|
445
|
+
puts "Exception when calling IntegrationsApi->delete_integration2: #{e}"
|
446
|
+
end
|
447
|
+
```
|
448
|
+
|
449
|
+
### Parameters
|
450
|
+
This endpoint does not need any parameter.
|
451
|
+
|
452
|
+
### Return type
|
453
|
+
|
454
|
+
nil (empty response body)
|
455
|
+
|
456
|
+
### Authorization
|
457
|
+
|
458
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
459
|
+
|
460
|
+
### HTTP request headers
|
461
|
+
|
462
|
+
- **Content-Type**: application/json
|
463
|
+
- **Accept**: application/json
|
464
|
+
|
465
|
+
|
466
|
+
|
467
|
+
# **get_account_by_id**
|
468
|
+
> SalesforceAccount get_account_by_id(id)
|
469
|
+
|
470
|
+
Get Salesforce account
|
471
|
+
|
472
|
+
Gets a Salesforce account by its id.
|
473
|
+
|
474
|
+
### Example
|
475
|
+
```ruby
|
476
|
+
# load the gem
|
477
|
+
require 'subskribe_sandbox'
|
478
|
+
# setup authorization
|
479
|
+
SubskribeSandboxClient.configure do |config|
|
480
|
+
# Configure API key authorization: ApiKeyAuth
|
481
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
482
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
483
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
484
|
+
end
|
485
|
+
|
486
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
487
|
+
|
488
|
+
id = 'id_example' # String | id of the account
|
489
|
+
|
490
|
+
|
491
|
+
begin
|
492
|
+
#Get Salesforce account
|
493
|
+
result = api_instance.get_account_by_id(id)
|
494
|
+
p result
|
495
|
+
rescue SubskribeSandboxClient::ApiError => e
|
496
|
+
puts "Exception when calling IntegrationsApi->get_account_by_id: #{e}"
|
497
|
+
end
|
498
|
+
```
|
499
|
+
|
500
|
+
### Parameters
|
501
|
+
|
502
|
+
Name | Type | Description | Notes
|
503
|
+
------------- | ------------- | ------------- | -------------
|
504
|
+
**id** | **String**| id of the account |
|
505
|
+
|
506
|
+
### Return type
|
507
|
+
|
508
|
+
[**SalesforceAccount**](SalesforceAccount.md)
|
509
|
+
|
510
|
+
### Authorization
|
511
|
+
|
512
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
513
|
+
|
514
|
+
### HTTP request headers
|
515
|
+
|
516
|
+
- **Content-Type**: Not defined
|
517
|
+
- **Accept**: application/json
|
518
|
+
|
519
|
+
|
520
|
+
|
521
|
+
# **get_accounts_by_name**
|
522
|
+
> Array<SalesforceAccount> get_accounts_by_name(name)
|
523
|
+
|
524
|
+
Get Salesforce accounts
|
525
|
+
|
526
|
+
Returns Salesforce accounts matching the specified name.
|
527
|
+
|
528
|
+
### Example
|
529
|
+
```ruby
|
530
|
+
# load the gem
|
531
|
+
require 'subskribe_sandbox'
|
532
|
+
# setup authorization
|
533
|
+
SubskribeSandboxClient.configure do |config|
|
534
|
+
# Configure API key authorization: ApiKeyAuth
|
535
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
536
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
537
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
538
|
+
end
|
539
|
+
|
540
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
541
|
+
|
542
|
+
name = 'name_example' # String | account name
|
543
|
+
|
544
|
+
|
545
|
+
begin
|
546
|
+
#Get Salesforce accounts
|
547
|
+
result = api_instance.get_accounts_by_name(name)
|
548
|
+
p result
|
549
|
+
rescue SubskribeSandboxClient::ApiError => e
|
550
|
+
puts "Exception when calling IntegrationsApi->get_accounts_by_name: #{e}"
|
551
|
+
end
|
552
|
+
```
|
553
|
+
|
554
|
+
### Parameters
|
555
|
+
|
556
|
+
Name | Type | Description | Notes
|
557
|
+
------------- | ------------- | ------------- | -------------
|
558
|
+
**name** | **String**| account name |
|
559
|
+
|
560
|
+
### Return type
|
561
|
+
|
562
|
+
[**Array<SalesforceAccount>**](SalesforceAccount.md)
|
563
|
+
|
564
|
+
### Authorization
|
565
|
+
|
566
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
567
|
+
|
568
|
+
### HTTP request headers
|
569
|
+
|
570
|
+
- **Content-Type**: Not defined
|
571
|
+
- **Accept**: application/json
|
572
|
+
|
573
|
+
|
574
|
+
|
575
|
+
# **get_integration**
|
576
|
+
> Integration get_integration(integration_id)
|
577
|
+
|
578
|
+
Get integration details
|
579
|
+
|
580
|
+
Gets the integration details of the specified integration id
|
581
|
+
|
582
|
+
### Example
|
583
|
+
```ruby
|
584
|
+
# load the gem
|
585
|
+
require 'subskribe_sandbox'
|
586
|
+
# setup authorization
|
587
|
+
SubskribeSandboxClient.configure do |config|
|
588
|
+
# Configure API key authorization: ApiKeyAuth
|
589
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
590
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
591
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
592
|
+
end
|
593
|
+
|
594
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
595
|
+
|
596
|
+
integration_id = 'integration_id_example' # String | integration id
|
597
|
+
|
598
|
+
|
599
|
+
begin
|
600
|
+
#Get integration details
|
601
|
+
result = api_instance.get_integration(integration_id)
|
602
|
+
p result
|
603
|
+
rescue SubskribeSandboxClient::ApiError => e
|
604
|
+
puts "Exception when calling IntegrationsApi->get_integration: #{e}"
|
605
|
+
end
|
606
|
+
```
|
607
|
+
|
608
|
+
### Parameters
|
609
|
+
|
610
|
+
Name | Type | Description | Notes
|
611
|
+
------------- | ------------- | ------------- | -------------
|
612
|
+
**integration_id** | **String**| integration id |
|
613
|
+
|
614
|
+
### Return type
|
615
|
+
|
616
|
+
[**Integration**](Integration.md)
|
617
|
+
|
618
|
+
### Authorization
|
619
|
+
|
620
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
621
|
+
|
622
|
+
### HTTP request headers
|
623
|
+
|
624
|
+
- **Content-Type**: Not defined
|
625
|
+
- **Accept**: application/json
|
626
|
+
|
627
|
+
|
628
|
+
|
629
|
+
# **get_integration1**
|
630
|
+
> AvalaraIntegration get_integration1(integration_id)
|
631
|
+
|
632
|
+
Gets Avalara integration details
|
633
|
+
|
634
|
+
Gets the integration details of the specified integration id
|
635
|
+
|
636
|
+
### Example
|
637
|
+
```ruby
|
638
|
+
# load the gem
|
639
|
+
require 'subskribe_sandbox'
|
640
|
+
# setup authorization
|
641
|
+
SubskribeSandboxClient.configure do |config|
|
642
|
+
# Configure API key authorization: ApiKeyAuth
|
643
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
644
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
645
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
646
|
+
end
|
647
|
+
|
648
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
649
|
+
|
650
|
+
integration_id = 'integration_id_example' # String | integration id
|
651
|
+
|
652
|
+
|
653
|
+
begin
|
654
|
+
#Gets Avalara integration details
|
655
|
+
result = api_instance.get_integration1(integration_id)
|
656
|
+
p result
|
657
|
+
rescue SubskribeSandboxClient::ApiError => e
|
658
|
+
puts "Exception when calling IntegrationsApi->get_integration1: #{e}"
|
659
|
+
end
|
660
|
+
```
|
661
|
+
|
662
|
+
### Parameters
|
663
|
+
|
664
|
+
Name | Type | Description | Notes
|
665
|
+
------------- | ------------- | ------------- | -------------
|
666
|
+
**integration_id** | **String**| integration id |
|
667
|
+
|
668
|
+
### Return type
|
669
|
+
|
670
|
+
[**AvalaraIntegration**](AvalaraIntegration.md)
|
671
|
+
|
672
|
+
### Authorization
|
673
|
+
|
674
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
675
|
+
|
676
|
+
### HTTP request headers
|
677
|
+
|
678
|
+
- **Content-Type**: Not defined
|
679
|
+
- **Accept**: application/json
|
680
|
+
|
681
|
+
|
682
|
+
|
683
|
+
# **get_integration2**
|
684
|
+
> TaxJarIntegration get_integration2(integration_id)
|
685
|
+
|
686
|
+
Get integration details
|
687
|
+
|
688
|
+
Gets the integration details of the specified integration id
|
689
|
+
|
690
|
+
### Example
|
691
|
+
```ruby
|
692
|
+
# load the gem
|
693
|
+
require 'subskribe_sandbox'
|
694
|
+
# setup authorization
|
695
|
+
SubskribeSandboxClient.configure do |config|
|
696
|
+
# Configure API key authorization: ApiKeyAuth
|
697
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
698
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
699
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
700
|
+
end
|
701
|
+
|
702
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
703
|
+
|
704
|
+
integration_id = 'integration_id_example' # String | integration id
|
705
|
+
|
706
|
+
|
707
|
+
begin
|
708
|
+
#Get integration details
|
709
|
+
result = api_instance.get_integration2(integration_id)
|
710
|
+
p result
|
711
|
+
rescue SubskribeSandboxClient::ApiError => e
|
712
|
+
puts "Exception when calling IntegrationsApi->get_integration2: #{e}"
|
713
|
+
end
|
714
|
+
```
|
715
|
+
|
716
|
+
### Parameters
|
717
|
+
|
718
|
+
Name | Type | Description | Notes
|
719
|
+
------------- | ------------- | ------------- | -------------
|
720
|
+
**integration_id** | **String**| integration id |
|
721
|
+
|
722
|
+
### Return type
|
723
|
+
|
724
|
+
[**TaxJarIntegration**](TaxJarIntegration.md)
|
725
|
+
|
726
|
+
### Authorization
|
727
|
+
|
728
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
729
|
+
|
730
|
+
### HTTP request headers
|
731
|
+
|
732
|
+
- **Content-Type**: Not defined
|
733
|
+
- **Accept**: application/json
|
734
|
+
|
735
|
+
|
736
|
+
|
737
|
+
# **get_integration_by_tenant**
|
738
|
+
> AvalaraIntegration get_integration_by_tenant
|
739
|
+
|
740
|
+
Gets Avalara integration details
|
741
|
+
|
742
|
+
Returns the details of the Avalara integration for your tenant
|
743
|
+
|
744
|
+
### Example
|
745
|
+
```ruby
|
746
|
+
# load the gem
|
747
|
+
require 'subskribe_sandbox'
|
748
|
+
# setup authorization
|
749
|
+
SubskribeSandboxClient.configure do |config|
|
750
|
+
# Configure API key authorization: ApiKeyAuth
|
751
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
752
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
753
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
754
|
+
end
|
755
|
+
|
756
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
757
|
+
|
758
|
+
begin
|
759
|
+
#Gets Avalara integration details
|
760
|
+
result = api_instance.get_integration_by_tenant
|
761
|
+
p result
|
762
|
+
rescue SubskribeSandboxClient::ApiError => e
|
763
|
+
puts "Exception when calling IntegrationsApi->get_integration_by_tenant: #{e}"
|
764
|
+
end
|
765
|
+
```
|
766
|
+
|
767
|
+
### Parameters
|
768
|
+
This endpoint does not need any parameter.
|
769
|
+
|
770
|
+
### Return type
|
771
|
+
|
772
|
+
[**AvalaraIntegration**](AvalaraIntegration.md)
|
773
|
+
|
774
|
+
### Authorization
|
775
|
+
|
776
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
777
|
+
|
778
|
+
### HTTP request headers
|
779
|
+
|
780
|
+
- **Content-Type**: Not defined
|
781
|
+
- **Accept**: application/json
|
782
|
+
|
783
|
+
|
784
|
+
|
785
|
+
# **get_opportunities_by_account_id**
|
786
|
+
> Array<Opportunity> get_opportunities_by_account_id(account_id)
|
787
|
+
|
788
|
+
Get Salesforce opportunities
|
789
|
+
|
790
|
+
Returns the Salesforce opportunities associated withe the specified account.
|
791
|
+
|
792
|
+
### Example
|
793
|
+
```ruby
|
794
|
+
# load the gem
|
795
|
+
require 'subskribe_sandbox'
|
796
|
+
# setup authorization
|
797
|
+
SubskribeSandboxClient.configure do |config|
|
798
|
+
# Configure API key authorization: ApiKeyAuth
|
799
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
800
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
801
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
802
|
+
end
|
803
|
+
|
804
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
805
|
+
|
806
|
+
account_id = 'account_id_example' # String | id of the account
|
807
|
+
|
808
|
+
|
809
|
+
begin
|
810
|
+
#Get Salesforce opportunities
|
811
|
+
result = api_instance.get_opportunities_by_account_id(account_id)
|
812
|
+
p result
|
813
|
+
rescue SubskribeSandboxClient::ApiError => e
|
814
|
+
puts "Exception when calling IntegrationsApi->get_opportunities_by_account_id: #{e}"
|
815
|
+
end
|
816
|
+
```
|
817
|
+
|
818
|
+
### Parameters
|
819
|
+
|
820
|
+
Name | Type | Description | Notes
|
821
|
+
------------- | ------------- | ------------- | -------------
|
822
|
+
**account_id** | **String**| id of the account |
|
823
|
+
|
824
|
+
### Return type
|
825
|
+
|
826
|
+
[**Array<Opportunity>**](Opportunity.md)
|
827
|
+
|
828
|
+
### Authorization
|
829
|
+
|
830
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
831
|
+
|
832
|
+
### HTTP request headers
|
833
|
+
|
834
|
+
- **Content-Type**: Not defined
|
835
|
+
- **Accept**: application/json
|
836
|
+
|
837
|
+
|
838
|
+
|
839
|
+
# **import_account**
|
840
|
+
> import_account(body)
|
841
|
+
|
842
|
+
Import account from Salesforce
|
843
|
+
|
844
|
+
Imports an account from Salesforce. On success a redirect uri is returned.
|
845
|
+
|
846
|
+
### Example
|
847
|
+
```ruby
|
848
|
+
# load the gem
|
849
|
+
require 'subskribe_sandbox'
|
850
|
+
# setup authorization
|
851
|
+
SubskribeSandboxClient.configure do |config|
|
852
|
+
# Configure API key authorization: ApiKeyAuth
|
853
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
854
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
855
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
856
|
+
end
|
857
|
+
|
858
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
859
|
+
|
860
|
+
body = SubskribeSandboxClient::SalesforceAccount.new # SalesforceAccount | json representation of the account
|
861
|
+
|
862
|
+
|
863
|
+
begin
|
864
|
+
#Import account from Salesforce
|
865
|
+
api_instance.import_account(body)
|
866
|
+
rescue SubskribeSandboxClient::ApiError => e
|
867
|
+
puts "Exception when calling IntegrationsApi->import_account: #{e}"
|
868
|
+
end
|
869
|
+
```
|
870
|
+
|
871
|
+
### Parameters
|
872
|
+
|
873
|
+
Name | Type | Description | Notes
|
874
|
+
------------- | ------------- | ------------- | -------------
|
875
|
+
**body** | [**SalesforceAccount**](SalesforceAccount.md)| json representation of the account |
|
876
|
+
|
877
|
+
### Return type
|
878
|
+
|
879
|
+
nil (empty response body)
|
880
|
+
|
881
|
+
### Authorization
|
882
|
+
|
883
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
884
|
+
|
885
|
+
### HTTP request headers
|
886
|
+
|
887
|
+
- **Content-Type**: application/json
|
888
|
+
- **Accept**: application/json
|
889
|
+
|
890
|
+
|
891
|
+
|
892
|
+
# **initiate_integration**
|
893
|
+
> initiate_integration(opts)
|
894
|
+
|
895
|
+
Create Docusign integration
|
896
|
+
|
897
|
+
Creates an integration with Docusign. On success a redirect URL is returned.
|
898
|
+
|
899
|
+
### Example
|
900
|
+
```ruby
|
901
|
+
# load the gem
|
902
|
+
require 'subskribe_sandbox'
|
903
|
+
# setup authorization
|
904
|
+
SubskribeSandboxClient.configure do |config|
|
905
|
+
# Configure API key authorization: ApiKeyAuth
|
906
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
907
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
908
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
909
|
+
end
|
910
|
+
|
911
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
912
|
+
|
913
|
+
opts = {
|
914
|
+
body: SubskribeSandboxClient::DocuSignIntegrationRequestJson.new # DocuSignIntegrationRequestJson | details of the integration
|
915
|
+
}
|
916
|
+
|
917
|
+
begin
|
918
|
+
#Create Docusign integration
|
919
|
+
api_instance.initiate_integration(opts)
|
920
|
+
rescue SubskribeSandboxClient::ApiError => e
|
921
|
+
puts "Exception when calling IntegrationsApi->initiate_integration: #{e}"
|
922
|
+
end
|
923
|
+
```
|
924
|
+
|
925
|
+
### Parameters
|
926
|
+
|
927
|
+
Name | Type | Description | Notes
|
928
|
+
------------- | ------------- | ------------- | -------------
|
929
|
+
**body** | [**DocuSignIntegrationRequestJson**](DocuSignIntegrationRequestJson.md)| details of the integration | [optional]
|
930
|
+
|
931
|
+
### Return type
|
932
|
+
|
933
|
+
nil (empty response body)
|
934
|
+
|
935
|
+
### Authorization
|
936
|
+
|
937
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
938
|
+
|
939
|
+
### HTTP request headers
|
940
|
+
|
941
|
+
- **Content-Type**: application/json
|
942
|
+
- **Accept**: application/json
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
# **initiate_integration1**
|
947
|
+
> String initiate_integration1(opts)
|
948
|
+
|
949
|
+
Initiate a HubSpot integration
|
950
|
+
|
951
|
+
Initiates an integration with HubSpot. On success redirect URL is returned.
|
952
|
+
|
953
|
+
### Example
|
954
|
+
```ruby
|
955
|
+
# load the gem
|
956
|
+
require 'subskribe_sandbox'
|
957
|
+
# setup authorization
|
958
|
+
SubskribeSandboxClient.configure do |config|
|
959
|
+
# Configure API key authorization: ApiKeyAuth
|
960
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
961
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
962
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
963
|
+
end
|
964
|
+
|
965
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
966
|
+
|
967
|
+
opts = {
|
968
|
+
email: 'email_example' # String | admin email
|
969
|
+
}
|
970
|
+
|
971
|
+
begin
|
972
|
+
#Initiate a HubSpot integration
|
973
|
+
result = api_instance.initiate_integration1(opts)
|
974
|
+
p result
|
975
|
+
rescue SubskribeSandboxClient::ApiError => e
|
976
|
+
puts "Exception when calling IntegrationsApi->initiate_integration1: #{e}"
|
977
|
+
end
|
978
|
+
```
|
979
|
+
|
980
|
+
### Parameters
|
981
|
+
|
982
|
+
Name | Type | Description | Notes
|
983
|
+
------------- | ------------- | ------------- | -------------
|
984
|
+
**email** | **String**| admin email | [optional]
|
985
|
+
|
986
|
+
### Return type
|
987
|
+
|
988
|
+
**String**
|
989
|
+
|
990
|
+
### Authorization
|
991
|
+
|
992
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
993
|
+
|
994
|
+
### HTTP request headers
|
995
|
+
|
996
|
+
- **Content-Type**: application/json
|
997
|
+
- **Accept**: application/json
|
998
|
+
|
999
|
+
|
1000
|
+
|
1001
|
+
# **initiate_integration2**
|
1002
|
+
> initiate_integration2(opts)
|
1003
|
+
|
1004
|
+
Initiate integration with Salesforce
|
1005
|
+
|
1006
|
+
Initiate a Salesforce integration. On success a redirect url is returned.
|
1007
|
+
|
1008
|
+
### Example
|
1009
|
+
```ruby
|
1010
|
+
# load the gem
|
1011
|
+
require 'subskribe_sandbox'
|
1012
|
+
# setup authorization
|
1013
|
+
SubskribeSandboxClient.configure do |config|
|
1014
|
+
# Configure API key authorization: ApiKeyAuth
|
1015
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1016
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1017
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1018
|
+
end
|
1019
|
+
|
1020
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1021
|
+
|
1022
|
+
opts = {
|
1023
|
+
body: SubskribeSandboxClient::SalesforceClientIntegrationRequestJson.new # SalesforceClientIntegrationRequestJson |
|
1024
|
+
}
|
1025
|
+
|
1026
|
+
begin
|
1027
|
+
#Initiate integration with Salesforce
|
1028
|
+
api_instance.initiate_integration2(opts)
|
1029
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1030
|
+
puts "Exception when calling IntegrationsApi->initiate_integration2: #{e}"
|
1031
|
+
end
|
1032
|
+
```
|
1033
|
+
|
1034
|
+
### Parameters
|
1035
|
+
|
1036
|
+
Name | Type | Description | Notes
|
1037
|
+
------------- | ------------- | ------------- | -------------
|
1038
|
+
**body** | [**SalesforceClientIntegrationRequestJson**](SalesforceClientIntegrationRequestJson.md)| | [optional]
|
1039
|
+
|
1040
|
+
### Return type
|
1041
|
+
|
1042
|
+
nil (empty response body)
|
1043
|
+
|
1044
|
+
### Authorization
|
1045
|
+
|
1046
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1047
|
+
|
1048
|
+
### HTTP request headers
|
1049
|
+
|
1050
|
+
- **Content-Type**: application/json
|
1051
|
+
- **Accept**: application/json
|
1052
|
+
|
1053
|
+
|
1054
|
+
|
1055
|
+
# **integrate**
|
1056
|
+
> integrate(opts)
|
1057
|
+
|
1058
|
+
Create an Avalara integration
|
1059
|
+
|
1060
|
+
Creates an integration with Avalara according to the specified details. On success the id of the integration is returned
|
1061
|
+
|
1062
|
+
### Example
|
1063
|
+
```ruby
|
1064
|
+
# load the gem
|
1065
|
+
require 'subskribe_sandbox'
|
1066
|
+
# setup authorization
|
1067
|
+
SubskribeSandboxClient.configure do |config|
|
1068
|
+
# Configure API key authorization: ApiKeyAuth
|
1069
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1070
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1071
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1072
|
+
end
|
1073
|
+
|
1074
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1075
|
+
|
1076
|
+
opts = {
|
1077
|
+
body: SubskribeSandboxClient::AvalaraIntegrationInput.new # AvalaraIntegrationInput | json representing the integration
|
1078
|
+
}
|
1079
|
+
|
1080
|
+
begin
|
1081
|
+
#Create an Avalara integration
|
1082
|
+
api_instance.integrate(opts)
|
1083
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1084
|
+
puts "Exception when calling IntegrationsApi->integrate: #{e}"
|
1085
|
+
end
|
1086
|
+
```
|
1087
|
+
|
1088
|
+
### Parameters
|
1089
|
+
|
1090
|
+
Name | Type | Description | Notes
|
1091
|
+
------------- | ------------- | ------------- | -------------
|
1092
|
+
**body** | [**AvalaraIntegrationInput**](AvalaraIntegrationInput.md)| json representing the integration | [optional]
|
1093
|
+
|
1094
|
+
### Return type
|
1095
|
+
|
1096
|
+
nil (empty response body)
|
1097
|
+
|
1098
|
+
### Authorization
|
1099
|
+
|
1100
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1101
|
+
|
1102
|
+
### HTTP request headers
|
1103
|
+
|
1104
|
+
- **Content-Type**: application/json
|
1105
|
+
- **Accept**: application/json
|
1106
|
+
|
1107
|
+
|
1108
|
+
|
1109
|
+
# **ping**
|
1110
|
+
> ping(opts)
|
1111
|
+
|
1112
|
+
Pings Avalara
|
1113
|
+
|
1114
|
+
Once an integration is set up Avalara can be pinged to ensure it is working correctly. On success \"PONG\" is returned.
|
1115
|
+
|
1116
|
+
### Example
|
1117
|
+
```ruby
|
1118
|
+
# load the gem
|
1119
|
+
require 'subskribe_sandbox'
|
1120
|
+
# setup authorization
|
1121
|
+
SubskribeSandboxClient.configure do |config|
|
1122
|
+
# Configure API key authorization: ApiKeyAuth
|
1123
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1124
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1125
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1126
|
+
end
|
1127
|
+
|
1128
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1129
|
+
|
1130
|
+
opts = {
|
1131
|
+
body: SubskribeSandboxClient::AvalaraIntegrationInput.new # AvalaraIntegrationInput |
|
1132
|
+
}
|
1133
|
+
|
1134
|
+
begin
|
1135
|
+
#Pings Avalara
|
1136
|
+
api_instance.ping(opts)
|
1137
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1138
|
+
puts "Exception when calling IntegrationsApi->ping: #{e}"
|
1139
|
+
end
|
1140
|
+
```
|
1141
|
+
|
1142
|
+
### Parameters
|
1143
|
+
|
1144
|
+
Name | Type | Description | Notes
|
1145
|
+
------------- | ------------- | ------------- | -------------
|
1146
|
+
**body** | [**AvalaraIntegrationInput**](AvalaraIntegrationInput.md)| | [optional]
|
1147
|
+
|
1148
|
+
### Return type
|
1149
|
+
|
1150
|
+
nil (empty response body)
|
1151
|
+
|
1152
|
+
### Authorization
|
1153
|
+
|
1154
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1155
|
+
|
1156
|
+
### HTTP request headers
|
1157
|
+
|
1158
|
+
- **Content-Type**: Not defined
|
1159
|
+
- **Accept**: application/json
|
1160
|
+
|
1161
|
+
|
1162
|
+
|
1163
|
+
# **setup_hub_spot**
|
1164
|
+
> setup_hub_spot
|
1165
|
+
|
1166
|
+
Add custom properties to HubSpot
|
1167
|
+
|
1168
|
+
Add custom properties to HubSpot
|
1169
|
+
|
1170
|
+
### Example
|
1171
|
+
```ruby
|
1172
|
+
# load the gem
|
1173
|
+
require 'subskribe_sandbox'
|
1174
|
+
# setup authorization
|
1175
|
+
SubskribeSandboxClient.configure do |config|
|
1176
|
+
# Configure API key authorization: ApiKeyAuth
|
1177
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1178
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1179
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1180
|
+
end
|
1181
|
+
|
1182
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1183
|
+
|
1184
|
+
begin
|
1185
|
+
#Add custom properties to HubSpot
|
1186
|
+
api_instance.setup_hub_spot
|
1187
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1188
|
+
puts "Exception when calling IntegrationsApi->setup_hub_spot: #{e}"
|
1189
|
+
end
|
1190
|
+
```
|
1191
|
+
|
1192
|
+
### Parameters
|
1193
|
+
This endpoint does not need any parameter.
|
1194
|
+
|
1195
|
+
### Return type
|
1196
|
+
|
1197
|
+
nil (empty response body)
|
1198
|
+
|
1199
|
+
### Authorization
|
1200
|
+
|
1201
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1202
|
+
|
1203
|
+
### HTTP request headers
|
1204
|
+
|
1205
|
+
- **Content-Type**: application/json
|
1206
|
+
- **Accept**: application/json
|
1207
|
+
|
1208
|
+
|
1209
|
+
|
1210
|
+
# **sync_account_to_salesforce**
|
1211
|
+
> sync_account_to_salesforce(id)
|
1212
|
+
|
1213
|
+
Sync an account to Salesforce
|
1214
|
+
|
1215
|
+
Syncs the account ARR and its orders to Salesforce.
|
1216
|
+
|
1217
|
+
### Example
|
1218
|
+
```ruby
|
1219
|
+
# load the gem
|
1220
|
+
require 'subskribe_sandbox'
|
1221
|
+
# setup authorization
|
1222
|
+
SubskribeSandboxClient.configure do |config|
|
1223
|
+
# Configure API key authorization: ApiKeyAuth
|
1224
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1225
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1226
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1227
|
+
end
|
1228
|
+
|
1229
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1230
|
+
|
1231
|
+
id = 'id_example' # String | account id to sync
|
1232
|
+
|
1233
|
+
|
1234
|
+
begin
|
1235
|
+
#Sync an account to Salesforce
|
1236
|
+
api_instance.sync_account_to_salesforce(id)
|
1237
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1238
|
+
puts "Exception when calling IntegrationsApi->sync_account_to_salesforce: #{e}"
|
1239
|
+
end
|
1240
|
+
```
|
1241
|
+
|
1242
|
+
### Parameters
|
1243
|
+
|
1244
|
+
Name | Type | Description | Notes
|
1245
|
+
------------- | ------------- | ------------- | -------------
|
1246
|
+
**id** | **String**| account id to sync |
|
1247
|
+
|
1248
|
+
### Return type
|
1249
|
+
|
1250
|
+
nil (empty response body)
|
1251
|
+
|
1252
|
+
### Authorization
|
1253
|
+
|
1254
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1255
|
+
|
1256
|
+
### HTTP request headers
|
1257
|
+
|
1258
|
+
- **Content-Type**: application/json
|
1259
|
+
- **Accept**: application/json
|
1260
|
+
|
1261
|
+
|
1262
|
+
|
1263
|
+
# **sync_deleted_orders_to_salesforce**
|
1264
|
+
> OrderJson sync_deleted_orders_to_salesforce(ids)
|
1265
|
+
|
1266
|
+
Sync orders to Salesforce
|
1267
|
+
|
1268
|
+
Syncs the specified order to Salesforce.
|
1269
|
+
|
1270
|
+
### Example
|
1271
|
+
```ruby
|
1272
|
+
# load the gem
|
1273
|
+
require 'subskribe_sandbox'
|
1274
|
+
# setup authorization
|
1275
|
+
SubskribeSandboxClient.configure do |config|
|
1276
|
+
# Configure API key authorization: ApiKeyAuth
|
1277
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1278
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1279
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1280
|
+
end
|
1281
|
+
|
1282
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1283
|
+
|
1284
|
+
ids = [SubskribeSandboxClient::Array<String>.new] # Array<String> | opportunityIds
|
1285
|
+
|
1286
|
+
|
1287
|
+
begin
|
1288
|
+
#Sync orders to Salesforce
|
1289
|
+
result = api_instance.sync_deleted_orders_to_salesforce(ids)
|
1290
|
+
p result
|
1291
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1292
|
+
puts "Exception when calling IntegrationsApi->sync_deleted_orders_to_salesforce: #{e}"
|
1293
|
+
end
|
1294
|
+
```
|
1295
|
+
|
1296
|
+
### Parameters
|
1297
|
+
|
1298
|
+
Name | Type | Description | Notes
|
1299
|
+
------------- | ------------- | ------------- | -------------
|
1300
|
+
**ids** | **Array<String>**| opportunityIds |
|
1301
|
+
|
1302
|
+
### Return type
|
1303
|
+
|
1304
|
+
[**OrderJson**](OrderJson.md)
|
1305
|
+
|
1306
|
+
### Authorization
|
1307
|
+
|
1308
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1309
|
+
|
1310
|
+
### HTTP request headers
|
1311
|
+
|
1312
|
+
- **Content-Type**: application/json
|
1313
|
+
- **Accept**: application/json
|
1314
|
+
|
1315
|
+
|
1316
|
+
|
1317
|
+
# **sync_esign_details_for_order_to_hub_spot**
|
1318
|
+
> sync_esign_details_for_order_to_hub_spot(order_id)
|
1319
|
+
|
1320
|
+
Sync esign details for order id
|
1321
|
+
|
1322
|
+
|
1323
|
+
|
1324
|
+
### Example
|
1325
|
+
```ruby
|
1326
|
+
# load the gem
|
1327
|
+
require 'subskribe_sandbox'
|
1328
|
+
# setup authorization
|
1329
|
+
SubskribeSandboxClient.configure do |config|
|
1330
|
+
# Configure API key authorization: ApiKeyAuth
|
1331
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1332
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1333
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1334
|
+
end
|
1335
|
+
|
1336
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1337
|
+
|
1338
|
+
order_id = 'order_id_example' # String |
|
1339
|
+
|
1340
|
+
|
1341
|
+
begin
|
1342
|
+
#Sync esign details for order id
|
1343
|
+
api_instance.sync_esign_details_for_order_to_hub_spot(order_id)
|
1344
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1345
|
+
puts "Exception when calling IntegrationsApi->sync_esign_details_for_order_to_hub_spot: #{e}"
|
1346
|
+
end
|
1347
|
+
```
|
1348
|
+
|
1349
|
+
### Parameters
|
1350
|
+
|
1351
|
+
Name | Type | Description | Notes
|
1352
|
+
------------- | ------------- | ------------- | -------------
|
1353
|
+
**order_id** | **String**| |
|
1354
|
+
|
1355
|
+
### Return type
|
1356
|
+
|
1357
|
+
nil (empty response body)
|
1358
|
+
|
1359
|
+
### Authorization
|
1360
|
+
|
1361
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1362
|
+
|
1363
|
+
### HTTP request headers
|
1364
|
+
|
1365
|
+
- **Content-Type**: application/json
|
1366
|
+
- **Accept**: application/json
|
1367
|
+
|
1368
|
+
|
1369
|
+
|
1370
|
+
# **sync_order_to_salesforce**
|
1371
|
+
> OrderJson sync_order_to_salesforce(id)
|
1372
|
+
|
1373
|
+
Sync order to Salesforce
|
1374
|
+
|
1375
|
+
Syncs the specified order to Salesforce.
|
1376
|
+
|
1377
|
+
### Example
|
1378
|
+
```ruby
|
1379
|
+
# load the gem
|
1380
|
+
require 'subskribe_sandbox'
|
1381
|
+
# setup authorization
|
1382
|
+
SubskribeSandboxClient.configure do |config|
|
1383
|
+
# Configure API key authorization: ApiKeyAuth
|
1384
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1385
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1386
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1387
|
+
end
|
1388
|
+
|
1389
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1390
|
+
|
1391
|
+
id = 'id_example' # String | order id
|
1392
|
+
|
1393
|
+
|
1394
|
+
begin
|
1395
|
+
#Sync order to Salesforce
|
1396
|
+
result = api_instance.sync_order_to_salesforce(id)
|
1397
|
+
p result
|
1398
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1399
|
+
puts "Exception when calling IntegrationsApi->sync_order_to_salesforce: #{e}"
|
1400
|
+
end
|
1401
|
+
```
|
1402
|
+
|
1403
|
+
### Parameters
|
1404
|
+
|
1405
|
+
Name | Type | Description | Notes
|
1406
|
+
------------- | ------------- | ------------- | -------------
|
1407
|
+
**id** | **String**| order id |
|
1408
|
+
|
1409
|
+
### Return type
|
1410
|
+
|
1411
|
+
[**OrderJson**](OrderJson.md)
|
1412
|
+
|
1413
|
+
### Authorization
|
1414
|
+
|
1415
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1416
|
+
|
1417
|
+
### HTTP request headers
|
1418
|
+
|
1419
|
+
- **Content-Type**: application/json
|
1420
|
+
- **Accept**: application/json
|
1421
|
+
|
1422
|
+
|
1423
|
+
|
1424
|
+
# **sync_orders_to_salesforce**
|
1425
|
+
> OrderJson sync_orders_to_salesforce(ids)
|
1426
|
+
|
1427
|
+
Sync orders to Salesforce
|
1428
|
+
|
1429
|
+
Syncs the specified order to Salesforce.
|
1430
|
+
|
1431
|
+
### Example
|
1432
|
+
```ruby
|
1433
|
+
# load the gem
|
1434
|
+
require 'subskribe_sandbox'
|
1435
|
+
# setup authorization
|
1436
|
+
SubskribeSandboxClient.configure do |config|
|
1437
|
+
# Configure API key authorization: ApiKeyAuth
|
1438
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1439
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1440
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1441
|
+
end
|
1442
|
+
|
1443
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1444
|
+
|
1445
|
+
ids = [SubskribeSandboxClient::Array<String>.new] # Array<String> | order ids
|
1446
|
+
|
1447
|
+
|
1448
|
+
begin
|
1449
|
+
#Sync orders to Salesforce
|
1450
|
+
result = api_instance.sync_orders_to_salesforce(ids)
|
1451
|
+
p result
|
1452
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1453
|
+
puts "Exception when calling IntegrationsApi->sync_orders_to_salesforce: #{e}"
|
1454
|
+
end
|
1455
|
+
```
|
1456
|
+
|
1457
|
+
### Parameters
|
1458
|
+
|
1459
|
+
Name | Type | Description | Notes
|
1460
|
+
------------- | ------------- | ------------- | -------------
|
1461
|
+
**ids** | **Array<String>**| order ids |
|
1462
|
+
|
1463
|
+
### Return type
|
1464
|
+
|
1465
|
+
[**OrderJson**](OrderJson.md)
|
1466
|
+
|
1467
|
+
### Authorization
|
1468
|
+
|
1469
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1470
|
+
|
1471
|
+
### HTTP request headers
|
1472
|
+
|
1473
|
+
- **Content-Type**: application/json
|
1474
|
+
- **Accept**: application/json
|
1475
|
+
|
1476
|
+
|
1477
|
+
|
1478
|
+
# **sync_tenant_to_salesforce**
|
1479
|
+
> sync_tenant_to_salesforce(tenant_id, opts)
|
1480
|
+
|
1481
|
+
Sync whole tenant to Salesforce in a paginated fashion
|
1482
|
+
|
1483
|
+
Syncs the specified tenant to Salesforce. Returns paginated JSON of accounts which were synced
|
1484
|
+
|
1485
|
+
### Example
|
1486
|
+
```ruby
|
1487
|
+
# load the gem
|
1488
|
+
require 'subskribe_sandbox'
|
1489
|
+
# setup authorization
|
1490
|
+
SubskribeSandboxClient.configure do |config|
|
1491
|
+
# Configure API key authorization: ApiKeyAuth
|
1492
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1493
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1494
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1495
|
+
end
|
1496
|
+
|
1497
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1498
|
+
|
1499
|
+
tenant_id = 'tenant_id_example' # String |
|
1500
|
+
|
1501
|
+
opts = {
|
1502
|
+
cursor: 'cursor_example', # String |
|
1503
|
+
limit: 56 # Integer |
|
1504
|
+
}
|
1505
|
+
|
1506
|
+
begin
|
1507
|
+
#Sync whole tenant to Salesforce in a paginated fashion
|
1508
|
+
api_instance.sync_tenant_to_salesforce(tenant_id, opts)
|
1509
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1510
|
+
puts "Exception when calling IntegrationsApi->sync_tenant_to_salesforce: #{e}"
|
1511
|
+
end
|
1512
|
+
```
|
1513
|
+
|
1514
|
+
### Parameters
|
1515
|
+
|
1516
|
+
Name | Type | Description | Notes
|
1517
|
+
------------- | ------------- | ------------- | -------------
|
1518
|
+
**tenant_id** | **String**| |
|
1519
|
+
**cursor** | [**String**](.md)| | [optional]
|
1520
|
+
**limit** | **Integer**| | [optional]
|
1521
|
+
|
1522
|
+
### Return type
|
1523
|
+
|
1524
|
+
nil (empty response body)
|
1525
|
+
|
1526
|
+
### Authorization
|
1527
|
+
|
1528
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1529
|
+
|
1530
|
+
### HTTP request headers
|
1531
|
+
|
1532
|
+
- **Content-Type**: application/json
|
1533
|
+
- **Accept**: application/json
|
1534
|
+
|
1535
|
+
|
1536
|
+
|
1537
|
+
# **test_integration**
|
1538
|
+
> String test_integration(opts)
|
1539
|
+
|
1540
|
+
Test an integration is valid
|
1541
|
+
|
1542
|
+
|
1543
|
+
|
1544
|
+
### Example
|
1545
|
+
```ruby
|
1546
|
+
# load the gem
|
1547
|
+
require 'subskribe_sandbox'
|
1548
|
+
# setup authorization
|
1549
|
+
SubskribeSandboxClient.configure do |config|
|
1550
|
+
# Configure API key authorization: ApiKeyAuth
|
1551
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1552
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1553
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1554
|
+
end
|
1555
|
+
|
1556
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1557
|
+
|
1558
|
+
opts = {
|
1559
|
+
body: SubskribeSandboxClient::AnrokIntegrationInput.new # AnrokIntegrationInput | Integration input as a JSON
|
1560
|
+
}
|
1561
|
+
|
1562
|
+
begin
|
1563
|
+
#Test an integration is valid
|
1564
|
+
result = api_instance.test_integration(opts)
|
1565
|
+
p result
|
1566
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1567
|
+
puts "Exception when calling IntegrationsApi->test_integration: #{e}"
|
1568
|
+
end
|
1569
|
+
```
|
1570
|
+
|
1571
|
+
### Parameters
|
1572
|
+
|
1573
|
+
Name | Type | Description | Notes
|
1574
|
+
------------- | ------------- | ------------- | -------------
|
1575
|
+
**body** | [**AnrokIntegrationInput**](AnrokIntegrationInput.md)| Integration input as a JSON | [optional]
|
1576
|
+
|
1577
|
+
### Return type
|
1578
|
+
|
1579
|
+
**String**
|
1580
|
+
|
1581
|
+
### Authorization
|
1582
|
+
|
1583
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1584
|
+
|
1585
|
+
### HTTP request headers
|
1586
|
+
|
1587
|
+
- **Content-Type**: application/json
|
1588
|
+
- **Accept**: application/json
|
1589
|
+
|
1590
|
+
|
1591
|
+
|
1592
|
+
# **test_integration1**
|
1593
|
+
> String test_integration1(opts)
|
1594
|
+
|
1595
|
+
Test an integration is valid
|
1596
|
+
|
1597
|
+
|
1598
|
+
|
1599
|
+
### Example
|
1600
|
+
```ruby
|
1601
|
+
# load the gem
|
1602
|
+
require 'subskribe_sandbox'
|
1603
|
+
# setup authorization
|
1604
|
+
SubskribeSandboxClient.configure do |config|
|
1605
|
+
# Configure API key authorization: ApiKeyAuth
|
1606
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1607
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1608
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1609
|
+
end
|
1610
|
+
|
1611
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1612
|
+
|
1613
|
+
opts = {
|
1614
|
+
body: SubskribeSandboxClient::TaxJarIntegrationInput.new # TaxJarIntegrationInput | Integration input as a JSON
|
1615
|
+
}
|
1616
|
+
|
1617
|
+
begin
|
1618
|
+
#Test an integration is valid
|
1619
|
+
result = api_instance.test_integration1(opts)
|
1620
|
+
p result
|
1621
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1622
|
+
puts "Exception when calling IntegrationsApi->test_integration1: #{e}"
|
1623
|
+
end
|
1624
|
+
```
|
1625
|
+
|
1626
|
+
### Parameters
|
1627
|
+
|
1628
|
+
Name | Type | Description | Notes
|
1629
|
+
------------- | ------------- | ------------- | -------------
|
1630
|
+
**body** | [**TaxJarIntegrationInput**](TaxJarIntegrationInput.md)| Integration input as a JSON | [optional]
|
1631
|
+
|
1632
|
+
### Return type
|
1633
|
+
|
1634
|
+
**String**
|
1635
|
+
|
1636
|
+
### Authorization
|
1637
|
+
|
1638
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1639
|
+
|
1640
|
+
### HTTP request headers
|
1641
|
+
|
1642
|
+
- **Content-Type**: application/json
|
1643
|
+
- **Accept**: application/json
|
1644
|
+
|
1645
|
+
|
1646
|
+
|
1647
|
+
# **update_primary_order_id_for_opportunity**
|
1648
|
+
> OrderJson update_primary_order_id_for_opportunity(id)
|
1649
|
+
|
1650
|
+
Make an order primary
|
1651
|
+
|
1652
|
+
Marks an order as the primary order for its opportunity.
|
1653
|
+
|
1654
|
+
### Example
|
1655
|
+
```ruby
|
1656
|
+
# load the gem
|
1657
|
+
require 'subskribe_sandbox'
|
1658
|
+
# setup authorization
|
1659
|
+
SubskribeSandboxClient.configure do |config|
|
1660
|
+
# Configure API key authorization: ApiKeyAuth
|
1661
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1662
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1663
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1664
|
+
end
|
1665
|
+
|
1666
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1667
|
+
|
1668
|
+
id = 'id_example' # String | order id
|
1669
|
+
|
1670
|
+
|
1671
|
+
begin
|
1672
|
+
#Make an order primary
|
1673
|
+
result = api_instance.update_primary_order_id_for_opportunity(id)
|
1674
|
+
p result
|
1675
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1676
|
+
puts "Exception when calling IntegrationsApi->update_primary_order_id_for_opportunity: #{e}"
|
1677
|
+
end
|
1678
|
+
```
|
1679
|
+
|
1680
|
+
### Parameters
|
1681
|
+
|
1682
|
+
Name | Type | Description | Notes
|
1683
|
+
------------- | ------------- | ------------- | -------------
|
1684
|
+
**id** | **String**| order id |
|
1685
|
+
|
1686
|
+
### Return type
|
1687
|
+
|
1688
|
+
[**OrderJson**](OrderJson.md)
|
1689
|
+
|
1690
|
+
### Authorization
|
1691
|
+
|
1692
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1693
|
+
|
1694
|
+
### HTTP request headers
|
1695
|
+
|
1696
|
+
- **Content-Type**: application/json
|
1697
|
+
- **Accept**: application/json
|
1698
|
+
|
1699
|
+
|
1700
|
+
|
1701
|
+
# **verify_setup**
|
1702
|
+
> verify_setup
|
1703
|
+
|
1704
|
+
Verify HubSpot setup
|
1705
|
+
|
1706
|
+
Verify custom objects and properties
|
1707
|
+
|
1708
|
+
### Example
|
1709
|
+
```ruby
|
1710
|
+
# load the gem
|
1711
|
+
require 'subskribe_sandbox'
|
1712
|
+
# setup authorization
|
1713
|
+
SubskribeSandboxClient.configure do |config|
|
1714
|
+
# Configure API key authorization: ApiKeyAuth
|
1715
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
1716
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1717
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
1718
|
+
end
|
1719
|
+
|
1720
|
+
api_instance = SubskribeSandboxClient::IntegrationsApi.new
|
1721
|
+
|
1722
|
+
begin
|
1723
|
+
#Verify HubSpot setup
|
1724
|
+
api_instance.verify_setup
|
1725
|
+
rescue SubskribeSandboxClient::ApiError => e
|
1726
|
+
puts "Exception when calling IntegrationsApi->verify_setup: #{e}"
|
1727
|
+
end
|
1728
|
+
```
|
1729
|
+
|
1730
|
+
### Parameters
|
1731
|
+
This endpoint does not need any parameter.
|
1732
|
+
|
1733
|
+
### Return type
|
1734
|
+
|
1735
|
+
nil (empty response body)
|
1736
|
+
|
1737
|
+
### Authorization
|
1738
|
+
|
1739
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
1740
|
+
|
1741
|
+
### HTTP request headers
|
1742
|
+
|
1743
|
+
- **Content-Type**: application/json
|
1744
|
+
- **Accept**: application/json
|
1745
|
+
|
1746
|
+
|
1747
|
+
|