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/EventSchemasApi.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# TogaiClient::EventSchemasApi
|
|
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
|
| ------ | ------------ | ----------- |
|
|
@@ -8,10 +8,10 @@ All URIs are relative to *https://sandbox-api.togai.com*
|
|
|
8
8
|
| [**create_event_schema**](EventSchemasApi.md#create_event_schema) | **POST** /event_schema | Create an event schema |
|
|
9
9
|
| [**deactivate_event_schema**](EventSchemasApi.md#deactivate_event_schema) | **POST** /event_schema/{event_schema_name}/deactivate | Deactivate an event schema |
|
|
10
10
|
| [**delete_event_schema**](EventSchemasApi.md#delete_event_schema) | **DELETE** /event_schema/{event_schema_name} | Delete an event schema |
|
|
11
|
+
| [**event_schema_event_schema_name_patch**](EventSchemasApi.md#event_schema_event_schema_name_patch) | **PATCH** /event_schema/{event_schema_name} | Update an event schema |
|
|
11
12
|
| [**get_event_schema**](EventSchemasApi.md#get_event_schema) | **GET** /event_schema/{event_schema_name} | Get an event schema |
|
|
12
13
|
| [**list_event_schema_versions**](EventSchemasApi.md#list_event_schema_versions) | **GET** /event_schema/{event_schema_name}/versions | List all event schema versions |
|
|
13
14
|
| [**list_event_schemas**](EventSchemasApi.md#list_event_schemas) | **GET** /event_schema | List event schemas |
|
|
14
|
-
| [**update_event_schema**](EventSchemasApi.md#update_event_schema) | **PATCH** /event_schema/{event_schema_name} | Update an event schema |
|
|
15
15
|
|
|
16
16
|
|
|
17
17
|
## activate_event_schema
|
|
@@ -34,7 +34,7 @@ TogaiClient.configure do |config|
|
|
|
34
34
|
end
|
|
35
35
|
|
|
36
36
|
api_instance = TogaiClient::EventSchemasApi.new
|
|
37
|
-
event_schema_name = '
|
|
37
|
+
event_schema_name = 'rides' # String |
|
|
38
38
|
|
|
39
39
|
begin
|
|
40
40
|
# Activate an event schema
|
|
@@ -89,7 +89,7 @@ end
|
|
|
89
89
|
|
|
90
90
|
Create an event schema
|
|
91
91
|
|
|
92
|
-
Create an event schema
|
|
92
|
+
Create an event schema with attributes and dimensions to process events.
|
|
93
93
|
|
|
94
94
|
### Examples
|
|
95
95
|
|
|
@@ -158,7 +158,7 @@ end
|
|
|
158
158
|
|
|
159
159
|
Deactivate an event schema
|
|
160
160
|
|
|
161
|
-
|
|
161
|
+
You can deactivate an event schema using this API. In case you have an activate usage meter associated with the event schema, you will need to deactivate it first and then try deactivating the event schema.
|
|
162
162
|
|
|
163
163
|
### Examples
|
|
164
164
|
|
|
@@ -172,7 +172,7 @@ TogaiClient.configure do |config|
|
|
|
172
172
|
end
|
|
173
173
|
|
|
174
174
|
api_instance = TogaiClient::EventSchemasApi.new
|
|
175
|
-
event_schema_name = '
|
|
175
|
+
event_schema_name = 'rides' # String |
|
|
176
176
|
|
|
177
177
|
begin
|
|
178
178
|
# Deactivate an event schema
|
|
@@ -227,7 +227,7 @@ end
|
|
|
227
227
|
|
|
228
228
|
Delete an event schema
|
|
229
229
|
|
|
230
|
-
|
|
230
|
+
To delete(archive) an event schema, you’re required to archive associated active usage meters if any.
|
|
231
231
|
|
|
232
232
|
### Examples
|
|
233
233
|
|
|
@@ -241,7 +241,7 @@ TogaiClient.configure do |config|
|
|
|
241
241
|
end
|
|
242
242
|
|
|
243
243
|
api_instance = TogaiClient::EventSchemasApi.new
|
|
244
|
-
event_schema_name = '
|
|
244
|
+
event_schema_name = 'rides' # String |
|
|
245
245
|
|
|
246
246
|
begin
|
|
247
247
|
# Delete an event schema
|
|
@@ -290,13 +290,13 @@ end
|
|
|
290
290
|
- **Accept**: application/json
|
|
291
291
|
|
|
292
292
|
|
|
293
|
-
##
|
|
293
|
+
## event_schema_event_schema_name_patch
|
|
294
294
|
|
|
295
|
-
> <EventSchema>
|
|
295
|
+
> <EventSchema> event_schema_event_schema_name_patch(event_schema_name, update_event_schema_request)
|
|
296
296
|
|
|
297
|
-
|
|
297
|
+
Update an event schema
|
|
298
298
|
|
|
299
|
-
|
|
299
|
+
Update an event schema and add new attributes and dimensions Once an event schema is activated, you cannot update or delete existing attributes and dimensions however you can add new attributes and dimensions and update event schema description. operationId: updateEventSchema
|
|
300
300
|
|
|
301
301
|
### Examples
|
|
302
302
|
|
|
@@ -310,35 +310,33 @@ TogaiClient.configure do |config|
|
|
|
310
310
|
end
|
|
311
311
|
|
|
312
312
|
api_instance = TogaiClient::EventSchemasApi.new
|
|
313
|
-
event_schema_name = '
|
|
314
|
-
|
|
315
|
-
version: 56 # Integer | Optional version to get a specific version. Gets latest version if it is not provided.
|
|
316
|
-
}
|
|
313
|
+
event_schema_name = 'rides' # String |
|
|
314
|
+
update_event_schema_request = TogaiClient::UpdateEventSchemaRequest.new # UpdateEventSchemaRequest | Payload to update event schema
|
|
317
315
|
|
|
318
316
|
begin
|
|
319
|
-
#
|
|
320
|
-
result = api_instance.
|
|
317
|
+
# Update an event schema
|
|
318
|
+
result = api_instance.event_schema_event_schema_name_patch(event_schema_name, update_event_schema_request)
|
|
321
319
|
p result
|
|
322
320
|
rescue TogaiClient::ApiError => e
|
|
323
|
-
puts "Error when calling EventSchemasApi->
|
|
321
|
+
puts "Error when calling EventSchemasApi->event_schema_event_schema_name_patch: #{e}"
|
|
324
322
|
end
|
|
325
323
|
```
|
|
326
324
|
|
|
327
|
-
#### Using the
|
|
325
|
+
#### Using the event_schema_event_schema_name_patch_with_http_info variant
|
|
328
326
|
|
|
329
327
|
This returns an Array which contains the response data, status code and headers.
|
|
330
328
|
|
|
331
|
-
> <Array(<EventSchema>, Integer, Hash)>
|
|
329
|
+
> <Array(<EventSchema>, Integer, Hash)> event_schema_event_schema_name_patch_with_http_info(event_schema_name, update_event_schema_request)
|
|
332
330
|
|
|
333
331
|
```ruby
|
|
334
332
|
begin
|
|
335
|
-
#
|
|
336
|
-
data, status_code, headers = api_instance.
|
|
333
|
+
# Update an event schema
|
|
334
|
+
data, status_code, headers = api_instance.event_schema_event_schema_name_patch_with_http_info(event_schema_name, update_event_schema_request)
|
|
337
335
|
p status_code # => 2xx
|
|
338
336
|
p headers # => { ... }
|
|
339
337
|
p data # => <EventSchema>
|
|
340
338
|
rescue TogaiClient::ApiError => e
|
|
341
|
-
puts "Error when calling EventSchemasApi->
|
|
339
|
+
puts "Error when calling EventSchemasApi->event_schema_event_schema_name_patch_with_http_info: #{e}"
|
|
342
340
|
end
|
|
343
341
|
```
|
|
344
342
|
|
|
@@ -347,7 +345,7 @@ end
|
|
|
347
345
|
| Name | Type | Description | Notes |
|
|
348
346
|
| ---- | ---- | ----------- | ----- |
|
|
349
347
|
| **event_schema_name** | **String** | | |
|
|
350
|
-
| **
|
|
348
|
+
| **update_event_schema_request** | [**UpdateEventSchemaRequest**](UpdateEventSchemaRequest.md) | Payload to update event schema | |
|
|
351
349
|
|
|
352
350
|
### Return type
|
|
353
351
|
|
|
@@ -359,17 +357,17 @@ end
|
|
|
359
357
|
|
|
360
358
|
### HTTP request headers
|
|
361
359
|
|
|
362
|
-
- **Content-Type**:
|
|
360
|
+
- **Content-Type**: application/json
|
|
363
361
|
- **Accept**: application/json
|
|
364
362
|
|
|
365
363
|
|
|
366
|
-
##
|
|
364
|
+
## get_event_schema
|
|
367
365
|
|
|
368
|
-
> <
|
|
366
|
+
> <EventSchema> get_event_schema(event_schema_name, opts)
|
|
369
367
|
|
|
370
|
-
|
|
368
|
+
Get an event schema
|
|
371
369
|
|
|
372
|
-
|
|
370
|
+
Get an event schema
|
|
373
371
|
|
|
374
372
|
### Examples
|
|
375
373
|
|
|
@@ -383,32 +381,35 @@ TogaiClient.configure do |config|
|
|
|
383
381
|
end
|
|
384
382
|
|
|
385
383
|
api_instance = TogaiClient::EventSchemasApi.new
|
|
386
|
-
event_schema_name = '
|
|
384
|
+
event_schema_name = 'rides' # String |
|
|
385
|
+
opts = {
|
|
386
|
+
version: 2 # Integer | Optional version to get a specific version. Gets latest version if it is not provided.
|
|
387
|
+
}
|
|
387
388
|
|
|
388
389
|
begin
|
|
389
|
-
#
|
|
390
|
-
result = api_instance.
|
|
390
|
+
# Get an event schema
|
|
391
|
+
result = api_instance.get_event_schema(event_schema_name, opts)
|
|
391
392
|
p result
|
|
392
393
|
rescue TogaiClient::ApiError => e
|
|
393
|
-
puts "Error when calling EventSchemasApi->
|
|
394
|
+
puts "Error when calling EventSchemasApi->get_event_schema: #{e}"
|
|
394
395
|
end
|
|
395
396
|
```
|
|
396
397
|
|
|
397
|
-
#### Using the
|
|
398
|
+
#### Using the get_event_schema_with_http_info variant
|
|
398
399
|
|
|
399
400
|
This returns an Array which contains the response data, status code and headers.
|
|
400
401
|
|
|
401
|
-
> <Array(<
|
|
402
|
+
> <Array(<EventSchema>, Integer, Hash)> get_event_schema_with_http_info(event_schema_name, opts)
|
|
402
403
|
|
|
403
404
|
```ruby
|
|
404
405
|
begin
|
|
405
|
-
#
|
|
406
|
-
data, status_code, headers = api_instance.
|
|
406
|
+
# Get an event schema
|
|
407
|
+
data, status_code, headers = api_instance.get_event_schema_with_http_info(event_schema_name, opts)
|
|
407
408
|
p status_code # => 2xx
|
|
408
409
|
p headers # => { ... }
|
|
409
|
-
p data # => <
|
|
410
|
+
p data # => <EventSchema>
|
|
410
411
|
rescue TogaiClient::ApiError => e
|
|
411
|
-
puts "Error when calling EventSchemasApi->
|
|
412
|
+
puts "Error when calling EventSchemasApi->get_event_schema_with_http_info: #{e}"
|
|
412
413
|
end
|
|
413
414
|
```
|
|
414
415
|
|
|
@@ -417,10 +418,11 @@ end
|
|
|
417
418
|
| Name | Type | Description | Notes |
|
|
418
419
|
| ---- | ---- | ----------- | ----- |
|
|
419
420
|
| **event_schema_name** | **String** | | |
|
|
421
|
+
| **version** | **Integer** | Optional version to get a specific version. Gets latest version if it is not provided. | [optional] |
|
|
420
422
|
|
|
421
423
|
### Return type
|
|
422
424
|
|
|
423
|
-
[**
|
|
425
|
+
[**EventSchema**](EventSchema.md)
|
|
424
426
|
|
|
425
427
|
### Authorization
|
|
426
428
|
|
|
@@ -432,13 +434,13 @@ end
|
|
|
432
434
|
- **Accept**: application/json
|
|
433
435
|
|
|
434
436
|
|
|
435
|
-
##
|
|
437
|
+
## list_event_schema_versions
|
|
436
438
|
|
|
437
|
-
> <
|
|
439
|
+
> <EventSchemaVersionsResponse> list_event_schema_versions(event_schema_name)
|
|
438
440
|
|
|
439
|
-
List event
|
|
441
|
+
List all event schema versions
|
|
440
442
|
|
|
441
|
-
|
|
443
|
+
Get a list of all the versions of an event schema
|
|
442
444
|
|
|
443
445
|
### Examples
|
|
444
446
|
|
|
@@ -452,37 +454,32 @@ TogaiClient.configure do |config|
|
|
|
452
454
|
end
|
|
453
455
|
|
|
454
456
|
api_instance = TogaiClient::EventSchemasApi.new
|
|
455
|
-
|
|
456
|
-
statuses: 'statuses_example', # String | Filter by provided statuses
|
|
457
|
-
next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEyMywgInNvcnRPcmRlciI6ICJhc2MifQ==', # String |
|
|
458
|
-
page_size: '10', # String |
|
|
459
|
-
sort_order: 'ASC' # String |
|
|
460
|
-
}
|
|
457
|
+
event_schema_name = 'rides' # String |
|
|
461
458
|
|
|
462
459
|
begin
|
|
463
|
-
# List event
|
|
464
|
-
result = api_instance.
|
|
460
|
+
# List all event schema versions
|
|
461
|
+
result = api_instance.list_event_schema_versions(event_schema_name)
|
|
465
462
|
p result
|
|
466
463
|
rescue TogaiClient::ApiError => e
|
|
467
|
-
puts "Error when calling EventSchemasApi->
|
|
464
|
+
puts "Error when calling EventSchemasApi->list_event_schema_versions: #{e}"
|
|
468
465
|
end
|
|
469
466
|
```
|
|
470
467
|
|
|
471
|
-
#### Using the
|
|
468
|
+
#### Using the list_event_schema_versions_with_http_info variant
|
|
472
469
|
|
|
473
470
|
This returns an Array which contains the response data, status code and headers.
|
|
474
471
|
|
|
475
|
-
> <Array(<
|
|
472
|
+
> <Array(<EventSchemaVersionsResponse>, Integer, Hash)> list_event_schema_versions_with_http_info(event_schema_name)
|
|
476
473
|
|
|
477
474
|
```ruby
|
|
478
475
|
begin
|
|
479
|
-
# List event
|
|
480
|
-
data, status_code, headers = api_instance.
|
|
476
|
+
# List all event schema versions
|
|
477
|
+
data, status_code, headers = api_instance.list_event_schema_versions_with_http_info(event_schema_name)
|
|
481
478
|
p status_code # => 2xx
|
|
482
479
|
p headers # => { ... }
|
|
483
|
-
p data # => <
|
|
480
|
+
p data # => <EventSchemaVersionsResponse>
|
|
484
481
|
rescue TogaiClient::ApiError => e
|
|
485
|
-
puts "Error when calling EventSchemasApi->
|
|
482
|
+
puts "Error when calling EventSchemasApi->list_event_schema_versions_with_http_info: #{e}"
|
|
486
483
|
end
|
|
487
484
|
```
|
|
488
485
|
|
|
@@ -490,14 +487,11 @@ end
|
|
|
490
487
|
|
|
491
488
|
| Name | Type | Description | Notes |
|
|
492
489
|
| ---- | ---- | ----------- | ----- |
|
|
493
|
-
| **
|
|
494
|
-
| **next_token** | **String** | | [optional] |
|
|
495
|
-
| **page_size** | **String** | | [optional] |
|
|
496
|
-
| **sort_order** | **String** | | [optional] |
|
|
490
|
+
| **event_schema_name** | **String** | | |
|
|
497
491
|
|
|
498
492
|
### Return type
|
|
499
493
|
|
|
500
|
-
[**
|
|
494
|
+
[**EventSchemaVersionsResponse**](EventSchemaVersionsResponse.md)
|
|
501
495
|
|
|
502
496
|
### Authorization
|
|
503
497
|
|
|
@@ -509,13 +503,13 @@ end
|
|
|
509
503
|
- **Accept**: application/json
|
|
510
504
|
|
|
511
505
|
|
|
512
|
-
##
|
|
506
|
+
## list_event_schemas
|
|
513
507
|
|
|
514
|
-
> <
|
|
508
|
+
> <EventSchemaListPaginatedResponse> list_event_schemas(opts)
|
|
515
509
|
|
|
516
|
-
|
|
510
|
+
List event schemas
|
|
517
511
|
|
|
518
|
-
|
|
512
|
+
Returns a list of event schema with pagination.
|
|
519
513
|
|
|
520
514
|
### Examples
|
|
521
515
|
|
|
@@ -529,33 +523,36 @@ TogaiClient.configure do |config|
|
|
|
529
523
|
end
|
|
530
524
|
|
|
531
525
|
api_instance = TogaiClient::EventSchemasApi.new
|
|
532
|
-
|
|
533
|
-
|
|
526
|
+
opts = {
|
|
527
|
+
status: 'ACTIVE', # String | Filter by provided status
|
|
528
|
+
next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String |
|
|
529
|
+
page_size: 10 # Float |
|
|
530
|
+
}
|
|
534
531
|
|
|
535
532
|
begin
|
|
536
|
-
#
|
|
537
|
-
result = api_instance.
|
|
533
|
+
# List event schemas
|
|
534
|
+
result = api_instance.list_event_schemas(opts)
|
|
538
535
|
p result
|
|
539
536
|
rescue TogaiClient::ApiError => e
|
|
540
|
-
puts "Error when calling EventSchemasApi->
|
|
537
|
+
puts "Error when calling EventSchemasApi->list_event_schemas: #{e}"
|
|
541
538
|
end
|
|
542
539
|
```
|
|
543
540
|
|
|
544
|
-
#### Using the
|
|
541
|
+
#### Using the list_event_schemas_with_http_info variant
|
|
545
542
|
|
|
546
543
|
This returns an Array which contains the response data, status code and headers.
|
|
547
544
|
|
|
548
|
-
> <Array(<
|
|
545
|
+
> <Array(<EventSchemaListPaginatedResponse>, Integer, Hash)> list_event_schemas_with_http_info(opts)
|
|
549
546
|
|
|
550
547
|
```ruby
|
|
551
548
|
begin
|
|
552
|
-
#
|
|
553
|
-
data, status_code, headers = api_instance.
|
|
549
|
+
# List event schemas
|
|
550
|
+
data, status_code, headers = api_instance.list_event_schemas_with_http_info(opts)
|
|
554
551
|
p status_code # => 2xx
|
|
555
552
|
p headers # => { ... }
|
|
556
|
-
p data # => <
|
|
553
|
+
p data # => <EventSchemaListPaginatedResponse>
|
|
557
554
|
rescue TogaiClient::ApiError => e
|
|
558
|
-
puts "Error when calling EventSchemasApi->
|
|
555
|
+
puts "Error when calling EventSchemasApi->list_event_schemas_with_http_info: #{e}"
|
|
559
556
|
end
|
|
560
557
|
```
|
|
561
558
|
|
|
@@ -563,12 +560,13 @@ end
|
|
|
563
560
|
|
|
564
561
|
| Name | Type | Description | Notes |
|
|
565
562
|
| ---- | ---- | ----------- | ----- |
|
|
566
|
-
| **
|
|
567
|
-
| **
|
|
563
|
+
| **status** | **String** | Filter by provided status | [optional] |
|
|
564
|
+
| **next_token** | **String** | | [optional] |
|
|
565
|
+
| **page_size** | **Float** | | [optional] |
|
|
568
566
|
|
|
569
567
|
### Return type
|
|
570
568
|
|
|
571
|
-
[**
|
|
569
|
+
[**EventSchemaListPaginatedResponse**](EventSchemaListPaginatedResponse.md)
|
|
572
570
|
|
|
573
571
|
### Authorization
|
|
574
572
|
|
|
@@ -576,6 +574,6 @@ end
|
|
|
576
574
|
|
|
577
575
|
### HTTP request headers
|
|
578
576
|
|
|
579
|
-
- **Content-Type**:
|
|
577
|
+
- **Content-Type**: Not defined
|
|
580
578
|
- **Accept**: application/json
|
|
581
579
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::EventSchemasForFeature
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **schema_name** | **String** | | |
|
|
8
|
+
| **attribute_name** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::EventSchemasForFeature.new(
|
|
16
|
+
schema_name: null,
|
|
17
|
+
attribute_name: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/EventSource.md
ADDED
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::EventSource
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | Unique identifier representing the source | |
|
|
8
|
+
| **type** | **String** | Type of source | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::EventSource.new(
|
|
16
|
+
id: null,
|
|
17
|
+
type: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/EventWithStatus.md
CHANGED
|
@@ -4,8 +4,12 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reference_id** | **String** | Unique id generated by Togai to identify an event uniquely | |
|
|
7
8
|
| **event_payload** | [**Event**](Event.md) | | |
|
|
8
9
|
| **ingestion_status** | [**IngestionStatus**](IngestionStatus.md) | | |
|
|
10
|
+
| **customer_id** | **String** | The associated account belongs to this customer | [optional] |
|
|
11
|
+
| **source** | [**EventSource**](EventSource.md) | | [optional] |
|
|
12
|
+
| **created_at** | **Time** | Created time stamp of the event. This timestamp must be in ISO 8601 format. | |
|
|
9
13
|
|
|
10
14
|
## Example
|
|
11
15
|
|
|
@@ -13,8 +17,12 @@
|
|
|
13
17
|
require 'togai_client'
|
|
14
18
|
|
|
15
19
|
instance = TogaiClient::EventWithStatus.new(
|
|
20
|
+
reference_id: null,
|
|
16
21
|
event_payload: null,
|
|
17
|
-
ingestion_status: null
|
|
22
|
+
ingestion_status: null,
|
|
23
|
+
customer_id: 1,
|
|
24
|
+
source: null,
|
|
25
|
+
created_at: null
|
|
18
26
|
)
|
|
19
27
|
```
|
|
20
28
|
|
|
@@ -4,9 +4,13 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **reference_id** | **String** | Unique id generated by Togai to identify an event uniquely | |
|
|
7
8
|
| **event_payload** | [**Event**](Event.md) | | |
|
|
8
9
|
| **ingestion_status** | [**IngestionStatus**](IngestionStatus.md) | | |
|
|
9
|
-
| **
|
|
10
|
+
| **customer_id** | **String** | The associated account belongs to this customer | [optional] |
|
|
11
|
+
| **source** | [**EventSource**](EventSource.md) | | [optional] |
|
|
12
|
+
| **created_at** | **Time** | Created time stamp of the event. This timestamp must be in ISO 8601 format. | |
|
|
13
|
+
| **event_pipeline_info** | [**EventPipelineInfo**](EventPipelineInfo.md) | | |
|
|
10
14
|
|
|
11
15
|
## Example
|
|
12
16
|
|
|
@@ -14,8 +18,12 @@
|
|
|
14
18
|
require 'togai_client'
|
|
15
19
|
|
|
16
20
|
instance = TogaiClient::EventWithStatusAndEventPipelineInfo.new(
|
|
21
|
+
reference_id: null,
|
|
17
22
|
event_payload: null,
|
|
18
23
|
ingestion_status: null,
|
|
24
|
+
customer_id: 1,
|
|
25
|
+
source: null,
|
|
26
|
+
created_at: null,
|
|
19
27
|
event_pipeline_info: null
|
|
20
28
|
)
|
|
21
29
|
```
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# TogaiClient::EventsCorrectionResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<EventCorrectionInfo>**](EventCorrectionInfo.md) | | |
|
|
8
|
+
|
|
9
|
+
## Example
|
|
10
|
+
|
|
11
|
+
```ruby
|
|
12
|
+
require 'togai_client'
|
|
13
|
+
|
|
14
|
+
instance = TogaiClient::EventsCorrectionResponse.new(
|
|
15
|
+
data: null
|
|
16
|
+
)
|
|
17
|
+
```
|
|
18
|
+
|
data/docs/ExpiryType.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# TogaiClient::ExternalPaymentReference
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **source_name** | **String** | | |
|
|
8
|
+
| **source_type** | **String** | | |
|
|
9
|
+
| **transaction_number** | **String** | Check number or Card transaction number | |
|
|
10
|
+
| **description** | **String** | | [optional] |
|
|
11
|
+
| **metadata** | **Hash<String, Object>** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'togai_client'
|
|
17
|
+
|
|
18
|
+
instance = TogaiClient::ExternalPaymentReference.new(
|
|
19
|
+
source_name: null,
|
|
20
|
+
source_type: null,
|
|
21
|
+
transaction_number: null,
|
|
22
|
+
description: null,
|
|
23
|
+
metadata: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
data/docs/Feature.md
ADDED
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# TogaiClient::Feature
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **billable_name** | **String** | | [optional] |
|
|
10
|
+
| **display_name** | **String** | Display name of feature. This is an auto-generated field which contains billableName of feature. If billableName is not provided, name will be used as display name. | |
|
|
11
|
+
| **schema_associations** | [**Array<EventSchemasForFeature>**](EventSchemasForFeature.md) | Association of a feature with event_schemas | |
|
|
12
|
+
| **created_at** | **Time** | | |
|
|
13
|
+
| **updated_at** | **Time** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'togai_client'
|
|
19
|
+
|
|
20
|
+
instance = TogaiClient::Feature.new(
|
|
21
|
+
id: null,
|
|
22
|
+
name: null,
|
|
23
|
+
billable_name: null,
|
|
24
|
+
display_name: null,
|
|
25
|
+
schema_associations: null,
|
|
26
|
+
created_at: null,
|
|
27
|
+
updated_at: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|