subskribe_dev 1.0.0 → 1.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/Gemfile +0 -1
- data/README.md +514 -24
- data/docs/AccountAddress.md +17 -0
- data/docs/AccountAddressJson.md +13 -0
- data/docs/AccountContact.md +24 -0
- data/docs/AccountContactJson.md +18 -0
- data/docs/AccountJson.md +27 -0
- data/docs/AccountPaymentMethodJson.md +13 -0
- data/docs/AccountReceivableContactJson.md +12 -0
- data/docs/AccountingApi.md +182 -0
- data/docs/AccountingEvent.md +19 -0
- data/docs/AccountingEventPaginatedResponse.md +10 -0
- data/docs/AccountingPeriod.md +22 -0
- data/docs/AccountingPeriodCalculation.md +13 -0
- data/docs/AccountsApi.md +884 -0
- data/docs/AddAndApplyPaymentApplicationJson.md +19 -0
- data/docs/AnrokIntegrationInput.md +8 -0
- data/docs/ApprovalMatrixImportDataJson.md +13 -0
- data/docs/ApprovalMatrixImportPreview.md +12 -0
- data/docs/ApprovalRoleJson.md +12 -0
- data/docs/ApprovalRoleSegmentChange.md +11 -0
- data/docs/ApprovalSegmentJson.md +12 -0
- data/docs/ApprovalsApi.md +1028 -0
- data/docs/Attachment.md +17 -0
- data/docs/AttachmentsApi.md +294 -0
- data/docs/AttributeReference.md +9 -0
- data/docs/AuthSamlIntegrationJson.md +10 -0
- data/docs/AuthenticationApi.md +329 -0
- data/docs/AutomatedInvoiceRule.md +24 -0
- data/docs/AutomatedInvoiceRuleRequestJson.md +20 -0
- data/docs/AvalaraIntegration.md +14 -0
- data/docs/AvalaraIntegrationInput.md +12 -0
- data/docs/BillingApi.md +2173 -0
- data/docs/BillingEventEntry.md +11 -0
- data/docs/BillingEventInput.md +11 -0
- data/docs/BulkInvoiceRun.md +20 -0
- data/docs/BulkInvoiceRunExclusions.md +9 -0
- data/docs/BulkInvoiceRunInput.md +13 -0
- data/docs/BulkInvoiceRunItem.md +28 -0
- data/docs/BulkInvoiceRunSelector.md +8 -0
- data/docs/BulkPaymentUploadData.md +18 -0
- data/docs/BulkPaymentUploadResult.md +10 -0
- data/docs/ByteBuffer.md +15 -0
- data/docs/CatalogRelationship.md +13 -0
- data/docs/ChargeJson.md +47 -0
- data/docs/ChargePartialJson.md +22 -0
- data/docs/CompanyContactJson.md +12 -0
- data/docs/CreditMemoApi.md +671 -0
- data/docs/CreditMemoApplicationJson.md +13 -0
- data/docs/CreditMemoBalanceJson.md +11 -0
- data/docs/CreditMemoJson.md +20 -0
- data/docs/CreditMemoLineItemJson.md +15 -0
- data/docs/CreditMemoLineItemRequestJson.md +11 -0
- data/docs/CreditMemoPaginationResponseJson.md +10 -0
- data/docs/CrmAccountImportResponse.md +9 -0
- data/docs/CustomFieldApi.md +411 -0
- data/docs/CustomFieldDefault.md +9 -0
- data/docs/CustomFieldDefinitionCreateInput.md +15 -0
- data/docs/CustomFieldDefinitionJson.md +17 -0
- data/docs/CustomFieldDefinitionUpdateInput.md +12 -0
- data/docs/CustomFieldEntry.md +17 -0
- data/docs/CustomFieldUpdateInput.md +9 -0
- data/docs/CustomFieldValue.md +16 -0
- data/docs/CustomizationApi.md +244 -0
- data/docs/DataImport.md +19 -0
- data/docs/DefaultApi.md +225 -0
- data/docs/DiscountDetailJson.md +13 -0
- data/docs/DiscountJson.md +12 -0
- data/docs/DiscountsApi.md +337 -0
- data/docs/DocuSignIntegrationRequestJson.md +10 -0
- data/docs/DocuSignIntegrationResponseJson.md +11 -0
- data/docs/DocumentCustomContent.md +11 -0
- data/docs/DocumentSection.md +13 -0
- data/docs/DocumentTemplateJson.md +15 -0
- data/docs/DunningSettingJson.md +9 -0
- data/docs/ERPApi.md +278 -0
- data/docs/EmailNotifiersList.md +10 -0
- data/docs/EntitiesApi.md +389 -0
- data/docs/Entity.md +22 -0
- data/docs/EntityApi.md +66 -0
- data/docs/EntityJson.md +21 -0
- data/docs/EntityRef.md +10 -0
- data/docs/Entry.md +10 -0
- data/docs/ExternalArrScheduleJson.md +17 -0
- data/docs/FlatfileWorkbookResponse.md +8 -0
- data/docs/FlatfileWorkbookResponseData.md +9 -0
- data/docs/ImportApi.md +589 -0
- data/docs/InputStream.md +7 -0
- data/docs/Integration.md +17 -0
- data/docs/IntegrationsApi.md +1747 -0
- data/docs/InvoiceBalanceJson.md +11 -0
- data/docs/InvoiceItemJson.md +27 -0
- data/docs/InvoiceItemPreviewJson.md +13 -0
- data/docs/InvoiceJson.md +31 -0
- data/docs/InvoiceJsonPaginationResponse.md +10 -0
- data/docs/InvoiceNumberPrefix.md +8 -0
- data/docs/InvoicePreviewJson.md +12 -0
- data/docs/LedgerAccount.md +16 -0
- data/docs/LedgerAccountMapping.md +12 -0
- data/docs/MetricsJson.md +17 -0
- data/docs/MetricsReportingApi.md +228 -0
- data/docs/NotificationTargetAndSubscriptions.md +13 -0
- data/docs/NotificationsApi.md +226 -0
- data/docs/NumberConfig.md +12 -0
- data/docs/Opportunity.md +20 -0
- data/docs/OpportunityApi.md +178 -0
- data/docs/OpportunityJson.md +20 -0
- data/docs/OpportunityPaginationResponse.md +10 -0
- data/docs/OpportunityRestJson.md +19 -0
- data/docs/OrderJson.md +59 -0
- data/docs/OrderJsonPaginationResponse.md +10 -0
- data/docs/OrderLineItemJson.md +34 -0
- data/docs/OrderLineItemRequestJson.md +24 -0
- data/docs/OrderRequestJson.md +46 -0
- data/docs/OrderTerms.md +13 -0
- data/docs/OrdersApi.md +1429 -0
- data/docs/PaginatedResponse.md +10 -0
- data/docs/PaymentBalanceJson.md +11 -0
- data/docs/PaymentConfiguration.md +8 -0
- data/docs/PaymentJson.md +16 -0
- data/docs/PaymentJsonPaginationResponse.md +10 -0
- data/docs/PaymentTermSettingsJson.md +10 -0
- data/docs/PaymentsApi.md +450 -0
- data/docs/PlanJson.md +20 -0
- data/docs/PlanJsonPaginationResponse.md +10 -0
- data/docs/PredefinedReportDefChartJson.md +17 -0
- data/docs/PredefinedReportDefJson.md +12 -0
- data/docs/PredefinedReportDefsJson.md +8 -0
- data/docs/PredefinedReportJson.md +11 -0
- data/docs/PredefinedReportParam.md +14 -0
- data/docs/PredefinedReportParamObject.md +14 -0
- data/docs/PrepaidStats.md +22 -0
- data/docs/PriceTierJson.md +10 -0
- data/docs/ProductCatalogApi.md +1866 -0
- data/docs/ProductCategory.md +14 -0
- data/docs/ProductCategoryPaginationResponse.md +10 -0
- data/docs/ProductInputJson.md +15 -0
- data/docs/ProductJson.md +18 -0
- data/docs/ProductJsonPaginationResponse.md +10 -0
- data/docs/PurchaseOrder.md +10 -0
- data/docs/RateCardApi.md +56 -0
- data/docs/RawUsage.md +14 -0
- data/docs/RawUsagesData.md +8 -0
- data/docs/RecognitionEventCompletion.md +19 -0
- data/docs/RecognitionRule.md +20 -0
- data/docs/RecurrenceJson.md +9 -0
- data/docs/Refund.md +21 -0
- data/docs/RefundDetail.md +20 -0
- data/docs/RefundRequestJson.md +15 -0
- data/docs/RefundsApi.md +179 -0
- data/docs/ReportDuration.md +9 -0
- data/docs/ReportJobResponse.md +11 -0
- data/docs/ReportsApi.md +220 -0
- data/docs/RevenueRecognitionApi.md +495 -0
- data/docs/SalesRoomApi.md +62 -0
- data/docs/SalesforceAccount.md +13 -0
- data/docs/SalesforceAccountBillingAddress.md +12 -0
- data/docs/SalesforceClientIntegrationRequestJson.md +11 -0
- data/docs/SettingsApi.md +1127 -56
- data/docs/SettlementApplication.md +19 -0
- data/docs/StandaloneCreditMemoRequest.md +20 -0
- data/docs/SubscriptionChargeAlias.md +11 -0
- data/docs/SubscriptionChargeJson.md +23 -0
- data/docs/SubscriptionJson.md +40 -0
- data/docs/SubscriptionUpdateJson.md +16 -0
- data/docs/SubscriptionsApi.md +573 -0
- data/docs/TaxJarIntegration.md +14 -0
- data/docs/TaxJarIntegrationInput.md +9 -0
- data/docs/TaxRateJson.md +15 -0
- data/docs/TaxRatePaginationResponseJson.md +10 -0
- data/docs/TenantCreditMemoConfigurationJson.md +11 -0
- data/docs/TenantDiscountJson.md +9 -0
- data/docs/TenantDiscountLineItemJson.md +10 -0
- data/docs/TenantInvoiceConfig.md +12 -0
- data/docs/TenantJson.md +19 -0
- data/docs/TenantSettingJson.md +15 -0
- data/docs/TimeSeriesAmountJson.md +9 -0
- data/docs/TimeZone.md +11 -0
- data/docs/UnitOfMeasureJson.md +1 -1
- data/docs/UnitOfMeasurePaginationResponseJson.md +1 -1
- data/docs/UpdateInvoiceRequest.md +13 -0
- data/docs/UsageAggregateOutput.md +16 -0
- data/docs/UsageApi.md +611 -0
- data/docs/UsageBatchInsertResult.md +11 -0
- data/docs/UserGroupJson.md +12 -0
- data/docs/UserGroupRequestJson.md +12 -0
- data/docs/UserInput.md +16 -0
- data/docs/UserJson.md +22 -0
- data/docs/UserPaginationResponseJson.md +10 -0
- data/docs/UsersApi.md +774 -0
- data/docs/VoidInvoiceRequest.md +9 -0
- data/docs/VoidPaymentJson.md +12 -0
- data/lib/subskribe_dev/api/accounting_api.rb +193 -0
- data/lib/subskribe_dev/api/accounts_api.rb +858 -0
- data/lib/subskribe_dev/api/approvals_api.rb +965 -0
- data/lib/subskribe_dev/api/attachments_api.rb +299 -0
- data/lib/subskribe_dev/api/authentication_api.rb +335 -0
- data/lib/subskribe_dev/api/billing_api.rb +2098 -0
- data/lib/subskribe_dev/api/credit_memo_api.rb +636 -0
- data/lib/subskribe_dev/api/custom_field_api.rb +434 -0
- data/lib/subskribe_dev/api/customization_api.rb +269 -0
- data/lib/subskribe_dev/api/default_api.rb +223 -0
- data/lib/{swagger_client/api/settings_api.rb → subskribe_dev/api/discounts_api.rb} +133 -126
- data/lib/subskribe_dev/api/entities_api.rb +374 -0
- data/lib/subskribe_dev/api/entity_api.rb +79 -0
- data/lib/subskribe_dev/api/erp_api.rb +278 -0
- data/lib/subskribe_dev/api/import_api.rb +568 -0
- data/lib/subskribe_dev/api/integrations_api.rb +1678 -0
- data/lib/subskribe_dev/api/metrics_reporting_api.rb +223 -0
- data/lib/subskribe_dev/api/notifications_api.rb +245 -0
- data/lib/subskribe_dev/api/opportunity_api.rb +177 -0
- data/lib/subskribe_dev/api/orders_api.rb +1381 -0
- data/lib/subskribe_dev/api/payments_api.rb +431 -0
- data/lib/subskribe_dev/api/product_catalog_api.rb +1828 -0
- data/lib/subskribe_dev/api/rate_card_api.rb +68 -0
- data/lib/subskribe_dev/api/refunds_api.rb +189 -0
- data/lib/subskribe_dev/api/reports_api.rb +227 -0
- data/lib/subskribe_dev/api/revenue_recognition_api.rb +484 -0
- data/lib/subskribe_dev/api/sales_room_api.rb +74 -0
- data/lib/subskribe_dev/api/settings_api.rb +1321 -0
- data/lib/subskribe_dev/api/subscriptions_api.rb +576 -0
- data/lib/subskribe_dev/api/usage_api.rb +604 -0
- data/lib/subskribe_dev/api/users_api.rb +728 -0
- data/lib/{swagger_client → subskribe_dev}/api_client.rb +2 -2
- data/lib/{swagger_client → subskribe_dev}/api_error.rb +1 -1
- data/lib/{swagger_client → subskribe_dev}/configuration.rb +1 -1
- data/lib/subskribe_dev/models/account_address.rb +265 -0
- data/lib/subskribe_dev/models/account_address_json.rb +229 -0
- data/lib/subskribe_dev/models/account_contact.rb +530 -0
- data/lib/subskribe_dev/models/account_contact_json.rb +274 -0
- data/lib/subskribe_dev/models/account_json.rb +395 -0
- data/lib/subskribe_dev/models/account_payment_method_json.rb +268 -0
- data/lib/subskribe_dev/models/account_receivable_contact_json.rb +225 -0
- data/lib/subskribe_dev/models/accounting_event.rb +319 -0
- data/lib/subskribe_dev/models/accounting_event_paginated_response.rb +204 -0
- data/lib/subskribe_dev/models/accounting_period.rb +356 -0
- data/lib/subskribe_dev/models/accounting_period_calculation.rb +229 -0
- data/lib/subskribe_dev/models/add_and_apply_payment_application_json.rb +344 -0
- data/lib/subskribe_dev/models/anrok_integration_input.rb +184 -0
- data/lib/subskribe_dev/models/approval_matrix_import_data_json.rb +229 -0
- data/lib/subskribe_dev/models/approval_matrix_import_preview.rb +226 -0
- data/lib/subskribe_dev/models/approval_role_json.rb +220 -0
- data/lib/subskribe_dev/models/approval_role_segment_change.rb +211 -0
- data/lib/subskribe_dev/models/approval_segment_json.rb +220 -0
- data/lib/subskribe_dev/models/attachment.rb +326 -0
- data/lib/subskribe_dev/models/attribute_reference.rb +193 -0
- data/lib/subskribe_dev/models/auth_saml_integration_json.rb +204 -0
- data/lib/subskribe_dev/models/automated_invoice_rule.rb +328 -0
- data/lib/subskribe_dev/models/automated_invoice_rule_request_json.rb +307 -0
- data/lib/subskribe_dev/models/avalara_integration.rb +238 -0
- data/lib/subskribe_dev/models/avalara_integration_input.rb +268 -0
- data/lib/subskribe_dev/models/billing_event_entry.rb +211 -0
- data/lib/subskribe_dev/models/billing_event_input.rb +216 -0
- data/lib/subskribe_dev/models/bulk_invoice_run.rb +350 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_exclusions.rb +197 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_input.rb +263 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_item.rb +364 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_selector.rb +184 -0
- data/lib/subskribe_dev/models/bulk_payment_upload_data.rb +274 -0
- data/lib/subskribe_dev/models/bulk_payment_upload_result.rb +204 -0
- data/lib/subskribe_dev/models/byte_buffer.rb +247 -0
- data/lib/subskribe_dev/models/catalog_relationship.rb +364 -0
- data/lib/subskribe_dev/models/charge_json.rb +631 -0
- data/lib/subskribe_dev/models/charge_partial_json.rb +310 -0
- data/lib/subskribe_dev/models/company_contact_json.rb +225 -0
- data/lib/subskribe_dev/models/credit_memo_application_json.rb +239 -0
- data/lib/subskribe_dev/models/credit_memo_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/credit_memo_json.rb +363 -0
- data/lib/subskribe_dev/models/credit_memo_line_item_json.rb +252 -0
- data/lib/subskribe_dev/models/credit_memo_line_item_request_json.rb +211 -0
- data/lib/subskribe_dev/models/credit_memo_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/crm_account_import_response.rb +193 -0
- data/lib/subskribe_dev/models/custom_field_default.rb +195 -0
- data/lib/subskribe_dev/models/custom_field_definition_create_input.rb +317 -0
- data/lib/subskribe_dev/models/custom_field_definition_json.rb +313 -0
- data/lib/subskribe_dev/models/custom_field_definition_update_input.rb +256 -0
- data/lib/subskribe_dev/models/custom_field_entry.rb +325 -0
- data/lib/subskribe_dev/models/custom_field_update_input.rb +195 -0
- data/lib/subskribe_dev/models/custom_field_value.rb +316 -0
- data/lib/subskribe_dev/models/data_import.rb +355 -0
- data/lib/subskribe_dev/models/discount_detail_json.rb +263 -0
- data/lib/subskribe_dev/models/discount_json.rb +254 -0
- data/lib/subskribe_dev/models/docu_sign_integration_request_json.rb +236 -0
- data/lib/subskribe_dev/models/docu_sign_integration_response_json.rb +245 -0
- data/lib/subskribe_dev/models/document_custom_content.rb +211 -0
- data/lib/subskribe_dev/models/document_section.rb +265 -0
- data/lib/subskribe_dev/models/document_template_json.rb +300 -0
- data/lib/subskribe_dev/models/dunning_setting_json.rb +200 -0
- data/lib/subskribe_dev/models/email_notifiers_list.rb +208 -0
- data/lib/subskribe_dev/models/entity.rb +356 -0
- data/lib/subskribe_dev/models/entity_json.rb +347 -0
- data/lib/subskribe_dev/models/entity_ref.rb +202 -0
- data/lib/subskribe_dev/models/entry.rb +202 -0
- data/lib/subskribe_dev/models/external_arr_schedule_json.rb +319 -0
- data/lib/subskribe_dev/models/flatfile_workbook_response.rb +184 -0
- data/lib/subskribe_dev/models/flatfile_workbook_response_data.rb +193 -0
- data/lib/subskribe_dev/models/input_stream.rb +175 -0
- data/lib/subskribe_dev/models/integration.rb +311 -0
- data/lib/subskribe_dev/models/invoice_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/invoice_item_json.rb +355 -0
- data/lib/subskribe_dev/models/invoice_item_preview_json.rb +229 -0
- data/lib/subskribe_dev/models/invoice_json.rb +439 -0
- data/lib/subskribe_dev/models/invoice_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/invoice_number_prefix.rb +184 -0
- data/lib/subskribe_dev/models/invoice_preview_json.rb +222 -0
- data/lib/subskribe_dev/models/ledger_account.rb +316 -0
- data/lib/subskribe_dev/models/ledger_account_mapping.rb +222 -0
- data/lib/subskribe_dev/models/metrics_json.rb +267 -0
- data/lib/subskribe_dev/models/notification_target_and_subscriptions.rb +265 -0
- data/lib/subskribe_dev/models/number_config.rb +254 -0
- data/lib/subskribe_dev/models/opportunity.rb +326 -0
- data/lib/subskribe_dev/models/opportunity_json.rb +326 -0
- data/lib/subskribe_dev/models/opportunity_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/opportunity_rest_json.rb +317 -0
- data/lib/subskribe_dev/models/order_json.rb +754 -0
- data/lib/subskribe_dev/models/order_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/order_line_item_json.rb +465 -0
- data/lib/subskribe_dev/models/order_line_item_request_json.rb +375 -0
- data/lib/subskribe_dev/models/order_request_json.rb +616 -0
- data/lib/subskribe_dev/models/order_terms.rb +265 -0
- data/lib/subskribe_dev/models/paginated_response.rb +204 -0
- data/lib/subskribe_dev/models/payment_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/payment_configuration.rb +208 -0
- data/lib/subskribe_dev/models/payment_json.rb +300 -0
- data/lib/subskribe_dev/models/payment_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/payment_term_settings_json.rb +219 -0
- data/lib/subskribe_dev/models/plan_json.rb +339 -0
- data/lib/subskribe_dev/models/plan_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/predefined_report_def_chart_json.rb +265 -0
- data/lib/subskribe_dev/models/predefined_report_def_json.rb +222 -0
- data/lib/subskribe_dev/models/predefined_report_defs_json.rb +186 -0
- data/lib/subskribe_dev/models/predefined_report_json.rb +213 -0
- data/lib/subskribe_dev/models/predefined_report_param.rb +296 -0
- data/lib/subskribe_dev/models/predefined_report_param_object.rb +296 -0
- data/lib/subskribe_dev/models/prepaid_stats.rb +310 -0
- data/lib/subskribe_dev/models/price_tier_json.rb +212 -0
- data/lib/subskribe_dev/models/product_category.rb +264 -0
- data/lib/subskribe_dev/models/product_category_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/product_input_json.rb +249 -0
- data/lib/subskribe_dev/models/product_json.rb +276 -0
- data/lib/subskribe_dev/models/product_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/purchase_order.rb +226 -0
- data/lib/subskribe_dev/models/raw_usage.rb +247 -0
- data/lib/subskribe_dev/models/raw_usages_data.rb +192 -0
- data/lib/subskribe_dev/models/recognition_event_completion.rb +322 -0
- data/lib/subskribe_dev/models/recognition_rule.rb +376 -0
- data/lib/subskribe_dev/models/recurrence_json.rb +256 -0
- data/lib/subskribe_dev/models/refund.rb +301 -0
- data/lib/subskribe_dev/models/refund_detail.rb +322 -0
- data/lib/subskribe_dev/models/refund_request_json.rb +272 -0
- data/lib/subskribe_dev/models/report_duration.rb +193 -0
- data/lib/subskribe_dev/models/report_job_response.rb +245 -0
- data/lib/subskribe_dev/models/salesforce_account.rb +229 -0
- data/lib/subskribe_dev/models/salesforce_account_billing_address.rb +220 -0
- data/lib/subskribe_dev/models/salesforce_client_integration_request_json.rb +211 -0
- data/lib/subskribe_dev/models/settlement_application.rb +329 -0
- data/lib/subskribe_dev/models/standalone_credit_memo_request.rb +353 -0
- data/lib/subskribe_dev/models/subscription_charge_alias.rb +283 -0
- data/lib/subskribe_dev/models/subscription_charge_json.rb +362 -0
- data/lib/subskribe_dev/models/subscription_json.rb +583 -0
- data/lib/subskribe_dev/models/subscription_update_json.rb +280 -0
- data/lib/subskribe_dev/models/tax_jar_integration.rb +238 -0
- data/lib/subskribe_dev/models/tax_jar_integration_input.rb +193 -0
- data/lib/subskribe_dev/models/tax_rate_json.rb +286 -0
- data/lib/subskribe_dev/models/tax_rate_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/tenant_credit_memo_configuration_json.rb +211 -0
- data/lib/subskribe_dev/models/tenant_discount_json.rb +193 -0
- data/lib/subskribe_dev/models/tenant_discount_line_item_json.rb +202 -0
- data/lib/subskribe_dev/models/tenant_invoice_config.rb +254 -0
- data/lib/subskribe_dev/models/tenant_json.rb +283 -0
- data/lib/subskribe_dev/models/tenant_setting_json.rb +307 -0
- data/lib/subskribe_dev/models/time_series_amount_json.rb +193 -0
- data/lib/subskribe_dev/models/time_zone.rb +211 -0
- data/lib/{swagger_client → subskribe_dev}/models/unit_of_measure_json.rb +2 -2
- data/lib/{swagger_client → subskribe_dev}/models/unit_of_measure_pagination_response_json.rb +2 -2
- data/lib/subskribe_dev/models/update_invoice_request.rb +282 -0
- data/lib/subskribe_dev/models/usage_aggregate_output.rb +258 -0
- data/lib/subskribe_dev/models/usage_batch_insert_result.rb +213 -0
- data/lib/subskribe_dev/models/user_group_json.rb +224 -0
- data/lib/subskribe_dev/models/user_group_request_json.rb +224 -0
- data/lib/subskribe_dev/models/user_input.rb +304 -0
- data/lib/subskribe_dev/models/user_json.rb +376 -0
- data/lib/subskribe_dev/models/user_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/void_invoice_request.rb +203 -0
- data/lib/subskribe_dev/models/void_payment_json.rb +235 -0
- data/lib/{swagger_client → subskribe_dev}/version.rb +2 -2
- data/lib/subskribe_dev.rb +229 -0
- data/spec/api/accounting_api_spec.rb +74 -0
- data/spec/api/accounts_api_spec.rb +232 -0
- data/spec/api/approvals_api_spec.rb +260 -0
- data/spec/api/attachments_api_spec.rb +100 -0
- data/spec/api/authentication_api_spec.rb +108 -0
- data/spec/api/billing_api_spec.rb +516 -0
- data/spec/api/credit_memo_api_spec.rb +181 -0
- data/spec/api/custom_field_api_spec.rb +126 -0
- data/spec/api/customization_api_spec.rb +89 -0
- data/spec/api/default_api_spec.rb +81 -0
- data/spec/api/discounts_api_spec.rb +108 -0
- data/spec/api/entities_api_spec.rb +120 -0
- data/spec/api/entity_api_spec.rb +48 -0
- data/spec/api/erp_api_spec.rb +95 -0
- data/spec/api/import_api_spec.rb +164 -0
- data/spec/api/integrations_api_spec.rb +420 -0
- data/spec/api/metrics_reporting_api_spec.rb +84 -0
- data/spec/api/notifications_api_spec.rb +84 -0
- data/spec/api/opportunity_api_spec.rb +72 -0
- data/spec/api/orders_api_spec.rb +351 -0
- data/spec/api/payments_api_spec.rb +132 -0
- data/spec/api/product_catalog_api_spec.rb +448 -0
- data/spec/api/rate_card_api_spec.rb +46 -0
- data/spec/api/refunds_api_spec.rb +73 -0
- data/spec/api/reports_api_spec.rb +82 -0
- data/spec/api/revenue_recognition_api_spec.rb +144 -0
- data/spec/api/sales_room_api_spec.rb +47 -0
- data/spec/api/settings_api_spec.rb +3 -3
- data/spec/api/subscriptions_api_spec.rb +162 -0
- data/spec/api/usage_api_spec.rb +169 -0
- data/spec/api/users_api_spec.rb +203 -0
- data/spec/api_client_spec.rb +31 -31
- data/spec/configuration_spec.rb +3 -3
- data/spec/models/account_address_json_spec.rb +71 -0
- data/spec/models/account_address_spec.rb +95 -0
- data/spec/models/account_contact_json_spec.rb +101 -0
- data/spec/models/account_contact_spec.rb +141 -0
- data/spec/models/account_json_spec.rb +163 -0
- data/spec/models/account_payment_method_json_spec.rb +75 -0
- data/spec/models/account_receivable_contact_json_spec.rb +65 -0
- data/spec/models/accounting_event_paginated_response_spec.rb +53 -0
- data/spec/models/accounting_event_spec.rb +111 -0
- data/spec/models/accounting_period_calculation_spec.rb +71 -0
- data/spec/models/accounting_period_spec.rb +133 -0
- data/spec/models/add_and_apply_payment_application_json_spec.rb +115 -0
- data/spec/models/anrok_integration_input_spec.rb +41 -0
- data/spec/models/approval_matrix_import_data_json_spec.rb +71 -0
- data/spec/models/approval_matrix_import_preview_spec.rb +65 -0
- data/spec/models/approval_role_json_spec.rb +65 -0
- data/spec/models/approval_role_segment_change_spec.rb +59 -0
- data/spec/models/approval_segment_json_spec.rb +65 -0
- data/spec/models/attachment_spec.rb +103 -0
- data/spec/models/attribute_reference_spec.rb +47 -0
- data/spec/models/auth_saml_integration_json_spec.rb +53 -0
- data/spec/models/automated_invoice_rule_request_json_spec.rb +113 -0
- data/spec/models/automated_invoice_rule_spec.rb +137 -0
- data/spec/models/avalara_integration_input_spec.rb +65 -0
- data/spec/models/avalara_integration_spec.rb +77 -0
- data/spec/models/billing_event_entry_spec.rb +59 -0
- data/spec/models/billing_event_input_spec.rb +59 -0
- data/spec/models/bulk_invoice_run_exclusions_spec.rb +47 -0
- data/spec/models/bulk_invoice_run_input_spec.rb +75 -0
- data/spec/models/bulk_invoice_run_item_spec.rb +161 -0
- data/spec/models/bulk_invoice_run_selector_spec.rb +41 -0
- data/spec/models/bulk_invoice_run_spec.rb +125 -0
- data/spec/models/bulk_payment_upload_data_spec.rb +101 -0
- data/spec/models/bulk_payment_upload_result_spec.rb +53 -0
- data/spec/models/byte_buffer_spec.rb +83 -0
- data/spec/models/catalog_relationship_spec.rb +75 -0
- data/spec/models/charge_json_spec.rb +295 -0
- data/spec/models/charge_partial_json_spec.rb +125 -0
- data/spec/models/company_contact_json_spec.rb +65 -0
- data/spec/models/credit_memo_application_json_spec.rb +71 -0
- data/spec/models/credit_memo_balance_json_spec.rb +59 -0
- data/spec/models/credit_memo_json_spec.rb +117 -0
- data/spec/models/credit_memo_line_item_json_spec.rb +83 -0
- data/spec/models/credit_memo_line_item_request_json_spec.rb +59 -0
- data/spec/models/credit_memo_pagination_response_json_spec.rb +53 -0
- data/spec/models/crm_account_import_response_spec.rb +47 -0
- data/spec/models/custom_field_default_spec.rb +47 -0
- data/spec/models/custom_field_definition_create_input_spec.rb +95 -0
- data/spec/models/custom_field_definition_json_spec.rb +103 -0
- data/spec/models/custom_field_definition_update_input_spec.rb +69 -0
- data/spec/models/custom_field_entry_spec.rb +103 -0
- data/spec/models/custom_field_update_input_spec.rb +47 -0
- data/spec/models/custom_field_value_spec.rb +97 -0
- data/spec/models/data_import_spec.rb +123 -0
- data/spec/models/discount_detail_json_spec.rb +75 -0
- data/spec/models/discount_json_spec.rb +69 -0
- data/spec/models/docu_sign_integration_request_json_spec.rb +57 -0
- data/spec/models/docu_sign_integration_response_json_spec.rb +63 -0
- data/spec/models/document_custom_content_spec.rb +59 -0
- data/spec/models/document_section_spec.rb +75 -0
- data/spec/models/document_template_json_spec.rb +91 -0
- data/spec/models/dunning_setting_json_spec.rb +47 -0
- data/spec/models/email_notifiers_list_spec.rb +53 -0
- data/spec/models/entity_json_spec.rb +127 -0
- data/spec/models/entity_ref_spec.rb +53 -0
- data/spec/models/entity_spec.rb +133 -0
- data/spec/models/entry_spec.rb +53 -0
- data/spec/models/external_arr_schedule_json_spec.rb +99 -0
- data/spec/models/flatfile_workbook_response_data_spec.rb +47 -0
- data/spec/models/flatfile_workbook_response_spec.rb +41 -0
- data/spec/models/input_stream_spec.rb +35 -0
- data/spec/models/integration_spec.rb +103 -0
- data/spec/models/invoice_balance_json_spec.rb +59 -0
- data/spec/models/invoice_item_json_spec.rb +155 -0
- data/spec/models/invoice_item_preview_json_spec.rb +71 -0
- data/spec/models/invoice_json_pagination_response_spec.rb +53 -0
- data/spec/models/invoice_json_spec.rb +187 -0
- data/spec/models/invoice_number_prefix_spec.rb +41 -0
- data/spec/models/invoice_preview_json_spec.rb +65 -0
- data/spec/models/ledger_account_mapping_spec.rb +65 -0
- data/spec/models/ledger_account_spec.rb +93 -0
- data/spec/models/metrics_json_spec.rb +95 -0
- data/spec/models/notification_target_and_subscriptions_spec.rb +79 -0
- data/spec/models/number_config_spec.rb +69 -0
- data/spec/models/opportunity_json_spec.rb +117 -0
- data/spec/models/opportunity_pagination_response_spec.rb +53 -0
- data/spec/models/opportunity_rest_json_spec.rb +111 -0
- data/spec/models/opportunity_spec.rb +117 -0
- data/spec/models/order_json_pagination_response_spec.rb +53 -0
- data/spec/models/order_json_spec.rb +367 -0
- data/spec/models/order_line_item_json_spec.rb +201 -0
- data/spec/models/order_line_item_request_json_spec.rb +141 -0
- data/spec/models/order_request_json_spec.rb +285 -0
- data/spec/models/order_terms_spec.rb +75 -0
- data/spec/models/paginated_response_spec.rb +53 -0
- data/spec/models/payment_balance_json_spec.rb +59 -0
- data/spec/models/payment_configuration_spec.rb +45 -0
- data/spec/models/payment_json_pagination_response_spec.rb +53 -0
- data/spec/models/payment_json_spec.rb +93 -0
- data/spec/models/payment_term_settings_json_spec.rb +53 -0
- data/spec/models/plan_json_pagination_response_spec.rb +53 -0
- data/spec/models/plan_json_spec.rb +117 -0
- data/spec/models/predefined_report_def_chart_json_spec.rb +95 -0
- data/spec/models/predefined_report_def_json_spec.rb +65 -0
- data/spec/models/predefined_report_defs_json_spec.rb +41 -0
- data/spec/models/predefined_report_json_spec.rb +59 -0
- data/spec/models/predefined_report_param_object_spec.rb +85 -0
- data/spec/models/predefined_report_param_spec.rb +85 -0
- data/spec/models/prepaid_stats_spec.rb +125 -0
- data/spec/models/price_tier_json_spec.rb +53 -0
- data/spec/models/product_category_pagination_response_spec.rb +53 -0
- data/spec/models/product_category_spec.rb +77 -0
- data/spec/models/product_input_json_spec.rb +83 -0
- data/spec/models/product_json_pagination_response_spec.rb +53 -0
- data/spec/models/product_json_spec.rb +101 -0
- data/spec/models/purchase_order_spec.rb +53 -0
- data/spec/models/raw_usage_spec.rb +77 -0
- data/spec/models/raw_usages_data_spec.rb +41 -0
- data/spec/models/recognition_event_completion_spec.rb +111 -0
- data/spec/models/recognition_rule_spec.rb +133 -0
- data/spec/models/recurrence_json_spec.rb +51 -0
- data/spec/models/refund_detail_spec.rb +113 -0
- data/spec/models/refund_request_json_spec.rb +83 -0
- data/spec/models/refund_spec.rb +119 -0
- data/spec/models/report_duration_spec.rb +47 -0
- data/spec/models/report_job_response_spec.rb +63 -0
- data/spec/models/salesforce_account_billing_address_spec.rb +65 -0
- data/spec/models/salesforce_account_spec.rb +71 -0
- data/spec/models/salesforce_client_integration_request_json_spec.rb +59 -0
- data/spec/models/settlement_application_spec.rb +115 -0
- data/spec/models/standalone_credit_memo_request_spec.rb +117 -0
- data/spec/models/subscription_charge_alias_spec.rb +59 -0
- data/spec/models/subscription_charge_json_spec.rb +131 -0
- data/spec/models/subscription_json_spec.rb +241 -0
- data/spec/models/subscription_update_json_spec.rb +89 -0
- data/spec/models/tax_jar_integration_input_spec.rb +47 -0
- data/spec/models/tax_jar_integration_spec.rb +77 -0
- data/spec/models/tax_rate_json_spec.rb +87 -0
- data/spec/models/tax_rate_pagination_response_json_spec.rb +53 -0
- data/spec/models/tenant_credit_memo_configuration_json_spec.rb +59 -0
- data/spec/models/tenant_discount_json_spec.rb +47 -0
- data/spec/models/tenant_discount_line_item_json_spec.rb +53 -0
- data/spec/models/tenant_invoice_config_spec.rb +69 -0
- data/spec/models/tenant_json_spec.rb +107 -0
- data/spec/models/tenant_setting_json_spec.rb +95 -0
- data/spec/models/time_series_amount_json_spec.rb +47 -0
- data/spec/models/time_zone_spec.rb +59 -0
- data/spec/models/unit_of_measure_json_spec.rb +3 -3
- data/spec/models/unit_of_measure_pagination_response_json_spec.rb +3 -3
- data/spec/models/update_invoice_request_spec.rb +71 -0
- data/spec/models/usage_aggregate_output_spec.rb +89 -0
- data/spec/models/usage_batch_insert_result_spec.rb +59 -0
- data/spec/models/user_group_json_spec.rb +65 -0
- data/spec/models/user_group_request_json_spec.rb +65 -0
- data/spec/models/user_input_spec.rb +97 -0
- data/spec/models/user_json_spec.rb +137 -0
- data/spec/models/user_pagination_response_json_spec.rb +53 -0
- data/spec/models/void_invoice_request_spec.rb +47 -0
- data/spec/models/void_payment_json_spec.rb +65 -0
- data/spec/spec_helper.rb +1 -1
- data/{swagger_client.gemspec → subskribe_dev.gemspec} +6 -6
- metadata +762 -16
- data/lib/swagger_client.rb +0 -42
- data/swagger_client-1.0.0.gem +0 -0
- data/test1.rb +0 -24
data/docs/AccountsApi.md
ADDED
@@ -0,0 +1,884 @@
|
|
1
|
+
# SubskribeDevClient::AccountsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.dev2.subskribe.net*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**add_account**](AccountsApi.md#add_account) | **POST** /accounts | Add a new account
|
8
|
+
[**add_account_contact**](AccountsApi.md#add_account_contact) | **POST** /accounts/{accountId}/contacts | Add a contact for an account
|
9
|
+
[**add_account_payment_method**](AccountsApi.md#add_account_payment_method) | **POST** /accounts/{accountId}/paymentMethods | Add a payment method to an account
|
10
|
+
[**delete_account**](AccountsApi.md#delete_account) | **DELETE** /accounts/{id} | Delete an account
|
11
|
+
[**delete_account_contact**](AccountsApi.md#delete_account_contact) | **DELETE** /accounts/{accountId}/contacts/{contactId} | Delete a contact
|
12
|
+
[**get_account**](AccountsApi.md#get_account) | **GET** /accounts/{id} | Get an account by id
|
13
|
+
[**get_account_contact**](AccountsApi.md#get_account_contact) | **GET** /accounts/{accountId}/contacts/{contactId} | Gets contact details
|
14
|
+
[**get_account_contacts**](AccountsApi.md#get_account_contacts) | **GET** /accounts/{accountId}/contacts | Get contacts for an account
|
15
|
+
[**get_account_metrics**](AccountsApi.md#get_account_metrics) | **GET** /accounts/{id}/metrics | Returns metrics for the specified account
|
16
|
+
[**get_account_payment_methods**](AccountsApi.md#get_account_payment_methods) | **GET** /accounts/{accountId}/paymentMethods | Get the payment methods for an account
|
17
|
+
[**get_accounts**](AccountsApi.md#get_accounts) | **GET** /accounts | Get all accounts
|
18
|
+
[**get_payment_method**](AccountsApi.md#get_payment_method) | **GET** /accounts/{accountId}/paymentMethods/{id} | Get the details of a payment method
|
19
|
+
[**import_crm_account**](AccountsApi.md#import_crm_account) | **POST** /accounts/crm/import | Import an account from a CRM
|
20
|
+
[**update_account**](AccountsApi.md#update_account) | **PUT** /accounts/{id} | Update an account
|
21
|
+
[**update_account_contact**](AccountsApi.md#update_account_contact) | **PUT** /accounts/{accountId}/contacts/{contactId} | Update a contact
|
22
|
+
|
23
|
+
|
24
|
+
# **add_account**
|
25
|
+
> AccountJson add_account(opts)
|
26
|
+
|
27
|
+
Add a new account
|
28
|
+
|
29
|
+
Create an account with the specified parameters. On success, the id of the newly created account is returned
|
30
|
+
|
31
|
+
### Example
|
32
|
+
```ruby
|
33
|
+
# load the gem
|
34
|
+
require 'subskribe_dev'
|
35
|
+
# setup authorization
|
36
|
+
SubskribeDevClient.configure do |config|
|
37
|
+
# Configure API key authorization: ApiKeyAuth
|
38
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
39
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
40
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
41
|
+
end
|
42
|
+
|
43
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
44
|
+
|
45
|
+
opts = {
|
46
|
+
body: SubskribeDevClient::AccountJson.new # AccountJson |
|
47
|
+
}
|
48
|
+
|
49
|
+
begin
|
50
|
+
#Add a new account
|
51
|
+
result = api_instance.add_account(opts)
|
52
|
+
p result
|
53
|
+
rescue SubskribeDevClient::ApiError => e
|
54
|
+
puts "Exception when calling AccountsApi->add_account: #{e}"
|
55
|
+
end
|
56
|
+
```
|
57
|
+
|
58
|
+
### Parameters
|
59
|
+
|
60
|
+
Name | Type | Description | Notes
|
61
|
+
------------- | ------------- | ------------- | -------------
|
62
|
+
**body** | [**AccountJson**](AccountJson.md)| | [optional]
|
63
|
+
|
64
|
+
### Return type
|
65
|
+
|
66
|
+
[**AccountJson**](AccountJson.md)
|
67
|
+
|
68
|
+
### Authorization
|
69
|
+
|
70
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
71
|
+
|
72
|
+
### HTTP request headers
|
73
|
+
|
74
|
+
- **Content-Type**: application/json
|
75
|
+
- **Accept**: application/json
|
76
|
+
|
77
|
+
|
78
|
+
|
79
|
+
# **add_account_contact**
|
80
|
+
> AccountContactJson add_account_contact(account_id, opts)
|
81
|
+
|
82
|
+
Add a contact for an account
|
83
|
+
|
84
|
+
Creates and adds a new contact for the specified account and returns the new contact ID
|
85
|
+
|
86
|
+
### Example
|
87
|
+
```ruby
|
88
|
+
# load the gem
|
89
|
+
require 'subskribe_dev'
|
90
|
+
# setup authorization
|
91
|
+
SubskribeDevClient.configure do |config|
|
92
|
+
# Configure API key authorization: ApiKeyAuth
|
93
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
94
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
95
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
96
|
+
end
|
97
|
+
|
98
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
99
|
+
|
100
|
+
account_id = 'account_id_example' # String |
|
101
|
+
|
102
|
+
opts = {
|
103
|
+
body: SubskribeDevClient::AccountContactJson.new, # AccountContactJson |
|
104
|
+
skip_address_validation: true, # BOOLEAN | value = perform basic address validation
|
105
|
+
strict_validation: true # BOOLEAN | value = require the address to match a canonical address, if it exists
|
106
|
+
}
|
107
|
+
|
108
|
+
begin
|
109
|
+
#Add a contact for an account
|
110
|
+
result = api_instance.add_account_contact(account_id, opts)
|
111
|
+
p result
|
112
|
+
rescue SubskribeDevClient::ApiError => e
|
113
|
+
puts "Exception when calling AccountsApi->add_account_contact: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
### Parameters
|
118
|
+
|
119
|
+
Name | Type | Description | Notes
|
120
|
+
------------- | ------------- | ------------- | -------------
|
121
|
+
**account_id** | **String**| |
|
122
|
+
**body** | [**AccountContactJson**](AccountContactJson.md)| | [optional]
|
123
|
+
**skip_address_validation** | **BOOLEAN**| value = perform basic address validation | [optional]
|
124
|
+
**strict_validation** | **BOOLEAN**| value = require the address to match a canonical address, if it exists | [optional]
|
125
|
+
|
126
|
+
### Return type
|
127
|
+
|
128
|
+
[**AccountContactJson**](AccountContactJson.md)
|
129
|
+
|
130
|
+
### Authorization
|
131
|
+
|
132
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
133
|
+
|
134
|
+
### HTTP request headers
|
135
|
+
|
136
|
+
- **Content-Type**: Not defined
|
137
|
+
- **Accept**: application/json
|
138
|
+
|
139
|
+
|
140
|
+
|
141
|
+
# **add_account_payment_method**
|
142
|
+
> AccountPaymentMethodJson add_account_payment_method(account_id, opts)
|
143
|
+
|
144
|
+
Add a payment method to an account
|
145
|
+
|
146
|
+
Add a payment method to the specified account and return its ID
|
147
|
+
|
148
|
+
### Example
|
149
|
+
```ruby
|
150
|
+
# load the gem
|
151
|
+
require 'subskribe_dev'
|
152
|
+
# setup authorization
|
153
|
+
SubskribeDevClient.configure do |config|
|
154
|
+
# Configure API key authorization: ApiKeyAuth
|
155
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
156
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
157
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
158
|
+
end
|
159
|
+
|
160
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
161
|
+
|
162
|
+
account_id = 'account_id_example' # String |
|
163
|
+
|
164
|
+
opts = {
|
165
|
+
body: SubskribeDevClient::AccountPaymentMethodJson.new # AccountPaymentMethodJson |
|
166
|
+
}
|
167
|
+
|
168
|
+
begin
|
169
|
+
#Add a payment method to an account
|
170
|
+
result = api_instance.add_account_payment_method(account_id, opts)
|
171
|
+
p result
|
172
|
+
rescue SubskribeDevClient::ApiError => e
|
173
|
+
puts "Exception when calling AccountsApi->add_account_payment_method: #{e}"
|
174
|
+
end
|
175
|
+
```
|
176
|
+
|
177
|
+
### Parameters
|
178
|
+
|
179
|
+
Name | Type | Description | Notes
|
180
|
+
------------- | ------------- | ------------- | -------------
|
181
|
+
**account_id** | **String**| |
|
182
|
+
**body** | [**AccountPaymentMethodJson**](AccountPaymentMethodJson.md)| | [optional]
|
183
|
+
|
184
|
+
### Return type
|
185
|
+
|
186
|
+
[**AccountPaymentMethodJson**](AccountPaymentMethodJson.md)
|
187
|
+
|
188
|
+
### Authorization
|
189
|
+
|
190
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
191
|
+
|
192
|
+
### HTTP request headers
|
193
|
+
|
194
|
+
- **Content-Type**: application/json
|
195
|
+
- **Accept**: application/json
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
# **delete_account**
|
200
|
+
> delete_account(id)
|
201
|
+
|
202
|
+
Delete an account
|
203
|
+
|
204
|
+
Deletes the account associated with the passed ID
|
205
|
+
|
206
|
+
### Example
|
207
|
+
```ruby
|
208
|
+
# load the gem
|
209
|
+
require 'subskribe_dev'
|
210
|
+
# setup authorization
|
211
|
+
SubskribeDevClient.configure do |config|
|
212
|
+
# Configure API key authorization: ApiKeyAuth
|
213
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
214
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
215
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
216
|
+
end
|
217
|
+
|
218
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
219
|
+
|
220
|
+
id = 'id_example' # String |
|
221
|
+
|
222
|
+
|
223
|
+
begin
|
224
|
+
#Delete an account
|
225
|
+
api_instance.delete_account(id)
|
226
|
+
rescue SubskribeDevClient::ApiError => e
|
227
|
+
puts "Exception when calling AccountsApi->delete_account: #{e}"
|
228
|
+
end
|
229
|
+
```
|
230
|
+
|
231
|
+
### Parameters
|
232
|
+
|
233
|
+
Name | Type | Description | Notes
|
234
|
+
------------- | ------------- | ------------- | -------------
|
235
|
+
**id** | **String**| |
|
236
|
+
|
237
|
+
### Return type
|
238
|
+
|
239
|
+
nil (empty response body)
|
240
|
+
|
241
|
+
### Authorization
|
242
|
+
|
243
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
244
|
+
|
245
|
+
### HTTP request headers
|
246
|
+
|
247
|
+
- **Content-Type**: Not defined
|
248
|
+
- **Accept**: application/json
|
249
|
+
|
250
|
+
|
251
|
+
|
252
|
+
# **delete_account_contact**
|
253
|
+
> delete_account_contact(contact_id, account_id)
|
254
|
+
|
255
|
+
Delete a contact
|
256
|
+
|
257
|
+
Deletes the contact specified by the account id and contact id
|
258
|
+
|
259
|
+
### Example
|
260
|
+
```ruby
|
261
|
+
# load the gem
|
262
|
+
require 'subskribe_dev'
|
263
|
+
# setup authorization
|
264
|
+
SubskribeDevClient.configure do |config|
|
265
|
+
# Configure API key authorization: ApiKeyAuth
|
266
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
267
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
268
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
269
|
+
end
|
270
|
+
|
271
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
272
|
+
|
273
|
+
contact_id = 'contact_id_example' # String |
|
274
|
+
|
275
|
+
account_id = 'account_id_example' # String |
|
276
|
+
|
277
|
+
|
278
|
+
begin
|
279
|
+
#Delete a contact
|
280
|
+
api_instance.delete_account_contact(contact_id, account_id)
|
281
|
+
rescue SubskribeDevClient::ApiError => e
|
282
|
+
puts "Exception when calling AccountsApi->delete_account_contact: #{e}"
|
283
|
+
end
|
284
|
+
```
|
285
|
+
|
286
|
+
### Parameters
|
287
|
+
|
288
|
+
Name | Type | Description | Notes
|
289
|
+
------------- | ------------- | ------------- | -------------
|
290
|
+
**contact_id** | **String**| |
|
291
|
+
**account_id** | **String**| |
|
292
|
+
|
293
|
+
### Return type
|
294
|
+
|
295
|
+
nil (empty response body)
|
296
|
+
|
297
|
+
### Authorization
|
298
|
+
|
299
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
300
|
+
|
301
|
+
### HTTP request headers
|
302
|
+
|
303
|
+
- **Content-Type**: Not defined
|
304
|
+
- **Accept**: application/json
|
305
|
+
|
306
|
+
|
307
|
+
|
308
|
+
# **get_account**
|
309
|
+
> AccountJson get_account(id, opts)
|
310
|
+
|
311
|
+
Get an account by id
|
312
|
+
|
313
|
+
Returns the details of the account specified by the passed id
|
314
|
+
|
315
|
+
### Example
|
316
|
+
```ruby
|
317
|
+
# load the gem
|
318
|
+
require 'subskribe_dev'
|
319
|
+
# setup authorization
|
320
|
+
SubskribeDevClient.configure do |config|
|
321
|
+
# Configure API key authorization: ApiKeyAuth
|
322
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
323
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
324
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
325
|
+
end
|
326
|
+
|
327
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
328
|
+
|
329
|
+
id = 'id_example' # String |
|
330
|
+
|
331
|
+
opts = {
|
332
|
+
id_type: 'id_type_example' # String |
|
333
|
+
}
|
334
|
+
|
335
|
+
begin
|
336
|
+
#Get an account by id
|
337
|
+
result = api_instance.get_account(id, opts)
|
338
|
+
p result
|
339
|
+
rescue SubskribeDevClient::ApiError => e
|
340
|
+
puts "Exception when calling AccountsApi->get_account: #{e}"
|
341
|
+
end
|
342
|
+
```
|
343
|
+
|
344
|
+
### Parameters
|
345
|
+
|
346
|
+
Name | Type | Description | Notes
|
347
|
+
------------- | ------------- | ------------- | -------------
|
348
|
+
**id** | **String**| |
|
349
|
+
**id_type** | **String**| | [optional]
|
350
|
+
|
351
|
+
### Return type
|
352
|
+
|
353
|
+
[**AccountJson**](AccountJson.md)
|
354
|
+
|
355
|
+
### Authorization
|
356
|
+
|
357
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
358
|
+
|
359
|
+
### HTTP request headers
|
360
|
+
|
361
|
+
- **Content-Type**: Not defined
|
362
|
+
- **Accept**: application/json
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
# **get_account_contact**
|
367
|
+
> AccountContactJson get_account_contact(account_id, contact_id)
|
368
|
+
|
369
|
+
Gets contact details
|
370
|
+
|
371
|
+
Returns the details of the specified contact
|
372
|
+
|
373
|
+
### Example
|
374
|
+
```ruby
|
375
|
+
# load the gem
|
376
|
+
require 'subskribe_dev'
|
377
|
+
# setup authorization
|
378
|
+
SubskribeDevClient.configure do |config|
|
379
|
+
# Configure API key authorization: ApiKeyAuth
|
380
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
381
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
382
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
383
|
+
end
|
384
|
+
|
385
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
386
|
+
|
387
|
+
account_id = 'account_id_example' # String |
|
388
|
+
|
389
|
+
contact_id = 'contact_id_example' # String |
|
390
|
+
|
391
|
+
|
392
|
+
begin
|
393
|
+
#Gets contact details
|
394
|
+
result = api_instance.get_account_contact(account_id, contact_id)
|
395
|
+
p result
|
396
|
+
rescue SubskribeDevClient::ApiError => e
|
397
|
+
puts "Exception when calling AccountsApi->get_account_contact: #{e}"
|
398
|
+
end
|
399
|
+
```
|
400
|
+
|
401
|
+
### Parameters
|
402
|
+
|
403
|
+
Name | Type | Description | Notes
|
404
|
+
------------- | ------------- | ------------- | -------------
|
405
|
+
**account_id** | **String**| |
|
406
|
+
**contact_id** | **String**| |
|
407
|
+
|
408
|
+
### Return type
|
409
|
+
|
410
|
+
[**AccountContactJson**](AccountContactJson.md)
|
411
|
+
|
412
|
+
### Authorization
|
413
|
+
|
414
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
415
|
+
|
416
|
+
### HTTP request headers
|
417
|
+
|
418
|
+
- **Content-Type**: Not defined
|
419
|
+
- **Accept**: application/json
|
420
|
+
|
421
|
+
|
422
|
+
|
423
|
+
# **get_account_contacts**
|
424
|
+
> Array<AccountContactJson> get_account_contacts(account_id, opts)
|
425
|
+
|
426
|
+
Get contacts for an account
|
427
|
+
|
428
|
+
Returns a list of contacts associated with the specified account id
|
429
|
+
|
430
|
+
### Example
|
431
|
+
```ruby
|
432
|
+
# load the gem
|
433
|
+
require 'subskribe_dev'
|
434
|
+
# setup authorization
|
435
|
+
SubskribeDevClient.configure do |config|
|
436
|
+
# Configure API key authorization: ApiKeyAuth
|
437
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
438
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
439
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
440
|
+
end
|
441
|
+
|
442
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
443
|
+
|
444
|
+
account_id = 'account_id_example' # String |
|
445
|
+
|
446
|
+
opts = {
|
447
|
+
expand: true # BOOLEAN |
|
448
|
+
}
|
449
|
+
|
450
|
+
begin
|
451
|
+
#Get contacts for an account
|
452
|
+
result = api_instance.get_account_contacts(account_id, opts)
|
453
|
+
p result
|
454
|
+
rescue SubskribeDevClient::ApiError => e
|
455
|
+
puts "Exception when calling AccountsApi->get_account_contacts: #{e}"
|
456
|
+
end
|
457
|
+
```
|
458
|
+
|
459
|
+
### Parameters
|
460
|
+
|
461
|
+
Name | Type | Description | Notes
|
462
|
+
------------- | ------------- | ------------- | -------------
|
463
|
+
**account_id** | **String**| |
|
464
|
+
**expand** | **BOOLEAN**| | [optional]
|
465
|
+
|
466
|
+
### Return type
|
467
|
+
|
468
|
+
[**Array<AccountContactJson>**](AccountContactJson.md)
|
469
|
+
|
470
|
+
### Authorization
|
471
|
+
|
472
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
473
|
+
|
474
|
+
### HTTP request headers
|
475
|
+
|
476
|
+
- **Content-Type**: Not defined
|
477
|
+
- **Accept**: application/json
|
478
|
+
|
479
|
+
|
480
|
+
|
481
|
+
# **get_account_metrics**
|
482
|
+
> MetricsJson get_account_metrics(id, opts)
|
483
|
+
|
484
|
+
Returns metrics for the specified account
|
485
|
+
|
486
|
+
Fetches metrics such as ARR, TCV, etc for the specified account as of the specified target date
|
487
|
+
|
488
|
+
### Example
|
489
|
+
```ruby
|
490
|
+
# load the gem
|
491
|
+
require 'subskribe_dev'
|
492
|
+
# setup authorization
|
493
|
+
SubskribeDevClient.configure do |config|
|
494
|
+
# Configure API key authorization: ApiKeyAuth
|
495
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
496
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
497
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
498
|
+
end
|
499
|
+
|
500
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
501
|
+
|
502
|
+
id = 'id_example' # String |
|
503
|
+
|
504
|
+
opts = {
|
505
|
+
target_date: 789 # Integer |
|
506
|
+
}
|
507
|
+
|
508
|
+
begin
|
509
|
+
#Returns metrics for the specified account
|
510
|
+
result = api_instance.get_account_metrics(id, opts)
|
511
|
+
p result
|
512
|
+
rescue SubskribeDevClient::ApiError => e
|
513
|
+
puts "Exception when calling AccountsApi->get_account_metrics: #{e}"
|
514
|
+
end
|
515
|
+
```
|
516
|
+
|
517
|
+
### Parameters
|
518
|
+
|
519
|
+
Name | Type | Description | Notes
|
520
|
+
------------- | ------------- | ------------- | -------------
|
521
|
+
**id** | **String**| |
|
522
|
+
**target_date** | **Integer**| | [optional]
|
523
|
+
|
524
|
+
### Return type
|
525
|
+
|
526
|
+
[**MetricsJson**](MetricsJson.md)
|
527
|
+
|
528
|
+
### Authorization
|
529
|
+
|
530
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
531
|
+
|
532
|
+
### HTTP request headers
|
533
|
+
|
534
|
+
- **Content-Type**: Not defined
|
535
|
+
- **Accept**: application/json
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
# **get_account_payment_methods**
|
540
|
+
> Array<AccountPaymentMethodJson> get_account_payment_methods(account_id)
|
541
|
+
|
542
|
+
Get the payment methods for an account
|
543
|
+
|
544
|
+
Returns a list of payment methods for the specified account id
|
545
|
+
|
546
|
+
### Example
|
547
|
+
```ruby
|
548
|
+
# load the gem
|
549
|
+
require 'subskribe_dev'
|
550
|
+
# setup authorization
|
551
|
+
SubskribeDevClient.configure do |config|
|
552
|
+
# Configure API key authorization: ApiKeyAuth
|
553
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
554
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
555
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
556
|
+
end
|
557
|
+
|
558
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
559
|
+
|
560
|
+
account_id = 'account_id_example' # String |
|
561
|
+
|
562
|
+
|
563
|
+
begin
|
564
|
+
#Get the payment methods for an account
|
565
|
+
result = api_instance.get_account_payment_methods(account_id)
|
566
|
+
p result
|
567
|
+
rescue SubskribeDevClient::ApiError => e
|
568
|
+
puts "Exception when calling AccountsApi->get_account_payment_methods: #{e}"
|
569
|
+
end
|
570
|
+
```
|
571
|
+
|
572
|
+
### Parameters
|
573
|
+
|
574
|
+
Name | Type | Description | Notes
|
575
|
+
------------- | ------------- | ------------- | -------------
|
576
|
+
**account_id** | **String**| |
|
577
|
+
|
578
|
+
### Return type
|
579
|
+
|
580
|
+
[**Array<AccountPaymentMethodJson>**](AccountPaymentMethodJson.md)
|
581
|
+
|
582
|
+
### Authorization
|
583
|
+
|
584
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
585
|
+
|
586
|
+
### HTTP request headers
|
587
|
+
|
588
|
+
- **Content-Type**: Not defined
|
589
|
+
- **Accept**: application/json
|
590
|
+
|
591
|
+
|
592
|
+
|
593
|
+
# **get_accounts**
|
594
|
+
> Array<AccountJson> get_accounts(opts)
|
595
|
+
|
596
|
+
Get all accounts
|
597
|
+
|
598
|
+
Returns a paginated list of accounts
|
599
|
+
|
600
|
+
### Example
|
601
|
+
```ruby
|
602
|
+
# load the gem
|
603
|
+
require 'subskribe_dev'
|
604
|
+
# setup authorization
|
605
|
+
SubskribeDevClient.configure do |config|
|
606
|
+
# Configure API key authorization: ApiKeyAuth
|
607
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
608
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
609
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
610
|
+
end
|
611
|
+
|
612
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
613
|
+
|
614
|
+
opts = {
|
615
|
+
cursor: 'cursor_example', # String |
|
616
|
+
limit: 56, # Integer |
|
617
|
+
type: 'type_example' # String |
|
618
|
+
}
|
619
|
+
|
620
|
+
begin
|
621
|
+
#Get all accounts
|
622
|
+
result = api_instance.get_accounts(opts)
|
623
|
+
p result
|
624
|
+
rescue SubskribeDevClient::ApiError => e
|
625
|
+
puts "Exception when calling AccountsApi->get_accounts: #{e}"
|
626
|
+
end
|
627
|
+
```
|
628
|
+
|
629
|
+
### Parameters
|
630
|
+
|
631
|
+
Name | Type | Description | Notes
|
632
|
+
------------- | ------------- | ------------- | -------------
|
633
|
+
**cursor** | [**String**](.md)| | [optional]
|
634
|
+
**limit** | **Integer**| | [optional]
|
635
|
+
**type** | **String**| | [optional]
|
636
|
+
|
637
|
+
### Return type
|
638
|
+
|
639
|
+
[**Array<AccountJson>**](AccountJson.md)
|
640
|
+
|
641
|
+
### Authorization
|
642
|
+
|
643
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
644
|
+
|
645
|
+
### HTTP request headers
|
646
|
+
|
647
|
+
- **Content-Type**: Not defined
|
648
|
+
- **Accept**: application/json
|
649
|
+
|
650
|
+
|
651
|
+
|
652
|
+
# **get_payment_method**
|
653
|
+
> AccountPaymentMethodJson get_payment_method(account_id, id)
|
654
|
+
|
655
|
+
Get the details of a payment method
|
656
|
+
|
657
|
+
Returns the details of the payment method for the specified account id and payment method id
|
658
|
+
|
659
|
+
### Example
|
660
|
+
```ruby
|
661
|
+
# load the gem
|
662
|
+
require 'subskribe_dev'
|
663
|
+
# setup authorization
|
664
|
+
SubskribeDevClient.configure do |config|
|
665
|
+
# Configure API key authorization: ApiKeyAuth
|
666
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
667
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
668
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
669
|
+
end
|
670
|
+
|
671
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
672
|
+
|
673
|
+
account_id = 'account_id_example' # String |
|
674
|
+
|
675
|
+
id = 'id_example' # String |
|
676
|
+
|
677
|
+
|
678
|
+
begin
|
679
|
+
#Get the details of a payment method
|
680
|
+
result = api_instance.get_payment_method(account_id, id)
|
681
|
+
p result
|
682
|
+
rescue SubskribeDevClient::ApiError => e
|
683
|
+
puts "Exception when calling AccountsApi->get_payment_method: #{e}"
|
684
|
+
end
|
685
|
+
```
|
686
|
+
|
687
|
+
### Parameters
|
688
|
+
|
689
|
+
Name | Type | Description | Notes
|
690
|
+
------------- | ------------- | ------------- | -------------
|
691
|
+
**account_id** | **String**| |
|
692
|
+
**id** | [**String**](.md)| |
|
693
|
+
|
694
|
+
### Return type
|
695
|
+
|
696
|
+
[**AccountPaymentMethodJson**](AccountPaymentMethodJson.md)
|
697
|
+
|
698
|
+
### Authorization
|
699
|
+
|
700
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
701
|
+
|
702
|
+
### HTTP request headers
|
703
|
+
|
704
|
+
- **Content-Type**: Not defined
|
705
|
+
- **Accept**: application/json
|
706
|
+
|
707
|
+
|
708
|
+
|
709
|
+
# **import_crm_account**
|
710
|
+
> CrmAccountImportResponse import_crm_account(opts)
|
711
|
+
|
712
|
+
Import an account from a CRM
|
713
|
+
|
714
|
+
Ensures an account exists which matches the passed details.If an account exists that has a matching CRM Id, it will be updated, if not, it will be created
|
715
|
+
|
716
|
+
### Example
|
717
|
+
```ruby
|
718
|
+
# load the gem
|
719
|
+
require 'subskribe_dev'
|
720
|
+
# setup authorization
|
721
|
+
SubskribeDevClient.configure do |config|
|
722
|
+
# Configure API key authorization: ApiKeyAuth
|
723
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
724
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
725
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
726
|
+
end
|
727
|
+
|
728
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
729
|
+
|
730
|
+
opts = {
|
731
|
+
body: SubskribeDevClient::AccountJson.new # AccountJson |
|
732
|
+
}
|
733
|
+
|
734
|
+
begin
|
735
|
+
#Import an account from a CRM
|
736
|
+
result = api_instance.import_crm_account(opts)
|
737
|
+
p result
|
738
|
+
rescue SubskribeDevClient::ApiError => e
|
739
|
+
puts "Exception when calling AccountsApi->import_crm_account: #{e}"
|
740
|
+
end
|
741
|
+
```
|
742
|
+
|
743
|
+
### Parameters
|
744
|
+
|
745
|
+
Name | Type | Description | Notes
|
746
|
+
------------- | ------------- | ------------- | -------------
|
747
|
+
**body** | [**AccountJson**](AccountJson.md)| | [optional]
|
748
|
+
|
749
|
+
### Return type
|
750
|
+
|
751
|
+
[**CrmAccountImportResponse**](CrmAccountImportResponse.md)
|
752
|
+
|
753
|
+
### Authorization
|
754
|
+
|
755
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
756
|
+
|
757
|
+
### HTTP request headers
|
758
|
+
|
759
|
+
- **Content-Type**: application/json
|
760
|
+
- **Accept**: application/json
|
761
|
+
|
762
|
+
|
763
|
+
|
764
|
+
# **update_account**
|
765
|
+
> update_account(id, opts)
|
766
|
+
|
767
|
+
Update an account
|
768
|
+
|
769
|
+
Updates an existing account with the specified parameters
|
770
|
+
|
771
|
+
### Example
|
772
|
+
```ruby
|
773
|
+
# load the gem
|
774
|
+
require 'subskribe_dev'
|
775
|
+
# setup authorization
|
776
|
+
SubskribeDevClient.configure do |config|
|
777
|
+
# Configure API key authorization: ApiKeyAuth
|
778
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
779
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
780
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
781
|
+
end
|
782
|
+
|
783
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
784
|
+
|
785
|
+
id = 'id_example' # String |
|
786
|
+
|
787
|
+
opts = {
|
788
|
+
body: SubskribeDevClient::AccountJson.new # AccountJson |
|
789
|
+
}
|
790
|
+
|
791
|
+
begin
|
792
|
+
#Update an account
|
793
|
+
api_instance.update_account(id, opts)
|
794
|
+
rescue SubskribeDevClient::ApiError => e
|
795
|
+
puts "Exception when calling AccountsApi->update_account: #{e}"
|
796
|
+
end
|
797
|
+
```
|
798
|
+
|
799
|
+
### Parameters
|
800
|
+
|
801
|
+
Name | Type | Description | Notes
|
802
|
+
------------- | ------------- | ------------- | -------------
|
803
|
+
**id** | **String**| |
|
804
|
+
**body** | [**AccountJson**](AccountJson.md)| | [optional]
|
805
|
+
|
806
|
+
### Return type
|
807
|
+
|
808
|
+
nil (empty response body)
|
809
|
+
|
810
|
+
### Authorization
|
811
|
+
|
812
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
813
|
+
|
814
|
+
### HTTP request headers
|
815
|
+
|
816
|
+
- **Content-Type**: application/json
|
817
|
+
- **Accept**: application/json
|
818
|
+
|
819
|
+
|
820
|
+
|
821
|
+
# **update_account_contact**
|
822
|
+
> update_account_contact(account_id, contact_id, opts)
|
823
|
+
|
824
|
+
Update a contact
|
825
|
+
|
826
|
+
Updates the contact specified by the account id and contact id with the passed information
|
827
|
+
|
828
|
+
### Example
|
829
|
+
```ruby
|
830
|
+
# load the gem
|
831
|
+
require 'subskribe_dev'
|
832
|
+
# setup authorization
|
833
|
+
SubskribeDevClient.configure do |config|
|
834
|
+
# Configure API key authorization: ApiKeyAuth
|
835
|
+
config.api_key['X-API-Key'] = 'YOUR API KEY'
|
836
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
837
|
+
#config.api_key_prefix['X-API-Key'] = 'Bearer'
|
838
|
+
end
|
839
|
+
|
840
|
+
api_instance = SubskribeDevClient::AccountsApi.new
|
841
|
+
|
842
|
+
account_id = 'account_id_example' # String |
|
843
|
+
|
844
|
+
contact_id = 'contact_id_example' # String |
|
845
|
+
|
846
|
+
opts = {
|
847
|
+
body: SubskribeDevClient::AccountContactJson.new, # AccountContactJson |
|
848
|
+
skip_address_validation: true, # BOOLEAN |
|
849
|
+
strict_validation: true # BOOLEAN |
|
850
|
+
}
|
851
|
+
|
852
|
+
begin
|
853
|
+
#Update a contact
|
854
|
+
api_instance.update_account_contact(account_id, contact_id, opts)
|
855
|
+
rescue SubskribeDevClient::ApiError => e
|
856
|
+
puts "Exception when calling AccountsApi->update_account_contact: #{e}"
|
857
|
+
end
|
858
|
+
```
|
859
|
+
|
860
|
+
### Parameters
|
861
|
+
|
862
|
+
Name | Type | Description | Notes
|
863
|
+
------------- | ------------- | ------------- | -------------
|
864
|
+
**account_id** | **String**| |
|
865
|
+
**contact_id** | **String**| |
|
866
|
+
**body** | [**AccountContactJson**](AccountContactJson.md)| | [optional]
|
867
|
+
**skip_address_validation** | **BOOLEAN**| | [optional]
|
868
|
+
**strict_validation** | **BOOLEAN**| | [optional]
|
869
|
+
|
870
|
+
### Return type
|
871
|
+
|
872
|
+
nil (empty response body)
|
873
|
+
|
874
|
+
### Authorization
|
875
|
+
|
876
|
+
[ApiKeyAuth](../README.md#ApiKeyAuth)
|
877
|
+
|
878
|
+
### HTTP request headers
|
879
|
+
|
880
|
+
- **Content-Type**: Not defined
|
881
|
+
- **Accept**: application/json
|
882
|
+
|
883
|
+
|
884
|
+
|