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
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **name** | **String** | Name of the
|
|
7
|
+
| **name** | **String** | Name of the Customer | [optional] |
|
|
8
8
|
| **primary_email** | **String** | Primary email of the customer | [optional] |
|
|
9
|
-
| **
|
|
9
|
+
| **address** | [**Address**](Address.md) | | [optional] |
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
@@ -14,9 +14,9 @@
|
|
|
14
14
|
require 'togai_client'
|
|
15
15
|
|
|
16
16
|
instance = TogaiClient::UpdateCustomerRequest.new(
|
|
17
|
-
name:
|
|
18
|
-
primary_email:
|
|
19
|
-
|
|
17
|
+
name: ACME Enterprise,
|
|
18
|
+
primary_email: admin@example.com,
|
|
19
|
+
address: null
|
|
20
20
|
)
|
|
21
21
|
```
|
|
22
22
|
|
|
@@ -5,8 +5,11 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **description** | **String** | Description of the event | [optional] |
|
|
8
|
-
| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) | |
|
|
9
|
-
| **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) | |
|
|
8
|
+
| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) | | [optional] |
|
|
9
|
+
| **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) | | [optional] |
|
|
10
|
+
| **enrichments** | [**Enrichments**](Enrichments.md) | | [optional] |
|
|
11
|
+
| **filter_fields** | **Array<String>** | List of fields that can be used for filtering in usage meter | [optional] |
|
|
12
|
+
| **event_id_template** | **String** | Template used to generate event id based on event payload | [optional] |
|
|
10
13
|
|
|
11
14
|
## Example
|
|
12
15
|
|
|
@@ -16,7 +19,10 @@ require 'togai_client'
|
|
|
16
19
|
instance = TogaiClient::UpdateEventSchemaRequest.new(
|
|
17
20
|
description: null,
|
|
18
21
|
attributes: null,
|
|
19
|
-
dimensions: null
|
|
22
|
+
dimensions: null,
|
|
23
|
+
enrichments: null,
|
|
24
|
+
filter_fields: null,
|
|
25
|
+
event_id_template: null
|
|
20
26
|
)
|
|
21
27
|
```
|
|
22
28
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::UpdateFeatureCreditsRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **effective_until** | **Time** | Expiry date-time for a feature credits entry | [optional] |
|
|
8
|
+
| **granted** | **Float** | Granted units for a feature credits entry | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::UpdateFeatureCreditsRequest.new(
|
|
16
|
+
effective_until: null,
|
|
17
|
+
granted: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TogaiClient::UpdateFeatureRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | Name of the feature | [optional] |
|
|
8
|
+
| **billable_name** | **String** | Billable name of addon. Billable name takes precedence over name to display in invoice. | [optional] |
|
|
9
|
+
| **schema_associations** | [**Array<EventSchemasForFeature>**](EventSchemasForFeature.md) | Association of a feature with event_schemas | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'togai_client'
|
|
15
|
+
|
|
16
|
+
instance = TogaiClient::UpdateFeatureRequest.new(
|
|
17
|
+
name: null,
|
|
18
|
+
billable_name: null,
|
|
19
|
+
schema_associations: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TogaiClient::UpdateIncidentStatusRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | Incident Status | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'togai_client'
|
|
13
|
+
|
|
14
|
+
instance = TogaiClient::UpdateIncidentStatusRequest.new(
|
|
15
|
+
status: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TogaiClient::UpdateInvoiceGroupAccounts
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_ids** | **Array<String>** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'togai_client'
|
|
13
|
+
|
|
14
|
+
instance = TogaiClient::UpdateInvoiceGroupAccounts.new(
|
|
15
|
+
account_ids: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# TogaiClient::UpdateInvoiceRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **start_date** | **Time** | | [optional] |
|
|
8
|
+
| **end_date** | **Time** | | [optional] |
|
|
9
|
+
| **status** | **String** | Status of invoice | [optional] |
|
|
10
|
+
| **line_items** | [**Array<CustomInvoiceLineItem>**](CustomInvoiceLineItem.md) | | [optional] |
|
|
11
|
+
| **auto_advance** | **Boolean** | This property defines the behaviour of status updates of invoices like: Enabling this property to true auto updates the status of invoice to DUE or PAID accordingly But disabling this property of left null does not auto update the custom status | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'togai_client'
|
|
17
|
+
|
|
18
|
+
instance = TogaiClient::UpdateInvoiceRequest.new(
|
|
19
|
+
start_date: 2020-06-04T12:00Z,
|
|
20
|
+
end_date: 2020-07-04T12:00Z,
|
|
21
|
+
status: DUE,
|
|
22
|
+
line_items: null,
|
|
23
|
+
auto_advance: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -4,8 +4,11 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **migration_mode** | [**MigrationMode**](MigrationMode.md) | | [optional] |
|
|
8
|
+
| **versions_to_migrate** | [**VersionsToMigrate**](VersionsToMigrate.md) | | [optional] |
|
|
7
9
|
| **description** | **String** | Description of price plan | [optional] |
|
|
8
|
-
| **price_plan_details** | [**
|
|
10
|
+
| **price_plan_details** | [**CreatePricePlanDetailsOverride**](CreatePricePlanDetailsOverride.md) | | [optional] |
|
|
11
|
+
| **pricing_rules** | [**Array<CreatePricingRule>**](CreatePricingRule.md) | | [optional] |
|
|
9
12
|
|
|
10
13
|
## Example
|
|
11
14
|
|
|
@@ -13,8 +16,11 @@
|
|
|
13
16
|
require 'togai_client'
|
|
14
17
|
|
|
15
18
|
instance = TogaiClient::UpdatePricePlanRequest.new(
|
|
19
|
+
migration_mode: null,
|
|
20
|
+
versions_to_migrate: null,
|
|
16
21
|
description: null,
|
|
17
|
-
price_plan_details: null
|
|
22
|
+
price_plan_details: null,
|
|
23
|
+
pricing_rules: null
|
|
18
24
|
)
|
|
19
25
|
```
|
|
20
26
|
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TogaiClient::UpdatePricePlanV2Request
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **description** | **String** | Description of price plan | [optional] |
|
|
8
|
+
| **pricing_cycle_config** | [**PricingCycleConfig**](PricingCycleConfig.md) | | [optional] |
|
|
9
|
+
| **supported_currencies** | **Array<String>** | List of currencies supported by the price plan | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'togai_client'
|
|
15
|
+
|
|
16
|
+
instance = TogaiClient::UpdatePricePlanV2Request.new(
|
|
17
|
+
description: null,
|
|
18
|
+
pricing_cycle_config: null,
|
|
19
|
+
supported_currencies: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TogaiClient::UpdatePricingRulesRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **pricing_rules** | [**Array<CreatePricingRule>**](CreatePricingRule.md) | | [optional] |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'togai_client'
|
|
13
|
+
|
|
14
|
+
instance = TogaiClient::UpdatePricingRulesRequest.new(
|
|
15
|
+
pricing_rules: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# TogaiClient::UpdatePricingScheduleRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mode** | **String** | Mode of request to create dis/association | [optional] |
|
|
8
|
+
| **price_plan_id** | **String** | Id of the price plan if association request | [optional] |
|
|
9
|
+
| **effective_from** | **Date** | Date of effectiveness of the association. The date is expected in YYYY-MM-DD format - Editing of a BILLING plan with deferredRevenue can be achieved with effectiveFrom as start date of current cycle or using `retainStartOffset` option. | |
|
|
10
|
+
| **effective_until** | **Date** | Date until which the association must be effective. The date is expected in YYYY-MM-DD format | |
|
|
11
|
+
| **price_plan_details_override** | [**CreatePricePlanDetailsOverride**](CreatePricePlanDetailsOverride.md) | | [optional] |
|
|
12
|
+
| **pricing_rules_override** | [**Array<CreatePricingRule>**](CreatePricingRule.md) | | [optional] |
|
|
13
|
+
| **retain_start_offsets** | **Boolean** | If this flag is true, current pricing cycle of the account on the date of association will continue rather than the configurations of the newly associated price plan. Pricing cycle overrides specified using `pricePlanDetailsOverride` will take precedence over the pricing cycle configurations of the new price plan that the account needs to migrate to. PricingCycleInterval of the existing plan and the new plan must be same for this to work. We'll return a `400 BadRequest` otherwise. Examples: - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL} New association (15th Oct to 15th Nov) of different price plan with retainStartOffsets option true will use the same pricing cycle configuration {dayOffset: 1, monthOffset: NIL} rather than using the pricing cycle configuration of the new price plan that the account needs to migrate to. - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL} New association (1st Nov to 30th Nov) of different price plan with retainStartOffsets option true will throw a `400 BadRequest` as no existing price plan configuration found on date of association | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'togai_client'
|
|
19
|
+
|
|
20
|
+
instance = TogaiClient::UpdatePricingScheduleRequest.new(
|
|
21
|
+
mode: null,
|
|
22
|
+
price_plan_id: null,
|
|
23
|
+
effective_from: null,
|
|
24
|
+
effective_until: null,
|
|
25
|
+
price_plan_details_override: null,
|
|
26
|
+
pricing_rules_override: null,
|
|
27
|
+
retain_start_offsets: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# TogaiClient::UpdatePricingScheduleRequestWithActions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mode** | **String** | Mode of request to create dis/association | [optional] |
|
|
8
|
+
| **price_plan_id** | **String** | Id of the price plan if association request | [optional] |
|
|
9
|
+
| **effective_from** | **Date** | Date of effectiveness of the association. The date is expected in YYYY-MM-DD format - Editing of a BILLING plan with deferredRevenue can be achieved with effectiveFrom as start date of current cycle or using `retainStartOffset` option. | |
|
|
10
|
+
| **effective_until** | **Date** | Date until which the association must be effective. The date is expected in YYYY-MM-DD format | |
|
|
11
|
+
| **price_plan_details_override** | [**CreatePricePlanDetailsOverride**](CreatePricePlanDetailsOverride.md) | | [optional] |
|
|
12
|
+
| **pricing_rules_override** | [**Array<CreatePricingRule>**](CreatePricingRule.md) | | [optional] |
|
|
13
|
+
| **retain_start_offsets** | **Boolean** | If this flag is true, current pricing cycle of the account on the date of association will continue rather than the configurations of the newly associated price plan. Pricing cycle overrides specified using `pricePlanDetailsOverride` will take precedence over the pricing cycle configurations of the new price plan that the account needs to migrate to. PricingCycleInterval of the existing plan and the new plan must be same for this to work. We'll return a `400 BadRequest` otherwise. Examples: - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL} New association (15th Oct to 15th Nov) of different price plan with retainStartOffsets option true will use the same pricing cycle configuration {dayOffset: 1, monthOffset: NIL} rather than using the pricing cycle configuration of the new price plan that the account needs to migrate to. - Ongoing plan (1st Oct to 30th Oct) - {dayOffset: 1, monthOffset: NIL} New association (1st Nov to 30th Nov) of different price plan with retainStartOffsets option true will throw a `400 BadRequest` as no existing price plan configuration found on date of association | [optional] |
|
|
14
|
+
| **pre_actions** | [**Array<PreAction>**](PreAction.md) | Pre actions to be performed before association or disassociation | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'togai_client'
|
|
20
|
+
|
|
21
|
+
instance = TogaiClient::UpdatePricingScheduleRequestWithActions.new(
|
|
22
|
+
mode: null,
|
|
23
|
+
price_plan_id: null,
|
|
24
|
+
effective_from: null,
|
|
25
|
+
effective_until: null,
|
|
26
|
+
price_plan_details_override: null,
|
|
27
|
+
pricing_rules_override: null,
|
|
28
|
+
retain_start_offsets: null,
|
|
29
|
+
pre_actions: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TogaiClient::UpdatePricingScheduleResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **account_id** | **String** | Identifier of the account | |
|
|
8
|
+
| **account_name** | **String** | Name of the Account | |
|
|
9
|
+
| **pricing_schedules** | [**Array<PlanOverride>**](PlanOverride.md) | | |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'togai_client'
|
|
15
|
+
|
|
16
|
+
instance = TogaiClient::UpdatePricingScheduleResponse.new(
|
|
17
|
+
account_id: null,
|
|
18
|
+
account_name: null,
|
|
19
|
+
pricing_schedules: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TogaiClient::UpdateProposalStatus
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **status** | **String** | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'togai_client'
|
|
13
|
+
|
|
14
|
+
instance = TogaiClient::UpdateProposalStatus.new(
|
|
15
|
+
status: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TogaiClient::UpdateSettingRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **name** | **String** | | [optional] |
|
|
8
|
+
| **value** | **String** | | [optional] |
|
|
9
|
+
| **data_type** | [**SettingDataType**](SettingDataType.md) | | [optional] |
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```ruby
|
|
14
|
+
require 'togai_client'
|
|
15
|
+
|
|
16
|
+
instance = TogaiClient::UpdateSettingRequest.new(
|
|
17
|
+
name: null,
|
|
18
|
+
value: null,
|
|
19
|
+
data_type: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -4,10 +4,14 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
7
|
+
| **name** | **String** | Name of usage meter. | [optional] |
|
|
8
|
+
| **billable_name** | **String** | Billable name of usage meter. Billable name takes precedence over name to display in invoice. | [optional] |
|
|
9
|
+
| **description** | **String** | Description of the usage meter | [optional] |
|
|
10
|
+
| **event_schema_name** | **String** | Event Schema Identifier | [optional] |
|
|
11
|
+
| **type** | **String** | Type of usage meter * COUNTER - Count usage | [optional] |
|
|
12
|
+
| **aggregation** | [**UsageMeterAggregation**](UsageMeterAggregation.md) | | [optional] |
|
|
10
13
|
| **computations** | [**Array<Computation>**](Computation.md) | | [optional] |
|
|
14
|
+
| **filters** | [**Array<UsageMeterFilterEntry>**](UsageMeterFilterEntry.md) | | [optional] |
|
|
11
15
|
|
|
12
16
|
## Example
|
|
13
17
|
|
|
@@ -15,10 +19,14 @@
|
|
|
15
19
|
require 'togai_client'
|
|
16
20
|
|
|
17
21
|
instance = TogaiClient::UpdateUsageMeterRequest.new(
|
|
22
|
+
name: null,
|
|
23
|
+
billable_name: null,
|
|
18
24
|
description: null,
|
|
25
|
+
event_schema_name: null,
|
|
19
26
|
type: COUNTER,
|
|
20
|
-
aggregation:
|
|
21
|
-
computations: null
|
|
27
|
+
aggregation: null,
|
|
28
|
+
computations: null,
|
|
29
|
+
filters: null
|
|
22
30
|
)
|
|
23
31
|
```
|
|
24
32
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::UpdateWalletRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **effective_from** | **Time** | | [optional] |
|
|
8
|
+
| **status** | [**WalletStatus**](WalletStatus.md) | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::UpdateWalletRequest.new(
|
|
16
|
+
effective_from: null,
|
|
17
|
+
status: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/UsageConfig.md
ADDED
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TogaiClient::UsageConfig
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **mode** | **String** | Mode to get the usage for the usage meters - CUSTOM: Use the usages provided in the request - LOOKUP_RANGE: Use the usage of a given account for the specified range - LOOKUP_CYCLE: Use the usage of a given account for the specified cycle | |
|
|
8
|
+
| **usage_map** | **Hash<String, Float>** | Map of usage meter id and usage, this will be considered if mode is CUSTOM | [optional] |
|
|
9
|
+
| **lookup_range** | [**UsageConfigLookupRange**](UsageConfigLookupRange.md) | | [optional] |
|
|
10
|
+
| **lookup_cycle** | [**UsageConfigLookupCycle**](UsageConfigLookupCycle.md) | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'togai_client'
|
|
16
|
+
|
|
17
|
+
instance = TogaiClient::UsageConfig.new(
|
|
18
|
+
mode: null,
|
|
19
|
+
usage_map: null,
|
|
20
|
+
lookup_range: null,
|
|
21
|
+
lookup_cycle: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::UsageConfigLookupCycle
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **cycle_effective_on** | **Time** | | [optional] |
|
|
8
|
+
| **account_id** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::UsageConfigLookupCycle.new(
|
|
16
|
+
cycle_effective_on: null,
|
|
17
|
+
account_id: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# TogaiClient::UsageConfigLookupRange
|
|
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::UsageConfigLookupRange.new(
|
|
17
|
+
start: null,
|
|
18
|
+
_end: null,
|
|
19
|
+
account_id: null
|
|
20
|
+
)
|
|
21
|
+
```
|
|
22
|
+
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# TogaiClient::UsageCycleInterval
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'togai_client'
|
|
12
|
+
|
|
13
|
+
instance = TogaiClient::UsageCycleInterval.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::UsageLookupRange
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **start** | **Time** | | |
|
|
8
|
+
| **_end** | **Time** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::UsageLookupRange.new(
|
|
16
|
+
start: null,
|
|
17
|
+
_end: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/UsageMeter.md
CHANGED
|
@@ -4,12 +4,17 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Identifier of the usage meter | |
|
|
7
8
|
| **name** | **String** | Name of the usage meter | |
|
|
9
|
+
| **billable_name** | **String** | Billable name of addon. Billable name takes precedence over name to display in invoice. | [optional] |
|
|
10
|
+
| **display_name** | **String** | Display name of usage meter. This is an auto-generated field which contains billableName of usage meter. If billableName is not provided, name will be used as display name. | |
|
|
8
11
|
| **description** | **String** | | [optional] |
|
|
12
|
+
| **filters** | [**Array<UsageMeterFilterEntry>**](UsageMeterFilterEntry.md) | | [optional] |
|
|
9
13
|
| **type** | **String** | Type of usage meter | |
|
|
10
14
|
| **status** | **String** | Status of usage meter | [optional] |
|
|
11
|
-
| **aggregation** | **
|
|
15
|
+
| **aggregation** | [**UsageMeterAggregation**](UsageMeterAggregation.md) | | |
|
|
12
16
|
| **computations** | [**Array<Computation>**](Computation.md) | | [optional] |
|
|
17
|
+
| **event_schema** | [**EventSchema**](EventSchema.md) | | [optional] |
|
|
13
18
|
| **created_at** | **Time** | | [optional] |
|
|
14
19
|
| **last_activated_at** | **Time** | | [optional] |
|
|
15
20
|
| **updated_at** | **Time** | | [optional] |
|
|
@@ -20,12 +25,17 @@
|
|
|
20
25
|
require 'togai_client'
|
|
21
26
|
|
|
22
27
|
instance = TogaiClient::UsageMeter.new(
|
|
28
|
+
id: null,
|
|
23
29
|
name: rides-usage,
|
|
30
|
+
billable_name: Rides Usage,
|
|
31
|
+
display_name: null,
|
|
24
32
|
description: Meter to track cab rides,
|
|
33
|
+
filters: null,
|
|
25
34
|
type: COUNTER,
|
|
26
35
|
status: DRAFT,
|
|
27
|
-
aggregation:
|
|
36
|
+
aggregation: null,
|
|
28
37
|
computations: null,
|
|
38
|
+
event_schema: null,
|
|
29
39
|
created_at: null,
|
|
30
40
|
last_activated_at: null,
|
|
31
41
|
updated_at: null
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# TogaiClient::UsageMeterAggregation
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'togai_client'
|
|
12
|
+
|
|
13
|
+
instance = TogaiClient::UsageMeterAggregation.new()
|
|
14
|
+
```
|
|
15
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::UsageMeterFilterEntry
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **field** | **String** | | |
|
|
8
|
+
| **value** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::UsageMeterFilterEntry.new(
|
|
16
|
+
field: null,
|
|
17
|
+
value: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|