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
data/docs/EventIngestionApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# TogaiClient::EventIngestionApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://api.togai.com*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -10,11 +10,11 @@ All URIs are relative to *https://sandbox-api.togai.com*
|
|
10
10
|
|
11
11
|
## ingest
|
12
12
|
|
13
|
-
> ingest(ingest_event_request)
|
13
|
+
> <IngestEventResponse> ingest(ingest_event_request)
|
14
14
|
|
15
15
|
Ingest events to Togai
|
16
16
|
|
17
|
-
API to ingest your
|
17
|
+
This API let’s you to ingest events to your Togai account. Events ingested using this API will be processed via associated usage meters and further via associated price plans to generate final billable value to invoice the customer Read more about [Event Ingestion](https://docs.togai.com/docs/event-ingestion)
|
18
18
|
|
19
19
|
### Examples
|
20
20
|
|
@@ -28,11 +28,12 @@ TogaiClient.configure do |config|
|
|
28
28
|
end
|
29
29
|
|
30
30
|
api_instance = TogaiClient::EventIngestionApi.new
|
31
|
-
ingest_event_request = TogaiClient::IngestEventRequest.new # IngestEventRequest | Request body to ingest events to Togai usage and billing management service.
|
31
|
+
ingest_event_request = TogaiClient::IngestEventRequest.new({event: TogaiClient::Event.new({schema_name: 'schema_name_example', timestamp: Time.now, account_id: '1', attributes: [TogaiClient::Attribute.new({name: 'message', value: '100'})], dimensions: { key: '{"Country":"India"}'}})}) # IngestEventRequest | Request body to ingest events to Togai usage and billing management service.
|
32
32
|
|
33
33
|
begin
|
34
34
|
# Ingest events to Togai
|
35
|
-
api_instance.ingest(ingest_event_request)
|
35
|
+
result = api_instance.ingest(ingest_event_request)
|
36
|
+
p result
|
36
37
|
rescue TogaiClient::ApiError => e
|
37
38
|
puts "Error when calling EventIngestionApi->ingest: #{e}"
|
38
39
|
end
|
@@ -40,9 +41,9 @@ end
|
|
40
41
|
|
41
42
|
#### Using the ingest_with_http_info variant
|
42
43
|
|
43
|
-
This returns an Array which contains the response data
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
44
45
|
|
45
|
-
> <Array(
|
46
|
+
> <Array(<IngestEventResponse>, Integer, Hash)> ingest_with_http_info(ingest_event_request)
|
46
47
|
|
47
48
|
```ruby
|
48
49
|
begin
|
@@ -50,7 +51,7 @@ begin
|
|
50
51
|
data, status_code, headers = api_instance.ingest_with_http_info(ingest_event_request)
|
51
52
|
p status_code # => 2xx
|
52
53
|
p headers # => { ... }
|
53
|
-
p data # =>
|
54
|
+
p data # => <IngestEventResponse>
|
54
55
|
rescue TogaiClient::ApiError => e
|
55
56
|
puts "Error when calling EventIngestionApi->ingest_with_http_info: #{e}"
|
56
57
|
end
|
@@ -64,7 +65,7 @@ end
|
|
64
65
|
|
65
66
|
### Return type
|
66
67
|
|
67
|
-
|
68
|
+
[**IngestEventResponse**](IngestEventResponse.md)
|
68
69
|
|
69
70
|
### Authorization
|
70
71
|
|
@@ -78,11 +79,11 @@ nil (empty response body)
|
|
78
79
|
|
79
80
|
## ingest_batch
|
80
81
|
|
81
|
-
> <
|
82
|
+
> <IngestEventResponse> ingest_batch(ingest_batch_event_request)
|
82
83
|
|
83
84
|
Ingest events to Togai in batch
|
84
85
|
|
85
|
-
API to ingest
|
86
|
+
This API let’s you to ingest events in batch upto 500 events. Ingest large amounts of events up to 500 in batches in an array using this API.
|
86
87
|
|
87
88
|
### Examples
|
88
89
|
|
@@ -96,7 +97,7 @@ TogaiClient.configure do |config|
|
|
96
97
|
end
|
97
98
|
|
98
99
|
api_instance = TogaiClient::EventIngestionApi.new
|
99
|
-
ingest_batch_event_request = TogaiClient::IngestBatchEventRequest.new({events: [TogaiClient::Event.new({
|
100
|
+
ingest_batch_event_request = TogaiClient::IngestBatchEventRequest.new({events: [TogaiClient::Event.new({schema_name: 'schema_name_example', timestamp: Time.now, account_id: '1', attributes: [TogaiClient::Attribute.new({name: 'message', value: '100'})], dimensions: { key: '{"Country":"India"}'}})]}) # IngestBatchEventRequest | Request body to ingest events in batch to Togai usage and billing management service.
|
100
101
|
|
101
102
|
begin
|
102
103
|
# Ingest events to Togai in batch
|
@@ -111,7 +112,7 @@ end
|
|
111
112
|
|
112
113
|
This returns an Array which contains the response data, status code and headers.
|
113
114
|
|
114
|
-
> <Array(<
|
115
|
+
> <Array(<IngestEventResponse>, Integer, Hash)> ingest_batch_with_http_info(ingest_batch_event_request)
|
115
116
|
|
116
117
|
```ruby
|
117
118
|
begin
|
@@ -119,7 +120,7 @@ begin
|
|
119
120
|
data, status_code, headers = api_instance.ingest_batch_with_http_info(ingest_batch_event_request)
|
120
121
|
p status_code # => 2xx
|
121
122
|
p headers # => { ... }
|
122
|
-
p data # => <
|
123
|
+
p data # => <IngestEventResponse>
|
123
124
|
rescue TogaiClient::ApiError => e
|
124
125
|
puts "Error when calling EventIngestionApi->ingest_batch_with_http_info: #{e}"
|
125
126
|
end
|
@@ -133,7 +134,7 @@ end
|
|
133
134
|
|
134
135
|
### Return type
|
135
136
|
|
136
|
-
[**
|
137
|
+
[**IngestEventResponse**](IngestEventResponse.md)
|
137
138
|
|
138
139
|
### Authorization
|
139
140
|
|
data/docs/EventManagementApi.md
CHANGED
@@ -1,20 +1,96 @@
|
|
1
1
|
# TogaiClient::EventManagementApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://api.togai.com*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
|
-
| [**
|
8
|
-
| [**
|
7
|
+
| [**event_correction**](EventManagementApi.md#event_correction) | **POST** /events/correction | Correct an ingested event |
|
8
|
+
| [**get_events**](EventManagementApi.md#get_events) | **GET** /events | Get a list of usage events with multiple query options |
|
9
|
+
| [**get_single_event**](EventManagementApi.md#get_single_event) | **GET** /events/{event_id} | Get an event using event id |
|
10
|
+
|
11
|
+
|
12
|
+
## event_correction
|
13
|
+
|
14
|
+
> <EventsCorrectionResponse> event_correction(action, opts)
|
15
|
+
|
16
|
+
Correct an ingested event
|
17
|
+
|
18
|
+
#### This API lets you to correct events. Available in both synchronous and asynchronous mode - **Usages**: Reduction of all usages associated with this event - **Revenue**: Reduction of all revenues associated with this event - **Entitlements**: Entitlements(Feature Credits) consumed by this event are granted back to the account. ### Possible Actions: - UNDO: Undo all usages, revenue and entitlements associated with an event - REDO: Performs UNDO and re-ingests the same event - REDO_EVENT: Performs UNDO and re-ingests the correction payload of the event
|
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::EventManagementApi.new
|
32
|
+
action = 'UNDO' # String | Action to perform in event correction
|
33
|
+
opts = {
|
34
|
+
require_confirmation: false, # Boolean | Specifies whether to start a migration only after a confirmation
|
35
|
+
event_correction_request: TogaiClient::EventCorrectionRequest.new # EventCorrectionRequest |
|
36
|
+
}
|
37
|
+
|
38
|
+
begin
|
39
|
+
# Correct an ingested event
|
40
|
+
result = api_instance.event_correction(action, opts)
|
41
|
+
p result
|
42
|
+
rescue TogaiClient::ApiError => e
|
43
|
+
puts "Error when calling EventManagementApi->event_correction: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
#### Using the event_correction_with_http_info variant
|
48
|
+
|
49
|
+
This returns an Array which contains the response data, status code and headers.
|
50
|
+
|
51
|
+
> <Array(<EventsCorrectionResponse>, Integer, Hash)> event_correction_with_http_info(action, opts)
|
52
|
+
|
53
|
+
```ruby
|
54
|
+
begin
|
55
|
+
# Correct an ingested event
|
56
|
+
data, status_code, headers = api_instance.event_correction_with_http_info(action, opts)
|
57
|
+
p status_code # => 2xx
|
58
|
+
p headers # => { ... }
|
59
|
+
p data # => <EventsCorrectionResponse>
|
60
|
+
rescue TogaiClient::ApiError => e
|
61
|
+
puts "Error when calling EventManagementApi->event_correction_with_http_info: #{e}"
|
62
|
+
end
|
63
|
+
```
|
64
|
+
|
65
|
+
### Parameters
|
66
|
+
|
67
|
+
| Name | Type | Description | Notes |
|
68
|
+
| ---- | ---- | ----------- | ----- |
|
69
|
+
| **action** | **String** | Action to perform in event correction | |
|
70
|
+
| **require_confirmation** | **Boolean** | Specifies whether to start a migration only after a confirmation | [optional] |
|
71
|
+
| **event_correction_request** | [**EventCorrectionRequest**](EventCorrectionRequest.md) | | [optional] |
|
72
|
+
|
73
|
+
### Return type
|
74
|
+
|
75
|
+
[**EventsCorrectionResponse**](EventsCorrectionResponse.md)
|
76
|
+
|
77
|
+
### Authorization
|
78
|
+
|
79
|
+
[bearerAuth](../README.md#bearerAuth)
|
80
|
+
|
81
|
+
### HTTP request headers
|
82
|
+
|
83
|
+
- **Content-Type**: application/json
|
84
|
+
- **Accept**: application/json
|
9
85
|
|
10
86
|
|
11
87
|
## get_events
|
12
88
|
|
13
89
|
> <GetEventsResponse> get_events(opts)
|
14
90
|
|
15
|
-
Get usage events
|
91
|
+
Get a list of usage events with multiple query options
|
16
92
|
|
17
|
-
API to
|
93
|
+
This API let’s you to fetch a list of events with multiple query parameters
|
18
94
|
|
19
95
|
### Examples
|
20
96
|
|
@@ -30,15 +106,14 @@ end
|
|
30
106
|
api_instance = TogaiClient::EventManagementApi.new
|
31
107
|
opts = {
|
32
108
|
next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String | Pagination token used as a marker to get records from next page.
|
33
|
-
status: 'PROCESSED', # String | Filter option to filter
|
34
|
-
account_id: '1234', # String | Filter option to filter
|
35
|
-
|
36
|
-
|
37
|
-
end_time: 1650110402000 # Integer | End time filter in epoch milli seconds
|
109
|
+
status: 'PROCESSED', # String | Filter option to filter by status.
|
110
|
+
account_id: '1234', # String | Filter option to filter based on account id.
|
111
|
+
schema_name: 'Rides', # String | Filter option to filter the events based on schema name.
|
112
|
+
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.
|
38
113
|
}
|
39
114
|
|
40
115
|
begin
|
41
|
-
# Get usage events
|
116
|
+
# Get a list of usage events with multiple query options
|
42
117
|
result = api_instance.get_events(opts)
|
43
118
|
p result
|
44
119
|
rescue TogaiClient::ApiError => e
|
@@ -54,7 +129,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
54
129
|
|
55
130
|
```ruby
|
56
131
|
begin
|
57
|
-
# Get usage events
|
132
|
+
# Get a list of usage events with multiple query options
|
58
133
|
data, status_code, headers = api_instance.get_events_with_http_info(opts)
|
59
134
|
p status_code # => 2xx
|
60
135
|
p headers # => { ... }
|
@@ -69,11 +144,10 @@ end
|
|
69
144
|
| Name | Type | Description | Notes |
|
70
145
|
| ---- | ---- | ----------- | ----- |
|
71
146
|
| **next_token** | **String** | Pagination token used as a marker to get records from next page. | [optional] |
|
72
|
-
| **status** | **String** | Filter option to filter
|
73
|
-
| **account_id** | **String** | Filter option to filter
|
147
|
+
| **status** | **String** | Filter option to filter by status. | [optional] |
|
148
|
+
| **account_id** | **String** | Filter option to filter based on account id. | [optional] |
|
149
|
+
| **schema_name** | **String** | Filter option to filter the events based on schema name. | [optional] |
|
74
150
|
| **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] |
|
75
|
-
| **start_time** | **Integer** | Start time filter in epoch milli seconds | [optional] |
|
76
|
-
| **end_time** | **Integer** | End time filter in epoch milli seconds | [optional] |
|
77
151
|
|
78
152
|
### Return type
|
79
153
|
|
@@ -93,9 +167,9 @@ end
|
|
93
167
|
|
94
168
|
> <GetEventResponse> get_single_event(event_id)
|
95
169
|
|
96
|
-
Get
|
170
|
+
Get an event using event id
|
97
171
|
|
98
|
-
|
172
|
+
Fetch details of a particular event using the event ID.
|
99
173
|
|
100
174
|
### Examples
|
101
175
|
|
@@ -109,10 +183,10 @@ TogaiClient.configure do |config|
|
|
109
183
|
end
|
110
184
|
|
111
185
|
api_instance = TogaiClient::EventManagementApi.new
|
112
|
-
event_id = '
|
186
|
+
event_id = 'f4a52f2d-b798-4e08-8b24-db0a5a468ba3' # String |
|
113
187
|
|
114
188
|
begin
|
115
|
-
# Get
|
189
|
+
# Get an event using event id
|
116
190
|
result = api_instance.get_single_event(event_id)
|
117
191
|
p result
|
118
192
|
rescue TogaiClient::ApiError => e
|
@@ -128,7 +202,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
128
202
|
|
129
203
|
```ruby
|
130
204
|
begin
|
131
|
-
# Get
|
205
|
+
# Get an event using event id
|
132
206
|
data, status_code, headers = api_instance.get_single_event_with_http_info(event_id)
|
133
207
|
p status_code # => 2xx
|
134
208
|
p headers # => { ... }
|
data/docs/EventPipelineInfo.md
CHANGED
@@ -5,10 +5,16 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **event_schema** | [**EventPipelineInfoEventSchema**](EventPipelineInfoEventSchema.md) | | [optional] |
|
8
|
-
| **usage_meters** | [**Array<
|
9
|
-
| **price_plans** | [**Array<
|
8
|
+
| **usage_meters** | [**Array<EventPipelineInfoUsageMeters>**](EventPipelineInfoUsageMeters.md) | | [optional] |
|
9
|
+
| **price_plans** | [**Array<EventPipelineInfoPricePlans>**](EventPipelineInfoPricePlans.md) | | [optional] |
|
10
10
|
| **account** | [**EventPipelineInfoAccount**](EventPipelineInfoAccount.md) | | [optional] |
|
11
11
|
| **customer** | [**EventPipelineInfoCustomer**](EventPipelineInfoCustomer.md) | | [optional] |
|
12
|
+
| **feature_details** | [**EventPipelineInfoFeatureDetails**](EventPipelineInfoFeatureDetails.md) | | [optional] |
|
13
|
+
| **enrichments** | [**EventPipelineInfoEnrichments**](EventPipelineInfoEnrichments.md) | | [optional] |
|
14
|
+
| **revenue_details** | [**Array<EventPipelineInfoRevenueDetails>**](EventPipelineInfoRevenueDetails.md) | | [optional] |
|
15
|
+
| **status_before_reverting** | **String** | | [optional] |
|
16
|
+
| **base_currency** | **String** | | [optional] |
|
17
|
+
| **invoice_currency** | **String** | | [optional] |
|
12
18
|
|
13
19
|
## Example
|
14
20
|
|
@@ -20,7 +26,13 @@ instance = TogaiClient::EventPipelineInfo.new(
|
|
20
26
|
usage_meters: null,
|
21
27
|
price_plans: null,
|
22
28
|
account: null,
|
23
|
-
customer: null
|
29
|
+
customer: null,
|
30
|
+
feature_details: null,
|
31
|
+
enrichments: null,
|
32
|
+
revenue_details: null,
|
33
|
+
status_before_reverting: null,
|
34
|
+
base_currency: null,
|
35
|
+
invoice_currency: null
|
24
36
|
)
|
25
37
|
```
|
26
38
|
|
@@ -6,6 +6,7 @@
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **id** | **String** | | |
|
8
8
|
| **name** | **String** | | |
|
9
|
+
| **_alias** | **String** | | [optional] |
|
9
10
|
|
10
11
|
## Example
|
11
12
|
|
@@ -14,7 +15,8 @@ require 'togai_client'
|
|
14
15
|
|
15
16
|
instance = TogaiClient::EventPipelineInfoAccount.new(
|
16
17
|
id: null,
|
17
|
-
name: null
|
18
|
+
name: null,
|
19
|
+
_alias: null
|
18
20
|
)
|
19
21
|
```
|
20
22
|
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TogaiClient::EventPipelineInfoEnrichments
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **attributes** | [**Array<EnrichedField>**](EnrichedField.md) | | [optional] |
|
8
|
+
| **dimensions** | [**Array<EnrichedField>**](EnrichedField.md) | | [optional] |
|
9
|
+
| **dependencies** | [**Array<EnrichmentDependency>**](EnrichmentDependency.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'togai_client'
|
15
|
+
|
16
|
+
instance = TogaiClient::EventPipelineInfoEnrichments.new(
|
17
|
+
attributes: null,
|
18
|
+
dimensions: null,
|
19
|
+
dependencies: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# TogaiClient::EventPipelineInfoFeatureDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **feature_id** | **String** | | |
|
8
|
+
| **mapped_attribute** | **String** | | |
|
9
|
+
| **overage_in_cycle** | **Float** | | [optional] |
|
10
|
+
| **overage_in_event** | **Float** | | [optional] |
|
11
|
+
|
12
|
+
## Example
|
13
|
+
|
14
|
+
```ruby
|
15
|
+
require 'togai_client'
|
16
|
+
|
17
|
+
instance = TogaiClient::EventPipelineInfoFeatureDetails.new(
|
18
|
+
feature_id: null,
|
19
|
+
mapped_attribute: null,
|
20
|
+
overage_in_cycle: null,
|
21
|
+
overage_in_event: null
|
22
|
+
)
|
23
|
+
```
|
24
|
+
|
@@ -0,0 +1,28 @@
|
|
1
|
+
# TogaiClient::EventPipelineInfoPricePlans
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | | |
|
8
|
+
| **id** | **String** | | |
|
9
|
+
| **schedule_id** | **String** | | |
|
10
|
+
| **cycle_start** | **Date** | | |
|
11
|
+
| **cycle_end** | **Date** | | |
|
12
|
+
| **usage_meters** | **Array<String>** | | [optional] |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'togai_client'
|
18
|
+
|
19
|
+
instance = TogaiClient::EventPipelineInfoPricePlans.new(
|
20
|
+
name: null,
|
21
|
+
id: null,
|
22
|
+
schedule_id: null,
|
23
|
+
cycle_start: null,
|
24
|
+
cycle_end: null,
|
25
|
+
usage_meters: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# TogaiClient::EventPipelineInfoRevenueDetails
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **usage_meter_id** | **String** | | |
|
8
|
+
| **revenue_base_currency** | **Float** | | |
|
9
|
+
| **revenue_invoice_currency** | **Float** | | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'togai_client'
|
15
|
+
|
16
|
+
instance = TogaiClient::EventPipelineInfoRevenueDetails.new(
|
17
|
+
usage_meter_id: null,
|
18
|
+
revenue_base_currency: null,
|
19
|
+
revenue_invoice_currency: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# TogaiClient::EventPipelineInfoUsageMeters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | | |
|
8
|
+
| **name** | **String** | | |
|
9
|
+
| **version** | **Integer** | | |
|
10
|
+
| **status** | **String** | | |
|
11
|
+
| **units** | **Float** | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'togai_client'
|
17
|
+
|
18
|
+
instance = TogaiClient::EventPipelineInfoUsageMeters.new(
|
19
|
+
id: null,
|
20
|
+
name: null,
|
21
|
+
version: null,
|
22
|
+
status: null,
|
23
|
+
units: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/EventSchema.md
CHANGED
@@ -8,8 +8,13 @@
|
|
8
8
|
| **description** | **String** | Description of the event | [optional] |
|
9
9
|
| **version** | **Integer** | Version of event schema | |
|
10
10
|
| **status** | **String** | Status of event schema * DRAFT - Schema is in draft state * ACTIVE - Schema is currently active * INACTIVE - Schema is currently inactive * ARCHIVED - Older version of event schema | [optional] |
|
11
|
-
| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) | |
|
11
|
+
| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) | | [optional] |
|
12
12
|
| **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) | | [optional] |
|
13
|
+
| **filter_fields** | **Array<String>** | | [optional] |
|
14
|
+
| **feature_details** | [**FeatureDetails**](FeatureDetails.md) | | [optional] |
|
15
|
+
| **enrichments** | [**Enrichments**](Enrichments.md) | | [optional] |
|
16
|
+
| **event_id_template** | **String** | Template used to generate event id based on event payload | [optional] |
|
17
|
+
| **event_level_revenue** | **Boolean** | | [optional] |
|
13
18
|
| **created_at** | **Time** | | [optional] |
|
14
19
|
| **updated_at** | **Time** | | [optional] |
|
15
20
|
|
@@ -25,6 +30,11 @@ instance = TogaiClient::EventSchema.new(
|
|
25
30
|
status: DRAFT,
|
26
31
|
attributes: null,
|
27
32
|
dimensions: null,
|
33
|
+
filter_fields: null,
|
34
|
+
feature_details: null,
|
35
|
+
enrichments: null,
|
36
|
+
event_id_template: null,
|
37
|
+
event_level_revenue: null,
|
28
38
|
created_at: null,
|
29
39
|
updated_at: null
|
30
40
|
)
|
data/docs/EventSchemaListData.md
CHANGED
@@ -8,8 +8,13 @@
|
|
8
8
|
| **description** | **String** | Description of the event | [optional] |
|
9
9
|
| **version** | **Integer** | Version of event schema | |
|
10
10
|
| **status** | **String** | Status of event schema * DRAFT - Schema is in draft state * ACTIVE - Schema is currently active * INACTIVE - Schema is currently inactive * ARCHIVED - Older version of event schema | [optional] |
|
11
|
-
| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) | |
|
11
|
+
| **attributes** | [**Array<EventAttributeSchema>**](EventAttributeSchema.md) | | [optional] |
|
12
12
|
| **dimensions** | [**Array<DimensionsSchema>**](DimensionsSchema.md) | | [optional] |
|
13
|
+
| **filter_fields** | **Array<String>** | | [optional] |
|
14
|
+
| **feature_details** | [**FeatureDetails**](FeatureDetails.md) | | [optional] |
|
15
|
+
| **enrichments** | [**Enrichments**](Enrichments.md) | | [optional] |
|
16
|
+
| **event_id_template** | **String** | Template used to generate event id based on event payload | [optional] |
|
17
|
+
| **event_level_revenue** | **Boolean** | | [optional] |
|
13
18
|
| **created_at** | **Time** | | [optional] |
|
14
19
|
| **updated_at** | **Time** | | [optional] |
|
15
20
|
| **usage_meters_count** | **Integer** | | [optional] |
|
@@ -26,6 +31,11 @@ instance = TogaiClient::EventSchemaListData.new(
|
|
26
31
|
status: DRAFT,
|
27
32
|
attributes: null,
|
28
33
|
dimensions: null,
|
34
|
+
filter_fields: null,
|
35
|
+
feature_details: null,
|
36
|
+
enrichments: null,
|
37
|
+
event_id_template: null,
|
38
|
+
event_level_revenue: null,
|
29
39
|
created_at: null,
|
30
40
|
updated_at: null,
|
31
41
|
usage_meters_count: null
|