Module: SubskribeSandboxClient

Defined in:
lib/subskribe_sandbox/version.rb,
lib/subskribe_sandbox.rb,
lib/subskribe_sandbox/api_error.rb,
lib/subskribe_sandbox/api_client.rb,
lib/subskribe_sandbox/api/erp_api.rb,
lib/subskribe_sandbox/models/entry.rb,
lib/subskribe_sandbox/api/usage_api.rb,
lib/subskribe_sandbox/api/users_api.rb,
lib/subskribe_sandbox/configuration.rb,
lib/subskribe_sandbox/models/entity.rb,
lib/subskribe_sandbox/models/refund.rb,
lib/subskribe_sandbox/api/import_api.rb,
lib/subskribe_sandbox/api/orders_api.rb,
lib/subskribe_sandbox/api/billing_api.rb,
lib/subskribe_sandbox/api/default_api.rb,
lib/subskribe_sandbox/api/refunds_api.rb,
lib/subskribe_sandbox/api/reports_api.rb,
lib/subskribe_sandbox/api/accounts_api.rb,
lib/subskribe_sandbox/api/entities_api.rb,
lib/subskribe_sandbox/api/payments_api.rb,
lib/subskribe_sandbox/api/settings_api.rb,
lib/subskribe_sandbox/models/plan_json.rb,
lib/subskribe_sandbox/models/raw_usage.rb,
lib/subskribe_sandbox/models/time_zone.rb,
lib/subskribe_sandbox/models/user_json.rb,
lib/subskribe_sandbox/api/approvals_api.rb,
lib/subskribe_sandbox/api/discounts_api.rb,
lib/subskribe_sandbox/api/rate_card_api.rb,
lib/subskribe_sandbox/models/attachment.rb,
lib/subskribe_sandbox/models/entity_ref.rb,
lib/subskribe_sandbox/models/order_json.rb,
lib/subskribe_sandbox/models/user_input.rb,
lib/subskribe_sandbox/api/accounting_api.rb,
lib/subskribe_sandbox/api/sales_room_api.rb,
lib/subskribe_sandbox/models/byte_buffer.rb,
lib/subskribe_sandbox/models/charge_json.rb,
lib/subskribe_sandbox/models/data_import.rb,
lib/subskribe_sandbox/models/entity_json.rb,
lib/subskribe_sandbox/models/integration.rb,
lib/subskribe_sandbox/models/opportunity.rb,
lib/subskribe_sandbox/models/order_terms.rb,
lib/subskribe_sandbox/models/tenant_json.rb,
lib/subskribe_sandbox/api/attachments_api.rb,
lib/subskribe_sandbox/api/credit_memo_api.rb,
lib/subskribe_sandbox/api/opportunity_api.rb,
lib/subskribe_sandbox/models/account_json.rb,
lib/subskribe_sandbox/models/input_stream.rb,
lib/subskribe_sandbox/models/invoice_json.rb,
lib/subskribe_sandbox/models/metrics_json.rb,
lib/subskribe_sandbox/models/payment_json.rb,
lib/subskribe_sandbox/models/product_json.rb,
lib/subskribe_sandbox/api/custom_field_api.rb,
lib/subskribe_sandbox/api/integrations_api.rb,
lib/subskribe_sandbox/models/discount_json.rb,
lib/subskribe_sandbox/models/number_config.rb,
lib/subskribe_sandbox/models/prepaid_stats.rb,
lib/subskribe_sandbox/models/refund_detail.rb,
lib/subskribe_sandbox/models/tax_rate_json.rb,
lib/subskribe_sandbox/api/customization_api.rb,
lib/subskribe_sandbox/api/notifications_api.rb,
lib/subskribe_sandbox/api/subscriptions_api.rb,
lib/subskribe_sandbox/models/ledger_account.rb,
lib/subskribe_sandbox/models/purchase_order.rb,
lib/subskribe_sandbox/api/authentication_api.rb,
lib/subskribe_sandbox/models/account_address.rb,
lib/subskribe_sandbox/models/account_contact.rb,
lib/subskribe_sandbox/models/price_tier_json.rb,
lib/subskribe_sandbox/models/raw_usages_data.rb,
lib/subskribe_sandbox/models/recurrence_json.rb,
lib/subskribe_sandbox/models/report_duration.rb,
lib/subskribe_sandbox/models/user_group_json.rb,
lib/subskribe_sandbox/api/product_catalog_api.rb,
lib/subskribe_sandbox/models/accounting_event.rb,
lib/subskribe_sandbox/models/bulk_invoice_run.rb,
lib/subskribe_sandbox/models/credit_memo_json.rb,
lib/subskribe_sandbox/models/document_section.rb,
lib/subskribe_sandbox/models/opportunity_json.rb,
lib/subskribe_sandbox/models/product_category.rb,
lib/subskribe_sandbox/models/recognition_rule.rb,
lib/subskribe_sandbox/models/accounting_period.rb,
lib/subskribe_sandbox/models/invoice_item_json.rb,
lib/subskribe_sandbox/models/subscription_json.rb,
lib/subskribe_sandbox/models/void_payment_json.rb,
lib/subskribe_sandbox/api/metrics_reporting_api.rb,
lib/subskribe_sandbox/models/approval_role_json.rb,
lib/subskribe_sandbox/models/custom_field_entry.rb,
lib/subskribe_sandbox/models/custom_field_value.rb,
lib/subskribe_sandbox/models/order_request_json.rb,
lib/subskribe_sandbox/models/plan_metadata_json.rb,
lib/subskribe_sandbox/models/product_input_json.rb,
lib/subskribe_sandbox/models/salesforce_account.rb,
lib/subskribe_sandbox/models/attribute_reference.rb,
lib/subskribe_sandbox/models/avalara_integration.rb,
lib/subskribe_sandbox/models/billing_event_entry.rb,
lib/subskribe_sandbox/models/billing_event_input.rb,
lib/subskribe_sandbox/models/charge_partial_json.rb,
lib/subskribe_sandbox/models/refund_request_json.rb,
lib/subskribe_sandbox/models/report_job_response.rb,
lib/subskribe_sandbox/models/tax_jar_integration.rb,
lib/subskribe_sandbox/models/tenant_setting_json.rb,
lib/subskribe_sandbox/api/revenue_recognition_api.rb,
lib/subskribe_sandbox/models/account_address_json.rb,
lib/subskribe_sandbox/models/account_contact_json.rb,
lib/subskribe_sandbox/models/catalog_relationship.rb,
lib/subskribe_sandbox/models/company_contact_json.rb,
lib/subskribe_sandbox/models/custom_field_default.rb,
lib/subskribe_sandbox/models/discount_detail_json.rb,
lib/subskribe_sandbox/models/dunning_setting_json.rb,
lib/subskribe_sandbox/models/email_notifiers_list.rb,
lib/subskribe_sandbox/models/invoice_balance_json.rb,
lib/subskribe_sandbox/models/invoice_preview_json.rb,
lib/subskribe_sandbox/models/order_line_item_json.rb,
lib/subskribe_sandbox/models/payment_balance_json.rb,
lib/subskribe_sandbox/models/tenant_discount_json.rb,
lib/subskribe_sandbox/models/unit_of_measure_json.rb,
lib/subskribe_sandbox/models/void_invoice_request.rb,
lib/subskribe_sandbox/models/approval_segment_json.rb,
lib/subskribe_sandbox/models/bulk_invoice_run_item.rb,
lib/subskribe_sandbox/models/invoice_number_prefix.rb,
lib/subskribe_sandbox/models/opportunity_rest_json.rb,
lib/subskribe_sandbox/models/payment_configuration.rb,
lib/subskribe_sandbox/models/tenant_invoice_config.rb,
lib/subskribe_sandbox/models/automated_invoice_rule.rb,
lib/subskribe_sandbox/models/bulk_invoice_run_input.rb,
lib/subskribe_sandbox/models/document_template_json.rb,
lib/subskribe_sandbox/models/ledger_account_mapping.rb,
lib/subskribe_sandbox/models/predefined_report_json.rb,
lib/subskribe_sandbox/models/settlement_application.rb,
lib/subskribe_sandbox/models/update_invoice_request.rb,
lib/subskribe_sandbox/models/usage_aggregate_output.rb,
lib/subskribe_sandbox/models/anrok_integration_input.rb,
lib/subskribe_sandbox/models/document_custom_content.rb,
lib/subskribe_sandbox/models/predefined_report_param.rb,
lib/subskribe_sandbox/models/time_series_amount_json.rb,
lib/subskribe_sandbox/models/user_group_request_json.rb,
lib/subskribe_sandbox/models/bulk_payment_upload_data.rb,
lib/subskribe_sandbox/models/credit_memo_balance_json.rb,
lib/subskribe_sandbox/models/subscription_charge_json.rb,
lib/subskribe_sandbox/models/subscription_update_json.rb,
lib/subskribe_sandbox/models/avalara_integration_input.rb,
lib/subskribe_sandbox/models/bulk_invoice_run_selector.rb,
lib/subskribe_sandbox/models/custom_field_update_input.rb,
lib/subskribe_sandbox/models/invoice_item_preview_json.rb,
lib/subskribe_sandbox/models/subscription_charge_alias.rb,
lib/subskribe_sandbox/models/tax_jar_integration_input.rb,
lib/subskribe_sandbox/models/usage_batch_insert_result.rb,
lib/subskribe_sandbox/models/auth_saml_integration_json.rb,
lib/subskribe_sandbox/models/bulk_payment_upload_result.rb,
lib/subskribe_sandbox/models/credit_memo_line_item_json.rb,
lib/subskribe_sandbox/models/external_arr_schedule_json.rb,
lib/subskribe_sandbox/models/flatfile_workbook_response.rb,
lib/subskribe_sandbox/models/payment_term_settings_json.rb,
lib/subskribe_sandbox/models/predefined_report_def_json.rb,
lib/subskribe_sandbox/models/account_payment_method_json.rb,
lib/subskribe_sandbox/models/bulk_invoice_run_exclusions.rb,
lib/subskribe_sandbox/models/crm_account_import_response.rb,
lib/subskribe_sandbox/models/paginated_accounts_response.rb,
lib/subskribe_sandbox/models/predefined_report_defs_json.rb,
lib/subskribe_sandbox/models/approval_role_segment_change.rb,
lib/subskribe_sandbox/models/credit_memo_application_json.rb,
lib/subskribe_sandbox/models/custom_field_definition_json.rb,
lib/subskribe_sandbox/models/order_line_item_request_json.rb,
lib/subskribe_sandbox/models/recognition_event_completion.rb,
lib/subskribe_sandbox/models/accounting_period_calculation.rb,
lib/subskribe_sandbox/models/plan_json_pagination_response.rb,
lib/subskribe_sandbox/models/user_pagination_response_json.rb,
lib/subskribe_sandbox/models/approval_matrix_import_preview.rb,
lib/subskribe_sandbox/models/order_json_pagination_response.rb,
lib/subskribe_sandbox/models/predefined_report_param_object.rb,
lib/subskribe_sandbox/models/standalone_credit_memo_request.rb,
lib/subskribe_sandbox/models/tenant_discount_line_item_json.rb,
lib/subskribe_sandbox/models/account_receivable_contact_json.rb,
lib/subskribe_sandbox/models/flatfile_workbook_response_data.rb,
lib/subskribe_sandbox/models/opportunity_pagination_response.rb,
lib/subskribe_sandbox/models/approval_matrix_import_data_json.rb,
lib/subskribe_sandbox/models/invoice_json_pagination_response.rb,
lib/subskribe_sandbox/models/paginated_subscriptions_response.rb,
lib/subskribe_sandbox/models/payment_json_pagination_response.rb,
lib/subskribe_sandbox/models/predefined_report_def_chart_json.rb,
lib/subskribe_sandbox/models/product_json_pagination_response.rb,
lib/subskribe_sandbox/models/tax_rate_pagination_response_json.rb,
lib/subskribe_sandbox/models/credit_memo_line_item_request_json.rb,
lib/subskribe_sandbox/models/docu_sign_integration_request_json.rb,
lib/subskribe_sandbox/models/salesforce_account_billing_address.rb,
lib/subskribe_sandbox/models/accounting_event_paginated_response.rb,
lib/subskribe_sandbox/models/automated_invoice_rule_request_json.rb,
lib/subskribe_sandbox/models/docu_sign_integration_response_json.rb,
lib/subskribe_sandbox/models/credit_memo_pagination_response_json.rb,
lib/subskribe_sandbox/models/custom_field_definition_create_input.rb,
lib/subskribe_sandbox/models/custom_field_definition_update_input.rb,
lib/subskribe_sandbox/models/product_category_pagination_response.rb,
lib/subskribe_sandbox/models/notification_target_and_subscriptions.rb,
lib/subskribe_sandbox/models/tenant_credit_memo_configuration_json.rb,
lib/subskribe_sandbox/models/add_and_apply_payment_application_json.rb,
lib/subskribe_sandbox/models/unit_of_measure_pagination_response_json.rb,
lib/subskribe_sandbox/models/salesforce_client_integration_request_json.rb

