togai_client 1.0.1 → 1.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +3 -4
- data/docs/Account.md +26 -2
- data/docs/AccountAlias.md +28 -0
- data/docs/AccountAliases.md +1 -3
- data/docs/AccountAliasesPaginatedResponse.md +20 -0
- data/docs/AccountSchedule.md +38 -0
- data/docs/AccountsApi.md +840 -124
- data/docs/AccountsBillingInformation.md +20 -0
- data/docs/ActivatePricePlanRequest.md +18 -0
- data/docs/AddAccountAliasesRequest.md +3 -1
- data/docs/AddOn.md +30 -0
- data/docs/AddOnPaginatedResponse.md +22 -0
- data/docs/AddOnType.md +15 -0
- data/docs/AddOnsApi.md +365 -0
- data/docs/Address.md +30 -0
- data/docs/Alert.md +40 -0
- data/docs/AlertStatus.md +15 -0
- data/docs/AlertTemplate.md +38 -0
- data/docs/AlertTemplatesPaginatedResponse.md +20 -0
- data/docs/AlertsApi.md +566 -0
- data/docs/AlertsPaginatedResponse.md +20 -0
- data/docs/AliasPaginatedResponse.md +20 -0
- data/docs/AliasesApi.md +291 -0
- data/docs/AssociationConfig.md +24 -0
- data/docs/Attribute.md +22 -0
- data/docs/AuthenticationApi.md +74 -0
- data/docs/BillingConfig.md +20 -0
- data/docs/BillingEntitlementRateCard.md +34 -0
- data/docs/BillingEntitlementRevenueSummary.md +18 -0
- data/docs/BulkRateCardOperationsRequest.md +18 -0
- data/docs/BulkRateCardOperationsResponse.md +18 -0
- data/docs/CalculateRevenueRequest.md +30 -0
- data/docs/CalculateRevenueResponse.md +24 -0
- data/docs/CalculateRevenueResponseV2.md +22 -0
- data/docs/Computation.md +5 -3
- data/docs/CreateAccountAliasRequest.md +22 -0
- data/docs/CreateAccountRequest.md +27 -5
- data/docs/CreateAccountRequestWithoutCustomerId.md +42 -0
- data/docs/CreateAddOnRequest.md +22 -0
- data/docs/CreateAlertRequest.md +32 -0
- data/docs/CreateAliasRequest.md +18 -0
- data/docs/CreateBulkAliasRequest.md +18 -0
- data/docs/CreateCreditRequest.md +18 -0
- data/docs/CreateCreditResponse.md +18 -0
- data/docs/CreateCustomInvoiceRequest.md +36 -0
- data/docs/CreateCustomerContactRequest.md +30 -0
- data/docs/CreateCustomerContactResponse.md +34 -0
- data/docs/CreateCustomerRequest.md +9 -7
- data/docs/CreateCustomerResponse.md +8 -2
- data/docs/CreateEntitySetting.md +26 -0
- data/docs/CreateEventSchemaRequest.md +7 -1
- data/docs/CreateFeatureRequest.md +22 -0
- data/docs/CreateInvoiceGroupRequest.md +28 -0
- data/docs/CreatePaymentRequest.md +30 -0
- data/docs/CreatePricePlanDetails.md +38 -0
- data/docs/CreatePricePlanDetailsOverride.md +34 -0
- data/docs/CreatePricePlanMigrationRequest.md +32 -0
- data/docs/CreatePricePlanRequest.md +6 -2
- data/docs/CreatePricePlanV2Request.md +30 -0
- data/docs/CreatePricingRule.md +28 -0
- data/docs/CreateProposalRequest.md +40 -0
- data/docs/CreatePurchaseRequest.md +38 -0
- data/docs/CreateUsageMeterRequest.md +12 -6
- data/docs/Credit.md +50 -0
- data/docs/CreditBalanceResponse.md +28 -0
- data/docs/CreditDetailsResponse.md +52 -0
- data/docs/CreditGrantRateCard.md +34 -0
- data/docs/CreditGrantRevenueSummary.md +18 -0
- data/docs/CreditGrantType.md +15 -0
- data/docs/CreditRateDetails.md +20 -0
- data/docs/CreditRequest.md +34 -0
- data/docs/CreditTransaction.md +30 -0
- data/docs/CreditsApi.md +369 -0
- data/docs/CurrencyConfig.md +22 -0
- data/docs/CurrencyRateValue.md +20 -0
- data/docs/CurrencySlabRateDetail.md +24 -0
- data/docs/CustomInvoiceLineItem.md +28 -0
- data/docs/Customer.md +6 -2
- data/docs/CustomerPortalApi.md +77 -0
- data/docs/CustomersApi.md +85 -13
- data/docs/Dependency.md +22 -0
- data/docs/EditAccountScheduleRequest.md +18 -0
- data/docs/EditPricingScheduleRequest.md +18 -0
- data/docs/EnrichedField.md +22 -0
- data/docs/EnrichmentDependency.md +24 -0
- data/docs/Enrichments.md +20 -0
- data/docs/EntitlementOverageConfig.md +22 -0
- data/docs/EntitlementOverageConfigLookupCycle.md +20 -0
- data/docs/EntitlementOverageEntry.md +20 -0
- data/docs/EntitlementOverageRateCard.md +32 -0
- data/docs/EntitlementOverageRevenueSummary.md +18 -0
- data/docs/EntitlementsApi.md +599 -0
- data/docs/Event.md +11 -11
- data/docs/EventCorrectionInfo.md +32 -0
- data/docs/EventCorrectionRequest.md +18 -0
- data/docs/EventIngestionApi.md +16 -15
- data/docs/EventManagementApi.md +95 -21
- data/docs/EventPipelineInfo.md +15 -3
- data/docs/EventPipelineInfoAccount.md +3 -1
- data/docs/EventPipelineInfoEnrichments.md +22 -0
- data/docs/EventPipelineInfoFeatureDetails.md +24 -0
- data/docs/EventPipelineInfoPricePlans.md +28 -0
- data/docs/EventPipelineInfoRevenueDetails.md +22 -0
- data/docs/EventPipelineInfoUsageMeters.md +26 -0
- data/docs/EventSchema.md +11 -1
- data/docs/EventSchemaListData.md +11 -1
- data/docs/EventSchemasApi.md +82 -84
- data/docs/EventSchemasForFeature.md +20 -0
- data/docs/EventSource.md +20 -0
- data/docs/EventWithStatus.md +9 -1
- data/docs/EventWithStatusAndEventPipelineInfo.md +9 -1
- data/docs/EventsCorrectionResponse.md +18 -0
- data/docs/ExpiryType.md +15 -0
- data/docs/ExternalPaymentReference.md +26 -0
- data/docs/Feature.md +30 -0
- data/docs/FeatureApi.md +293 -0
- data/docs/FeatureConfig.md +22 -0
- data/docs/FeatureCreditEntry.md +32 -0
- data/docs/FeatureDetails.md +20 -0
- data/docs/FeatureListResponse.md +30 -0
- data/docs/FeaturePaginatedListData.md +22 -0
- data/docs/Field.md +26 -0
- data/docs/FileDownloadUrlResponse.md +18 -0
- data/docs/FileStorageApi.md +151 -0
- data/docs/FinalizeAccountSchedules.md +20 -0
- data/docs/FinalizePricePlanRequest.md +20 -0
- data/docs/FixedFeeRateCard.md +34 -0
- data/docs/FixedFeeRevenueSummary.md +18 -0
- data/docs/FixedFeeType.md +15 -0
- data/docs/GetCustomerPortalDelegateTokenRequest.md +24 -0
- data/docs/GetEntitlementValuesResponse.md +18 -0
- data/docs/GetEntitlementValuesResponseDataInner.md +20 -0
- data/docs/GetFeatureCreditEntriesPaginatedResponse.md +20 -0
- data/docs/GetFeatureCreditsResponse.md +28 -0
- data/docs/GetJobResponse.md +36 -0
- data/docs/GetLicenseUpdatesResponse.md +20 -0
- data/docs/GetMetricsRequest.md +4 -4
- data/docs/GetProposalResponse.md +62 -0
- data/docs/GetPurchaseResponse.md +62 -0
- data/docs/GrantDetails.md +24 -0
- data/docs/Incident.md +36 -0
- data/docs/IncidentsPaginatedResponse.md +20 -0
- data/docs/IngestEventRequest.md +1 -1
- data/docs/IngestEventResponse.md +12 -2
- data/docs/Invoice.md +68 -0
- data/docs/InvoiceDetails.md +28 -0
- data/docs/InvoiceDetailsAccount.md +24 -0
- data/docs/InvoiceDetailsCustomer.md +24 -0
- data/docs/InvoiceDetailsInvoiceGroup.md +28 -0
- data/docs/InvoiceDetailsOrganization.md +24 -0
- data/docs/InvoiceGroupAccountsPaginatedResponse.md +40 -0
- data/docs/InvoiceGroupDetails.md +30 -0
- data/docs/InvoiceGroupPaginatedResponse.md +20 -0
- data/docs/InvoiceGroups.md +36 -0
- data/docs/InvoiceGroupsApi.md +358 -0
- data/docs/InvoiceInfoInner.md +20 -0
- data/docs/InvoiceLineItem.md +34 -0
- data/docs/InvoiceSummary.md +58 -0
- data/docs/InvoiceTiming.md +15 -0
- data/docs/InvoicesApi.md +751 -0
- data/docs/InvoicesClass.md +15 -0
- data/docs/InvoicesStatus.md +15 -0
- data/docs/InvoicesType.md +15 -0
- data/docs/JobEntriesPaginatedResponse.md +22 -0
- data/docs/JobEntriesResponse.md +26 -0
- data/docs/JobsApi.md +361 -0
- data/docs/JobsPaginatedResponse.md +22 -0
- data/docs/JobsWithoutStatusInfoResponse.md +24 -0
- data/docs/LicenseEntriesConfig.md +24 -0
- data/docs/LicenseEntriesConfigLookupCycle.md +20 -0
- data/docs/LicenseEntriesConfigLookupRange.md +22 -0
- data/docs/LicenseEntry.md +22 -0
- data/docs/LicenseEntryDetailsUpdateRequest.md +22 -0
- data/docs/LicenseRateCard.md +40 -0
- data/docs/LicenseRateCardConfig.md +20 -0
- data/docs/LicenseUpdate.md +26 -0
- data/docs/LicenseUpdateRequest.md +30 -0
- data/docs/LicenseUpdateResponse.md +28 -0
- data/docs/LicensesApi.md +300 -0
- data/docs/ListCreditsResponse.md +20 -0
- data/docs/ListInvoicesResponse.md +20 -0
- data/docs/ListPaymentResponse.md +20 -0
- data/docs/ManageMiscellaneousChargesRequest.md +18 -0
- data/docs/MaxQuantityBreachAction.md +15 -0
- data/docs/MetricQuery.md +7 -5
- data/docs/MetricQueryFilterEntry.md +1 -1
- data/docs/MetricQueryResponse.md +1 -1
- data/docs/MetricsApi.md +7 -7
- data/docs/MigrationMode.md +15 -0
- data/docs/MinimumCommitment.md +20 -0
- data/docs/MiscellaneousCharge.md +26 -0
- data/docs/MiscellaneousChargesResponse.md +18 -0
- data/docs/ModelAlias.md +20 -0
- data/docs/NamedLicenseEntriesConfig.md +24 -0
- data/docs/NamedLicenseEntriesConfigLookupCycle.md +20 -0
- data/docs/NamedLicenseEntriesConfigLookupRange.md +22 -0
- data/docs/NamedLicenseEntry.md +24 -0
- data/docs/NamedLicenseUpdate.md +32 -0
- data/docs/NamedLicenseUpdatesPaginatedResponse.md +20 -0
- data/docs/Payment.md +38 -0
- data/docs/PaymentLineItemRecord.md +24 -0
- data/docs/PaymentsApi.md +227 -0
- data/docs/PlanOverride.md +6 -0
- data/docs/PreAction.md +20 -0
- data/docs/PriceExperimentationApi.md +147 -0
- data/docs/PricePlan.md +4 -0
- data/docs/PricePlanDetails.md +25 -3
- data/docs/PricePlanDetailsConfig.md +28 -0
- data/docs/PricePlanDetailsOverride.md +16 -2
- data/docs/PricePlanInfo.md +20 -0
- data/docs/PricePlanListData.md +10 -2
- data/docs/PricePlanMigrationConfig.md +30 -0
- data/docs/PricePlanType.md +15 -0
- data/docs/PricePlanV2.md +42 -0
- data/docs/PricePlanV2Api.md +953 -0
- data/docs/PricePlanV2PaginatedResponse.md +20 -0
- data/docs/PricePlansApi.md +202 -52
- data/docs/PricingCycleConfig.md +6 -6
- data/docs/PricingCycleConfigStartOffset.md +1 -1
- data/docs/PricingCycleInterval.md +15 -0
- data/docs/PricingRule.md +32 -0
- data/docs/PricingRuleAction.md +26 -0
- data/docs/PricingRuleChangesLog.md +30 -0
- data/docs/PricingRuleInfo.md +24 -0
- data/docs/PricingRuleTiming.md +15 -0
- data/docs/PricingRulesApi.md +83 -0
- data/docs/PricingRulesLog.md +28 -0
- data/docs/PricingRulesLogsPaginatedResponse.md +18 -0
- data/docs/PricingRulesPaginatedResponse.md +18 -0
- data/docs/PricingRulesValues.md +20 -0
- data/docs/PricingSchedule.md +9 -1
- data/docs/PricingSchedulePaginatedResponse.md +22 -0
- data/docs/PricingScheduleWithPricePlanId.md +36 -0
- data/docs/Proposal.md +62 -0
- data/docs/ProposalsListResponse.md +40 -0
- data/docs/ProposalsPaginatedResponse.md +22 -0
- data/docs/ProratedRefundMode.md +15 -0
- data/docs/ProrationConfig.md +22 -0
- data/docs/ProrationConfigCustomConfig.md +22 -0
- data/docs/ProrationConfigLookupCycleConfig.md +22 -0
- data/docs/Purchase.md +58 -0
- data/docs/PurchaseFeatureDetails.md +30 -0
- data/docs/PurchaseListResponse.md +46 -0
- data/docs/PurchasePaginatedListData.md +22 -0
- data/docs/PurchasePlanOverride.md +22 -0
- data/docs/PurchaseStatus.md +15 -0
- data/docs/PurchaseType.md +15 -0
- data/docs/QueryColumn.md +26 -0
- data/docs/QueryFilter.md +22 -0
- data/docs/QueryFunction.md +20 -0
- data/docs/QueryInput.md +28 -0
- data/docs/QueryInputSortInner.md +20 -0
- data/docs/RateCard.md +23 -5
- data/docs/RateCardData.md +28 -0
- data/docs/RateCardDetails.md +30 -0
- data/docs/RateCardOperation.md +22 -0
- data/docs/RateCardPaginatedResponse.md +20 -0
- data/docs/RatePlan.md +20 -0
- data/docs/RateValue.md +22 -0
- data/docs/RecurrenceConfig.md +20 -0
- data/docs/RemoveAccountAliasRequest.md +20 -0
- data/docs/RemoveAccountAliasesRequest.md +4 -2
- data/docs/Report.md +38 -0
- data/docs/ReportStatus.md +15 -0
- data/docs/ReportType.md +15 -0
- data/docs/ReportsApi.md +83 -0
- data/docs/ReportsPaginatedResponse.md +20 -0
- data/docs/RevenueInfo.md +42 -0
- data/docs/RevenueInfoV2.md +32 -0
- data/docs/RevenueSummaryWithMetadata.md +24 -0
- data/docs/ScheduleInfo.md +22 -0
- data/docs/SchedulesApi.md +667 -0
- data/docs/SchedulesPaginatedResponse.md +22 -0
- data/docs/Setting.md +30 -0
- data/docs/SettingDataType.md +15 -0
- data/docs/SettingPaginatedResponse.md +22 -0
- data/docs/SettingsApi.md +301 -0
- data/docs/Slab.md +24 -0
- data/docs/SlabDetail.md +26 -0
- data/docs/SlabRate.md +22 -0
- data/docs/SlabRevenue.md +22 -0
- data/docs/SlabRevenueMetadata.md +22 -0
- data/docs/SlabRevenueSummary.md +24 -0
- data/docs/SlabRevenueWithMetadata.md +24 -0
- data/docs/TokenResponse.md +18 -0
- data/docs/TopupWalletRequest.md +18 -0
- data/docs/UpdateAccountRequest.md +18 -2
- data/docs/UpdateAccountScheduleV2Request.md +26 -0
- data/docs/UpdateAddOnRequest.md +20 -0
- data/docs/UpdateAlertRequest.md +26 -0
- data/docs/UpdateCustomerRequest.md +5 -5
- data/docs/UpdateEventSchemaRequest.md +9 -3
- data/docs/UpdateFeatureCreditsRequest.md +20 -0
- data/docs/UpdateFeatureRequest.md +22 -0
- data/docs/UpdateIncidentStatusRequest.md +18 -0
- data/docs/UpdateInvoiceGroupAccounts.md +18 -0
- data/docs/UpdateInvoiceRequest.md +26 -0
- data/docs/UpdatePricePlanRequest.md +8 -2
- data/docs/UpdatePricePlanV2Request.md +22 -0
- data/docs/UpdatePricingRulesRequest.md +18 -0
- data/docs/UpdatePricingScheduleRequest.md +30 -0
- data/docs/UpdatePricingScheduleRequestWithActions.md +32 -0
- data/docs/UpdatePricingScheduleResponse.md +22 -0
- data/docs/UpdateProposalStatus.md +18 -0
- data/docs/UpdateSettingRequest.md +22 -0
- data/docs/UpdateUsageMeterRequest.md +13 -5
- data/docs/UpdateWalletRequest.md +20 -0
- data/docs/UsageConfig.md +24 -0
- data/docs/UsageConfigLookupCycle.md +20 -0
- data/docs/UsageConfigLookupRange.md +22 -0
- data/docs/UsageCycleInterval.md +15 -0
- data/docs/UsageLookupRange.md +20 -0
- data/docs/UsageMeter.md +12 -2
- data/docs/UsageMeterAggregation.md +15 -0
- data/docs/UsageMeterFilterEntry.md +20 -0
- data/docs/UsageMetersApi.md +64 -74
- data/docs/UsageRateCard.md +28 -0
- data/docs/ValidateEntitlementValueRequest.md +18 -0
- data/docs/ValidatedEntityError.md +24 -0
- data/docs/ValidatedEntityErrorsPaginatedResponse.md +20 -0
- data/docs/VersionsToMigrate.md +15 -0
- data/docs/WalletApi.md +301 -0
- data/docs/WalletBalanceResponse.md +40 -0
- data/docs/WalletEntriesPaginatedResponse.md +20 -0
- data/docs/WalletEntry.md +34 -0
- data/docs/WalletStatus.md +15 -0
- data/docs/WalletTopupDetails.md +20 -0
- data/lib/togai_client/api/accounts_api.rb +881 -220
- data/lib/togai_client/api/add_ons_api.rb +372 -0
- data/lib/togai_client/api/alerts_api.rb +527 -0
- data/lib/togai_client/api/aliases_api.rb +279 -0
- data/lib/togai_client/api/authentication_api.rb +79 -0
- data/lib/togai_client/api/credits_api.rb +351 -0
- data/lib/togai_client/api/customer_portal_api.rb +90 -0
- data/lib/togai_client/api/customers_api.rb +96 -18
- data/lib/togai_client/api/entitlements_api.rb +655 -0
- data/lib/togai_client/api/event_ingestion_api.rb +15 -15
- data/lib/togai_client/api/event_management_api.rb +97 -21
- data/lib/togai_client/api/event_schemas_api.rb +104 -107
- data/lib/togai_client/api/feature_api.rb +298 -0
- data/lib/togai_client/api/file_storage_api.rb +151 -0
- data/lib/togai_client/api/invoice_groups_api.rb +370 -0
- data/lib/togai_client/api/invoices_api.rb +705 -0
- data/lib/togai_client/api/jobs_api.rb +337 -0
- data/lib/togai_client/api/licenses_api.rb +282 -0
- data/lib/togai_client/api/metrics_api.rb +6 -6
- data/lib/togai_client/api/payments_api.rb +215 -0
- data/lib/togai_client/api/price_experimentation_api.rb +158 -0
- data/lib/togai_client/api/price_plan_v2_api.rb +960 -0
- data/lib/togai_client/api/price_plans_api.rb +214 -62
- data/lib/togai_client/api/pricing_rules_api.rb +106 -0
- data/lib/togai_client/api/reports_api.rb +92 -0
- data/lib/togai_client/api/schedules_api.rb +685 -0
- data/lib/togai_client/api/settings_api.rb +302 -0
- data/lib/togai_client/api/usage_meters_api.rb +97 -153
- data/lib/togai_client/api/wallet_api.rb +310 -0
- data/lib/togai_client/api_client.rb +25 -23
- data/lib/togai_client/api_error.rb +2 -1
- data/lib/togai_client/configuration.rb +51 -18
- data/lib/togai_client/models/account.rb +260 -28
- data/lib/togai_client/models/account_alias.rb +329 -0
- data/lib/togai_client/models/account_aliases.rb +23 -67
- data/lib/togai_client/models/account_aliases_paginated_response.rb +233 -0
- data/lib/togai_client/models/account_paginated_response.rb +14 -19
- data/lib/togai_client/models/account_schedule.rb +375 -0
- data/lib/togai_client/models/accounts_billing_information.rb +228 -0
- data/lib/togai_client/models/activate_price_plan_request.rb +235 -0
- data/lib/togai_client/models/add_account_aliases_request.rb +64 -25
- data/lib/togai_client/models/add_on.rb +395 -0
- data/lib/togai_client/models/add_on_paginated_response.rb +241 -0
- data/lib/togai_client/models/add_on_type.rb +42 -0
- data/lib/togai_client/models/address.rb +276 -0
- data/lib/togai_client/models/alert.rb +391 -0
- data/lib/togai_client/models/alert_status.rb +40 -0
- data/lib/togai_client/models/alert_template.rb +343 -0
- data/lib/togai_client/models/alert_templates_paginated_response.rb +232 -0
- data/lib/togai_client/models/alerts_paginated_response.rb +232 -0
- data/lib/togai_client/models/alias_paginated_response.rb +226 -0
- data/lib/togai_client/models/association_config.rb +244 -0
- data/lib/togai_client/models/attribute.rb +327 -0
- data/lib/togai_client/models/base_success_response.rb +16 -19
- data/lib/togai_client/models/billing_config.rb +225 -0
- data/lib/togai_client/models/billing_entitlement_rate_card.rb +370 -0
- data/lib/togai_client/models/billing_entitlement_revenue_summary.rb +221 -0
- data/lib/togai_client/models/bulk_rate_card_operations_request.rb +224 -0
- data/lib/togai_client/models/bulk_rate_card_operations_response.rb +224 -0
- data/lib/togai_client/models/calculate_revenue_request.rb +297 -0
- data/lib/togai_client/models/calculate_revenue_response.rb +264 -0
- data/lib/togai_client/models/calculate_revenue_response_v2.rb +248 -0
- data/lib/togai_client/models/computation.rb +49 -27
- data/lib/togai_client/models/create_account_alias_request.rb +270 -0
- data/lib/togai_client/models/create_account_request.rb +306 -27
- data/lib/togai_client/models/create_account_request_without_customer_id.rb +551 -0
- data/lib/togai_client/models/create_add_on_request.rb +309 -0
- data/lib/togai_client/models/create_alert_request.rb +327 -0
- data/lib/togai_client/models/create_alias_request.rb +241 -0
- data/lib/togai_client/models/create_bulk_alias_request.rb +252 -0
- data/lib/togai_client/models/create_credit_request.rb +224 -0
- data/lib/togai_client/models/create_credit_response.rb +223 -0
- data/lib/togai_client/models/create_custom_invoice_request.rb +411 -0
- data/lib/togai_client/models/create_customer_contact_request.rb +402 -0
- data/lib/togai_client/models/create_customer_contact_response.rb +435 -0
- data/lib/togai_client/models/create_customer_request.rb +69 -47
- data/lib/togai_client/models/create_customer_response.rb +81 -40
- data/lib/togai_client/models/create_entity_setting.rb +308 -0
- data/lib/togai_client/models/create_event_schema_request.rb +70 -24
- data/lib/togai_client/models/create_feature_request.rb +309 -0
- data/lib/togai_client/models/create_invoice_group_request.rb +344 -0
- data/lib/togai_client/models/create_payment_request.rb +394 -0
- data/lib/togai_client/models/create_price_plan_details.rb +339 -0
- data/lib/togai_client/models/create_price_plan_details_override.rb +319 -0
- data/lib/togai_client/models/create_price_plan_migration_request.rb +385 -0
- data/lib/togai_client/models/create_price_plan_request.rb +69 -24
- data/lib/togai_client/models/create_price_plan_v2_request.rb +367 -0
- data/lib/togai_client/models/create_pricing_rule.rb +313 -0
- data/lib/togai_client/models/create_proposal_request.rb +371 -0
- data/lib/togai_client/models/create_purchase_request.rb +330 -0
- data/lib/togai_client/models/create_usage_meter_request.rb +85 -42
- data/lib/togai_client/models/credit.rb +490 -0
- data/lib/togai_client/models/credit_balance_response.rb +302 -0
- data/lib/togai_client/models/credit_details_response.rb +508 -0
- data/lib/togai_client/models/credit_grant_rate_card.rb +332 -0
- data/lib/togai_client/models/credit_grant_revenue_summary.rb +221 -0
- data/lib/togai_client/models/credit_grant_type.rb +40 -0
- data/lib/togai_client/models/credit_rate_details.rb +262 -0
- data/lib/togai_client/models/credit_request.rb +330 -0
- data/lib/togai_client/models/credit_transaction.rb +357 -0
- data/lib/togai_client/models/currency_config.rb +296 -0
- data/lib/togai_client/models/currency_rate_value.rb +237 -0
- data/lib/togai_client/models/currency_slab_rate_detail.rb +287 -0
- data/lib/togai_client/models/custom_invoice_line_item.rb +260 -0
- data/lib/togai_client/models/customer.rb +68 -26
- data/lib/togai_client/models/customer_paginated_response.rb +14 -19
- data/lib/togai_client/models/dependency.rb +287 -0
- data/lib/togai_client/models/dimensions_schema.rb +16 -19
- data/lib/togai_client/models/edit_account_schedule_request.rb +252 -0
- data/lib/togai_client/models/edit_pricing_schedule_request.rb +252 -0
- data/lib/togai_client/models/enriched_field.rb +288 -0
- data/lib/togai_client/models/enrichment_dependency.rb +297 -0
- data/lib/togai_client/models/enrichments.rb +234 -0
- data/lib/togai_client/models/entitlement_overage_config.rb +278 -0
- data/lib/togai_client/models/entitlement_overage_config_lookup_cycle.rb +258 -0
- data/lib/togai_client/models/entitlement_overage_entry.rb +256 -0
- data/lib/togai_client/models/entitlement_overage_rate_card.rb +324 -0
- data/lib/togai_client/models/entitlement_overage_revenue_summary.rb +221 -0
- data/lib/togai_client/models/error_response.rb +16 -19
- data/lib/togai_client/models/event.rb +104 -84
- data/lib/togai_client/models/event_attribute_schema.rb +22 -21
- data/lib/togai_client/models/event_correction_info.rb +384 -0
- data/lib/togai_client/models/event_correction_request.rb +215 -0
- data/lib/togai_client/models/event_pipeline_info.rb +76 -25
- data/lib/togai_client/models/event_pipeline_info_account.rb +31 -23
- data/lib/togai_client/models/event_pipeline_info_customer.rb +18 -19
- data/lib/togai_client/models/event_pipeline_info_enrichments.rb +238 -0
- data/lib/togai_client/models/event_pipeline_info_event_schema.rb +18 -19
- data/lib/togai_client/models/event_pipeline_info_feature_details.rb +255 -0
- data/lib/togai_client/models/event_pipeline_info_price_plans.rb +306 -0
- data/lib/togai_client/models/event_pipeline_info_revenue_details.rb +253 -0
- data/lib/togai_client/models/event_pipeline_info_usage_meters.rb +312 -0
- data/lib/togai_client/models/event_schema.rb +89 -29
- data/lib/togai_client/models/event_schema_list_data.rb +90 -31
- data/lib/togai_client/models/event_schema_list_paginated_response.rb +14 -19
- data/lib/togai_client/models/event_schema_versions_response.rb +16 -19
- data/lib/togai_client/models/event_schemas_for_feature.rb +259 -0
- data/lib/togai_client/models/event_source.rb +278 -0
- data/lib/togai_client/models/event_with_status.rb +94 -23
- data/lib/togai_client/models/event_with_status_and_event_pipeline_info.rb +100 -23
- data/lib/togai_client/models/events_correction_response.rb +252 -0
- data/lib/togai_client/models/expiry_type.rb +41 -0
- data/lib/togai_client/models/external_payment_reference.rb +309 -0
- data/lib/togai_client/models/feature.rb +365 -0
- data/lib/togai_client/models/feature_config.rb +266 -0
- data/lib/togai_client/models/feature_credit_entry.rb +387 -0
- data/lib/togai_client/models/feature_details.rb +238 -0
- data/lib/togai_client/models/feature_list_response.rb +343 -0
- data/lib/togai_client/models/feature_paginated_list_data.rb +234 -0
- data/lib/togai_client/models/field.rb +331 -0
- data/lib/togai_client/models/file_download_url_response.rb +221 -0
- data/lib/togai_client/models/finalize_account_schedules.rb +228 -0
- data/lib/togai_client/models/finalize_price_plan_request.rb +246 -0
- data/lib/togai_client/models/fixed_fee_rate_card.rb +354 -0
- data/lib/togai_client/models/fixed_fee_revenue_summary.rb +221 -0
- data/lib/togai_client/models/fixed_fee_type.rb +40 -0
- data/lib/togai_client/models/get_customer_portal_delegate_token_request.rb +255 -0
- data/lib/togai_client/models/get_entitlement_values_response.rb +223 -0
- data/lib/togai_client/models/get_entitlement_values_response_data_inner.rb +239 -0
- data/lib/togai_client/models/get_event_response.rb +16 -19
- data/lib/togai_client/models/get_events_response.rb +21 -20
- data/lib/togai_client/models/get_feature_credit_entries_paginated_response.rb +225 -0
- data/lib/togai_client/models/get_feature_credits_response.rb +333 -0
- data/lib/togai_client/models/get_job_response.rb +399 -0
- data/lib/togai_client/models/get_license_updates_response.rb +252 -0
- data/lib/togai_client/models/get_metrics_request.rb +22 -19
- data/lib/togai_client/models/get_metrics_response.rb +16 -19
- data/lib/togai_client/models/get_proposal_response.rb +536 -0
- data/lib/togai_client/models/get_purchase_response.rb +519 -0
- data/lib/togai_client/models/grant_details.rb +299 -0
- data/lib/togai_client/models/incident.rb +347 -0
- data/lib/togai_client/models/incidents_paginated_response.rb +232 -0
- data/lib/togai_client/models/ingest_batch_event_request.rb +21 -24
- data/lib/togai_client/models/ingest_event_request.rb +21 -19
- data/lib/togai_client/models/ingest_event_response.rb +76 -42
- data/lib/togai_client/models/ingestion_status.rb +23 -22
- data/lib/togai_client/models/invoice.rb +571 -0
- data/lib/togai_client/models/invoice_details.rb +259 -0
- data/lib/togai_client/models/invoice_details_account.rb +269 -0
- data/lib/togai_client/models/invoice_details_customer.rb +255 -0
- data/lib/togai_client/models/invoice_details_invoice_group.rb +294 -0
- data/lib/togai_client/models/invoice_details_organization.rb +264 -0
- data/lib/togai_client/models/invoice_group_accounts_paginated_response.rb +430 -0
- data/lib/togai_client/models/invoice_group_details.rb +330 -0
- data/lib/togai_client/models/invoice_group_paginated_response.rb +225 -0
- data/lib/togai_client/models/invoice_groups.rb +403 -0
- data/lib/togai_client/models/invoice_info_inner.rb +239 -0
- data/lib/togai_client/models/invoice_line_item.rb +381 -0
- data/lib/togai_client/models/invoice_summary.rb +520 -0
- data/lib/togai_client/models/invoice_timing.rb +41 -0
- data/lib/togai_client/models/invoices_class.rb +41 -0
- data/lib/togai_client/models/invoices_status.rb +47 -0
- data/lib/togai_client/models/invoices_type.rb +44 -0
- data/lib/togai_client/models/job_entries_paginated_response.rb +234 -0
- data/lib/togai_client/models/job_entries_response.rb +314 -0
- data/lib/togai_client/models/jobs_paginated_response.rb +234 -0
- data/lib/togai_client/models/jobs_without_status_info_response.rb +269 -0
- data/lib/togai_client/models/license_entries_config.rb +287 -0
- data/lib/togai_client/models/license_entries_config_lookup_cycle.rb +251 -0
- data/lib/togai_client/models/license_entries_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/license_entry.rb +272 -0
- data/lib/togai_client/models/license_entry_details_update_request.rb +277 -0
- data/lib/togai_client/models/license_rate_card.rb +388 -0
- data/lib/togai_client/models/license_rate_card_config.rb +246 -0
- data/lib/togai_client/models/license_update.rb +320 -0
- data/lib/togai_client/models/license_update_request.rb +377 -0
- data/lib/togai_client/models/license_update_response.rb +342 -0
- data/lib/togai_client/models/list_credits_response.rb +280 -0
- data/lib/togai_client/models/list_invoices_response.rb +280 -0
- data/lib/togai_client/models/list_payment_response.rb +280 -0
- data/lib/togai_client/models/manage_miscellaneous_charges_request.rb +224 -0
- data/lib/togai_client/models/max_quantity_breach_action.rb +39 -0
- data/lib/togai_client/models/metric_data_points.rb +28 -29
- data/lib/togai_client/models/metric_data_points_grouped_by.rb +18 -19
- data/lib/togai_client/models/metric_name.rb +11 -4
- data/lib/togai_client/models/metric_query.rb +45 -24
- data/lib/togai_client/models/metric_query_filter_entry.rb +19 -20
- data/lib/togai_client/models/metric_query_response.rb +42 -19
- data/lib/togai_client/models/migration_mode.rb +44 -0
- data/lib/togai_client/models/minimum_commitment.rb +258 -0
- data/lib/togai_client/models/miscellaneous_charge.rb +265 -0
- data/lib/togai_client/models/miscellaneous_charges_response.rb +224 -0
- data/lib/togai_client/models/model_alias.rb +238 -0
- data/lib/togai_client/models/named_license_entries_config.rb +287 -0
- data/lib/togai_client/models/named_license_entries_config_lookup_cycle.rb +251 -0
- data/lib/togai_client/models/named_license_entries_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/named_license_entry.rb +281 -0
- data/lib/togai_client/models/named_license_update.rb +396 -0
- data/lib/togai_client/models/named_license_updates_paginated_response.rb +252 -0
- data/lib/togai_client/models/pagination_options.rb +14 -19
- data/lib/togai_client/models/payment.rb +380 -0
- data/lib/togai_client/models/payment_line_item_record.rb +290 -0
- data/lib/togai_client/models/plan_override.rb +64 -20
- data/lib/togai_client/models/pre_action.rb +269 -0
- data/lib/togai_client/models/price_plan.rb +59 -21
- data/lib/togai_client/models/price_plan_details.rb +182 -45
- data/lib/togai_client/models/price_plan_details_config.rb +344 -0
- data/lib/togai_client/models/price_plan_details_override.rb +135 -35
- data/lib/togai_client/models/price_plan_info.rb +230 -0
- data/lib/togai_client/models/price_plan_list_data.rb +116 -25
- data/lib/togai_client/models/price_plan_migration_config.rb +368 -0
- data/lib/togai_client/models/price_plan_paginated_response.rb +16 -19
- data/lib/togai_client/models/price_plan_type.rb +40 -0
- data/lib/togai_client/models/price_plan_v2.rb +519 -0
- data/lib/togai_client/models/price_plan_v2_paginated_response.rb +233 -0
- data/lib/togai_client/models/price_type.rb +7 -4
- data/lib/togai_client/models/pricing_cycle_config.rb +34 -67
- data/lib/togai_client/models/pricing_cycle_config_start_offset.rb +20 -21
- data/lib/togai_client/models/pricing_cycle_interval.rb +43 -0
- data/lib/togai_client/models/pricing_model.rb +7 -4
- data/lib/togai_client/models/pricing_rule.rb +382 -0
- data/lib/togai_client/models/pricing_rule_action.rb +293 -0
- data/lib/togai_client/models/pricing_rule_changes_log.rb +290 -0
- data/lib/togai_client/models/pricing_rule_info.rb +249 -0
- data/lib/togai_client/models/pricing_rule_timing.rb +40 -0
- data/lib/togai_client/models/pricing_rules_log.rb +318 -0
- data/lib/togai_client/models/pricing_rules_logs_paginated_response.rb +224 -0
- data/lib/togai_client/models/pricing_rules_paginated_response.rb +223 -0
- data/lib/togai_client/models/pricing_rules_values.rb +223 -0
- data/lib/togai_client/models/pricing_schedule.rb +100 -23
- data/lib/togai_client/models/pricing_schedule_paginated_response.rb +234 -0
- data/lib/togai_client/models/pricing_schedule_with_price_plan_id.rb +365 -0
- data/lib/togai_client/models/proposal.rb +536 -0
- data/lib/togai_client/models/proposals_list_response.rb +390 -0
- data/lib/togai_client/models/proposals_paginated_response.rb +234 -0
- data/lib/togai_client/models/prorated_refund_mode.rb +42 -0
- data/lib/togai_client/models/proration_config.rb +275 -0
- data/lib/togai_client/models/proration_config_custom_config.rb +254 -0
- data/lib/togai_client/models/proration_config_lookup_cycle_config.rb +261 -0
- data/lib/togai_client/models/purchase.rb +493 -0
- data/lib/togai_client/models/purchase_feature_details.rb +317 -0
- data/lib/togai_client/models/purchase_list_response.rb +393 -0
- data/lib/togai_client/models/purchase_paginated_list_data.rb +234 -0
- data/lib/togai_client/models/purchase_plan_override.rb +296 -0
- data/lib/togai_client/models/purchase_status.rb +46 -0
- data/lib/togai_client/models/purchase_type.rb +42 -0
- data/lib/togai_client/models/query_column.rb +259 -0
- data/lib/togai_client/models/query_filter.rb +255 -0
- data/lib/togai_client/models/query_function.rb +239 -0
- data/lib/togai_client/models/query_input.rb +295 -0
- data/lib/togai_client/models/query_input_sort_inner.rb +237 -0
- data/lib/togai_client/models/rate_card.rb +342 -38
- data/lib/togai_client/models/rate_card_data.rb +370 -0
- data/lib/togai_client/models/rate_card_details.rb +269 -0
- data/lib/togai_client/models/rate_card_operation.rb +302 -0
- data/lib/togai_client/models/rate_card_paginated_response.rb +233 -0
- data/lib/togai_client/models/rate_card_type.rb +13 -5
- data/lib/togai_client/models/rate_plan.rb +282 -0
- data/lib/togai_client/models/rate_value.rb +270 -0
- data/lib/togai_client/models/recurrence_config.rb +225 -0
- data/lib/togai_client/models/remove_account_alias_request.rb +232 -0
- data/lib/togai_client/models/remove_account_aliases_request.rb +30 -49
- data/lib/togai_client/models/report.rb +362 -0
- data/lib/togai_client/models/report_status.rb +43 -0
- data/lib/togai_client/models/report_type.rb +41 -0
- data/lib/togai_client/models/reports_paginated_response.rb +226 -0
- data/lib/togai_client/models/revenue_info.rb +335 -0
- data/lib/togai_client/models/revenue_info_v2.rb +297 -0
- data/lib/togai_client/models/revenue_summary_with_metadata.rb +255 -0
- data/lib/togai_client/models/schedule_info.rb +250 -0
- data/lib/togai_client/models/schedules_paginated_response.rb +241 -0
- data/lib/togai_client/models/setting.rb +340 -0
- data/lib/togai_client/models/setting_data_type.rb +42 -0
- data/lib/togai_client/models/setting_paginated_response.rb +234 -0
- data/lib/togai_client/models/slab.rb +315 -0
- data/lib/togai_client/models/slab_detail.rb +298 -0
- data/lib/togai_client/models/slab_rate.rb +249 -0
- data/lib/togai_client/models/slab_revenue.rb +281 -0
- data/lib/togai_client/models/slab_revenue_metadata.rb +232 -0
- data/lib/togai_client/models/slab_revenue_summary.rb +262 -0
- data/lib/togai_client/models/slab_revenue_with_metadata.rb +299 -0
- data/lib/togai_client/models/token_response.rb +221 -0
- data/lib/togai_client/models/topup_wallet_request.rb +222 -0
- data/lib/togai_client/models/update_account_request.rb +196 -26
- data/lib/togai_client/models/update_account_schedule_v2_request.rb +303 -0
- data/lib/togai_client/models/update_add_on_request.rb +264 -0
- data/lib/togai_client/models/update_alert_request.rb +274 -0
- data/lib/togai_client/models/update_customer_request.rb +36 -49
- data/lib/togai_client/models/update_event_schema_request.rb +68 -38
- data/lib/togai_client/models/update_feature_credits_request.rb +225 -0
- data/lib/togai_client/models/update_feature_request.rb +295 -0
- data/lib/togai_client/models/update_incident_status_request.rb +256 -0
- data/lib/togai_client/models/update_invoice_group_accounts.rb +252 -0
- data/lib/togai_client/models/update_invoice_request.rb +317 -0
- data/lib/togai_client/models/update_price_plan_request.rb +81 -25
- data/lib/togai_client/models/update_price_plan_v2_request.rb +266 -0
- data/lib/togai_client/models/update_pricing_rules_request.rb +216 -0
- data/lib/togai_client/models/update_pricing_schedule_request.rb +323 -0
- data/lib/togai_client/models/update_pricing_schedule_request_with_actions.rb +343 -0
- data/lib/togai_client/models/update_pricing_schedule_response.rb +276 -0
- data/lib/togai_client/models/update_proposal_status.rb +256 -0
- data/lib/togai_client/models/update_setting_request.rb +255 -0
- data/lib/togai_client/models/update_usage_meter_request.rb +105 -50
- data/lib/togai_client/models/update_wallet_request.rb +246 -0
- data/lib/togai_client/models/usage_config.rb +287 -0
- data/lib/togai_client/models/usage_config_lookup_cycle.rb +250 -0
- data/lib/togai_client/models/usage_config_lookup_range.rb +273 -0
- data/lib/togai_client/models/usage_cycle_interval.rb +43 -0
- data/lib/togai_client/models/usage_lookup_range.rb +238 -0
- data/lib/togai_client/models/usage_meter.rb +156 -39
- data/lib/togai_client/models/usage_meter_aggregation.rb +40 -0
- data/lib/togai_client/models/usage_meter_filter_entry.rb +238 -0
- data/lib/togai_client/models/usage_meter_paginated_response.rb +14 -19
- data/lib/togai_client/models/usage_rate_card.rb +285 -0
- data/lib/togai_client/models/validate_entitlement_value_request.rb +222 -0
- data/lib/togai_client/models/validated_entity_error.rb +273 -0
- data/lib/togai_client/models/validated_entity_errors_paginated_response.rb +232 -0
- data/lib/togai_client/models/versions_to_migrate.rb +40 -0
- data/lib/togai_client/models/wallet_balance_response.rb +388 -0
- data/lib/togai_client/models/wallet_entries_paginated_response.rb +280 -0
- data/lib/togai_client/models/wallet_entry.rb +421 -0
- data/lib/togai_client/models/wallet_status.rb +40 -0
- data/lib/togai_client/models/wallet_topup_details.rb +233 -0
- data/lib/togai_client/version.rb +2 -2
- data/lib/togai_client.rb +279 -21
- data/spec/spec_helper.rb +1 -1
- data/togai_client.gemspec +4 -3
- metadata +561 -5
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# TogaiClient::PricePlanV2PaginatedResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **data** | [**Array<PricePlanV2>**](PricePlanV2.md) | | |
|
|
8
|
+
| **next_token** | **String** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'togai_client'
|
|
14
|
+
|
|
15
|
+
instance = TogaiClient::PricePlanV2PaginatedResponse.new(
|
|
16
|
+
data: null,
|
|
17
|
+
next_token: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
data/docs/PricePlansApi.md
CHANGED
|
@@ -1,23 +1,25 @@
|
|
|
1
1
|
# TogaiClient::PricePlansApi
|
|
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
|
-
| [**activate_price_plan**](PricePlansApi.md#activate_price_plan) | **POST** /price_plans/{
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**
|
|
11
|
-
| [**
|
|
7
|
+
| [**activate_price_plan**](PricePlansApi.md#activate_price_plan) | **POST** /price_plans/{price_plan_id}/activate | (DEPRECATED) Activate a price plan |
|
|
8
|
+
| [**archive_price_plan**](PricePlansApi.md#archive_price_plan) | **DELETE** /price_plans/{price_plan_id} | (DEPRECATED) Archive a price plan |
|
|
9
|
+
| [**create_price_plan**](PricePlansApi.md#create_price_plan) | **POST** /price_plans | (DEPRECATED) Create a price plan |
|
|
10
|
+
| [**get_price_plan**](PricePlansApi.md#get_price_plan) | **GET** /price_plans/{price_plan_id} | (DEPRECATED) Get a price plan |
|
|
11
|
+
| [**get_price_plans**](PricePlansApi.md#get_price_plans) | **GET** /price_plans | (DEPRECATED) List price plans |
|
|
12
|
+
| [**price_plan_migration**](PricePlansApi.md#price_plan_migration) | **POST** /price_plans/migration | (DEPRECATED) Create a price plan migration |
|
|
13
|
+
| [**update_price_plan**](PricePlansApi.md#update_price_plan) | **PATCH** /price_plans/{price_plan_id} | (DEPRECATED) Update a price plan |
|
|
12
14
|
|
|
13
15
|
|
|
14
16
|
## activate_price_plan
|
|
15
17
|
|
|
16
|
-
> <PricePlan> activate_price_plan(
|
|
18
|
+
> <PricePlan> activate_price_plan(price_plan_id, activate_price_plan_request)
|
|
17
19
|
|
|
18
|
-
Activate a price plan
|
|
20
|
+
(DEPRECATED) Activate a price plan
|
|
19
21
|
|
|
20
|
-
Activate a price plan
|
|
22
|
+
Activate a price plan details using price plan id
|
|
21
23
|
|
|
22
24
|
### Examples
|
|
23
25
|
|
|
@@ -31,11 +33,12 @@ TogaiClient.configure do |config|
|
|
|
31
33
|
end
|
|
32
34
|
|
|
33
35
|
api_instance = TogaiClient::PricePlansApi.new
|
|
34
|
-
|
|
36
|
+
price_plan_id = 'pp.1zYnCiM9Bpg.lv25y' # String |
|
|
37
|
+
activate_price_plan_request = TogaiClient::ActivatePricePlanRequest.new({currencies: ['currencies_example']}) # ActivatePricePlanRequest | Payload to activate price plan
|
|
35
38
|
|
|
36
39
|
begin
|
|
37
|
-
# Activate a price plan
|
|
38
|
-
result = api_instance.activate_price_plan(
|
|
40
|
+
# (DEPRECATED) Activate a price plan
|
|
41
|
+
result = api_instance.activate_price_plan(price_plan_id, activate_price_plan_request)
|
|
39
42
|
p result
|
|
40
43
|
rescue TogaiClient::ApiError => e
|
|
41
44
|
puts "Error when calling PricePlansApi->activate_price_plan: #{e}"
|
|
@@ -46,12 +49,12 @@ end
|
|
|
46
49
|
|
|
47
50
|
This returns an Array which contains the response data, status code and headers.
|
|
48
51
|
|
|
49
|
-
> <Array(<PricePlan>, Integer, Hash)> activate_price_plan_with_http_info(
|
|
52
|
+
> <Array(<PricePlan>, Integer, Hash)> activate_price_plan_with_http_info(price_plan_id, activate_price_plan_request)
|
|
50
53
|
|
|
51
54
|
```ruby
|
|
52
55
|
begin
|
|
53
|
-
# Activate a price plan
|
|
54
|
-
data, status_code, headers = api_instance.activate_price_plan_with_http_info(
|
|
56
|
+
# (DEPRECATED) Activate a price plan
|
|
57
|
+
data, status_code, headers = api_instance.activate_price_plan_with_http_info(price_plan_id, activate_price_plan_request)
|
|
55
58
|
p status_code # => 2xx
|
|
56
59
|
p headers # => { ... }
|
|
57
60
|
p data # => <PricePlan>
|
|
@@ -64,7 +67,8 @@ end
|
|
|
64
67
|
|
|
65
68
|
| Name | Type | Description | Notes |
|
|
66
69
|
| ---- | ---- | ----------- | ----- |
|
|
67
|
-
| **
|
|
70
|
+
| **price_plan_id** | **String** | | |
|
|
71
|
+
| **activate_price_plan_request** | [**ActivatePricePlanRequest**](ActivatePricePlanRequest.md) | Payload to activate price plan | |
|
|
68
72
|
|
|
69
73
|
### Return type
|
|
70
74
|
|
|
@@ -76,17 +80,86 @@ end
|
|
|
76
80
|
|
|
77
81
|
### HTTP request headers
|
|
78
82
|
|
|
83
|
+
- **Content-Type**: application/json
|
|
84
|
+
- **Accept**: application/json
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
## archive_price_plan
|
|
88
|
+
|
|
89
|
+
> <BaseSuccessResponse> archive_price_plan(price_plan_id)
|
|
90
|
+
|
|
91
|
+
(DEPRECATED) Archive a price plan
|
|
92
|
+
|
|
93
|
+
Archive a price plan
|
|
94
|
+
|
|
95
|
+
### Examples
|
|
96
|
+
|
|
97
|
+
```ruby
|
|
98
|
+
require 'time'
|
|
99
|
+
require 'togai_client'
|
|
100
|
+
# setup authorization
|
|
101
|
+
TogaiClient.configure do |config|
|
|
102
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
103
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
104
|
+
end
|
|
105
|
+
|
|
106
|
+
api_instance = TogaiClient::PricePlansApi.new
|
|
107
|
+
price_plan_id = 'pp.1zYnCiM9Bpg.lv25y' # String |
|
|
108
|
+
|
|
109
|
+
begin
|
|
110
|
+
# (DEPRECATED) Archive a price plan
|
|
111
|
+
result = api_instance.archive_price_plan(price_plan_id)
|
|
112
|
+
p result
|
|
113
|
+
rescue TogaiClient::ApiError => e
|
|
114
|
+
puts "Error when calling PricePlansApi->archive_price_plan: #{e}"
|
|
115
|
+
end
|
|
116
|
+
```
|
|
117
|
+
|
|
118
|
+
#### Using the archive_price_plan_with_http_info variant
|
|
119
|
+
|
|
120
|
+
This returns an Array which contains the response data, status code and headers.
|
|
121
|
+
|
|
122
|
+
> <Array(<BaseSuccessResponse>, Integer, Hash)> archive_price_plan_with_http_info(price_plan_id)
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
begin
|
|
126
|
+
# (DEPRECATED) Archive a price plan
|
|
127
|
+
data, status_code, headers = api_instance.archive_price_plan_with_http_info(price_plan_id)
|
|
128
|
+
p status_code # => 2xx
|
|
129
|
+
p headers # => { ... }
|
|
130
|
+
p data # => <BaseSuccessResponse>
|
|
131
|
+
rescue TogaiClient::ApiError => e
|
|
132
|
+
puts "Error when calling PricePlansApi->archive_price_plan_with_http_info: #{e}"
|
|
133
|
+
end
|
|
134
|
+
```
|
|
135
|
+
|
|
136
|
+
### Parameters
|
|
137
|
+
|
|
138
|
+
| Name | Type | Description | Notes |
|
|
139
|
+
| ---- | ---- | ----------- | ----- |
|
|
140
|
+
| **price_plan_id** | **String** | | |
|
|
141
|
+
|
|
142
|
+
### Return type
|
|
143
|
+
|
|
144
|
+
[**BaseSuccessResponse**](BaseSuccessResponse.md)
|
|
145
|
+
|
|
146
|
+
### Authorization
|
|
147
|
+
|
|
148
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
149
|
+
|
|
150
|
+
### HTTP request headers
|
|
151
|
+
|
|
79
152
|
- **Content-Type**: Not defined
|
|
80
153
|
- **Accept**: application/json
|
|
81
154
|
|
|
82
155
|
|
|
83
156
|
## create_price_plan
|
|
84
157
|
|
|
85
|
-
> <PricePlan> create_price_plan(create_price_plan_request)
|
|
158
|
+
> <PricePlan> create_price_plan(create_price_plan_request, opts)
|
|
86
159
|
|
|
87
|
-
Create a price plan
|
|
160
|
+
(DEPRECATED) Create a price plan
|
|
88
161
|
|
|
89
|
-
|
|
162
|
+
This API let's you create and price plan Learn more about [Price Plans](https://docs.togai.com/docs/priceplan)
|
|
90
163
|
|
|
91
164
|
### Examples
|
|
92
165
|
|
|
@@ -100,11 +173,14 @@ TogaiClient.configure do |config|
|
|
|
100
173
|
end
|
|
101
174
|
|
|
102
175
|
api_instance = TogaiClient::PricePlansApi.new
|
|
103
|
-
create_price_plan_request = TogaiClient::CreatePricePlanRequest.new({name: 'name_example', price_plan_details: TogaiClient::
|
|
176
|
+
create_price_plan_request = TogaiClient::CreatePricePlanRequest.new({name: 'name_example', price_plan_details: TogaiClient::CreatePricePlanDetails.new({supported_currencies: ['supported_currencies_example']})}) # CreatePricePlanRequest | Payload to create price plan
|
|
177
|
+
opts = {
|
|
178
|
+
dry_run: false # Boolean |
|
|
179
|
+
}
|
|
104
180
|
|
|
105
181
|
begin
|
|
106
|
-
# Create a price plan
|
|
107
|
-
result = api_instance.create_price_plan(create_price_plan_request)
|
|
182
|
+
# (DEPRECATED) Create a price plan
|
|
183
|
+
result = api_instance.create_price_plan(create_price_plan_request, opts)
|
|
108
184
|
p result
|
|
109
185
|
rescue TogaiClient::ApiError => e
|
|
110
186
|
puts "Error when calling PricePlansApi->create_price_plan: #{e}"
|
|
@@ -115,12 +191,12 @@ end
|
|
|
115
191
|
|
|
116
192
|
This returns an Array which contains the response data, status code and headers.
|
|
117
193
|
|
|
118
|
-
> <Array(<PricePlan>, Integer, Hash)> create_price_plan_with_http_info(create_price_plan_request)
|
|
194
|
+
> <Array(<PricePlan>, Integer, Hash)> create_price_plan_with_http_info(create_price_plan_request, opts)
|
|
119
195
|
|
|
120
196
|
```ruby
|
|
121
197
|
begin
|
|
122
|
-
# Create a price plan
|
|
123
|
-
data, status_code, headers = api_instance.create_price_plan_with_http_info(create_price_plan_request)
|
|
198
|
+
# (DEPRECATED) Create a price plan
|
|
199
|
+
data, status_code, headers = api_instance.create_price_plan_with_http_info(create_price_plan_request, opts)
|
|
124
200
|
p status_code # => 2xx
|
|
125
201
|
p headers # => { ... }
|
|
126
202
|
p data # => <PricePlan>
|
|
@@ -134,6 +210,7 @@ end
|
|
|
134
210
|
| Name | Type | Description | Notes |
|
|
135
211
|
| ---- | ---- | ----------- | ----- |
|
|
136
212
|
| **create_price_plan_request** | [**CreatePricePlanRequest**](CreatePricePlanRequest.md) | Payload to create price plan | |
|
|
213
|
+
| **dry_run** | **Boolean** | | [optional] |
|
|
137
214
|
|
|
138
215
|
### Return type
|
|
139
216
|
|
|
@@ -151,11 +228,11 @@ end
|
|
|
151
228
|
|
|
152
229
|
## get_price_plan
|
|
153
230
|
|
|
154
|
-
> <PricePlan> get_price_plan(
|
|
231
|
+
> <PricePlan> get_price_plan(price_plan_id, opts)
|
|
155
232
|
|
|
156
|
-
Get a price plan
|
|
233
|
+
(DEPRECATED) Get a price plan
|
|
157
234
|
|
|
158
|
-
Get a price plan
|
|
235
|
+
Get a price plan details using price plan id
|
|
159
236
|
|
|
160
237
|
### Examples
|
|
161
238
|
|
|
@@ -169,11 +246,14 @@ TogaiClient.configure do |config|
|
|
|
169
246
|
end
|
|
170
247
|
|
|
171
248
|
api_instance = TogaiClient::PricePlansApi.new
|
|
172
|
-
|
|
249
|
+
price_plan_id = 'pp.1zYnCiM9Bpg.lv25y' # String |
|
|
250
|
+
opts = {
|
|
251
|
+
version: 2 # Integer | Optional version to get a specific version. Gets latest version if it is not provided.
|
|
252
|
+
}
|
|
173
253
|
|
|
174
254
|
begin
|
|
175
|
-
# Get a price plan
|
|
176
|
-
result = api_instance.get_price_plan(
|
|
255
|
+
# (DEPRECATED) Get a price plan
|
|
256
|
+
result = api_instance.get_price_plan(price_plan_id, opts)
|
|
177
257
|
p result
|
|
178
258
|
rescue TogaiClient::ApiError => e
|
|
179
259
|
puts "Error when calling PricePlansApi->get_price_plan: #{e}"
|
|
@@ -184,12 +264,12 @@ end
|
|
|
184
264
|
|
|
185
265
|
This returns an Array which contains the response data, status code and headers.
|
|
186
266
|
|
|
187
|
-
> <Array(<PricePlan>, Integer, Hash)> get_price_plan_with_http_info(
|
|
267
|
+
> <Array(<PricePlan>, Integer, Hash)> get_price_plan_with_http_info(price_plan_id, opts)
|
|
188
268
|
|
|
189
269
|
```ruby
|
|
190
270
|
begin
|
|
191
|
-
# Get a price plan
|
|
192
|
-
data, status_code, headers = api_instance.get_price_plan_with_http_info(
|
|
271
|
+
# (DEPRECATED) Get a price plan
|
|
272
|
+
data, status_code, headers = api_instance.get_price_plan_with_http_info(price_plan_id, opts)
|
|
193
273
|
p status_code # => 2xx
|
|
194
274
|
p headers # => { ... }
|
|
195
275
|
p data # => <PricePlan>
|
|
@@ -202,7 +282,8 @@ end
|
|
|
202
282
|
|
|
203
283
|
| Name | Type | Description | Notes |
|
|
204
284
|
| ---- | ---- | ----------- | ----- |
|
|
205
|
-
| **
|
|
285
|
+
| **price_plan_id** | **String** | | |
|
|
286
|
+
| **version** | **Integer** | Optional version to get a specific version. Gets latest version if it is not provided. | [optional] |
|
|
206
287
|
|
|
207
288
|
### Return type
|
|
208
289
|
|
|
@@ -222,9 +303,9 @@ end
|
|
|
222
303
|
|
|
223
304
|
> <PricePlanPaginatedResponse> get_price_plans(opts)
|
|
224
305
|
|
|
225
|
-
List price plans
|
|
306
|
+
(DEPRECATED) List price plans
|
|
226
307
|
|
|
227
|
-
|
|
308
|
+
Get a list of price plans
|
|
228
309
|
|
|
229
310
|
### Examples
|
|
230
311
|
|
|
@@ -239,12 +320,12 @@ end
|
|
|
239
320
|
|
|
240
321
|
api_instance = TogaiClient::PricePlansApi.new
|
|
241
322
|
opts = {
|
|
242
|
-
next_token: '
|
|
243
|
-
page_size:
|
|
323
|
+
next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String |
|
|
324
|
+
page_size: 10 # Float |
|
|
244
325
|
}
|
|
245
326
|
|
|
246
327
|
begin
|
|
247
|
-
# List price plans
|
|
328
|
+
# (DEPRECATED) List price plans
|
|
248
329
|
result = api_instance.get_price_plans(opts)
|
|
249
330
|
p result
|
|
250
331
|
rescue TogaiClient::ApiError => e
|
|
@@ -260,7 +341,7 @@ This returns an Array which contains the response data, status code and headers.
|
|
|
260
341
|
|
|
261
342
|
```ruby
|
|
262
343
|
begin
|
|
263
|
-
# List price plans
|
|
344
|
+
# (DEPRECATED) List price plans
|
|
264
345
|
data, status_code, headers = api_instance.get_price_plans_with_http_info(opts)
|
|
265
346
|
p status_code # => 2xx
|
|
266
347
|
p headers # => { ... }
|
|
@@ -275,7 +356,7 @@ end
|
|
|
275
356
|
| Name | Type | Description | Notes |
|
|
276
357
|
| ---- | ---- | ----------- | ----- |
|
|
277
358
|
| **next_token** | **String** | | [optional] |
|
|
278
|
-
| **page_size** | **
|
|
359
|
+
| **page_size** | **Float** | | [optional] |
|
|
279
360
|
|
|
280
361
|
### Return type
|
|
281
362
|
|
|
@@ -291,13 +372,82 @@ end
|
|
|
291
372
|
- **Accept**: application/json
|
|
292
373
|
|
|
293
374
|
|
|
375
|
+
## price_plan_migration
|
|
376
|
+
|
|
377
|
+
> <BaseSuccessResponse> price_plan_migration(create_price_plan_migration_request)
|
|
378
|
+
|
|
379
|
+
(DEPRECATED) Create a price plan migration
|
|
380
|
+
|
|
381
|
+
Migrates accounts across price plans. This is an asynchronous process functioning on top of Togai's Jobs framework. Status of the created migrations can be obtained using the [Jobs APIs](https://docs.togai.com/api-reference/jobs/get-the-status-of-a-job)
|
|
382
|
+
|
|
383
|
+
### Examples
|
|
384
|
+
|
|
385
|
+
```ruby
|
|
386
|
+
require 'time'
|
|
387
|
+
require 'togai_client'
|
|
388
|
+
# setup authorization
|
|
389
|
+
TogaiClient.configure do |config|
|
|
390
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
391
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
392
|
+
end
|
|
393
|
+
|
|
394
|
+
api_instance = TogaiClient::PricePlansApi.new
|
|
395
|
+
create_price_plan_migration_request = TogaiClient::CreatePricePlanMigrationRequest.new({source_id: 'source_id_example', source_version: 37, migration_mode: 'IMMEDIATE'}) # CreatePricePlanMigrationRequest | Payload to create price plan migration request
|
|
396
|
+
|
|
397
|
+
begin
|
|
398
|
+
# (DEPRECATED) Create a price plan migration
|
|
399
|
+
result = api_instance.price_plan_migration(create_price_plan_migration_request)
|
|
400
|
+
p result
|
|
401
|
+
rescue TogaiClient::ApiError => e
|
|
402
|
+
puts "Error when calling PricePlansApi->price_plan_migration: #{e}"
|
|
403
|
+
end
|
|
404
|
+
```
|
|
405
|
+
|
|
406
|
+
#### Using the price_plan_migration_with_http_info variant
|
|
407
|
+
|
|
408
|
+
This returns an Array which contains the response data, status code and headers.
|
|
409
|
+
|
|
410
|
+
> <Array(<BaseSuccessResponse>, Integer, Hash)> price_plan_migration_with_http_info(create_price_plan_migration_request)
|
|
411
|
+
|
|
412
|
+
```ruby
|
|
413
|
+
begin
|
|
414
|
+
# (DEPRECATED) Create a price plan migration
|
|
415
|
+
data, status_code, headers = api_instance.price_plan_migration_with_http_info(create_price_plan_migration_request)
|
|
416
|
+
p status_code # => 2xx
|
|
417
|
+
p headers # => { ... }
|
|
418
|
+
p data # => <BaseSuccessResponse>
|
|
419
|
+
rescue TogaiClient::ApiError => e
|
|
420
|
+
puts "Error when calling PricePlansApi->price_plan_migration_with_http_info: #{e}"
|
|
421
|
+
end
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
### Parameters
|
|
425
|
+
|
|
426
|
+
| Name | Type | Description | Notes |
|
|
427
|
+
| ---- | ---- | ----------- | ----- |
|
|
428
|
+
| **create_price_plan_migration_request** | [**CreatePricePlanMigrationRequest**](CreatePricePlanMigrationRequest.md) | Payload to create price plan migration request | |
|
|
429
|
+
|
|
430
|
+
### Return type
|
|
431
|
+
|
|
432
|
+
[**BaseSuccessResponse**](BaseSuccessResponse.md)
|
|
433
|
+
|
|
434
|
+
### Authorization
|
|
435
|
+
|
|
436
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
437
|
+
|
|
438
|
+
### HTTP request headers
|
|
439
|
+
|
|
440
|
+
- **Content-Type**: application/json
|
|
441
|
+
- **Accept**: application/json
|
|
442
|
+
|
|
443
|
+
|
|
294
444
|
## update_price_plan
|
|
295
445
|
|
|
296
|
-
> <PricePlan> update_price_plan(
|
|
446
|
+
> <PricePlan> update_price_plan(price_plan_id, update_price_plan_request)
|
|
297
447
|
|
|
298
|
-
Update a price plan
|
|
448
|
+
(DEPRECATED) Update a price plan
|
|
299
449
|
|
|
300
|
-
Update
|
|
450
|
+
Update an existing price plan Price Plans with status as DRAFT alone can be updated . Learn more about [Price plans](https://docs.togai.com/docs/priceplan) from our Guides
|
|
301
451
|
|
|
302
452
|
### Examples
|
|
303
453
|
|
|
@@ -311,12 +461,12 @@ TogaiClient.configure do |config|
|
|
|
311
461
|
end
|
|
312
462
|
|
|
313
463
|
api_instance = TogaiClient::PricePlansApi.new
|
|
314
|
-
|
|
464
|
+
price_plan_id = 'pp.1zYnCiM9Bpg.lv25y' # String |
|
|
315
465
|
update_price_plan_request = TogaiClient::UpdatePricePlanRequest.new # UpdatePricePlanRequest | Payload to update price plan
|
|
316
466
|
|
|
317
467
|
begin
|
|
318
|
-
# Update a price plan
|
|
319
|
-
result = api_instance.update_price_plan(
|
|
468
|
+
# (DEPRECATED) Update a price plan
|
|
469
|
+
result = api_instance.update_price_plan(price_plan_id, update_price_plan_request)
|
|
320
470
|
p result
|
|
321
471
|
rescue TogaiClient::ApiError => e
|
|
322
472
|
puts "Error when calling PricePlansApi->update_price_plan: #{e}"
|
|
@@ -327,12 +477,12 @@ end
|
|
|
327
477
|
|
|
328
478
|
This returns an Array which contains the response data, status code and headers.
|
|
329
479
|
|
|
330
|
-
> <Array(<PricePlan>, Integer, Hash)> update_price_plan_with_http_info(
|
|
480
|
+
> <Array(<PricePlan>, Integer, Hash)> update_price_plan_with_http_info(price_plan_id, update_price_plan_request)
|
|
331
481
|
|
|
332
482
|
```ruby
|
|
333
483
|
begin
|
|
334
|
-
# Update a price plan
|
|
335
|
-
data, status_code, headers = api_instance.update_price_plan_with_http_info(
|
|
484
|
+
# (DEPRECATED) Update a price plan
|
|
485
|
+
data, status_code, headers = api_instance.update_price_plan_with_http_info(price_plan_id, update_price_plan_request)
|
|
336
486
|
p status_code # => 2xx
|
|
337
487
|
p headers # => { ... }
|
|
338
488
|
p data # => <PricePlan>
|
|
@@ -345,7 +495,7 @@ end
|
|
|
345
495
|
|
|
346
496
|
| Name | Type | Description | Notes |
|
|
347
497
|
| ---- | ---- | ----------- | ----- |
|
|
348
|
-
| **
|
|
498
|
+
| **price_plan_id** | **String** | | |
|
|
349
499
|
| **update_price_plan_request** | [**UpdatePricePlanRequest**](UpdatePricePlanRequest.md) | Payload to update price plan | |
|
|
350
500
|
|
|
351
501
|
### Return type
|
data/docs/PricingCycleConfig.md
CHANGED
|
@@ -4,10 +4,10 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **interval** | **
|
|
8
|
-
| **
|
|
9
|
-
| **
|
|
10
|
-
| **
|
|
7
|
+
| **interval** | [**PricingCycleInterval**](PricingCycleInterval.md) | | |
|
|
8
|
+
| **start_offset** | [**PricingCycleConfigStartOffset**](PricingCycleConfigStartOffset.md) | | [optional] |
|
|
9
|
+
| **grace_period** | **Integer** | Togai allows you to ingest past dated events that will be processed by a pricing cycle till the end grace period. For example: Pricing cycle is Monthly from 1st to 30th and gracePeriod is 5 days which next month 1 to 5th date, you can ingest past dated events during this grace period. | |
|
|
10
|
+
| **anniversary_cycle** | **Boolean** | Togai calculates the startOffsets based on the date of association instead of requiring from the user and these offsets will be applied as an override if this flag is enabled. Examples: WEEKLY - - 23/10/2023 (Monday) - {dayOffset: 1, monthOffset: NIL} - 25/10/2023 (Wednesday) - {dayOffset: 3, monthOffset: NIL} - 29/10/2023 (Sunday) - {dayOffset: 7, monthOffset: NIL} MONTHLY - - 1st Oct - {dayOffset: 1, monthOffset: NIL} - 12th Oct - {dayOffset: 12, monthOffset: NIL} - 28th Oct - {dayOffset: 28, monthOffset: NIL} - 30th Oct - {dayOffset: 30, monthOffset: NIL} - 31th Oct - {dayOffset: LAST, monthOffset: NIL} QUARTERLY - 15th Jan, 15th Apr, 15th Jul and 15th Oct - {dayOffset: 15, monthOffset: 1} - 15th Feb, 15th May, 15th Aug and 15th Nov - {dayOffset: 15, monthOffset: 2} - 15th Mar, 15th Jun, 15th Sep and 15th Dec - {dayOffset: 15, monthOffset: 3} HALF_YEARLY - 15th Jan and 15th Jul - {dayOffset: 15, monthOffset: 1} - 15th Apr and 15th Oct - {dayOffset: 15, monthOffset: 4} - 15th Jun and 15th Dec - {dayOffset: 15, monthOffset: 6} ANNUALLY - 15th Jan - {dayOffset: 15, monthOffset: 1} - 29th Feb on Leap year - {dayOffset: LAST, monthOffset: 2} - 28th Feb - {dayOffset: LAST, monthOffset: 2} - 15th Aug - {dayOffset: 15, monthOffset: 8} - 15th Dec - {dayOffset: 15, monthOffset: 12} | [optional] |
|
|
11
11
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
@@ -16,9 +16,9 @@ require 'togai_client'
|
|
|
16
16
|
|
|
17
17
|
instance = TogaiClient::PricingCycleConfig.new(
|
|
18
18
|
interval: null,
|
|
19
|
-
start_type: null,
|
|
20
19
|
start_offset: null,
|
|
21
|
-
grace_period: 3
|
|
20
|
+
grace_period: 3,
|
|
21
|
+
anniversary_cycle: null
|
|
22
22
|
)
|
|
23
23
|
```
|
|
24
24
|
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
|
-
| **day_offset** | **String** | min: \"1\" and max: \"31\" as strings. Spl. string allowed: LAST | |
|
|
7
|
+
| **day_offset** | **String** | If interval is WEEKLY, min: \"1\" and max: \"7\" as strings. Spl. string allowed: LAST Otherwise, min: \"1\" and max: \"31\" as strings. Spl. string allowed: LAST | |
|
|
8
8
|
| **month_offset** | **String** | min: \"1\" and max: \"12\". Spl. string allowed: FIRST / LAST. For QUARTERLY only 1 - 3 is allowed and for HALF_YEARLY 1 - 6. This being an optional field, shouldn't be passed for MONTHLY. | |
|
|
9
9
|
|
|
10
10
|
## Example
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# TogaiClient::PricingCycleInterval
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
|
|
8
|
+
## Example
|
|
9
|
+
|
|
10
|
+
```ruby
|
|
11
|
+
require 'togai_client'
|
|
12
|
+
|
|
13
|
+
instance = TogaiClient::PricingCycleInterval.new()
|
|
14
|
+
```
|
|
15
|
+
|
data/docs/PricingRule.md
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# TogaiClient::PricingRule
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | |
|
|
9
|
+
| **version** | **Integer** | | |
|
|
10
|
+
| **invoice_timing** | [**PricingRuleTiming**](PricingRuleTiming.md) | | [optional] |
|
|
11
|
+
| **order** | **Integer** | | |
|
|
12
|
+
| **condition** | **String** | JSON logic condition deciding whether to compute this pricing rule or not | [optional] |
|
|
13
|
+
| **computation** | **String** | JSON logic to be computed | |
|
|
14
|
+
| **action** | [**PricingRuleAction**](PricingRuleAction.md) | | |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'togai_client'
|
|
20
|
+
|
|
21
|
+
instance = TogaiClient::PricingRule.new(
|
|
22
|
+
id: null,
|
|
23
|
+
name: null,
|
|
24
|
+
version: null,
|
|
25
|
+
invoice_timing: null,
|
|
26
|
+
order: null,
|
|
27
|
+
condition: null,
|
|
28
|
+
computation: null,
|
|
29
|
+
action: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# TogaiClient::PricingRuleAction
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | |
|
|
8
|
+
| **target** | **String** | | [optional] |
|
|
9
|
+
| **id** | **String** | | [optional] |
|
|
10
|
+
| **description** | **String** | | [optional] |
|
|
11
|
+
| **metadata** | **Hash<String, String>** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'togai_client'
|
|
17
|
+
|
|
18
|
+
instance = TogaiClient::PricingRuleAction.new(
|
|
19
|
+
type: null,
|
|
20
|
+
target: null,
|
|
21
|
+
id: null,
|
|
22
|
+
description: null,
|
|
23
|
+
metadata: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
# TogaiClient::PricingRuleChangesLog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **key** | **String** | | |
|
|
8
|
+
| **key_name** | **String** | | [optional] |
|
|
9
|
+
| **old_revenue** | **Float** | | |
|
|
10
|
+
| **new_revenue** | **Float** | | |
|
|
11
|
+
| **old_usage** | **Float** | | [optional] |
|
|
12
|
+
| **new_usage** | **Float** | | [optional] |
|
|
13
|
+
| **error_message** | **String** | | [optional] |
|
|
14
|
+
|
|
15
|
+
## Example
|
|
16
|
+
|
|
17
|
+
```ruby
|
|
18
|
+
require 'togai_client'
|
|
19
|
+
|
|
20
|
+
instance = TogaiClient::PricingRuleChangesLog.new(
|
|
21
|
+
key: null,
|
|
22
|
+
key_name: null,
|
|
23
|
+
old_revenue: null,
|
|
24
|
+
new_revenue: null,
|
|
25
|
+
old_usage: null,
|
|
26
|
+
new_usage: null,
|
|
27
|
+
error_message: null
|
|
28
|
+
)
|
|
29
|
+
```
|
|
30
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# TogaiClient::PricingRuleInfo
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **id** | **String** | | |
|
|
8
|
+
| **name** | **String** | | [optional] |
|
|
9
|
+
| **condition** | **String** | | [optional] |
|
|
10
|
+
| **computation** | **String** | | [optional] |
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```ruby
|
|
15
|
+
require 'togai_client'
|
|
16
|
+
|
|
17
|
+
instance = TogaiClient::PricingRuleInfo.new(
|
|
18
|
+
id: null,
|
|
19
|
+
name: null,
|
|
20
|
+
condition: null,
|
|
21
|
+
computation: null
|
|
22
|
+
)
|
|
23
|
+
```
|
|
24
|
+
|