togai_client 1.0.1 → 1.0.2
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 +3 -4
- data/docs/Account.md +26 -2
- data/docs/AccountAlias.md +28 -0
- data/docs/AccountAliases.md +1 -3
- data/docs/AccountAliasesPaginatedResponse.md +20 -0
- data/docs/AccountSchedule.md +38 -0
- data/docs/AccountsApi.md +840 -124
- data/docs/AccountsBillingInformation.md +20 -0
- data/docs/ActivatePricePlanRequest.md +18 -0
- data/docs/AddAccountAliasesRequest.md +3 -1
- data/docs/AddOn.md +30 -0
- data/docs/AddOnPaginatedResponse.md +22 -0
- data/docs/AddOnType.md +15 -0
- data/docs/AddOnsApi.md +365 -0
- data/docs/Address.md +30 -0
- data/docs/Alert.md +40 -0
- data/docs/AlertStatus.md +15 -0
- data/docs/AlertTemplate.md +38 -0
- data/docs/AlertTemplatesPaginatedResponse.md +20 -0
- data/docs/AlertsApi.md +566 -0
- data/docs/AlertsPaginatedResponse.md +20 -0
- data/docs/AliasPaginatedResponse.md +20 -0
- data/docs/AliasesApi.md +291 -0
- data/docs/AssociationConfig.md +24 -0
- data/docs/Attribute.md +22 -0
- data/docs/AuthenticationApi.md +74 -0
- data/docs/BillingConfig.md +20 -0
- data/docs/BillingEntitlementRateCard.md +34 -0
- data/docs/BillingEntitlementRevenueSummary.md +18 -0
- data/docs/BulkRateCardOperationsRequest.md +18 -0
- data/docs/BulkRateCardOperationsResponse.md +18 -0
- data/docs/CalculateRevenueRequest.md +30 -0
- data/docs/CalculateRevenueResponse.md +24 -0
- data/docs/CalculateRevenueResponseV2.md +22 -0
- data/docs/Computation.md +5 -3
- data/docs/CreateAccountAliasRequest.md +22 -0
- data/docs/CreateAccountRequest.md +27 -5
- data/docs/CreateAccountRequestWithoutCustomerId.md +42 -0
- data/docs/CreateAddOnRequest.md +22 -0
- data/docs/CreateAlertRequest.md +32 -0
- data/docs/CreateAliasRequest.md +18 -0
- data/docs/CreateBulkAliasRequest.md +18 -0
- data/docs/CreateCreditRequest.md +18 -0
- data/docs/CreateCreditResponse.md +18 -0
- data/docs/CreateCustomInvoiceRequest.md +36 -0
- data/docs/CreateCustomerContactRequest.md +30 -0
- data/docs/CreateCustomerContactResponse.md +34 -0
- data/docs/CreateCustomerRequest.md +9 -7
- data/docs/CreateCustomerResponse.md +8 -2
- data/docs/CreateEntitySetting.md +26 -0
- data/docs/CreateEventSchemaRequest.md +7 -1
- data/docs/CreateFeatureRequest.md +22 -0
- data/docs/CreateInvoiceGroupRequest.md +28 -0
- data/docs/CreatePaymentRequest.md +30 -0
- data/docs/CreatePricePlanDetails.md +38 -0
- data/docs/CreatePricePlanDetailsOverride.md +34 -0
- data/docs/CreatePricePlanMigrationRequest.md +32 -0
- data/docs/CreatePricePlanRequest.md +6 -2
- data/docs/CreatePricePlanV2Request.md +30 -0
- data/docs/CreatePricingRule.md +28 -0
- data/docs/CreateProposalRequest.md +40 -0
- data/docs/CreatePurchaseRequest.md +38 -0
- data/docs/CreateUsageMeterRequest.md +12 -6
- data/docs/Credit.md +50 -0
- data/docs/CreditBalanceResponse.md +28 -0
- data/docs/CreditDetailsResponse.md +52 -0
- data/docs/CreditGrantRateCard.md +34 -0
- data/docs/CreditGrantRevenueSummary.md +18 -0
- data/docs/CreditGrantType.md +15 -0
- data/docs/CreditRateDetails.md +20 -0
- data/docs/CreditRequest.md +34 -0
- data/docs/CreditTransaction.md +30 -0
- data/docs/CreditsApi.md +369 -0
- data/docs/CurrencyConfig.md +22 -0
- data/docs/CurrencyRateValue.md +20 -0
- data/docs/CurrencySlabRateDetail.md +24 -0
- data/docs/CustomInvoiceLineItem.md +28 -0
- data/docs/Customer.md +6 -2
- data/docs/CustomerPortalApi.md +77 -0
- data/docs/CustomersApi.md +85 -13
- data/docs/Dependency.md +22 -0
- data/docs/EditAccountScheduleRequest.md +18 -0
- data/docs/EditPricingScheduleRequest.md +18 -0
- data/docs/EnrichedField.md +22 -0
- data/docs/EnrichmentDependency.md +24 -0
- data/docs/Enrichments.md +20 -0
- data/docs/EntitlementOverageConfig.md +22 -0
- data/docs/EntitlementOverageConfigLookupCycle.md +20 -0
- data/docs/EntitlementOverageEntry.md +20 -0
- data/docs/EntitlementOverageRateCard.md +32 -0
- data/docs/EntitlementOverageRevenueSummary.md +18 -0
- data/docs/EntitlementsApi.md +599 -0
- data/docs/Event.md +11 -11
- data/docs/EventCorrectionInfo.md +32 -0
- data/docs/EventCorrectionRequest.md +18 -0
- data/docs/EventIngestionApi.md +16 -15
- data/docs/EventManagementApi.md +95 -21
- data/docs/EventPipelineInfo.md +15 -3
- data/docs/EventPipelineInfoAccount.md +3 -1
- data/docs/EventPipelineInfoEnrichments.md +22 -0
- data/docs/EventPipelineInfoFeatureDetails.md +24 -0
- data/docs/EventPipelineInfoPricePlans.md +28 -0
- data/docs/EventPipelineInfoRevenueDetails.md +22 -0
- data/docs/EventPipelineInfoUsageMeters.md +26 -0
- data/docs/EventSchema.md +11 -1
- data/docs/EventSchemaListData.md +11 -1
- data/docs/EventSchemasApi.md +82 -84
- data/docs/EventSchemasForFeature.md +20 -0
- data/docs/EventSource.md +20 -0
- data/docs/EventWithStatus.md +9 -1
- data/docs/EventWithStatusAndEventPipelineInfo.md +9 -1
- data/docs/EventsCorrectionResponse.md +18 -0
- data/docs/ExpiryType.md +15 -0
- data/docs/ExternalPaymentReference.md +26 -0
- data/docs/Feature.md +30 -0
- data/docs/FeatureApi.md +293 -0
- data/docs/FeatureConfig.md +22 -0
- data/docs/FeatureCreditEntry.md +32 -0
- data/docs/FeatureDetails.md +20 -0
- data/docs/FeatureListResponse.md +30 -0
- data/docs/FeaturePaginatedListData.md +22 -0
- data/docs/Field.md +26 -0
- data/docs/FileDownloadUrlResponse.md +18 -0
- data/docs/FileStorageApi.md +151 -0
- data/docs/FinalizeAccountSchedules.md +20 -0
- data/docs/FinalizePricePlanRequest.md +20 -0
- data/docs/FixedFeeRateCard.md +34 -0
- data/docs/FixedFeeRevenueSummary.md +18 -0
- data/docs/FixedFeeType.md +15 -0
- data/docs/GetCustomerPortalDelegateTokenRequest.md +24 -0
- data/docs/GetEntitlementValuesResponse.md +18 -0
- data/docs/GetEntitlementValuesResponseDataInner.md +20 -0
- data/docs/GetFeatureCreditEntriesPaginatedResponse.md +20 -0
- data/docs/GetFeatureCreditsResponse.md +28 -0
- data/docs/GetJobResponse.md +36 -0
- data/docs/GetLicenseUpdatesResponse.md +20 -0
- data/docs/GetMetricsRequest.md +4 -4
- data/docs/GetProposalResponse.md +62 -0
- data/docs/GetPurchaseResponse.md +62 -0
- data/docs/GrantDetails.md +24 -0
- data/docs/Incident.md +36 -0
- data/docs/IncidentsPaginatedResponse.md +20 -0
- data/docs/IngestEventRequest.md +1 -1
- data/docs/IngestEventResponse.md +12 -2
- data/docs/Invoice.md +68 -0
- data/docs/InvoiceDetails.md +28 -0
- data/docs/InvoiceDetailsAccount.md +24 -0
- data/docs/InvoiceDetailsCustomer.md +24 -0
- data/docs/InvoiceDetailsInvoiceGroup.md +28 -0
- data/docs/InvoiceDetailsOrganization.md +24 -0
- data/docs/InvoiceGroupAccountsPaginatedResponse.md +40 -0
- data/docs/InvoiceGroupDetails.md +30 -0
- data/docs/InvoiceGroupPaginatedResponse.md +20 -0
- data/docs/InvoiceGroups.md +36 -0
- data/docs/InvoiceGroupsApi.md +358 -0
- data/docs/InvoiceInfoInner.md +20 -0
- data/docs/InvoiceLineItem.md +34 -0
- data/docs/InvoiceSummary.md +58 -0
- data/docs/InvoiceTiming.md +15 -0
- data/docs/InvoicesApi.md +751 -0
- data/docs/InvoicesClass.md +15 -0
- data/docs/InvoicesStatus.md +15 -0
- data/docs/InvoicesType.md +15 -0
- data/docs/JobEntriesPaginatedResponse.md +22 -0
- data/docs/JobEntriesResponse.md +26 -0
- data/docs/JobsApi.md +361 -0
- data/docs/JobsPaginatedResponse.md +22 -0
- data/docs/JobsWithoutStatusInfoResponse.md +24 -0
- data/docs/LicenseEntriesConfig.md +24 -0
- data/docs/LicenseEntriesConfigLookupCycle.md +20 -0
- data/docs/LicenseEntriesConfigLookupRange.md +22 -0
- data/docs/LicenseEntry.md +22 -0
- data/docs/LicenseEntryDetailsUpdateRequest.md +22 -0
- data/docs/LicenseRateCard.md +40 -0
- data/docs/LicenseRateCardConfig.md +20 -0
- data/docs/LicenseUpdate.md +26 -0
- data/docs/LicenseUpdateRequest.md +30 -0
- data/docs/LicenseUpdateResponse.md +28 -0
- data/docs/LicensesApi.md +300 -0
- data/docs/ListCreditsResponse.md +20 -0
- data/docs/ListInvoicesResponse.md +20 -0
- data/docs/ListPaymentResponse.md +20 -0
- data/docs/ManageMiscellaneousChargesRequest.md +18 -0
- data/docs/MaxQuantityBreachAction.md +15 -0
- data/docs/MetricQuery.md +7 -5
- data/docs/MetricQueryFilterEntry.md +1 -1
- data/docs/MetricQueryResponse.md +1 -1
- data/docs/MetricsApi.md +7 -7
- data/docs/MigrationMode.md +15 -0
- data/docs/MinimumCommitment.md +20 -0
- data/docs/MiscellaneousCharge.md +26 -0
- data/docs/MiscellaneousChargesResponse.md +18 -0
- data/docs/ModelAlias.md +20 -0
- data/docs/NamedLicenseEntriesConfig.md +24 -0
- data/docs/NamedLicenseEntriesConfigLookupCycle.md +20 -0
- data/docs/NamedLicenseEntriesConfigLookupRange.md +22 -0
- data/docs/NamedLicenseEntry.md +24 -0
- data/docs/NamedLicenseUpdate.md +32 -0
- data/docs/NamedLicenseUpdatesPaginatedResponse.md +20 -0
- data/docs/Payment.md +38 -0
- data/docs/PaymentLineItemRecord.md +24 -0
- data/docs/PaymentsApi.md +227 -0
- data/docs/PlanOverride.md +6 -0
- data/docs/PreAction.md +20 -0
- data/docs/PriceExperimentationApi.md +147 -0
- data/docs/PricePlan.md +4 -0
- data/docs/PricePlanDetails.md +25 -3
- data/docs/PricePlanDetailsConfig.md +28 -0
- data/docs/PricePlanDetailsOverride.md +16 -2
- data/docs/PricePlanInfo.md +20 -0
- data/docs/PricePlanListData.md +10 -2
- data/docs/PricePlanMigrationConfig.md +30 -0
- data/docs/PricePlanType.md +15 -0
- data/docs/PricePlanV2.md +42 -0
- data/docs/PricePlanV2Api.md +953 -0
- data/docs/PricePlanV2PaginatedResponse.md +20 -0
- data/docs/PricePlansApi.md +202 -52
- data/docs/PricingCycleConfig.md +6 -6
- data/docs/PricingCycleConfigStartOffset.md +1 -1
- data/docs/PricingCycleInterval.md +15 -0
- data/docs/PricingRule.md +32 -0
- data/docs/PricingRuleAction.md +26 -0
- data/docs/PricingRuleChangesLog.md +30 -0
- data/docs/PricingRuleInfo.md +24 -0
- data/docs/PricingRuleTiming.md +15 -0
- data/docs/PricingRulesApi.md +83 -0
- data/docs/PricingRulesLog.md +28 -0
- data/docs/PricingRulesLogsPaginatedResponse.md +18 -0
- data/docs/PricingRulesPaginatedResponse.md +18 -0
- data/docs/PricingRulesValues.md +20 -0
- data/docs/PricingSchedule.md +9 -1
- data/docs/PricingSchedulePaginatedResponse.md +22 -0
- data/docs/PricingScheduleWithPricePlanId.md +36 -0
- data/docs/Proposal.md +62 -0
- data/docs/ProposalsListResponse.md +40 -0
- data/docs/ProposalsPaginatedResponse.md +22 -0
- data/docs/ProratedRefundMode.md +15 -0
- data/docs/ProrationConfig.md +22 -0
- data/docs/ProrationConfigCustomConfig.md +22 -0
- data/docs/ProrationConfigLookupCycleConfig.md +22 -0
- data/docs/Purchase.md +58 -0
- data/docs/PurchaseFeatureDetails.md +30 -0
- data/docs/PurchaseListResponse.md +46 -0
- data/docs/PurchasePaginatedListData.md +22 -0
- data/docs/PurchasePlanOverride.md +22 -0
- data/docs/PurchaseStatus.md +15 -0
- data/docs/PurchaseType.md +15 -0
- data/docs/QueryColumn.md +26 -0
- data/docs/QueryFilter.md +22 -0
- data/docs/QueryFunction.md +20 -0
- data/docs/QueryInput.md +28 -0
- data/docs/QueryInputSortInner.md +20 -0
- data/docs/RateCard.md +23 -5
- data/docs/RateCardData.md +28 -0
- data/docs/RateCardDetails.md +30 -0
- data/docs/RateCardOperation.md +22 -0
- data/docs/RateCardPaginatedResponse.md +20 -0
- data/docs/RatePlan.md +20 -0
- data/docs/RateValue.md +22 -0
- data/docs/RecurrenceConfig.md +20 -0
- data/docs/RemoveAccountAliasRequest.md +20 -0
- data/docs/RemoveAccountAliasesRequest.md +4 -2
- data/docs/Report.md +38 -0
- data/docs/ReportStatus.md +15 -0
- data/docs/ReportType.md +15 -0
- data/docs/ReportsApi.md +83 -0
- data/docs/ReportsPaginatedResponse.md +20 -0
- data/docs/RevenueInfo.md +42 -0
- data/docs/RevenueInfoV2.md +32 -0
- data/docs/RevenueSummaryWithMetadata.md +24 -0
- data/docs/ScheduleInfo.md +22 -0
- data/docs/SchedulesApi.md +667 -0
- data/docs/SchedulesPaginatedResponse.md +22 -0
- data/docs/Setting.md +30 -0
- data/docs/SettingDataType.md +15 -0
- data/docs/SettingPaginatedResponse.md +22 -0
- data/docs/SettingsApi.md +301 -0
- data/docs/Slab.md +24 -0
- data/docs/SlabDetail.md +26 -0
- data/docs/SlabRate.md +22 -0
- data/docs/SlabRevenue.md +22 -0
- data/docs/SlabRevenueMetadata.md +22 -0
- data/docs/SlabRevenueSummary.md +24 -0
- data/docs/SlabRevenueWithMetadata.md +24 -0
- data/docs/TokenResponse.md +18 -0
- data/docs/TopupWalletRequest.md +18 -0
- data/docs/UpdateAccountRequest.md +18 -2
- data/docs/UpdateAccountScheduleV2Request.md +26 -0
- data/docs/UpdateAddOnRequest.md +20 -0
- data/docs/UpdateAlertRequest.md +26 -0
- data/docs/UpdateCustomerRequest.md +5 -5
- data/docs/UpdateEventSchemaRequest.md +9 -3
- data/docs/UpdateFeatureCreditsRequest.md +20 -0
- data/docs/UpdateFeatureRequest.md +22 -0
- data/docs/UpdateIncidentStatusRequest.md +18 -0
- data/docs/UpdateInvoiceGroupAccounts.md +18 -0
- data/docs/UpdateInvoiceRequest.md +26 -0
- data/docs/UpdatePricePlanRequest.md +8 -2
- data/docs/UpdatePricePlanV2Request.md +22 -0
- data/docs/UpdatePricingRulesRequest.md +18 -0
- data/docs/UpdatePricingScheduleRequest.md +30 -0
- data/docs/UpdatePricingScheduleRequestWithActions.md +32 -0
- data/docs/UpdatePricingScheduleResponse.md +22 -0
- data/docs/UpdateProposalStatus.md +18 -0
- data/docs/UpdateSettingRequest.md +22 -0
- data/docs/UpdateUsageMeterRequest.md +13 -5
- data/docs/UpdateWalletRequest.md +20 -0
- data/docs/UsageConfig.md +24 -0
- data/docs/UsageConfigLookupCycle.md +20 -0
- data/docs/UsageConfigLookupRange.md +22 -0
- data/docs/UsageCycleInterval.md +15 -0
- data/docs/UsageLookupRange.md +20 -0
- data/docs/UsageMeter.md +12 -2
- data/docs/UsageMeterAggregation.md +15 -0
- data/docs/UsageMeterFilterEntry.md +20 -0
- data/docs/UsageMetersApi.md +64 -74
- data/docs/UsageRateCard.md +28 -0
- data/docs/ValidateEntitlementValueRequest.md +18 -0
- data/docs/ValidatedEntityError.md +24 -0
- data/docs/ValidatedEntityErrorsPaginatedResponse.md +20 -0
- data/docs/VersionsToMigrate.md +15 -0
- data/docs/WalletApi.md +301 -0
- data/docs/WalletBalanceResponse.md +40 -0
- data/docs/WalletEntriesPaginatedResponse.md +20 -0
- data/docs/WalletEntry.md +34 -0
- data/docs/WalletStatus.md +15 -0
- data/docs/WalletTopupDetails.md +20 -0
- data/lib/togai_client/api/accounts_api.rb +881 -220
- data/lib/togai_client/api/add_ons_api.rb +372 -0
- data/lib/togai_client/api/alerts_api.rb +527 -0
- data/lib/togai_client/api/aliases_api.rb +279 -0
- data/lib/togai_client/api/authentication_api.rb +79 -0
- data/lib/togai_client/api/credits_api.rb +351 -0
- data/lib/togai_client/api/customer_portal_api.rb +90 -0
- data/lib/togai_client/api/customers_api.rb +96 -18
- data/lib/togai_client/api/entitlements_api.rb +655 -0
- data/lib/togai_client/api/event_ingestion_api.rb +15 -15
- data/lib/togai_client/api/event_management_api.rb +97 -21
- data/lib/togai_client/api/event_schemas_api.rb +104 -107
- data/lib/togai_client/api/feature_api.rb +298 -0
- data/lib/togai_client/api/file_storage_api.rb +151 -0
- data/lib/togai_client/api/invoice_groups_api.rb +370 -0
- data/lib/togai_client/api/invoices_api.rb +705 -0
- data/lib/togai_client/api/jobs_api.rb +337 -0
- data/lib/togai_client/api/licenses_api.rb +282 -0
- data/lib/togai_client/api/metrics_api.rb +6 -6
- data/lib/togai_client/api/payments_api.rb +215 -0
- data/lib/togai_client/api/price_experimentation_api.rb +158 -0
- data/lib/togai_client/api/price_plan_v2_api.rb +960 -0
- data/lib/togai_client/api/price_plans_api.rb +214 -62
- data/lib/togai_client/api/pricing_rules_api.rb +106 -0
- data/lib/togai_client/api/reports_api.rb +92 -0
- data/lib/togai_client/api/schedules_api.rb +685 -0
- data/lib/togai_client/api/settings_api.rb +302 -0
- data/lib/togai_client/api/usage_meters_api.rb +97 -153
- data/lib/togai_client/api/wallet_api.rb +310 -0
- data/lib/togai_client/api_client.rb +25 -23
- data/lib/togai_client/api_error.rb +2 -1
- data/lib/togai_client/configuration.rb +51 -18
- data/lib/togai_client/models/account.rb +260 -28
- data/lib/togai_client/models/account_alias.rb +329 -0
- data/lib/togai_client/models/account_aliases.rb +23 -67
- data/lib/togai_client/models/account_aliases_paginated_response.rb +233 -0
- data/lib/togai_client/models/account_paginated_response.rb +14 -19
- data/lib/togai_client/models/account_schedule.rb +375 -0
- data/lib/togai_client/models/accounts_billing_information.rb +228 -0
- data/lib/togai_client/models/activate_price_plan_request.rb +235 -0
- data/lib/togai_client/models/add_account_aliases_request.rb +64 -25
- data/lib/togai_client/models/add_on.rb +395 -0
- data/lib/togai_client/models/add_on_paginated_response.rb +241 -0
- data/lib/togai_client/models/add_on_type.rb +42 -0
- data/lib/togai_client/models/address.rb +276 -0
- data/lib/togai_client/models/alert.rb +391 -0
- data/lib/togai_client/models/alert_status.rb +40 -0
- data/lib/togai_client/models/alert_template.rb +343 -0
- data/lib/togai_client/models/alert_templates_paginated_response.rb +232 -0
- data/lib/togai_client/models/alerts_paginated_response.rb +232 -0
- data/lib/togai_client/models/alias_paginated_response.rb +226 -0
- data/lib/togai_client/models/association_config.rb +244 -0
- data/lib/togai_client/models/attribute.rb +327 -0
- data/lib/togai_client/models/base_success_response.rb +16 -19
- data/lib/togai_client/models/billing_config.rb +225 -0
- data/lib/togai_client/models/billing_entitlement_rate_card.rb +370 -0
- data/lib/togai_client/models/billing_entitlement_revenue_summary.rb +221 -0
- data/lib/togai_client/models/bulk_rate_card_operations_request.rb +224 -0
- data/lib/togai_client/models/bulk_rate_card_operations_response.rb +224 -0
- data/lib/togai_client/models/calculate_revenue_request.rb +297 -0
- data/lib/togai_client/models/calculate_revenue_response.rb +264 -0
- data/lib/togai_client/models/calculate_revenue_response_v2.rb +248 -0
- data/lib/togai_client/models/computation.rb +49 -27
- data/lib/togai_client/models/create_account_alias_request.rb +270 -0
- data/lib/togai_client/models/create_account_request.rb +306 -27
- data/lib/togai_client/models/create_account_request_without_customer_id.rb +551 -0
- data/lib/togai_client/models/create_add_on_request.rb +309 -0
- data/lib/togai_client/models/create_alert_request.rb +327 -0
- data/lib/togai_client/models/create_alias_request.rb +241 -0
- data/lib/togai_client/models/create_bulk_alias_request.rb +252 -0
- data/lib/togai_client/models/create_credit_request.rb +224 -0
- data/lib/togai_client/models/create_credit_response.rb +223 -0
- data/lib/togai_client/models/create_custom_invoice_request.rb +411 -0
- data/lib/togai_client/models/create_customer_contact_request.rb +402 -0
- data/lib/togai_client/models/create_customer_contact_response.rb +435 -0
- data/lib/togai_client/models/create_customer_request.rb +69 -47
- data/lib/togai_client/models/create_customer_response.rb +81 -40
- data/lib/togai_client/models/create_entity_setting.rb +308 -0
- data/lib/togai_client/models/create_event_schema_request.rb +70 -24
- data/lib/togai_client/models/create_feature_request.rb +309 -0
- data/lib/togai_client/models/create_invoice_group_request.rb +344 -0
- data/lib/togai_client/models/create_payment_request.rb +394 -0
- data/lib/togai_client/models/create_price_plan_details.rb +339 -0
- data/lib/togai_client/models/create_price_plan_details_override.rb +319 -0
- data/lib/togai_client/models/create_price_plan_migration_request.rb +385 -0
- data/lib/togai_client/models/create_price_plan_request.rb +69 -24
- data/lib/togai_client/models/create_price_plan_v2_request.rb +367 -0
- data/lib/togai_client/models/create_pricing_rule.rb +313 -0
- data/lib/togai_client/models/create_proposal_request.rb +371 -0
- data/lib/togai_client/models/create_purchase_request.rb +330 -0
- data/lib/togai_client/models/create_usage_meter_request.rb +85 -42
- data/lib/togai_client/models/credit.rb +490 -0
- data/lib/togai_client/models/credit_balance_response.rb +302 -0
- data/lib/togai_client/models/credit_details_response.rb +508 -0
- data/lib/togai_client/models/credit_grant_rate_card.rb +332 -0
- data/lib/togai_client/models/credit_grant_revenue_summary.rb +221 -0
- data/lib/togai_client/models/credit_grant_type.rb +40 -0
- data/lib/togai_client/models/credit_rate_details.rb +262 -0
- data/lib/togai_client/models/credit_request.rb +330 -0
- data/lib/togai_client/models/credit_transaction.rb +357 -0
- data/lib/togai_client/models/currency_config.rb +296 -0
- data/lib/togai_client/models/currency_rate_value.rb +237 -0
- data/lib/togai_client/models/currency_slab_rate_detail.rb +287 -0
- data/lib/togai_client/models/custom_invoice_line_item.rb +260 -0
- data/lib/togai_client/models/customer.rb +68 -26
- data/lib/togai_client/models/customer_paginated_response.rb +14 -19
- data/lib/togai_client/models/dependency.rb +287 -0
- data/lib/togai_client/models/dimensions_schema.rb +16 -19
- data/lib/togai_client/models/edit_account_schedule_request.rb +252 -0
- data/lib/togai_client/models/edit_pricing_schedule_request.rb +252 -0
- data/lib/togai_client/models/enriched_field.rb +288 -0
- data/lib/togai_client/models/enrichment_dependency.rb +297 -0
- data/lib/togai_client/models/enrichments.rb +234 -0
- data/lib/togai_client/models/entitlement_overage_config.rb +278 -0
- data/lib/togai_client/models/entitlement_overage_config_lookup_cycle.rb +258 -0
- data/lib/togai_client/models/entitlement_overage_entry.rb +256 -0
- data/lib/togai_client/models/entitlement_overage_rate_card.rb +324 -0
- data/lib/togai_client/models/entitlement_overage_revenue_summary.rb +221 -0
- data/lib/togai_client/models/error_response.rb +16 -19
- data/lib/togai_client/models/event.rb +104 -84
- data/lib/togai_client/models/event_attribute_schema.rb +22 -21
- data/lib/togai_client/models/event_correction_info.rb +384 -0
- data/lib/togai_client/models/event_correction_request.rb +215 -0
- data/lib/togai_client/models/event_pipeline_info.rb +76 -25
- data/lib/togai_client/models/event_pipeline_info_account.rb +31 -23
- data/lib/togai_client/models/event_pipeline_info_customer.rb +18 -19
- data/lib/togai_client/models/event_pipeline_info_enrichments.rb +238 -0
- data/lib/togai_client/models/event_pipeline_info_event_schema.rb +18 -19
- data/lib/togai_client/models/event_pipeline_info_feature_details.rb +255 -0
- data/lib/togai_client/models/event_pipeline_info_price_plans.rb +306 -0
- data/lib/togai_client/models/event_pipeline_info_revenue_details.rb +253 -0
- data/lib/togai_client/models/event_pipeline_info_usage_meters.rb +312 -0
- data/lib/togai_client/models/event_schema.rb +89 -29
- data/lib/togai_client/models/event_schema_list_data.rb +90 -31
- data/lib/togai_client/models/event_schema_list_paginated_response.rb +14 -19
- data/lib/togai_client/models/event_schema_versions_response.rb +16 -19
- data/lib/togai_client/models/event_schemas_for_feature.rb +259 -0
- data/lib/togai_client/models/event_source.rb +278 -0
- data/lib/togai_client/models/event_with_status.rb +94 -23
- data/lib/togai_client/models/event_with_status_and_event_pipeline_info.rb +100 -23
- data/lib/togai_client/models/events_correction_response.rb +252 -0
- data/lib/togai_client/models/expiry_type.rb +41 -0
- data/lib/togai_client/models/external_payment_reference.rb +309 -0
- data/lib/togai_client/models/feature.rb +365 -0
- data/lib/togai_client/models/feature_config.rb +266 -0
- data/lib/togai_client/models/feature_credit_entry.rb +387 -0
- data/lib/togai_client/models/feature_details.rb +238 -0
- data/lib/togai_client/models/feature_list_response.rb +343 -0
- data/lib/togai_client/models/feature_paginated_list_data.rb +234 -0
- data/lib/togai_client/models/field.rb +331 -0
- data/lib/togai_client/models/file_download_url_response.rb +221 -0
- data/lib/togai_client/models/finalize_account_schedules.rb +228 -0
- data/lib/togai_client/models/finalize_price_plan_request.rb +246 -0
- data/lib/togai_client/models/fixed_fee_rate_card.rb +354 -0
- data/lib/togai_client/models/fixed_fee_revenue_summary.rb +221 -0
- data/lib/togai_client/models/fixed_fee_type.rb +40 -0
- data/lib/togai_client/models/get_customer_portal_delegate_token_request.rb +255 -0
- data/lib/togai_client/models/get_entitlement_values_response.rb +223 -0
- data/lib/togai_client/models/get_entitlement_values_response_data_inner.rb +239 -0
- data/lib/togai_client/models/get_event_response.rb +16 -19
- data/lib/togai_client/models/get_events_response.rb +21 -20
- data/lib/togai_client/models/get_feature_credit_entries_paginated_response.rb +225 -0
- data/lib/togai_client/models/get_feature_credits_response.rb +333 -0
- data/lib/togai_client/models/get_job_response.rb +399 -0
- data/lib/togai_client/models/get_license_updates_response.rb +252 -0
- data/lib/togai_client/models/get_metrics_request.rb +22 -19
- data/lib/togai_client/models/get_metrics_response.rb +16 -19
- data/lib/togai_client/models/get_proposal_response.rb +536 -0
- data/lib/togai_client/models/get_purchase_response.rb +519 -0
- data/lib/togai_client/models/grant_details.rb +299 -0
- data/lib/togai_client/models/incident.rb +347 -0
- data/lib/togai_client/models/incidents_paginated_response.rb +232 -0
- data/lib/togai_client/models/ingest_batch_event_request.rb +21 -24
- data/lib/togai_client/models/ingest_event_request.rb +21 -19
- data/lib/togai_client/models/ingest_event_response.rb +76 -42
- data/lib/togai_client/models/ingestion_status.rb +23 -22
- data/lib/togai_client/models/invoice.rb +571 -0
- data/lib/togai_client/models/invoice_details.rb +259 -0
- data/lib/togai_client/models/invoice_details_account.rb +269 -0
- data/lib/togai_client/models/invoice_details_customer.rb +255 -0
- data/lib/togai_client/models/invoice_details_invoice_group.rb +294 -0
- data/lib/togai_client/models/invoice_details_organization.rb +264 -0
- data/lib/togai_client/models/invoice_group_accounts_paginated_response.rb +430 -0
- data/lib/togai_client/models/invoice_group_details.rb +330 -0
- data/lib/togai_client/models/invoice_group_paginated_response.rb +225 -0
- data/lib/togai_client/models/invoice_groups.rb +403 -0
- data/lib/togai_client/models/invoice_info_inner.rb +239 -0
- data/lib/togai_client/models/invoice_line_item.rb +381 -0
- data/lib/togai_client/models/invoice_summary.rb +520 -0
- data/lib/togai_client/models/invoice_timing.rb +41 -0
- data/lib/togai_client/models/invoices_class.rb +41 -0
- data/lib/togai_client/models/invoices_status.rb +47 -0
- data/lib/togai_client/models/invoices_type.rb +44 -0
- data/lib/togai_client/models/job_entries_paginated_response.rb +234 -0
- data/lib/togai_client/models/job_entries_response.rb +314 -0
- data/lib/togai_client/models/jobs_paginated_response.rb +234 -0
- data/lib/togai_client/models/jobs_without_status_info_response.rb +269 -0
- data/lib/togai_client/models/license_entries_config.rb +287 -0
- data/lib/togai_client/models/license_entries_config_lookup_cycle.rb +251 -0
- data/lib/togai_client/models/license_entries_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/license_entry.rb +272 -0
- data/lib/togai_client/models/license_entry_details_update_request.rb +277 -0
- data/lib/togai_client/models/license_rate_card.rb +388 -0
- data/lib/togai_client/models/license_rate_card_config.rb +246 -0
- data/lib/togai_client/models/license_update.rb +320 -0
- data/lib/togai_client/models/license_update_request.rb +377 -0
- data/lib/togai_client/models/license_update_response.rb +342 -0
- data/lib/togai_client/models/list_credits_response.rb +280 -0
- data/lib/togai_client/models/list_invoices_response.rb +280 -0
- data/lib/togai_client/models/list_payment_response.rb +280 -0
- data/lib/togai_client/models/manage_miscellaneous_charges_request.rb +224 -0
- data/lib/togai_client/models/max_quantity_breach_action.rb +39 -0
- data/lib/togai_client/models/metric_data_points.rb +28 -29
- data/lib/togai_client/models/metric_data_points_grouped_by.rb +18 -19
- data/lib/togai_client/models/metric_name.rb +11 -4
- data/lib/togai_client/models/metric_query.rb +45 -24
- data/lib/togai_client/models/metric_query_filter_entry.rb +19 -20
- data/lib/togai_client/models/metric_query_response.rb +42 -19
- data/lib/togai_client/models/migration_mode.rb +44 -0
- data/lib/togai_client/models/minimum_commitment.rb +258 -0
- data/lib/togai_client/models/miscellaneous_charge.rb +265 -0
- data/lib/togai_client/models/miscellaneous_charges_response.rb +224 -0
- data/lib/togai_client/models/model_alias.rb +238 -0
- data/lib/togai_client/models/named_license_entries_config.rb +287 -0
- data/lib/togai_client/models/named_license_entries_config_lookup_cycle.rb +251 -0
- data/lib/togai_client/models/named_license_entries_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/named_license_entry.rb +281 -0
- data/lib/togai_client/models/named_license_update.rb +396 -0
- data/lib/togai_client/models/named_license_updates_paginated_response.rb +252 -0
- data/lib/togai_client/models/pagination_options.rb +14 -19
- data/lib/togai_client/models/payment.rb +380 -0
- data/lib/togai_client/models/payment_line_item_record.rb +290 -0
- data/lib/togai_client/models/plan_override.rb +64 -20
- data/lib/togai_client/models/pre_action.rb +269 -0
- data/lib/togai_client/models/price_plan.rb +59 -21
- data/lib/togai_client/models/price_plan_details.rb +182 -45
- data/lib/togai_client/models/price_plan_details_config.rb +344 -0
- data/lib/togai_client/models/price_plan_details_override.rb +135 -35
- data/lib/togai_client/models/price_plan_info.rb +230 -0
- data/lib/togai_client/models/price_plan_list_data.rb +116 -25
- data/lib/togai_client/models/price_plan_migration_config.rb +368 -0
- data/lib/togai_client/models/price_plan_paginated_response.rb +16 -19
- data/lib/togai_client/models/price_plan_type.rb +40 -0
- data/lib/togai_client/models/price_plan_v2.rb +519 -0
- data/lib/togai_client/models/price_plan_v2_paginated_response.rb +233 -0
- data/lib/togai_client/models/price_type.rb +7 -4
- data/lib/togai_client/models/pricing_cycle_config.rb +34 -67
- data/lib/togai_client/models/pricing_cycle_config_start_offset.rb +20 -21
- data/lib/togai_client/models/pricing_cycle_interval.rb +43 -0
- data/lib/togai_client/models/pricing_model.rb +7 -4
- data/lib/togai_client/models/pricing_rule.rb +382 -0
- data/lib/togai_client/models/pricing_rule_action.rb +293 -0
- data/lib/togai_client/models/pricing_rule_changes_log.rb +290 -0
- data/lib/togai_client/models/pricing_rule_info.rb +249 -0
- data/lib/togai_client/models/pricing_rule_timing.rb +40 -0
- data/lib/togai_client/models/pricing_rules_log.rb +318 -0
- data/lib/togai_client/models/pricing_rules_logs_paginated_response.rb +224 -0
- data/lib/togai_client/models/pricing_rules_paginated_response.rb +223 -0
- data/lib/togai_client/models/pricing_rules_values.rb +223 -0
- data/lib/togai_client/models/pricing_schedule.rb +100 -23
- data/lib/togai_client/models/pricing_schedule_paginated_response.rb +234 -0
- data/lib/togai_client/models/pricing_schedule_with_price_plan_id.rb +365 -0
- data/lib/togai_client/models/proposal.rb +536 -0
- data/lib/togai_client/models/proposals_list_response.rb +390 -0
- data/lib/togai_client/models/proposals_paginated_response.rb +234 -0
- data/lib/togai_client/models/prorated_refund_mode.rb +42 -0
- data/lib/togai_client/models/proration_config.rb +275 -0
- data/lib/togai_client/models/proration_config_custom_config.rb +254 -0
- data/lib/togai_client/models/proration_config_lookup_cycle_config.rb +261 -0
- data/lib/togai_client/models/purchase.rb +493 -0
- data/lib/togai_client/models/purchase_feature_details.rb +317 -0
- data/lib/togai_client/models/purchase_list_response.rb +393 -0
- data/lib/togai_client/models/purchase_paginated_list_data.rb +234 -0
- data/lib/togai_client/models/purchase_plan_override.rb +296 -0
- data/lib/togai_client/models/purchase_status.rb +46 -0
- data/lib/togai_client/models/purchase_type.rb +42 -0
- data/lib/togai_client/models/query_column.rb +259 -0
- data/lib/togai_client/models/query_filter.rb +255 -0
- data/lib/togai_client/models/query_function.rb +239 -0
- data/lib/togai_client/models/query_input.rb +295 -0
- data/lib/togai_client/models/query_input_sort_inner.rb +237 -0
- data/lib/togai_client/models/rate_card.rb +342 -38
- data/lib/togai_client/models/rate_card_data.rb +370 -0
- data/lib/togai_client/models/rate_card_details.rb +269 -0
- data/lib/togai_client/models/rate_card_operation.rb +302 -0
- data/lib/togai_client/models/rate_card_paginated_response.rb +233 -0
- data/lib/togai_client/models/rate_card_type.rb +13 -5
- data/lib/togai_client/models/rate_plan.rb +282 -0
- data/lib/togai_client/models/rate_value.rb +270 -0
- data/lib/togai_client/models/recurrence_config.rb +225 -0
- data/lib/togai_client/models/remove_account_alias_request.rb +232 -0
- data/lib/togai_client/models/remove_account_aliases_request.rb +30 -49
- data/lib/togai_client/models/report.rb +362 -0
- data/lib/togai_client/models/report_status.rb +43 -0
- data/lib/togai_client/models/report_type.rb +41 -0
- data/lib/togai_client/models/reports_paginated_response.rb +226 -0
- data/lib/togai_client/models/revenue_info.rb +335 -0
- data/lib/togai_client/models/revenue_info_v2.rb +297 -0
- data/lib/togai_client/models/revenue_summary_with_metadata.rb +255 -0
- data/lib/togai_client/models/schedule_info.rb +250 -0
- data/lib/togai_client/models/schedules_paginated_response.rb +241 -0
- data/lib/togai_client/models/setting.rb +340 -0
- data/lib/togai_client/models/setting_data_type.rb +42 -0
- data/lib/togai_client/models/setting_paginated_response.rb +234 -0
- data/lib/togai_client/models/slab.rb +315 -0
- data/lib/togai_client/models/slab_detail.rb +298 -0
- data/lib/togai_client/models/slab_rate.rb +249 -0
- data/lib/togai_client/models/slab_revenue.rb +281 -0
- data/lib/togai_client/models/slab_revenue_metadata.rb +232 -0
- data/lib/togai_client/models/slab_revenue_summary.rb +262 -0
- data/lib/togai_client/models/slab_revenue_with_metadata.rb +299 -0
- data/lib/togai_client/models/token_response.rb +221 -0
- data/lib/togai_client/models/topup_wallet_request.rb +222 -0
- data/lib/togai_client/models/update_account_request.rb +196 -26
- data/lib/togai_client/models/update_account_schedule_v2_request.rb +303 -0
- data/lib/togai_client/models/update_add_on_request.rb +264 -0
- data/lib/togai_client/models/update_alert_request.rb +274 -0
- data/lib/togai_client/models/update_customer_request.rb +36 -49
- data/lib/togai_client/models/update_event_schema_request.rb +68 -38
- data/lib/togai_client/models/update_feature_credits_request.rb +225 -0
- data/lib/togai_client/models/update_feature_request.rb +295 -0
- data/lib/togai_client/models/update_incident_status_request.rb +256 -0
- data/lib/togai_client/models/update_invoice_group_accounts.rb +252 -0
- data/lib/togai_client/models/update_invoice_request.rb +317 -0
- data/lib/togai_client/models/update_price_plan_request.rb +81 -25
- data/lib/togai_client/models/update_price_plan_v2_request.rb +266 -0
- data/lib/togai_client/models/update_pricing_rules_request.rb +216 -0
- data/lib/togai_client/models/update_pricing_schedule_request.rb +323 -0
- data/lib/togai_client/models/update_pricing_schedule_request_with_actions.rb +343 -0
- data/lib/togai_client/models/update_pricing_schedule_response.rb +276 -0
- data/lib/togai_client/models/update_proposal_status.rb +256 -0
- data/lib/togai_client/models/update_setting_request.rb +255 -0
- data/lib/togai_client/models/update_usage_meter_request.rb +105 -50
- data/lib/togai_client/models/update_wallet_request.rb +246 -0
- data/lib/togai_client/models/usage_config.rb +287 -0
- data/lib/togai_client/models/usage_config_lookup_cycle.rb +250 -0
- data/lib/togai_client/models/usage_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/usage_cycle_interval.rb +43 -0
- data/lib/togai_client/models/usage_lookup_range.rb +238 -0
- data/lib/togai_client/models/usage_meter.rb +156 -39
- data/lib/togai_client/models/usage_meter_aggregation.rb +40 -0
- data/lib/togai_client/models/usage_meter_filter_entry.rb +238 -0
- data/lib/togai_client/models/usage_meter_paginated_response.rb +14 -19
- data/lib/togai_client/models/usage_rate_card.rb +285 -0
- data/lib/togai_client/models/validate_entitlement_value_request.rb +222 -0
- data/lib/togai_client/models/validated_entity_error.rb +273 -0
- data/lib/togai_client/models/validated_entity_errors_paginated_response.rb +232 -0
- data/lib/togai_client/models/versions_to_migrate.rb +40 -0
- data/lib/togai_client/models/wallet_balance_response.rb +388 -0
- data/lib/togai_client/models/wallet_entries_paginated_response.rb +280 -0
- data/lib/togai_client/models/wallet_entry.rb +421 -0
- data/lib/togai_client/models/wallet_status.rb +40 -0
- data/lib/togai_client/models/wallet_topup_details.rb +233 -0
- data/lib/togai_client/version.rb +2 -2
- data/lib/togai_client.rb +279 -21
- data/spec/spec_helper.rb +1 -1
- data/togai_client.gemspec +4 -3
- metadata +561 -5
@@ -0,0 +1,24 @@
|
|
1
|
+
# TogaiClient::NamedLicenseEntriesConfig
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **mode** | **String** | Mode to get the named license entries for the license rate cards - CUSTOM: Use the named license entries provided in the request - LOOKUP_RANGE: Use the named license entries of a given account for the specified range - LOOKUP_CYCLE: Use the named license entries of a given account for the specified cycle | |
|
8
|
+
| **custom** | [**Array<NamedLicenseEntry>**](NamedLicenseEntry.md) | List of named license entries, this will be considered if mode is CUSTOM | [optional] |
|
9
|
+
| **lookup_range** | [**NamedLicenseEntriesConfigLookupRange**](NamedLicenseEntriesConfigLookupRange.md) | | [optional] |
|
10
|
+
| **lookup_cycle** | [**NamedLicenseEntriesConfigLookupCycle**](NamedLicenseEntriesConfigLookupCycle.md) | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'togai_client'
|
16
|
+
|
17
|
+
instance = TogaiClient::NamedLicenseEntriesConfig.new(
|
18
|
+
mode: null,
|
19
|
+
custom: null,
|
20
|
+
lookup_range: null,
|
21
|
+
lookup_cycle: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TogaiClient::NamedLicenseEntriesConfigLookupCycle
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **cycle_effective_on** | **Time** | Effective date of the cycle, will be used to get the named license entries of the cycle | [optional] |
|
8
|
+
| **account_id** | **String** | | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'togai_client'
|
14
|
+
|
15
|
+
instance = TogaiClient::NamedLicenseEntriesConfigLookupCycle.new(
|
16
|
+
cycle_effective_on: null,
|
17
|
+
account_id: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TogaiClient::NamedLicenseEntriesConfigLookupRange
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **start** | **Time** | | |
|
8
|
+
| **_end** | **Time** | | |
|
9
|
+
| **account_id** | **String** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'togai_client'
|
15
|
+
|
16
|
+
instance = TogaiClient::NamedLicenseEntriesConfigLookupRange.new(
|
17
|
+
start: null,
|
18
|
+
_end: null,
|
19
|
+
account_id: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# TogaiClient::NamedLicenseEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **license_id** | **String** | | |
|
8
|
+
| **name** | **Integer** | | |
|
9
|
+
| **effective_from** | **Time** | | |
|
10
|
+
| **effective_until** | **Time** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'togai_client'
|
16
|
+
|
17
|
+
instance = TogaiClient::NamedLicenseEntry.new(
|
18
|
+
license_id: null,
|
19
|
+
name: null,
|
20
|
+
effective_from: null,
|
21
|
+
effective_until: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# TogaiClient::NamedLicenseUpdate
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **license_id** | **String** | | |
|
9
|
+
| **account_id** | **String** | | |
|
10
|
+
| **name** | **String** | | |
|
11
|
+
| **effective_from** | **Time** | | [optional] |
|
12
|
+
| **effective_until** | **Time** | | [optional] |
|
13
|
+
| **created_at** | **Time** | | |
|
14
|
+
| **updated_at** | **Time** | | |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'togai_client'
|
20
|
+
|
21
|
+
instance = TogaiClient::NamedLicenseUpdate.new(
|
22
|
+
id: named_license_entry.20rvWRx.0ZwPG,
|
23
|
+
license_id: addon.fdjsl.313,
|
24
|
+
account_id: 123,
|
25
|
+
name: user1,
|
26
|
+
effective_from: 2021-03-04T14:25:10Z,
|
27
|
+
effective_until: 2021-03-04T14:25:10Z,
|
28
|
+
created_at: 2021-03-04T14:25:10Z,
|
29
|
+
updated_at: 2021-03-04T14:25:10Z
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# TogaiClient::NamedLicenseUpdatesPaginatedResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<NamedLicenseUpdate>**](NamedLicenseUpdate.md) | | |
|
8
|
+
| **next_token** | **String** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'togai_client'
|
14
|
+
|
15
|
+
instance = TogaiClient::NamedLicenseUpdatesPaginatedResponse.new(
|
16
|
+
data: null,
|
17
|
+
next_token: eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/Payment.md
ADDED
@@ -0,0 +1,38 @@
|
|
1
|
+
# TogaiClient::Payment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **description** | **String** | | [optional] |
|
9
|
+
| **notes** | **String** | | [optional] |
|
10
|
+
| **account_id** | **String** | | |
|
11
|
+
| **external_payment_references** | [**ExternalPaymentReference**](ExternalPaymentReference.md) | | |
|
12
|
+
| **line_item_records** | [**Array<PaymentLineItemRecord>**](PaymentLineItemRecord.md) | | |
|
13
|
+
| **total_amount** | **Float** | | |
|
14
|
+
| **currency** | **String** | | |
|
15
|
+
| **version** | **Float** | | |
|
16
|
+
| **created_by** | **String** | | |
|
17
|
+
| **created_at** | **Time** | | |
|
18
|
+
|
19
|
+
## Example
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'togai_client'
|
23
|
+
|
24
|
+
instance = TogaiClient::Payment.new(
|
25
|
+
id: pay.w123rwe.1231,
|
26
|
+
description: null,
|
27
|
+
notes: null,
|
28
|
+
account_id: ACC001,
|
29
|
+
external_payment_references: null,
|
30
|
+
line_item_records: null,
|
31
|
+
total_amount: null,
|
32
|
+
currency: null,
|
33
|
+
version: null,
|
34
|
+
created_by: null,
|
35
|
+
created_at: null
|
36
|
+
)
|
37
|
+
```
|
38
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# TogaiClient::PaymentLineItemRecord
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | | |
|
8
|
+
| **togai_id** | **String** | | [optional] |
|
9
|
+
| **amount** | **Float** | | [optional] |
|
10
|
+
| **order** | **Integer** | | |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'togai_client'
|
16
|
+
|
17
|
+
instance = TogaiClient::PaymentLineItemRecord.new(
|
18
|
+
type: null,
|
19
|
+
togai_id: inv.234.12efwe,
|
20
|
+
amount: null,
|
21
|
+
order: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
data/docs/PaymentsApi.md
ADDED
@@ -0,0 +1,227 @@
|
|
1
|
+
# TogaiClient::PaymentsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.togai.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_payments**](PaymentsApi.md#create_payments) | **POST** /payments | create payments |
|
8
|
+
| [**get_payment**](PaymentsApi.md#get_payment) | **GET** /payments/{payment_id} | Get a payment |
|
9
|
+
| [**list_payments**](PaymentsApi.md#list_payments) | **GET** /payments | List all payments |
|
10
|
+
|
11
|
+
|
12
|
+
## create_payments
|
13
|
+
|
14
|
+
> <Payment> create_payments(opts)
|
15
|
+
|
16
|
+
create payments
|
17
|
+
|
18
|
+
create payments
|
19
|
+
|
20
|
+
### Examples
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
require 'time'
|
24
|
+
require 'togai_client'
|
25
|
+
# setup authorization
|
26
|
+
TogaiClient.configure do |config|
|
27
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
28
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
29
|
+
end
|
30
|
+
|
31
|
+
api_instance = TogaiClient::PaymentsApi.new
|
32
|
+
opts = {
|
33
|
+
create_payment_request: TogaiClient::CreatePaymentRequest.new({account_id: 'ACC001', external_payment_reference: TogaiClient::ExternalPaymentReference.new({source_name: 'source_name_example', source_type: 'GATEWAY', transaction_number: 'transaction_number_example'}), line_item_records: [TogaiClient::PaymentLineItemRecord.new({type: 'INVOICE', order: 37})], currency: 'USD', total_amount: 3.56}) # CreatePaymentRequest | Payload to create a payment
|
34
|
+
}
|
35
|
+
|
36
|
+
begin
|
37
|
+
# create payments
|
38
|
+
result = api_instance.create_payments(opts)
|
39
|
+
p result
|
40
|
+
rescue TogaiClient::ApiError => e
|
41
|
+
puts "Error when calling PaymentsApi->create_payments: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
#### Using the create_payments_with_http_info variant
|
46
|
+
|
47
|
+
This returns an Array which contains the response data, status code and headers.
|
48
|
+
|
49
|
+
> <Array(<Payment>, Integer, Hash)> create_payments_with_http_info(opts)
|
50
|
+
|
51
|
+
```ruby
|
52
|
+
begin
|
53
|
+
# create payments
|
54
|
+
data, status_code, headers = api_instance.create_payments_with_http_info(opts)
|
55
|
+
p status_code # => 2xx
|
56
|
+
p headers # => { ... }
|
57
|
+
p data # => <Payment>
|
58
|
+
rescue TogaiClient::ApiError => e
|
59
|
+
puts "Error when calling PaymentsApi->create_payments_with_http_info: #{e}"
|
60
|
+
end
|
61
|
+
```
|
62
|
+
|
63
|
+
### Parameters
|
64
|
+
|
65
|
+
| Name | Type | Description | Notes |
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
67
|
+
| **create_payment_request** | [**CreatePaymentRequest**](CreatePaymentRequest.md) | Payload to create a payment | [optional] |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**Payment**](Payment.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
[bearerAuth](../README.md#bearerAuth)
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: application/json
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## get_payment
|
84
|
+
|
85
|
+
> <Payment> get_payment(payment_id, opts)
|
86
|
+
|
87
|
+
Get a payment
|
88
|
+
|
89
|
+
Get payment
|
90
|
+
|
91
|
+
### Examples
|
92
|
+
|
93
|
+
```ruby
|
94
|
+
require 'time'
|
95
|
+
require 'togai_client'
|
96
|
+
# setup authorization
|
97
|
+
TogaiClient.configure do |config|
|
98
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
99
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
100
|
+
end
|
101
|
+
|
102
|
+
api_instance = TogaiClient::PaymentsApi.new
|
103
|
+
payment_id = 'payment.1zYnCiM9Bpg.lv25y' # String |
|
104
|
+
opts = {
|
105
|
+
version: 2 # Integer | Optional version to get a specific version. Gets latest version if it is not provided.
|
106
|
+
}
|
107
|
+
|
108
|
+
begin
|
109
|
+
# Get a payment
|
110
|
+
result = api_instance.get_payment(payment_id, opts)
|
111
|
+
p result
|
112
|
+
rescue TogaiClient::ApiError => e
|
113
|
+
puts "Error when calling PaymentsApi->get_payment: #{e}"
|
114
|
+
end
|
115
|
+
```
|
116
|
+
|
117
|
+
#### Using the get_payment_with_http_info variant
|
118
|
+
|
119
|
+
This returns an Array which contains the response data, status code and headers.
|
120
|
+
|
121
|
+
> <Array(<Payment>, Integer, Hash)> get_payment_with_http_info(payment_id, opts)
|
122
|
+
|
123
|
+
```ruby
|
124
|
+
begin
|
125
|
+
# Get a payment
|
126
|
+
data, status_code, headers = api_instance.get_payment_with_http_info(payment_id, opts)
|
127
|
+
p status_code # => 2xx
|
128
|
+
p headers # => { ... }
|
129
|
+
p data # => <Payment>
|
130
|
+
rescue TogaiClient::ApiError => e
|
131
|
+
puts "Error when calling PaymentsApi->get_payment_with_http_info: #{e}"
|
132
|
+
end
|
133
|
+
```
|
134
|
+
|
135
|
+
### Parameters
|
136
|
+
|
137
|
+
| Name | Type | Description | Notes |
|
138
|
+
| ---- | ---- | ----------- | ----- |
|
139
|
+
| **payment_id** | **String** | | |
|
140
|
+
| **version** | **Integer** | Optional version to get a specific version. Gets latest version if it is not provided. | [optional] |
|
141
|
+
|
142
|
+
### Return type
|
143
|
+
|
144
|
+
[**Payment**](Payment.md)
|
145
|
+
|
146
|
+
### Authorization
|
147
|
+
|
148
|
+
[bearerAuth](../README.md#bearerAuth)
|
149
|
+
|
150
|
+
### HTTP request headers
|
151
|
+
|
152
|
+
- **Content-Type**: Not defined
|
153
|
+
- **Accept**: application/json
|
154
|
+
|
155
|
+
|
156
|
+
## list_payments
|
157
|
+
|
158
|
+
> <ListPaymentResponse> list_payments(opts)
|
159
|
+
|
160
|
+
List all payments
|
161
|
+
|
162
|
+
List all payments
|
163
|
+
|
164
|
+
### Examples
|
165
|
+
|
166
|
+
```ruby
|
167
|
+
require 'time'
|
168
|
+
require 'togai_client'
|
169
|
+
# setup authorization
|
170
|
+
TogaiClient.configure do |config|
|
171
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
172
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
173
|
+
end
|
174
|
+
|
175
|
+
api_instance = TogaiClient::PaymentsApi.new
|
176
|
+
opts = {
|
177
|
+
next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | Pagination token used as a marker to get records from next page.
|
178
|
+
page_size: 10 # Integer | Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided.
|
179
|
+
}
|
180
|
+
|
181
|
+
begin
|
182
|
+
# List all payments
|
183
|
+
result = api_instance.list_payments(opts)
|
184
|
+
p result
|
185
|
+
rescue TogaiClient::ApiError => e
|
186
|
+
puts "Error when calling PaymentsApi->list_payments: #{e}"
|
187
|
+
end
|
188
|
+
```
|
189
|
+
|
190
|
+
#### Using the list_payments_with_http_info variant
|
191
|
+
|
192
|
+
This returns an Array which contains the response data, status code and headers.
|
193
|
+
|
194
|
+
> <Array(<ListPaymentResponse>, Integer, Hash)> list_payments_with_http_info(opts)
|
195
|
+
|
196
|
+
```ruby
|
197
|
+
begin
|
198
|
+
# List all payments
|
199
|
+
data, status_code, headers = api_instance.list_payments_with_http_info(opts)
|
200
|
+
p status_code # => 2xx
|
201
|
+
p headers # => { ... }
|
202
|
+
p data # => <ListPaymentResponse>
|
203
|
+
rescue TogaiClient::ApiError => e
|
204
|
+
puts "Error when calling PaymentsApi->list_payments_with_http_info: #{e}"
|
205
|
+
end
|
206
|
+
```
|
207
|
+
|
208
|
+
### Parameters
|
209
|
+
|
210
|
+
| Name | Type | Description | Notes |
|
211
|
+
| ---- | ---- | ----------- | ----- |
|
212
|
+
| **next_token** | **String** | Pagination token used as a marker to get records from next page. | [optional] |
|
213
|
+
| **page_size** | **Integer** | Maximum page size expected by client to return the record list. NOTE: Max page size cannot be more than 50. Also 50 is the default page size if no value is provided. | [optional] |
|
214
|
+
|
215
|
+
### Return type
|
216
|
+
|
217
|
+
[**ListPaymentResponse**](ListPaymentResponse.md)
|
218
|
+
|
219
|
+
### Authorization
|
220
|
+
|
221
|
+
[bearerAuth](../README.md#bearerAuth)
|
222
|
+
|
223
|
+
### HTTP request headers
|
224
|
+
|
225
|
+
- **Content-Type**: Not defined
|
226
|
+
- **Accept**: application/json
|
227
|
+
|
data/docs/PlanOverride.md
CHANGED
@@ -4,8 +4,11 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **price_plan_id** | **String** | | |
|
7
9
|
| **price_plan_name** | **String** | | |
|
8
10
|
| **price_plan_details_override** | [**PricePlanDetailsOverride**](PricePlanDetailsOverride.md) | | [optional] |
|
11
|
+
| **pricing_rules_override** | [**Array<PricingRule>**](PricingRule.md) | | [optional] |
|
9
12
|
| **start_date** | **Time** | | |
|
10
13
|
| **end_date** | **Time** | | |
|
11
14
|
|
@@ -15,8 +18,11 @@
|
|
15
18
|
require 'togai_client'
|
16
19
|
|
17
20
|
instance = TogaiClient::PlanOverride.new(
|
21
|
+
id: null,
|
22
|
+
price_plan_id: null,
|
18
23
|
price_plan_name: null,
|
19
24
|
price_plan_details_override: null,
|
25
|
+
pricing_rules_override: null,
|
20
26
|
start_date: null,
|
21
27
|
end_date: null
|
22
28
|
)
|
data/docs/PreAction.md
ADDED
@@ -0,0 +1,20 @@
|
|
1
|
+
# TogaiClient::PreAction
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **type** | **String** | Type of pre action to be performed | |
|
8
|
+
| **config** | **Hash<String, String>** | Configuration required for performing pre action - `GRANT_LICENSE`: grant one time licenses to an account before association - `licenseId` [Required]: Id of the license to be granted - `updateType` [Required]: Type of update to be performed on the license (RELATIVE or ABSOLUTE) - `quantity` [Required]: Quantity of license to be granted - `effectiveFrom` [Optional]: Effective date from which the license will be granted | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'togai_client'
|
14
|
+
|
15
|
+
instance = TogaiClient::PreAction.new(
|
16
|
+
type: null,
|
17
|
+
config: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,147 @@
|
|
1
|
+
# TogaiClient::PriceExperimentationApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.togai.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**calculate_revenue**](PriceExperimentationApi.md#calculate_revenue) | **POST** /revenue_calculator | (DEPRECATED) Calculate and return the revenue for a existing or new price plan |
|
8
|
+
| [**calculate_revenue_v2**](PriceExperimentationApi.md#calculate_revenue_v2) | **POST** /v2/revenue_calculator | Calculate and return the revenue for a existing or new price plan v2 |
|
9
|
+
|
10
|
+
|
11
|
+
## calculate_revenue
|
12
|
+
|
13
|
+
> <CalculateRevenueResponse> calculate_revenue(calculate_revenue_request)
|
14
|
+
|
15
|
+
(DEPRECATED) Calculate and return the revenue for a existing or new price plan
|
16
|
+
|
17
|
+
Calculate and return the revenue for a existing or new price plan
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'togai_client'
|
24
|
+
# setup authorization
|
25
|
+
TogaiClient.configure do |config|
|
26
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = TogaiClient::PriceExperimentationApi.new
|
31
|
+
calculate_revenue_request = TogaiClient::CalculateRevenueRequest.new({currency_config: TogaiClient::CurrencyConfig.new({mode: 'CUSTOM'}), price_plan_details_config: TogaiClient::PricePlanDetailsConfig.new({mode: 'CUSTOM'}), usage_config: TogaiClient::UsageConfig.new({mode: 'CUSTOM'}), license_entries_config: TogaiClient::LicenseEntriesConfig.new({mode: 'CUSTOM'})}) # CalculateRevenueRequest | Request payload for calculateRevenueAPI
|
32
|
+
|
33
|
+
begin
|
34
|
+
# (DEPRECATED) Calculate and return the revenue for a existing or new price plan
|
35
|
+
result = api_instance.calculate_revenue(calculate_revenue_request)
|
36
|
+
p result
|
37
|
+
rescue TogaiClient::ApiError => e
|
38
|
+
puts "Error when calling PriceExperimentationApi->calculate_revenue: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the calculate_revenue_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<CalculateRevenueResponse>, Integer, Hash)> calculate_revenue_with_http_info(calculate_revenue_request)
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# (DEPRECATED) Calculate and return the revenue for a existing or new price plan
|
51
|
+
data, status_code, headers = api_instance.calculate_revenue_with_http_info(calculate_revenue_request)
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <CalculateRevenueResponse>
|
55
|
+
rescue TogaiClient::ApiError => e
|
56
|
+
puts "Error when calling PriceExperimentationApi->calculate_revenue_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
| Name | Type | Description | Notes |
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
64
|
+
| **calculate_revenue_request** | [**CalculateRevenueRequest**](CalculateRevenueRequest.md) | Request payload for calculateRevenueAPI | |
|
65
|
+
|
66
|
+
### Return type
|
67
|
+
|
68
|
+
[**CalculateRevenueResponse**](CalculateRevenueResponse.md)
|
69
|
+
|
70
|
+
### Authorization
|
71
|
+
|
72
|
+
[bearerAuth](../README.md#bearerAuth)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: application/json
|
77
|
+
- **Accept**: application/json
|
78
|
+
|
79
|
+
|
80
|
+
## calculate_revenue_v2
|
81
|
+
|
82
|
+
> <CalculateRevenueResponseV2> calculate_revenue_v2(calculate_revenue_request)
|
83
|
+
|
84
|
+
Calculate and return the revenue for a existing or new price plan v2
|
85
|
+
|
86
|
+
Calculate and return the revenue for a existing or new price plan v2
|
87
|
+
|
88
|
+
### Examples
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
require 'time'
|
92
|
+
require 'togai_client'
|
93
|
+
# setup authorization
|
94
|
+
TogaiClient.configure do |config|
|
95
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
96
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
97
|
+
end
|
98
|
+
|
99
|
+
api_instance = TogaiClient::PriceExperimentationApi.new
|
100
|
+
calculate_revenue_request = TogaiClient::CalculateRevenueRequest.new({currency_config: TogaiClient::CurrencyConfig.new({mode: 'CUSTOM'}), price_plan_details_config: TogaiClient::PricePlanDetailsConfig.new({mode: 'CUSTOM'}), usage_config: TogaiClient::UsageConfig.new({mode: 'CUSTOM'}), license_entries_config: TogaiClient::LicenseEntriesConfig.new({mode: 'CUSTOM'})}) # CalculateRevenueRequest | Request payload for calculateRevenueAPI
|
101
|
+
|
102
|
+
begin
|
103
|
+
# Calculate and return the revenue for a existing or new price plan v2
|
104
|
+
result = api_instance.calculate_revenue_v2(calculate_revenue_request)
|
105
|
+
p result
|
106
|
+
rescue TogaiClient::ApiError => e
|
107
|
+
puts "Error when calling PriceExperimentationApi->calculate_revenue_v2: #{e}"
|
108
|
+
end
|
109
|
+
```
|
110
|
+
|
111
|
+
#### Using the calculate_revenue_v2_with_http_info variant
|
112
|
+
|
113
|
+
This returns an Array which contains the response data, status code and headers.
|
114
|
+
|
115
|
+
> <Array(<CalculateRevenueResponseV2>, Integer, Hash)> calculate_revenue_v2_with_http_info(calculate_revenue_request)
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
begin
|
119
|
+
# Calculate and return the revenue for a existing or new price plan v2
|
120
|
+
data, status_code, headers = api_instance.calculate_revenue_v2_with_http_info(calculate_revenue_request)
|
121
|
+
p status_code # => 2xx
|
122
|
+
p headers # => { ... }
|
123
|
+
p data # => <CalculateRevenueResponseV2>
|
124
|
+
rescue TogaiClient::ApiError => e
|
125
|
+
puts "Error when calling PriceExperimentationApi->calculate_revenue_v2_with_http_info: #{e}"
|
126
|
+
end
|
127
|
+
```
|
128
|
+
|
129
|
+
### Parameters
|
130
|
+
|
131
|
+
| Name | Type | Description | Notes |
|
132
|
+
| ---- | ---- | ----------- | ----- |
|
133
|
+
| **calculate_revenue_request** | [**CalculateRevenueRequest**](CalculateRevenueRequest.md) | Request payload for calculateRevenueAPI | |
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
[**CalculateRevenueResponseV2**](CalculateRevenueResponseV2.md)
|
138
|
+
|
139
|
+
### Authorization
|
140
|
+
|
141
|
+
[bearerAuth](../README.md#bearerAuth)
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: application/json
|
146
|
+
- **Accept**: application/json
|
147
|
+
|
data/docs/PricePlan.md
CHANGED
@@ -4,7 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | Price plan id | |
|
7
8
|
| **name** | **String** | Name of the price plan | |
|
9
|
+
| **type** | [**PricePlanType**](PricePlanType.md) | | |
|
8
10
|
| **description** | **String** | Description of price plan | [optional] |
|
9
11
|
| **status** | **String** | Status of Price plan | |
|
10
12
|
| **pricing_schedule** | [**Array<PricingSchedule>**](PricingSchedule.md) | | |
|
@@ -15,7 +17,9 @@
|
|
15
17
|
require 'togai_client'
|
16
18
|
|
17
19
|
instance = TogaiClient::PricePlan.new(
|
20
|
+
id: null,
|
18
21
|
name: null,
|
22
|
+
type: null,
|
19
23
|
description: null,
|
20
24
|
status: null,
|
21
25
|
pricing_schedule: null
|
data/docs/PricePlanDetails.md
CHANGED
@@ -4,8 +4,19 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **
|
8
|
-
| **
|
7
|
+
| **supported_currencies** | **Array<String>** | | |
|
8
|
+
| **active_currencies** | **Array<String>** | | [readonly] |
|
9
|
+
| **pricing_cycle_config** | [**PricingCycleConfig**](PricingCycleConfig.md) | | [optional] |
|
10
|
+
| **usage_rate_cards** | [**Array<UsageRateCard>**](UsageRateCard.md) | | [optional] |
|
11
|
+
| **fixed_fee_rate_cards** | [**Array<FixedFeeRateCard>**](FixedFeeRateCard.md) | | [optional] |
|
12
|
+
| **license_rate_cards** | [**Array<LicenseRateCard>**](LicenseRateCard.md) | | [optional] |
|
13
|
+
| **billing_entitlement_rate_cards** | [**Array<BillingEntitlementRateCard>**](BillingEntitlementRateCard.md) | | [optional] |
|
14
|
+
| **entitlement_overage_rate_cards** | [**Array<EntitlementOverageRateCard>**](EntitlementOverageRateCard.md) | | [optional] |
|
15
|
+
| **minimum_commitment** | [**MinimumCommitment**](MinimumCommitment.md) | | [optional] |
|
16
|
+
| **credit_grant_rate_cards** | [**Array<CreditGrantRateCard>**](CreditGrantRateCard.md) | | [optional] |
|
17
|
+
| **type** | [**PricePlanType**](PricePlanType.md) | | [optional] |
|
18
|
+
| **deferred_revenue** | **Boolean** | | [optional] |
|
19
|
+
| **allow_ongoing_cycle_updates** | **Object** | Allow changes to price plan from the beginning of the ongoing cycle. type: boolean | [optional] |
|
9
20
|
|
10
21
|
## Example
|
11
22
|
|
@@ -13,8 +24,19 @@
|
|
13
24
|
require 'togai_client'
|
14
25
|
|
15
26
|
instance = TogaiClient::PricePlanDetails.new(
|
27
|
+
supported_currencies: null,
|
28
|
+
active_currencies: null,
|
16
29
|
pricing_cycle_config: null,
|
17
|
-
|
30
|
+
usage_rate_cards: null,
|
31
|
+
fixed_fee_rate_cards: null,
|
32
|
+
license_rate_cards: null,
|
33
|
+
billing_entitlement_rate_cards: null,
|
34
|
+
entitlement_overage_rate_cards: null,
|
35
|
+
minimum_commitment: null,
|
36
|
+
credit_grant_rate_cards: null,
|
37
|
+
type: null,
|
38
|
+
deferred_revenue: null,
|
39
|
+
allow_ongoing_cycle_updates: null
|
18
40
|
)
|
19
41
|
```
|
20
42
|
|