Overview

#Subskribe API

#No description provided (generated by Swagger Codegen github.com/swagger-api/swagger-codegen)

OpenAPI spec version: 1.0.0

Generated by: github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.4.41

Defined Under Namespace

Classes: AccountAddress, AccountAddressJson, AccountContact, AccountContactJson, AccountJson, AccountPaymentMethodJson, AccountReceivableContactJson, AccountingApi, AccountingEvent, AccountingEventPaginatedResponse, AccountingPeriod, AccountingPeriodCalculation, AccountsApi, AddAndApplyPaymentApplicationJson, AnrokIntegrationInput, ApiClient, ApiError, ApprovalMatrixImportDataJson, ApprovalMatrixImportPreview, ApprovalRoleJson, ApprovalRoleSegmentChange, ApprovalSegmentJson, ApprovalsApi, Attachment, AttachmentsApi, AttributeReference, AuthSamlIntegrationJson, AuthenticationApi, AutomatedInvoiceRule, AutomatedInvoiceRuleRequestJson, AvalaraIntegration, AvalaraIntegrationInput, BillingApi, BillingEventEntry, BillingEventInput, BulkInvoiceRun, BulkInvoiceRunExclusions, BulkInvoiceRunInput, BulkInvoiceRunItem, BulkInvoiceRunSelector, BulkPaymentUploadData, BulkPaymentUploadResult, ByteBuffer, CatalogRelationship, ChargeJson, ChargePartialJson, CompanyContactJson, Configuration, CreditMemoApi, CreditMemoApplicationJson, CreditMemoBalanceJson, CreditMemoJson, CreditMemoLineItemJson, CreditMemoLineItemRequestJson, CreditMemoPaginationResponseJson, CrmAccountImportResponse, CustomFieldApi, CustomFieldDefault, CustomFieldDefinitionCreateInput, CustomFieldDefinitionJson, CustomFieldDefinitionUpdateInput, CustomFieldEntry, CustomFieldUpdateInput, CustomFieldValue, CustomizationApi, DataImport, DefaultApi, DiscountDetailJson, DiscountJson, DiscountsApi, DocuSignIntegrationRequestJson, DocuSignIntegrationResponseJson, DocumentCustomContent, DocumentSection, DocumentTemplateJson, DunningSettingJson, ERPApi, EmailNotifiersList, EntitiesApi, Entity, EntityJson, EntityRef, Entry, ExternalArrScheduleJson, FlatfileWorkbookResponse, FlatfileWorkbookResponseData, ImportApi, InputStream, Integration, IntegrationsApi, InvoiceBalanceJson, InvoiceItemJson, InvoiceItemPreviewJson, InvoiceJson, InvoiceJsonPaginationResponse, InvoiceNumberPrefix, InvoicePreviewJson, LedgerAccount, LedgerAccountMapping, MetricsJson, MetricsReportingApi, NotificationTargetAndSubscriptions, NotificationsApi, NumberConfig, Opportunity, OpportunityApi, OpportunityJson, OpportunityPaginationResponse, OpportunityRestJson, OrderJson, OrderJsonPaginationResponse, OrderLineItemJson, OrderLineItemRequestJson, OrderRequestJson, OrderTerms, OrdersApi, PaginatedAccountsResponse, PaginatedSubscriptionsResponse, PaymentBalanceJson, PaymentConfiguration, PaymentJson, PaymentJsonPaginationResponse, PaymentTermSettingsJson, PaymentsApi, PlanJson, PlanJsonPaginationResponse, PlanMetadataJson, PredefinedReportDefChartJson, PredefinedReportDefJson, PredefinedReportDefsJson, PredefinedReportJson, PredefinedReportParam, PredefinedReportParamObject, PrepaidStats, PriceTierJson, ProductCatalogApi, ProductCategory, ProductCategoryPaginationResponse, ProductInputJson, ProductJson, ProductJsonPaginationResponse, PurchaseOrder, RateCardApi, RawUsage, RawUsagesData, RecognitionEventCompletion, RecognitionRule, RecurrenceJson, Refund, RefundDetail, RefundRequestJson, RefundsApi, ReportDuration, ReportJobResponse, ReportsApi, RevenueRecognitionApi, SalesRoomApi, SalesforceAccount, SalesforceAccountBillingAddress, SalesforceClientIntegrationRequestJson, SettingsApi, SettlementApplication, StandaloneCreditMemoRequest, SubscriptionChargeAlias, SubscriptionChargeJson, SubscriptionJson, SubscriptionUpdateJson, SubscriptionsApi, TaxJarIntegration, TaxJarIntegrationInput, TaxRateJson, TaxRatePaginationResponseJson, TenantCreditMemoConfigurationJson, TenantDiscountJson, TenantDiscountLineItemJson, TenantInvoiceConfig, TenantJson, TenantSettingJson, TimeSeriesAmountJson, TimeZone, UnitOfMeasureJson, UnitOfMeasurePaginationResponseJson, UpdateInvoiceRequest, UsageAggregateOutput, UsageApi, UsageBatchInsertResult, UserGroupJson, UserGroupRequestJson, UserInput, UserJson, UserPaginationResponseJson, UsersApi, VoidInvoiceRequest, VoidPaymentJson

Constant Summary collapse

VERSION = 
'1.0.2'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

Customize default settings for the SDK using block.

SubskribeSandboxClient.configure do |config|
  config.username = "xxx"
  config.password = "xxx"
end

If no block given, return the default Configuration object.



222
223
224
225
226
227
228
 
# File 'lib/subskribe_sandbox.rb', line 222

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end