subskribe_dev 1.1.0 → 1.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +505 -10
- data/docs/AccountAddress.md +17 -0
- data/docs/AccountAddressJson.md +13 -0
- data/docs/AccountContact.md +24 -0
- data/docs/AccountContactJson.md +18 -0
- data/docs/AccountJson.md +27 -0
- data/docs/AccountPaymentMethodJson.md +13 -0
- data/docs/AccountReceivableContactJson.md +12 -0
- data/docs/AccountingApi.md +182 -0
- data/docs/AccountingEvent.md +19 -0
- data/docs/AccountingEventPaginatedResponse.md +10 -0
- data/docs/AccountingPeriod.md +22 -0
- data/docs/AccountingPeriodCalculation.md +13 -0
- data/docs/AccountsApi.md +884 -0
- data/docs/AddAndApplyPaymentApplicationJson.md +19 -0
- data/docs/AnrokIntegrationInput.md +8 -0
- data/docs/ApprovalMatrixImportDataJson.md +13 -0
- data/docs/ApprovalMatrixImportPreview.md +12 -0
- data/docs/ApprovalRoleJson.md +12 -0
- data/docs/ApprovalRoleSegmentChange.md +11 -0
- data/docs/ApprovalSegmentJson.md +12 -0
- data/docs/ApprovalsApi.md +1028 -0
- data/docs/Attachment.md +17 -0
- data/docs/AttachmentsApi.md +294 -0
- data/docs/AttributeReference.md +9 -0
- data/docs/AuthSamlIntegrationJson.md +10 -0
- data/docs/AuthenticationApi.md +329 -0
- data/docs/AutomatedInvoiceRule.md +24 -0
- data/docs/AutomatedInvoiceRuleRequestJson.md +20 -0
- data/docs/AvalaraIntegration.md +14 -0
- data/docs/AvalaraIntegrationInput.md +12 -0
- data/docs/BillingApi.md +2173 -0
- data/docs/BillingEventEntry.md +11 -0
- data/docs/BillingEventInput.md +11 -0
- data/docs/BulkInvoiceRun.md +20 -0
- data/docs/BulkInvoiceRunExclusions.md +9 -0
- data/docs/BulkInvoiceRunInput.md +13 -0
- data/docs/BulkInvoiceRunItem.md +28 -0
- data/docs/BulkInvoiceRunSelector.md +8 -0
- data/docs/BulkPaymentUploadData.md +18 -0
- data/docs/BulkPaymentUploadResult.md +10 -0
- data/docs/ByteBuffer.md +15 -0
- data/docs/CatalogRelationship.md +13 -0
- data/docs/ChargeJson.md +47 -0
- data/docs/ChargePartialJson.md +22 -0
- data/docs/CompanyContactJson.md +12 -0
- data/docs/CreditMemoApi.md +671 -0
- data/docs/CreditMemoApplicationJson.md +13 -0
- data/docs/CreditMemoBalanceJson.md +11 -0
- data/docs/CreditMemoJson.md +20 -0
- data/docs/CreditMemoLineItemJson.md +15 -0
- data/docs/CreditMemoLineItemRequestJson.md +11 -0
- data/docs/CreditMemoPaginationResponseJson.md +10 -0
- data/docs/CrmAccountImportResponse.md +9 -0
- data/docs/CustomFieldApi.md +411 -0
- data/docs/CustomFieldDefault.md +9 -0
- data/docs/CustomFieldDefinitionCreateInput.md +15 -0
- data/docs/CustomFieldDefinitionJson.md +17 -0
- data/docs/CustomFieldDefinitionUpdateInput.md +12 -0
- data/docs/CustomFieldEntry.md +17 -0
- data/docs/CustomFieldUpdateInput.md +9 -0
- data/docs/CustomFieldValue.md +16 -0
- data/docs/CustomizationApi.md +244 -0
- data/docs/DataImport.md +19 -0
- data/docs/DefaultApi.md +225 -0
- data/docs/DiscountDetailJson.md +13 -0
- data/docs/DiscountJson.md +12 -0
- data/docs/DiscountsApi.md +337 -0
- data/docs/DocuSignIntegrationRequestJson.md +10 -0
- data/docs/DocuSignIntegrationResponseJson.md +11 -0
- data/docs/DocumentCustomContent.md +11 -0
- data/docs/DocumentSection.md +13 -0
- data/docs/DocumentTemplateJson.md +15 -0
- data/docs/DunningSettingJson.md +9 -0
- data/docs/ERPApi.md +278 -0
- data/docs/EmailNotifiersList.md +10 -0
- data/docs/EntitiesApi.md +561 -0
- data/docs/Entity.md +22 -0
- data/docs/EntityApi.md +66 -0
- data/docs/EntityJson.md +21 -0
- data/docs/EntityRef.md +10 -0
- data/docs/Entry.md +10 -0
- data/docs/ExternalArrScheduleJson.md +17 -0
- data/docs/FlatfileWorkbookResponse.md +8 -0
- data/docs/FlatfileWorkbookResponseData.md +9 -0
- data/docs/ImportApi.md +589 -0
- data/docs/InputStream.md +7 -0
- data/docs/Integration.md +17 -0
- data/docs/IntegrationsApi.md +1747 -0
- data/docs/InvoiceBalanceJson.md +11 -0
- data/docs/InvoiceItemJson.md +27 -0
- data/docs/InvoiceItemPreviewJson.md +13 -0
- data/docs/InvoiceJson.md +31 -0
- data/docs/InvoiceJsonPaginationResponse.md +10 -0
- data/docs/InvoiceNumberPrefix.md +8 -0
- data/docs/InvoicePreviewJson.md +12 -0
- data/docs/LedgerAccount.md +16 -0
- data/docs/LedgerAccountMapping.md +12 -0
- data/docs/MetricsJson.md +17 -0
- data/docs/MetricsReportingApi.md +228 -0
- data/docs/NotificationTargetAndSubscriptions.md +13 -0
- data/docs/NotificationsApi.md +226 -0
- data/docs/NumberConfig.md +12 -0
- data/docs/Opportunity.md +20 -0
- data/docs/OpportunityApi.md +178 -0
- data/docs/OpportunityJson.md +20 -0
- data/docs/OpportunityPaginationResponse.md +10 -0
- data/docs/OpportunityRestJson.md +19 -0
- data/docs/OrderJson.md +59 -0
- data/docs/OrderJsonPaginationResponse.md +10 -0
- data/docs/OrderLineItemJson.md +35 -0
- data/docs/OrderLineItemRequestJson.md +25 -0
- data/docs/OrderRequestJson.md +46 -0
- data/docs/OrderTerms.md +13 -0
- data/docs/OrdersApi.md +1429 -0
- data/docs/PaginatedAccountsResponse.md +10 -0
- data/docs/PaginatedResponse.md +10 -0
- data/docs/PaymentBalanceJson.md +11 -0
- data/docs/PaymentConfiguration.md +8 -0
- data/docs/PaymentJson.md +16 -0
- data/docs/PaymentJsonPaginationResponse.md +10 -0
- data/docs/PaymentTermSettingsJson.md +10 -0
- data/docs/PaymentsApi.md +450 -0
- data/docs/PlanJson.md +20 -0
- data/docs/PlanJsonPaginationResponse.md +10 -0
- data/docs/PlanMetadataJson.md +8 -0
- data/docs/PredefinedReportDefChartJson.md +17 -0
- data/docs/PredefinedReportDefJson.md +12 -0
- data/docs/PredefinedReportDefsJson.md +8 -0
- data/docs/PredefinedReportJson.md +11 -0
- data/docs/PredefinedReportParam.md +14 -0
- data/docs/PredefinedReportParamObject.md +14 -0
- data/docs/PrepaidStats.md +22 -0
- data/docs/PriceTierJson.md +10 -0
- data/docs/ProductCatalogApi.md +1924 -0
- data/docs/ProductCategory.md +14 -0
- data/docs/ProductCategoryPaginationResponse.md +10 -0
- data/docs/ProductInputJson.md +15 -0
- data/docs/ProductJson.md +18 -0
- data/docs/ProductJsonPaginationResponse.md +10 -0
- data/docs/PurchaseOrder.md +10 -0
- data/docs/RateCardApi.md +56 -0
- data/docs/RawUsage.md +14 -0
- data/docs/RawUsagesData.md +8 -0
- data/docs/RecognitionEventCompletion.md +19 -0
- data/docs/RecognitionRule.md +20 -0
- data/docs/RecurrenceJson.md +9 -0
- data/docs/Refund.md +21 -0
- data/docs/RefundDetail.md +20 -0
- data/docs/RefundRequestJson.md +15 -0
- data/docs/RefundsApi.md +179 -0
- data/docs/ReportDuration.md +9 -0
- data/docs/ReportJobResponse.md +11 -0
- data/docs/ReportsApi.md +220 -0
- data/docs/RevenueRecognitionApi.md +495 -0
- data/docs/SalesRoomApi.md +62 -0
- data/docs/SalesforceAccount.md +13 -0
- data/docs/SalesforceAccountBillingAddress.md +12 -0
- data/docs/SalesforceClientIntegrationRequestJson.md +11 -0
- data/docs/SettingsApi.md +1102 -31
- data/docs/SettlementApplication.md +19 -0
- data/docs/StandaloneCreditMemoRequest.md +20 -0
- data/docs/SubscriptionChargeAlias.md +11 -0
- data/docs/SubscriptionChargeJson.md +23 -0
- data/docs/SubscriptionJson.md +40 -0
- data/docs/SubscriptionUpdateJson.md +16 -0
- data/docs/SubscriptionsApi.md +573 -0
- data/docs/TaxJarIntegration.md +14 -0
- data/docs/TaxJarIntegrationInput.md +9 -0
- data/docs/TaxRateJson.md +15 -0
- data/docs/TaxRatePaginationResponseJson.md +10 -0
- data/docs/TenantCreditMemoConfigurationJson.md +11 -0
- data/docs/TenantDiscountJson.md +9 -0
- data/docs/TenantDiscountLineItemJson.md +10 -0
- data/docs/TenantInvoiceConfig.md +12 -0
- data/docs/TenantJson.md +19 -0
- data/docs/TenantSettingJson.md +15 -0
- data/docs/TimeSeriesAmountJson.md +9 -0
- data/docs/TimeZone.md +11 -0
- data/docs/UpdateInvoiceRequest.md +13 -0
- data/docs/UsageAggregateOutput.md +16 -0
- data/docs/UsageApi.md +611 -0
- data/docs/UsageBatchInsertResult.md +11 -0
- data/docs/UserGroupJson.md +12 -0
- data/docs/UserGroupRequestJson.md +12 -0
- data/docs/UserInput.md +16 -0
- data/docs/UserJson.md +22 -0
- data/docs/UserPaginationResponseJson.md +10 -0
- data/docs/UsersApi.md +774 -0
- data/docs/VoidInvoiceRequest.md +9 -0
- data/docs/VoidPaymentJson.md +12 -0
- data/lib/subskribe_dev/api/accounting_api.rb +193 -0
- data/lib/subskribe_dev/api/accounts_api.rb +858 -0
- data/lib/subskribe_dev/api/approvals_api.rb +965 -0
- data/lib/subskribe_dev/api/attachments_api.rb +299 -0
- data/lib/subskribe_dev/api/authentication_api.rb +335 -0
- data/lib/subskribe_dev/api/billing_api.rb +2098 -0
- data/lib/subskribe_dev/api/credit_memo_api.rb +636 -0
- data/lib/subskribe_dev/api/custom_field_api.rb +434 -0
- data/lib/subskribe_dev/api/customization_api.rb +269 -0
- data/lib/subskribe_dev/api/default_api.rb +223 -0
- data/lib/subskribe_dev/api/discounts_api.rb +340 -0
- data/lib/subskribe_dev/api/entities_api.rb +532 -0
- data/lib/subskribe_dev/api/entity_api.rb +79 -0
- data/lib/subskribe_dev/api/erp_api.rb +278 -0
- data/lib/subskribe_dev/api/import_api.rb +568 -0
- data/lib/subskribe_dev/api/integrations_api.rb +1678 -0
- data/lib/subskribe_dev/api/metrics_reporting_api.rb +223 -0
- data/lib/subskribe_dev/api/notifications_api.rb +245 -0
- data/lib/subskribe_dev/api/opportunity_api.rb +177 -0
- data/lib/subskribe_dev/api/orders_api.rb +1381 -0
- data/lib/subskribe_dev/api/payments_api.rb +431 -0
- data/lib/subskribe_dev/api/product_catalog_api.rb +1886 -0
- data/lib/subskribe_dev/api/rate_card_api.rb +68 -0
- data/lib/subskribe_dev/api/refunds_api.rb +189 -0
- data/lib/subskribe_dev/api/reports_api.rb +227 -0
- data/lib/subskribe_dev/api/revenue_recognition_api.rb +484 -0
- data/lib/subskribe_dev/api/sales_room_api.rb +74 -0
- data/lib/subskribe_dev/api/settings_api.rb +1027 -39
- data/lib/subskribe_dev/api/subscriptions_api.rb +576 -0
- data/lib/subskribe_dev/api/usage_api.rb +604 -0
- data/lib/subskribe_dev/api/users_api.rb +728 -0
- data/lib/subskribe_dev/configuration.rb +1 -1
- data/lib/subskribe_dev/models/account_address.rb +265 -0
- data/lib/subskribe_dev/models/account_address_json.rb +229 -0
- data/lib/subskribe_dev/models/account_contact.rb +530 -0
- data/lib/subskribe_dev/models/account_contact_json.rb +274 -0
- data/lib/subskribe_dev/models/account_json.rb +395 -0
- data/lib/subskribe_dev/models/account_payment_method_json.rb +268 -0
- data/lib/subskribe_dev/models/account_receivable_contact_json.rb +225 -0
- data/lib/subskribe_dev/models/accounting_event.rb +319 -0
- data/lib/subskribe_dev/models/accounting_event_paginated_response.rb +204 -0
- data/lib/subskribe_dev/models/accounting_period.rb +356 -0
- data/lib/subskribe_dev/models/accounting_period_calculation.rb +229 -0
- data/lib/subskribe_dev/models/add_and_apply_payment_application_json.rb +344 -0
- data/lib/subskribe_dev/models/anrok_integration_input.rb +184 -0
- data/lib/subskribe_dev/models/approval_matrix_import_data_json.rb +229 -0
- data/lib/subskribe_dev/models/approval_matrix_import_preview.rb +226 -0
- data/lib/subskribe_dev/models/approval_role_json.rb +220 -0
- data/lib/subskribe_dev/models/approval_role_segment_change.rb +211 -0
- data/lib/subskribe_dev/models/approval_segment_json.rb +220 -0
- data/lib/subskribe_dev/models/attachment.rb +326 -0
- data/lib/subskribe_dev/models/attribute_reference.rb +193 -0
- data/lib/subskribe_dev/models/auth_saml_integration_json.rb +204 -0
- data/lib/subskribe_dev/models/automated_invoice_rule.rb +328 -0
- data/lib/subskribe_dev/models/automated_invoice_rule_request_json.rb +307 -0
- data/lib/subskribe_dev/models/avalara_integration.rb +238 -0
- data/lib/subskribe_dev/models/avalara_integration_input.rb +268 -0
- data/lib/subskribe_dev/models/billing_event_entry.rb +211 -0
- data/lib/subskribe_dev/models/billing_event_input.rb +216 -0
- data/lib/subskribe_dev/models/bulk_invoice_run.rb +350 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_exclusions.rb +197 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_input.rb +263 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_item.rb +364 -0
- data/lib/subskribe_dev/models/bulk_invoice_run_selector.rb +184 -0
- data/lib/subskribe_dev/models/bulk_payment_upload_data.rb +274 -0
- data/lib/subskribe_dev/models/bulk_payment_upload_result.rb +204 -0
- data/lib/subskribe_dev/models/byte_buffer.rb +247 -0
- data/lib/subskribe_dev/models/catalog_relationship.rb +364 -0
- data/lib/subskribe_dev/models/charge_json.rb +631 -0
- data/lib/subskribe_dev/models/charge_partial_json.rb +310 -0
- data/lib/subskribe_dev/models/company_contact_json.rb +225 -0
- data/lib/subskribe_dev/models/credit_memo_application_json.rb +239 -0
- data/lib/subskribe_dev/models/credit_memo_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/credit_memo_json.rb +363 -0
- data/lib/subskribe_dev/models/credit_memo_line_item_json.rb +252 -0
- data/lib/subskribe_dev/models/credit_memo_line_item_request_json.rb +211 -0
- data/lib/subskribe_dev/models/credit_memo_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/crm_account_import_response.rb +193 -0
- data/lib/subskribe_dev/models/custom_field_default.rb +195 -0
- data/lib/subskribe_dev/models/custom_field_definition_create_input.rb +317 -0
- data/lib/subskribe_dev/models/custom_field_definition_json.rb +313 -0
- data/lib/subskribe_dev/models/custom_field_definition_update_input.rb +256 -0
- data/lib/subskribe_dev/models/custom_field_entry.rb +325 -0
- data/lib/subskribe_dev/models/custom_field_update_input.rb +195 -0
- data/lib/subskribe_dev/models/custom_field_value.rb +316 -0
- data/lib/subskribe_dev/models/data_import.rb +355 -0
- data/lib/subskribe_dev/models/discount_detail_json.rb +263 -0
- data/lib/subskribe_dev/models/discount_json.rb +254 -0
- data/lib/subskribe_dev/models/docu_sign_integration_request_json.rb +236 -0
- data/lib/subskribe_dev/models/docu_sign_integration_response_json.rb +245 -0
- data/lib/subskribe_dev/models/document_custom_content.rb +211 -0
- data/lib/subskribe_dev/models/document_section.rb +265 -0
- data/lib/subskribe_dev/models/document_template_json.rb +300 -0
- data/lib/subskribe_dev/models/dunning_setting_json.rb +200 -0
- data/lib/subskribe_dev/models/email_notifiers_list.rb +208 -0
- data/lib/subskribe_dev/models/entity.rb +356 -0
- data/lib/subskribe_dev/models/entity_json.rb +347 -0
- data/lib/subskribe_dev/models/entity_ref.rb +202 -0
- data/lib/subskribe_dev/models/entry.rb +202 -0
- data/lib/subskribe_dev/models/external_arr_schedule_json.rb +319 -0
- data/lib/subskribe_dev/models/flatfile_workbook_response.rb +184 -0
- data/lib/subskribe_dev/models/flatfile_workbook_response_data.rb +193 -0
- data/lib/subskribe_dev/models/input_stream.rb +175 -0
- data/lib/subskribe_dev/models/integration.rb +311 -0
- data/lib/subskribe_dev/models/invoice_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/invoice_item_json.rb +355 -0
- data/lib/subskribe_dev/models/invoice_item_preview_json.rb +229 -0
- data/lib/subskribe_dev/models/invoice_json.rb +439 -0
- data/lib/subskribe_dev/models/invoice_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/invoice_number_prefix.rb +184 -0
- data/lib/subskribe_dev/models/invoice_preview_json.rb +222 -0
- data/lib/subskribe_dev/models/ledger_account.rb +316 -0
- data/lib/subskribe_dev/models/ledger_account_mapping.rb +222 -0
- data/lib/subskribe_dev/models/metrics_json.rb +267 -0
- data/lib/subskribe_dev/models/notification_target_and_subscriptions.rb +265 -0
- data/lib/subskribe_dev/models/number_config.rb +254 -0
- data/lib/subskribe_dev/models/opportunity.rb +326 -0
- data/lib/subskribe_dev/models/opportunity_json.rb +326 -0
- data/lib/subskribe_dev/models/opportunity_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/opportunity_rest_json.rb +317 -0
- data/lib/subskribe_dev/models/order_json.rb +754 -0
- data/lib/subskribe_dev/models/order_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/order_line_item_json.rb +474 -0
- data/lib/subskribe_dev/models/order_line_item_request_json.rb +384 -0
- data/lib/subskribe_dev/models/order_request_json.rb +616 -0
- data/lib/subskribe_dev/models/order_terms.rb +265 -0
- data/lib/subskribe_dev/models/paginated_accounts_response.rb +204 -0
- data/lib/subskribe_dev/models/paginated_response.rb +204 -0
- data/lib/subskribe_dev/models/payment_balance_json.rb +211 -0
- data/lib/subskribe_dev/models/payment_configuration.rb +208 -0
- data/lib/subskribe_dev/models/payment_json.rb +300 -0
- data/lib/subskribe_dev/models/payment_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/payment_term_settings_json.rb +219 -0
- data/lib/subskribe_dev/models/plan_json.rb +339 -0
- data/lib/subskribe_dev/models/plan_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/plan_metadata_json.rb +187 -0
- data/lib/subskribe_dev/models/predefined_report_def_chart_json.rb +265 -0
- data/lib/subskribe_dev/models/predefined_report_def_json.rb +222 -0
- data/lib/subskribe_dev/models/predefined_report_defs_json.rb +186 -0
- data/lib/subskribe_dev/models/predefined_report_json.rb +213 -0
- data/lib/subskribe_dev/models/predefined_report_param.rb +296 -0
- data/lib/subskribe_dev/models/predefined_report_param_object.rb +296 -0
- data/lib/subskribe_dev/models/prepaid_stats.rb +310 -0
- data/lib/subskribe_dev/models/price_tier_json.rb +212 -0
- data/lib/subskribe_dev/models/product_category.rb +264 -0
- data/lib/subskribe_dev/models/product_category_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/product_input_json.rb +249 -0
- data/lib/subskribe_dev/models/product_json.rb +276 -0
- data/lib/subskribe_dev/models/product_json_pagination_response.rb +204 -0
- data/lib/subskribe_dev/models/purchase_order.rb +226 -0
- data/lib/subskribe_dev/models/raw_usage.rb +247 -0
- data/lib/subskribe_dev/models/raw_usages_data.rb +192 -0
- data/lib/subskribe_dev/models/recognition_event_completion.rb +322 -0
- data/lib/subskribe_dev/models/recognition_rule.rb +376 -0
- data/lib/subskribe_dev/models/recurrence_json.rb +256 -0
- data/lib/subskribe_dev/models/refund.rb +301 -0
- data/lib/subskribe_dev/models/refund_detail.rb +322 -0
- data/lib/subskribe_dev/models/refund_request_json.rb +272 -0
- data/lib/subskribe_dev/models/report_duration.rb +193 -0
- data/lib/subskribe_dev/models/report_job_response.rb +245 -0
- data/lib/subskribe_dev/models/salesforce_account.rb +229 -0
- data/lib/subskribe_dev/models/salesforce_account_billing_address.rb +220 -0
- data/lib/subskribe_dev/models/salesforce_client_integration_request_json.rb +211 -0
- data/lib/subskribe_dev/models/settlement_application.rb +329 -0
- data/lib/subskribe_dev/models/standalone_credit_memo_request.rb +353 -0
- data/lib/subskribe_dev/models/subscription_charge_alias.rb +283 -0
- data/lib/subskribe_dev/models/subscription_charge_json.rb +362 -0
- data/lib/subskribe_dev/models/subscription_json.rb +583 -0
- data/lib/subskribe_dev/models/subscription_update_json.rb +280 -0
- data/lib/subskribe_dev/models/tax_jar_integration.rb +238 -0
- data/lib/subskribe_dev/models/tax_jar_integration_input.rb +193 -0
- data/lib/subskribe_dev/models/tax_rate_json.rb +286 -0
- data/lib/subskribe_dev/models/tax_rate_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/tenant_credit_memo_configuration_json.rb +211 -0
- data/lib/subskribe_dev/models/tenant_discount_json.rb +193 -0
- data/lib/subskribe_dev/models/tenant_discount_line_item_json.rb +202 -0
- data/lib/subskribe_dev/models/tenant_invoice_config.rb +254 -0
- data/lib/subskribe_dev/models/tenant_json.rb +283 -0
- data/lib/subskribe_dev/models/tenant_setting_json.rb +307 -0
- data/lib/subskribe_dev/models/time_series_amount_json.rb +193 -0
- data/lib/subskribe_dev/models/time_zone.rb +211 -0
- data/lib/subskribe_dev/models/update_invoice_request.rb +282 -0
- data/lib/subskribe_dev/models/usage_aggregate_output.rb +258 -0
- data/lib/subskribe_dev/models/usage_batch_insert_result.rb +213 -0
- data/lib/subskribe_dev/models/user_group_json.rb +224 -0
- data/lib/subskribe_dev/models/user_group_request_json.rb +224 -0
- data/lib/subskribe_dev/models/user_input.rb +304 -0
- data/lib/subskribe_dev/models/user_json.rb +376 -0
- data/lib/subskribe_dev/models/user_pagination_response_json.rb +204 -0
- data/lib/subskribe_dev/models/void_invoice_request.rb +203 -0
- data/lib/subskribe_dev/models/void_payment_json.rb +235 -0
- data/lib/subskribe_dev/version.rb +1 -1
- data/lib/subskribe_dev.rb +188 -0
- data/spec/api/accounting_api_spec.rb +74 -0
- data/spec/api/accounts_api_spec.rb +232 -0
- data/spec/api/approvals_api_spec.rb +260 -0
- data/spec/api/attachments_api_spec.rb +100 -0
- data/spec/api/authentication_api_spec.rb +108 -0
- data/spec/api/billing_api_spec.rb +516 -0
- data/spec/api/credit_memo_api_spec.rb +181 -0
- data/spec/api/custom_field_api_spec.rb +126 -0
- data/spec/api/customization_api_spec.rb +89 -0
- data/spec/api/default_api_spec.rb +81 -0
- data/spec/api/discounts_api_spec.rb +108 -0
- data/spec/api/entities_api_spec.rb +120 -0
- data/spec/api/entity_api_spec.rb +48 -0
- data/spec/api/erp_api_spec.rb +95 -0
- data/spec/api/import_api_spec.rb +164 -0
- data/spec/api/integrations_api_spec.rb +420 -0
- data/spec/api/metrics_reporting_api_spec.rb +84 -0
- data/spec/api/notifications_api_spec.rb +84 -0
- data/spec/api/opportunity_api_spec.rb +72 -0
- data/spec/api/orders_api_spec.rb +351 -0
- data/spec/api/payments_api_spec.rb +132 -0
- data/spec/api/product_catalog_api_spec.rb +448 -0
- data/spec/api/rate_card_api_spec.rb +46 -0
- data/spec/api/refunds_api_spec.rb +73 -0
- data/spec/api/reports_api_spec.rb +82 -0
- data/spec/api/revenue_recognition_api_spec.rb +144 -0
- data/spec/api/sales_room_api_spec.rb +47 -0
- data/spec/api/subscriptions_api_spec.rb +162 -0
- data/spec/api/usage_api_spec.rb +169 -0
- data/spec/api/users_api_spec.rb +203 -0
- data/spec/models/account_address_json_spec.rb +71 -0
- data/spec/models/account_address_spec.rb +95 -0
- data/spec/models/account_contact_json_spec.rb +101 -0
- data/spec/models/account_contact_spec.rb +141 -0
- data/spec/models/account_json_spec.rb +163 -0
- data/spec/models/account_payment_method_json_spec.rb +75 -0
- data/spec/models/account_receivable_contact_json_spec.rb +65 -0
- data/spec/models/accounting_event_paginated_response_spec.rb +53 -0
- data/spec/models/accounting_event_spec.rb +111 -0
- data/spec/models/accounting_period_calculation_spec.rb +71 -0
- data/spec/models/accounting_period_spec.rb +133 -0
- data/spec/models/add_and_apply_payment_application_json_spec.rb +115 -0
- data/spec/models/anrok_integration_input_spec.rb +41 -0
- data/spec/models/approval_matrix_import_data_json_spec.rb +71 -0
- data/spec/models/approval_matrix_import_preview_spec.rb +65 -0
- data/spec/models/approval_role_json_spec.rb +65 -0
- data/spec/models/approval_role_segment_change_spec.rb +59 -0
- data/spec/models/approval_segment_json_spec.rb +65 -0
- data/spec/models/attachment_spec.rb +103 -0
- data/spec/models/attribute_reference_spec.rb +47 -0
- data/spec/models/auth_saml_integration_json_spec.rb +53 -0
- data/spec/models/automated_invoice_rule_request_json_spec.rb +113 -0
- data/spec/models/automated_invoice_rule_spec.rb +137 -0
- data/spec/models/avalara_integration_input_spec.rb +65 -0
- data/spec/models/avalara_integration_spec.rb +77 -0
- data/spec/models/billing_event_entry_spec.rb +59 -0
- data/spec/models/billing_event_input_spec.rb +59 -0
- data/spec/models/bulk_invoice_run_exclusions_spec.rb +47 -0
- data/spec/models/bulk_invoice_run_input_spec.rb +75 -0
- data/spec/models/bulk_invoice_run_item_spec.rb +161 -0
- data/spec/models/bulk_invoice_run_selector_spec.rb +41 -0
- data/spec/models/bulk_invoice_run_spec.rb +125 -0
- data/spec/models/bulk_payment_upload_data_spec.rb +101 -0
- data/spec/models/bulk_payment_upload_result_spec.rb +53 -0
- data/spec/models/byte_buffer_spec.rb +83 -0
- data/spec/models/catalog_relationship_spec.rb +75 -0
- data/spec/models/charge_json_spec.rb +295 -0
- data/spec/models/charge_partial_json_spec.rb +125 -0
- data/spec/models/company_contact_json_spec.rb +65 -0
- data/spec/models/credit_memo_application_json_spec.rb +71 -0
- data/spec/models/credit_memo_balance_json_spec.rb +59 -0
- data/spec/models/credit_memo_json_spec.rb +117 -0
- data/spec/models/credit_memo_line_item_json_spec.rb +83 -0
- data/spec/models/credit_memo_line_item_request_json_spec.rb +59 -0
- data/spec/models/credit_memo_pagination_response_json_spec.rb +53 -0
- data/spec/models/crm_account_import_response_spec.rb +47 -0
- data/spec/models/custom_field_default_spec.rb +47 -0
- data/spec/models/custom_field_definition_create_input_spec.rb +95 -0
- data/spec/models/custom_field_definition_json_spec.rb +103 -0
- data/spec/models/custom_field_definition_update_input_spec.rb +69 -0
- data/spec/models/custom_field_entry_spec.rb +103 -0
- data/spec/models/custom_field_update_input_spec.rb +47 -0
- data/spec/models/custom_field_value_spec.rb +97 -0
- data/spec/models/data_import_spec.rb +123 -0
- data/spec/models/discount_detail_json_spec.rb +75 -0
- data/spec/models/discount_json_spec.rb +69 -0
- data/spec/models/docu_sign_integration_request_json_spec.rb +57 -0
- data/spec/models/docu_sign_integration_response_json_spec.rb +63 -0
- data/spec/models/document_custom_content_spec.rb +59 -0
- data/spec/models/document_section_spec.rb +75 -0
- data/spec/models/document_template_json_spec.rb +91 -0
- data/spec/models/dunning_setting_json_spec.rb +47 -0
- data/spec/models/email_notifiers_list_spec.rb +53 -0
- data/spec/models/entity_json_spec.rb +127 -0
- data/spec/models/entity_ref_spec.rb +53 -0
- data/spec/models/entity_spec.rb +133 -0
- data/spec/models/entry_spec.rb +53 -0
- data/spec/models/external_arr_schedule_json_spec.rb +99 -0
- data/spec/models/flatfile_workbook_response_data_spec.rb +47 -0
- data/spec/models/flatfile_workbook_response_spec.rb +41 -0
- data/spec/models/input_stream_spec.rb +35 -0
- data/spec/models/integration_spec.rb +103 -0
- data/spec/models/invoice_balance_json_spec.rb +59 -0
- data/spec/models/invoice_item_json_spec.rb +155 -0
- data/spec/models/invoice_item_preview_json_spec.rb +71 -0
- data/spec/models/invoice_json_pagination_response_spec.rb +53 -0
- data/spec/models/invoice_json_spec.rb +187 -0
- data/spec/models/invoice_number_prefix_spec.rb +41 -0
- data/spec/models/invoice_preview_json_spec.rb +65 -0
- data/spec/models/ledger_account_mapping_spec.rb +65 -0
- data/spec/models/ledger_account_spec.rb +93 -0
- data/spec/models/metrics_json_spec.rb +95 -0
- data/spec/models/notification_target_and_subscriptions_spec.rb +79 -0
- data/spec/models/number_config_spec.rb +69 -0
- data/spec/models/opportunity_json_spec.rb +117 -0
- data/spec/models/opportunity_pagination_response_spec.rb +53 -0
- data/spec/models/opportunity_rest_json_spec.rb +111 -0
- data/spec/models/opportunity_spec.rb +117 -0
- data/spec/models/order_json_pagination_response_spec.rb +53 -0
- data/spec/models/order_json_spec.rb +367 -0
- data/spec/models/order_line_item_json_spec.rb +201 -0
- data/spec/models/order_line_item_request_json_spec.rb +141 -0
- data/spec/models/order_request_json_spec.rb +285 -0
- data/spec/models/order_terms_spec.rb +75 -0
- data/spec/models/paginated_accounts_response_spec.rb +53 -0
- data/spec/models/paginated_response_spec.rb +53 -0
- data/spec/models/payment_balance_json_spec.rb +59 -0
- data/spec/models/payment_configuration_spec.rb +45 -0
- data/spec/models/payment_json_pagination_response_spec.rb +53 -0
- data/spec/models/payment_json_spec.rb +93 -0
- data/spec/models/payment_term_settings_json_spec.rb +53 -0
- data/spec/models/plan_json_pagination_response_spec.rb +53 -0
- data/spec/models/plan_json_spec.rb +117 -0
- data/spec/models/plan_metadata_json_spec.rb +41 -0
- data/spec/models/predefined_report_def_chart_json_spec.rb +95 -0
- data/spec/models/predefined_report_def_json_spec.rb +65 -0
- data/spec/models/predefined_report_defs_json_spec.rb +41 -0
- data/spec/models/predefined_report_json_spec.rb +59 -0
- data/spec/models/predefined_report_param_object_spec.rb +85 -0
- data/spec/models/predefined_report_param_spec.rb +85 -0
- data/spec/models/prepaid_stats_spec.rb +125 -0
- data/spec/models/price_tier_json_spec.rb +53 -0
- data/spec/models/product_category_pagination_response_spec.rb +53 -0
- data/spec/models/product_category_spec.rb +77 -0
- data/spec/models/product_input_json_spec.rb +83 -0
- data/spec/models/product_json_pagination_response_spec.rb +53 -0
- data/spec/models/product_json_spec.rb +101 -0
- data/spec/models/purchase_order_spec.rb +53 -0
- data/spec/models/raw_usage_spec.rb +77 -0
- data/spec/models/raw_usages_data_spec.rb +41 -0
- data/spec/models/recognition_event_completion_spec.rb +111 -0
- data/spec/models/recognition_rule_spec.rb +133 -0
- data/spec/models/recurrence_json_spec.rb +51 -0
- data/spec/models/refund_detail_spec.rb +113 -0
- data/spec/models/refund_request_json_spec.rb +83 -0
- data/spec/models/refund_spec.rb +119 -0
- data/spec/models/report_duration_spec.rb +47 -0
- data/spec/models/report_job_response_spec.rb +63 -0
- data/spec/models/salesforce_account_billing_address_spec.rb +65 -0
- data/spec/models/salesforce_account_spec.rb +71 -0
- data/spec/models/salesforce_client_integration_request_json_spec.rb +59 -0
- data/spec/models/settlement_application_spec.rb +115 -0
- data/spec/models/standalone_credit_memo_request_spec.rb +117 -0
- data/spec/models/subscription_charge_alias_spec.rb +59 -0
- data/spec/models/subscription_charge_json_spec.rb +131 -0
- data/spec/models/subscription_json_spec.rb +241 -0
- data/spec/models/subscription_update_json_spec.rb +89 -0
- data/spec/models/tax_jar_integration_input_spec.rb +47 -0
- data/spec/models/tax_jar_integration_spec.rb +77 -0
- data/spec/models/tax_rate_json_spec.rb +87 -0
- data/spec/models/tax_rate_pagination_response_json_spec.rb +53 -0
- data/spec/models/tenant_credit_memo_configuration_json_spec.rb +59 -0
- data/spec/models/tenant_discount_json_spec.rb +47 -0
- data/spec/models/tenant_discount_line_item_json_spec.rb +53 -0
- data/spec/models/tenant_invoice_config_spec.rb +69 -0
- data/spec/models/tenant_json_spec.rb +107 -0
- data/spec/models/tenant_setting_json_spec.rb +95 -0
- data/spec/models/time_series_amount_json_spec.rb +47 -0
- data/spec/models/time_zone_spec.rb +59 -0
- data/spec/models/update_invoice_request_spec.rb +71 -0
- data/spec/models/usage_aggregate_output_spec.rb +89 -0
- data/spec/models/usage_batch_insert_result_spec.rb +59 -0
- data/spec/models/user_group_json_spec.rb +65 -0
- data/spec/models/user_group_request_json_spec.rb +65 -0
- data/spec/models/user_input_spec.rb +97 -0
- data/spec/models/user_json_spec.rb +137 -0
- data/spec/models/user_pagination_response_json_spec.rb +53 -0
- data/spec/models/void_invoice_request_spec.rb +47 -0
- data/spec/models/void_payment_json_spec.rb +65 -0
- data/subskribe_dev.gemspec +4 -4
- metadata +784 -28
@@ -0,0 +1,299 @@
|
|
1
|
+
=begin
|
2
|
+
#Subskribe API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.41
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module SubskribeDevClient
|
16
|
+
class AttachmentsApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Add an attachment
|
23
|
+
# Attaches a document to the specified account. The post body should contain the body of the document that is to be attached. On success the Id of the attachment is returned.
|
24
|
+
# @param account_id id of the account to attach the document to
|
25
|
+
# @param [Hash] opts the optional parameters
|
26
|
+
# @option opts [File] :file
|
27
|
+
# @option opts [String] :file_name name to associate with the attachment
|
28
|
+
# @option opts [String] :description description of the document
|
29
|
+
# @option opts [Integer] :size size in bytes of the document
|
30
|
+
# @option opts [String] :tag tag to apply to the attachment
|
31
|
+
# @return [Attachment]
|
32
|
+
def add_attachment_to_account(account_id, opts = {})
|
33
|
+
data, _status_code, _headers = add_attachment_to_account_with_http_info(account_id, opts)
|
34
|
+
data
|
35
|
+
end
|
36
|
+
|
37
|
+
# Add an attachment
|
38
|
+
# Attaches a document to the specified account. The post body should contain the body of the document that is to be attached. On success the Id of the attachment is returned.
|
39
|
+
# @param account_id id of the account to attach the document to
|
40
|
+
# @param [Hash] opts the optional parameters
|
41
|
+
# @option opts [File] :file
|
42
|
+
# @option opts [String] :file_name name to associate with the attachment
|
43
|
+
# @option opts [String] :description description of the document
|
44
|
+
# @option opts [Integer] :size size in bytes of the document
|
45
|
+
# @option opts [String] :tag tag to apply to the attachment
|
46
|
+
# @return [Array<(Attachment, Fixnum, Hash)>] Attachment data, response status code and response headers
|
47
|
+
def add_attachment_to_account_with_http_info(account_id, opts = {})
|
48
|
+
if @api_client.config.debugging
|
49
|
+
@api_client.config.logger.debug 'Calling API: AttachmentsApi.add_attachment_to_account ...'
|
50
|
+
end
|
51
|
+
# verify the required parameter 'account_id' is set
|
52
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
53
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AttachmentsApi.add_attachment_to_account"
|
54
|
+
end
|
55
|
+
if @api_client.config.client_side_validation && opts[:'tag'] && !['MASTER_SUBSCRIPTION_AGREEMENT', 'STATEMENT_OF_WORK', 'ORDER_FORM', 'OTHER'].include?(opts[:'tag'])
|
56
|
+
fail ArgumentError, 'invalid value for "tag", must be one of MASTER_SUBSCRIPTION_AGREEMENT, STATEMENT_OF_WORK, ORDER_FORM, OTHER'
|
57
|
+
end
|
58
|
+
# resource path
|
59
|
+
local_var_path = '/attachments/account/{accountId}'.sub('{' + 'accountId' + '}', account_id.to_s)
|
60
|
+
|
61
|
+
# query parameters
|
62
|
+
query_params = {}
|
63
|
+
query_params[:'fileName'] = opts[:'file_name'] if !opts[:'file_name'].nil?
|
64
|
+
query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
|
65
|
+
query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
|
66
|
+
query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
|
67
|
+
|
68
|
+
# header parameters
|
69
|
+
header_params = {}
|
70
|
+
# HTTP header 'Accept' (if needed)
|
71
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
72
|
+
# HTTP header 'Content-Type'
|
73
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
|
74
|
+
|
75
|
+
# form parameters
|
76
|
+
form_params = {}
|
77
|
+
form_params['file'] = opts[:'file'] if !opts[:'file'].nil?
|
78
|
+
|
79
|
+
# http body (model)
|
80
|
+
post_body = nil
|
81
|
+
auth_names = ['ApiKeyAuth']
|
82
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
83
|
+
:header_params => header_params,
|
84
|
+
:query_params => query_params,
|
85
|
+
:form_params => form_params,
|
86
|
+
:body => post_body,
|
87
|
+
:auth_names => auth_names,
|
88
|
+
:return_type => 'Attachment')
|
89
|
+
if @api_client.config.debugging
|
90
|
+
@api_client.config.logger.debug "API called: AttachmentsApi#add_attachment_to_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
91
|
+
end
|
92
|
+
return data, status_code, headers
|
93
|
+
end
|
94
|
+
# Delete an attachment
|
95
|
+
# Unattaches and deletes the specified document
|
96
|
+
# @param attachment_id id of the attachment
|
97
|
+
# @param [Hash] opts the optional parameters
|
98
|
+
# @return [nil]
|
99
|
+
def delete_attachment_from_account(attachment_id, opts = {})
|
100
|
+
delete_attachment_from_account_with_http_info(attachment_id, opts)
|
101
|
+
nil
|
102
|
+
end
|
103
|
+
|
104
|
+
# Delete an attachment
|
105
|
+
# Unattaches and deletes the specified document
|
106
|
+
# @param attachment_id id of the attachment
|
107
|
+
# @param [Hash] opts the optional parameters
|
108
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
109
|
+
def delete_attachment_from_account_with_http_info(attachment_id, opts = {})
|
110
|
+
if @api_client.config.debugging
|
111
|
+
@api_client.config.logger.debug 'Calling API: AttachmentsApi.delete_attachment_from_account ...'
|
112
|
+
end
|
113
|
+
# verify the required parameter 'attachment_id' is set
|
114
|
+
if @api_client.config.client_side_validation && attachment_id.nil?
|
115
|
+
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentsApi.delete_attachment_from_account"
|
116
|
+
end
|
117
|
+
# resource path
|
118
|
+
local_var_path = '/attachments/{attachmentId}'.sub('{' + 'attachmentId' + '}', attachment_id.to_s)
|
119
|
+
|
120
|
+
# query parameters
|
121
|
+
query_params = {}
|
122
|
+
|
123
|
+
# header parameters
|
124
|
+
header_params = {}
|
125
|
+
# HTTP header 'Accept' (if needed)
|
126
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
127
|
+
|
128
|
+
# form parameters
|
129
|
+
form_params = {}
|
130
|
+
|
131
|
+
# http body (model)
|
132
|
+
post_body = nil
|
133
|
+
auth_names = ['ApiKeyAuth']
|
134
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
135
|
+
:header_params => header_params,
|
136
|
+
:query_params => query_params,
|
137
|
+
:form_params => form_params,
|
138
|
+
:body => post_body,
|
139
|
+
:auth_names => auth_names)
|
140
|
+
if @api_client.config.debugging
|
141
|
+
@api_client.config.logger.debug "API called: AttachmentsApi#delete_attachment_from_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
142
|
+
end
|
143
|
+
return data, status_code, headers
|
144
|
+
end
|
145
|
+
# Get attachment contents
|
146
|
+
# Gets the contents of the specified attachment
|
147
|
+
# @param attachment_id id of the attachment
|
148
|
+
# @param [Hash] opts the optional parameters
|
149
|
+
# @return [nil]
|
150
|
+
def get_attachment(attachment_id, opts = {})
|
151
|
+
get_attachment_with_http_info(attachment_id, opts)
|
152
|
+
nil
|
153
|
+
end
|
154
|
+
|
155
|
+
# Get attachment contents
|
156
|
+
# Gets the contents of the specified attachment
|
157
|
+
# @param attachment_id id of the attachment
|
158
|
+
# @param [Hash] opts the optional parameters
|
159
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
160
|
+
def get_attachment_with_http_info(attachment_id, opts = {})
|
161
|
+
if @api_client.config.debugging
|
162
|
+
@api_client.config.logger.debug 'Calling API: AttachmentsApi.get_attachment ...'
|
163
|
+
end
|
164
|
+
# verify the required parameter 'attachment_id' is set
|
165
|
+
if @api_client.config.client_side_validation && attachment_id.nil?
|
166
|
+
fail ArgumentError, "Missing the required parameter 'attachment_id' when calling AttachmentsApi.get_attachment"
|
167
|
+
end
|
168
|
+
# resource path
|
169
|
+
local_var_path = '/attachments/{attachmentId}'.sub('{' + 'attachmentId' + '}', attachment_id.to_s)
|
170
|
+
|
171
|
+
# query parameters
|
172
|
+
query_params = {}
|
173
|
+
|
174
|
+
# header parameters
|
175
|
+
header_params = {}
|
176
|
+
# HTTP header 'Accept' (if needed)
|
177
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream', 'application/json'])
|
178
|
+
|
179
|
+
# form parameters
|
180
|
+
form_params = {}
|
181
|
+
|
182
|
+
# http body (model)
|
183
|
+
post_body = nil
|
184
|
+
auth_names = ['ApiKeyAuth']
|
185
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
186
|
+
:header_params => header_params,
|
187
|
+
:query_params => query_params,
|
188
|
+
:form_params => form_params,
|
189
|
+
:body => post_body,
|
190
|
+
:auth_names => auth_names)
|
191
|
+
if @api_client.config.debugging
|
192
|
+
@api_client.config.logger.debug "API called: AttachmentsApi#get_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
193
|
+
end
|
194
|
+
return data, status_code, headers
|
195
|
+
end
|
196
|
+
# Get attachments for an account
|
197
|
+
# Lists all the documents attached to an account
|
198
|
+
# @param account_id id of the attachment
|
199
|
+
# @param [Hash] opts the optional parameters
|
200
|
+
# @return [Array<Attachment>]
|
201
|
+
def list_account_attachments(account_id, opts = {})
|
202
|
+
data, _status_code, _headers = list_account_attachments_with_http_info(account_id, opts)
|
203
|
+
data
|
204
|
+
end
|
205
|
+
|
206
|
+
# Get attachments for an account
|
207
|
+
# Lists all the documents attached to an account
|
208
|
+
# @param account_id id of the attachment
|
209
|
+
# @param [Hash] opts the optional parameters
|
210
|
+
# @return [Array<(Array<Attachment>, Fixnum, Hash)>] Array<Attachment> data, response status code and response headers
|
211
|
+
def list_account_attachments_with_http_info(account_id, opts = {})
|
212
|
+
if @api_client.config.debugging
|
213
|
+
@api_client.config.logger.debug 'Calling API: AttachmentsApi.list_account_attachments ...'
|
214
|
+
end
|
215
|
+
# verify the required parameter 'account_id' is set
|
216
|
+
if @api_client.config.client_side_validation && account_id.nil?
|
217
|
+
fail ArgumentError, "Missing the required parameter 'account_id' when calling AttachmentsApi.list_account_attachments"
|
218
|
+
end
|
219
|
+
# resource path
|
220
|
+
local_var_path = '/attachments/account/{accountId}'.sub('{' + 'accountId' + '}', account_id.to_s)
|
221
|
+
|
222
|
+
# query parameters
|
223
|
+
query_params = {}
|
224
|
+
|
225
|
+
# header parameters
|
226
|
+
header_params = {}
|
227
|
+
# HTTP header 'Accept' (if needed)
|
228
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
229
|
+
|
230
|
+
# form parameters
|
231
|
+
form_params = {}
|
232
|
+
|
233
|
+
# http body (model)
|
234
|
+
post_body = nil
|
235
|
+
auth_names = ['ApiKeyAuth']
|
236
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
237
|
+
:header_params => header_params,
|
238
|
+
:query_params => query_params,
|
239
|
+
:form_params => form_params,
|
240
|
+
:body => post_body,
|
241
|
+
:auth_names => auth_names,
|
242
|
+
:return_type => 'Array<Attachment>')
|
243
|
+
if @api_client.config.debugging
|
244
|
+
@api_client.config.logger.debug "API called: AttachmentsApi#list_account_attachments\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
245
|
+
end
|
246
|
+
return data, status_code, headers
|
247
|
+
end
|
248
|
+
# Update the details of an attachment
|
249
|
+
# Updates the details of the specified document
|
250
|
+
# @param [Hash] opts the optional parameters
|
251
|
+
# @option opts [Attachment] :body json representing the attachment
|
252
|
+
# @return [Attachment]
|
253
|
+
def modify_attachment(opts = {})
|
254
|
+
data, _status_code, _headers = modify_attachment_with_http_info(opts)
|
255
|
+
data
|
256
|
+
end
|
257
|
+
|
258
|
+
# Update the details of an attachment
|
259
|
+
# Updates the details of the specified document
|
260
|
+
# @param [Hash] opts the optional parameters
|
261
|
+
# @option opts [Attachment] :body json representing the attachment
|
262
|
+
# @return [Array<(Attachment, Fixnum, Hash)>] Attachment data, response status code and response headers
|
263
|
+
def modify_attachment_with_http_info(opts = {})
|
264
|
+
if @api_client.config.debugging
|
265
|
+
@api_client.config.logger.debug 'Calling API: AttachmentsApi.modify_attachment ...'
|
266
|
+
end
|
267
|
+
# resource path
|
268
|
+
local_var_path = '/attachments'
|
269
|
+
|
270
|
+
# query parameters
|
271
|
+
query_params = {}
|
272
|
+
|
273
|
+
# header parameters
|
274
|
+
header_params = {}
|
275
|
+
# HTTP header 'Accept' (if needed)
|
276
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
277
|
+
# HTTP header 'Content-Type'
|
278
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
279
|
+
|
280
|
+
# form parameters
|
281
|
+
form_params = {}
|
282
|
+
|
283
|
+
# http body (model)
|
284
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
285
|
+
auth_names = ['ApiKeyAuth']
|
286
|
+
data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
|
287
|
+
:header_params => header_params,
|
288
|
+
:query_params => query_params,
|
289
|
+
:form_params => form_params,
|
290
|
+
:body => post_body,
|
291
|
+
:auth_names => auth_names,
|
292
|
+
:return_type => 'Attachment')
|
293
|
+
if @api_client.config.debugging
|
294
|
+
@api_client.config.logger.debug "API called: AttachmentsApi#modify_attachment\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
295
|
+
end
|
296
|
+
return data, status_code, headers
|
297
|
+
end
|
298
|
+
end
|
299
|
+
end
|
@@ -0,0 +1,335 @@
|
|
1
|
+
=begin
|
2
|
+
#Subskribe API
|
3
|
+
|
4
|
+
#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
5
|
+
|
6
|
+
OpenAPI spec version: 1.0.0
|
7
|
+
|
8
|
+
Generated by: https://github.com/swagger-api/swagger-codegen.git
|
9
|
+
Swagger Codegen version: 2.4.41
|
10
|
+
|
11
|
+
=end
|
12
|
+
|
13
|
+
require 'uri'
|
14
|
+
|
15
|
+
module SubskribeDevClient
|
16
|
+
class AuthenticationApi
|
17
|
+
attr_accessor :api_client
|
18
|
+
|
19
|
+
def initialize(api_client = ApiClient.default)
|
20
|
+
@api_client = api_client
|
21
|
+
end
|
22
|
+
# Add a saml integration
|
23
|
+
# Adds a saml integration
|
24
|
+
# @param [Hash] opts the optional parameters
|
25
|
+
# @option opts [AuthSamlIntegrationJson] :body saml representing the integration
|
26
|
+
# @return [nil]
|
27
|
+
def add_saml_integration(opts = {})
|
28
|
+
add_saml_integration_with_http_info(opts)
|
29
|
+
nil
|
30
|
+
end
|
31
|
+
|
32
|
+
# Add a saml integration
|
33
|
+
# Adds a saml integration
|
34
|
+
# @param [Hash] opts the optional parameters
|
35
|
+
# @option opts [AuthSamlIntegrationJson] :body saml representing the integration
|
36
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
37
|
+
def add_saml_integration_with_http_info(opts = {})
|
38
|
+
if @api_client.config.debugging
|
39
|
+
@api_client.config.logger.debug 'Calling API: AuthenticationApi.add_saml_integration ...'
|
40
|
+
end
|
41
|
+
# resource path
|
42
|
+
local_var_path = '/auth/saml'
|
43
|
+
|
44
|
+
# query parameters
|
45
|
+
query_params = {}
|
46
|
+
|
47
|
+
# header parameters
|
48
|
+
header_params = {}
|
49
|
+
# HTTP header 'Accept' (if needed)
|
50
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
51
|
+
# HTTP header 'Content-Type'
|
52
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
53
|
+
|
54
|
+
# form parameters
|
55
|
+
form_params = {}
|
56
|
+
|
57
|
+
# http body (model)
|
58
|
+
post_body = @api_client.object_to_http_body(opts[:'body'])
|
59
|
+
auth_names = ['ApiKeyAuth']
|
60
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
61
|
+
:header_params => header_params,
|
62
|
+
:query_params => query_params,
|
63
|
+
:form_params => form_params,
|
64
|
+
:body => post_body,
|
65
|
+
:auth_names => auth_names)
|
66
|
+
if @api_client.config.debugging
|
67
|
+
@api_client.config.logger.debug "API called: AuthenticationApi#add_saml_integration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
68
|
+
end
|
69
|
+
return data, status_code, headers
|
70
|
+
end
|
71
|
+
# Create a new api key
|
72
|
+
# Create a new api key with the specified parameters. The new key is returned
|
73
|
+
# @param [Hash] opts the optional parameters
|
74
|
+
# @option opts [String] :role Role-based permissions to be associated with the key. Specify this OR userId.
|
75
|
+
# @option opts [Integer] :expiry Time of expiry in seconds since Epoch (GMT)
|
76
|
+
# @option opts [String] :user_id User to associate key with. Specify this OR role.
|
77
|
+
# @option opts [String] :entity_id Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).
|
78
|
+
# @return [String]
|
79
|
+
def create_api_key(opts = {})
|
80
|
+
data, _status_code, _headers = create_api_key_with_http_info(opts)
|
81
|
+
data
|
82
|
+
end
|
83
|
+
|
84
|
+
# Create a new api key
|
85
|
+
# Create a new api key with the specified parameters. The new key is returned
|
86
|
+
# @param [Hash] opts the optional parameters
|
87
|
+
# @option opts [String] :role Role-based permissions to be associated with the key. Specify this OR userId.
|
88
|
+
# @option opts [Integer] :expiry Time of expiry in seconds since Epoch (GMT)
|
89
|
+
# @option opts [String] :user_id User to associate key with. Specify this OR role.
|
90
|
+
# @option opts [String] :entity_id Scope of entities that the key has access to. Either specify a single entity or all entities (i.e. *).
|
91
|
+
# @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers
|
92
|
+
def create_api_key_with_http_info(opts = {})
|
93
|
+
if @api_client.config.debugging
|
94
|
+
@api_client.config.logger.debug 'Calling API: AuthenticationApi.create_api_key ...'
|
95
|
+
end
|
96
|
+
if @api_client.config.client_side_validation && opts[:'role'] && !['ADMIN', 'FINANCE', 'SALES', 'DEAL_DESK', 'BILLING_CLERK', 'REVENUE_CLERK', 'READ_ONLY', 'EXECUTIVE', 'CRM', 'IMPORT'].include?(opts[:'role'])
|
97
|
+
fail ArgumentError, 'invalid value for "role", must be one of ADMIN, FINANCE, SALES, DEAL_DESK, BILLING_CLERK, REVENUE_CLERK, READ_ONLY, EXECUTIVE, CRM, IMPORT'
|
98
|
+
end
|
99
|
+
# resource path
|
100
|
+
local_var_path = '/apikey'
|
101
|
+
|
102
|
+
# query parameters
|
103
|
+
query_params = {}
|
104
|
+
query_params[:'role'] = opts[:'role'] if !opts[:'role'].nil?
|
105
|
+
query_params[:'expiry'] = opts[:'expiry'] if !opts[:'expiry'].nil?
|
106
|
+
query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
|
107
|
+
query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
|
108
|
+
|
109
|
+
# header parameters
|
110
|
+
header_params = {}
|
111
|
+
# HTTP header 'Accept' (if needed)
|
112
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
113
|
+
# HTTP header 'Content-Type'
|
114
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
115
|
+
|
116
|
+
# form parameters
|
117
|
+
form_params = {}
|
118
|
+
|
119
|
+
# http body (model)
|
120
|
+
post_body = nil
|
121
|
+
auth_names = ['ApiKeyAuth']
|
122
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
123
|
+
:header_params => header_params,
|
124
|
+
:query_params => query_params,
|
125
|
+
:form_params => form_params,
|
126
|
+
:body => post_body,
|
127
|
+
:auth_names => auth_names,
|
128
|
+
:return_type => 'String')
|
129
|
+
if @api_client.config.debugging
|
130
|
+
@api_client.config.logger.debug "API called: AuthenticationApi#create_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
131
|
+
end
|
132
|
+
return data, status_code, headers
|
133
|
+
end
|
134
|
+
# Retrieves all API keys
|
135
|
+
# Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)
|
136
|
+
# @param [Hash] opts the optional parameters
|
137
|
+
# @return [nil]
|
138
|
+
def get_all_api_keys(opts = {})
|
139
|
+
get_all_api_keys_with_http_info(opts)
|
140
|
+
nil
|
141
|
+
end
|
142
|
+
|
143
|
+
# Retrieves all API keys
|
144
|
+
# Retrieves a list of (maximum 500 items) all API keys (including expired and deactivated keys)
|
145
|
+
# @param [Hash] opts the optional parameters
|
146
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
147
|
+
def get_all_api_keys_with_http_info(opts = {})
|
148
|
+
if @api_client.config.debugging
|
149
|
+
@api_client.config.logger.debug 'Calling API: AuthenticationApi.get_all_api_keys ...'
|
150
|
+
end
|
151
|
+
# resource path
|
152
|
+
local_var_path = '/apikey'
|
153
|
+
|
154
|
+
# query parameters
|
155
|
+
query_params = {}
|
156
|
+
|
157
|
+
# header parameters
|
158
|
+
header_params = {}
|
159
|
+
# HTTP header 'Accept' (if needed)
|
160
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
161
|
+
# HTTP header 'Content-Type'
|
162
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
163
|
+
|
164
|
+
# form parameters
|
165
|
+
form_params = {}
|
166
|
+
|
167
|
+
# http body (model)
|
168
|
+
post_body = nil
|
169
|
+
auth_names = ['ApiKeyAuth']
|
170
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
171
|
+
:header_params => header_params,
|
172
|
+
:query_params => query_params,
|
173
|
+
:form_params => form_params,
|
174
|
+
:body => post_body,
|
175
|
+
:auth_names => auth_names)
|
176
|
+
if @api_client.config.debugging
|
177
|
+
@api_client.config.logger.debug "API called: AuthenticationApi#get_all_api_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
178
|
+
end
|
179
|
+
return data, status_code, headers
|
180
|
+
end
|
181
|
+
# Retrieve an API key by id
|
182
|
+
# Retrieve an api key referenced by its id
|
183
|
+
# @param id
|
184
|
+
# @param [Hash] opts the optional parameters
|
185
|
+
# @return [nil]
|
186
|
+
def get_api_key_by_id(id, opts = {})
|
187
|
+
get_api_key_by_id_with_http_info(id, opts)
|
188
|
+
nil
|
189
|
+
end
|
190
|
+
|
191
|
+
# Retrieve an API key by id
|
192
|
+
# Retrieve an api key referenced by its id
|
193
|
+
# @param id
|
194
|
+
# @param [Hash] opts the optional parameters
|
195
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
196
|
+
def get_api_key_by_id_with_http_info(id, opts = {})
|
197
|
+
if @api_client.config.debugging
|
198
|
+
@api_client.config.logger.debug 'Calling API: AuthenticationApi.get_api_key_by_id ...'
|
199
|
+
end
|
200
|
+
# verify the required parameter 'id' is set
|
201
|
+
if @api_client.config.client_side_validation && id.nil?
|
202
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticationApi.get_api_key_by_id"
|
203
|
+
end
|
204
|
+
# resource path
|
205
|
+
local_var_path = '/apikey/{id}'.sub('{' + 'id' + '}', id.to_s)
|
206
|
+
|
207
|
+
# query parameters
|
208
|
+
query_params = {}
|
209
|
+
|
210
|
+
# header parameters
|
211
|
+
header_params = {}
|
212
|
+
# HTTP header 'Accept' (if needed)
|
213
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
214
|
+
# HTTP header 'Content-Type'
|
215
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
216
|
+
|
217
|
+
# form parameters
|
218
|
+
form_params = {}
|
219
|
+
|
220
|
+
# http body (model)
|
221
|
+
post_body = nil
|
222
|
+
auth_names = ['ApiKeyAuth']
|
223
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
224
|
+
:header_params => header_params,
|
225
|
+
:query_params => query_params,
|
226
|
+
:form_params => form_params,
|
227
|
+
:body => post_body,
|
228
|
+
:auth_names => auth_names)
|
229
|
+
if @api_client.config.debugging
|
230
|
+
@api_client.config.logger.debug "API called: AuthenticationApi#get_api_key_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
231
|
+
end
|
232
|
+
return data, status_code, headers
|
233
|
+
end
|
234
|
+
# revoke all keys
|
235
|
+
# Revokes all keys for your tenant
|
236
|
+
# @param [Hash] opts the optional parameters
|
237
|
+
# @return [nil]
|
238
|
+
def revoke_api_key(opts = {})
|
239
|
+
revoke_api_key_with_http_info(opts)
|
240
|
+
nil
|
241
|
+
end
|
242
|
+
|
243
|
+
# revoke all keys
|
244
|
+
# Revokes all keys for your tenant
|
245
|
+
# @param [Hash] opts the optional parameters
|
246
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
247
|
+
def revoke_api_key_with_http_info(opts = {})
|
248
|
+
if @api_client.config.debugging
|
249
|
+
@api_client.config.logger.debug 'Calling API: AuthenticationApi.revoke_api_key ...'
|
250
|
+
end
|
251
|
+
# resource path
|
252
|
+
local_var_path = '/apikey/revoke'
|
253
|
+
|
254
|
+
# query parameters
|
255
|
+
query_params = {}
|
256
|
+
|
257
|
+
# header parameters
|
258
|
+
header_params = {}
|
259
|
+
# HTTP header 'Accept' (if needed)
|
260
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
261
|
+
# HTTP header 'Content-Type'
|
262
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
263
|
+
|
264
|
+
# form parameters
|
265
|
+
form_params = {}
|
266
|
+
|
267
|
+
# http body (model)
|
268
|
+
post_body = nil
|
269
|
+
auth_names = ['ApiKeyAuth']
|
270
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
271
|
+
:header_params => header_params,
|
272
|
+
:query_params => query_params,
|
273
|
+
:form_params => form_params,
|
274
|
+
:body => post_body,
|
275
|
+
:auth_names => auth_names)
|
276
|
+
if @api_client.config.debugging
|
277
|
+
@api_client.config.logger.debug "API called: AuthenticationApi#revoke_api_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
278
|
+
end
|
279
|
+
return data, status_code, headers
|
280
|
+
end
|
281
|
+
# revoke an API key by id
|
282
|
+
# Revoke an api key referenced by its id
|
283
|
+
# @param id
|
284
|
+
# @param [Hash] opts the optional parameters
|
285
|
+
# @return [nil]
|
286
|
+
def revoke_api_key_by_id(id, opts = {})
|
287
|
+
revoke_api_key_by_id_with_http_info(id, opts)
|
288
|
+
nil
|
289
|
+
end
|
290
|
+
|
291
|
+
# revoke an API key by id
|
292
|
+
# Revoke an api key referenced by its id
|
293
|
+
# @param id
|
294
|
+
# @param [Hash] opts the optional parameters
|
295
|
+
# @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
|
296
|
+
def revoke_api_key_by_id_with_http_info(id, opts = {})
|
297
|
+
if @api_client.config.debugging
|
298
|
+
@api_client.config.logger.debug 'Calling API: AuthenticationApi.revoke_api_key_by_id ...'
|
299
|
+
end
|
300
|
+
# verify the required parameter 'id' is set
|
301
|
+
if @api_client.config.client_side_validation && id.nil?
|
302
|
+
fail ArgumentError, "Missing the required parameter 'id' when calling AuthenticationApi.revoke_api_key_by_id"
|
303
|
+
end
|
304
|
+
# resource path
|
305
|
+
local_var_path = '/apikey/revoke/{id}'.sub('{' + 'id' + '}', id.to_s)
|
306
|
+
|
307
|
+
# query parameters
|
308
|
+
query_params = {}
|
309
|
+
|
310
|
+
# header parameters
|
311
|
+
header_params = {}
|
312
|
+
# HTTP header 'Accept' (if needed)
|
313
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
314
|
+
# HTTP header 'Content-Type'
|
315
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
316
|
+
|
317
|
+
# form parameters
|
318
|
+
form_params = {}
|
319
|
+
|
320
|
+
# http body (model)
|
321
|
+
post_body = nil
|
322
|
+
auth_names = ['ApiKeyAuth']
|
323
|
+
data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
|
324
|
+
:header_params => header_params,
|
325
|
+
:query_params => query_params,
|
326
|
+
:form_params => form_params,
|
327
|
+
:body => post_body,
|
328
|
+
:auth_names => auth_names)
|
329
|
+
if @api_client.config.debugging
|
330
|
+
@api_client.config.logger.debug "API called: AuthenticationApi#revoke_api_key_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
331
|
+
end
|
332
|
+
return data, status_code, headers
|
333
|
+
end
|
334
|
+
end
|
335
|
+
end
|