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/AccountsApi.md
CHANGED
|
@@ -1,26 +1,36 @@
|
|
|
1
1
|
# TogaiClient::AccountsApi
|
|
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
|
-
| [**add_aliases**](AccountsApi.md#add_aliases) | **POST** /
|
|
8
|
-
| [**
|
|
9
|
-
| [**
|
|
10
|
-
| [**delete_account**](AccountsApi.md#delete_account) | **DELETE** /
|
|
11
|
-
| [**get_account**](AccountsApi.md#get_account) | **GET** /
|
|
12
|
-
| [**get_accounts**](AccountsApi.md#get_accounts) | **GET** /
|
|
13
|
-
| [**
|
|
14
|
-
| [**
|
|
7
|
+
| [**add_aliases**](AccountsApi.md#add_aliases) | **POST** /accounts/{account_id}/add_aliases | Add Aliases to account |
|
|
8
|
+
| [**create_account**](AccountsApi.md#create_account) | **POST** /accounts | Create an account |
|
|
9
|
+
| [**create_proposal**](AccountsApi.md#create_proposal) | **POST** /accounts/{account_id}/purchase_proposals | (DEPRECATED) Propose a purchase of a plan |
|
|
10
|
+
| [**delete_account**](AccountsApi.md#delete_account) | **DELETE** /accounts/{account_id} | Delete an account |
|
|
11
|
+
| [**get_account**](AccountsApi.md#get_account) | **GET** /accounts/{account_id} | Get an account |
|
|
12
|
+
| [**get_accounts**](AccountsApi.md#get_accounts) | **GET** /accounts | List accounts of customer |
|
|
13
|
+
| [**get_pricing_schedules**](AccountsApi.md#get_pricing_schedules) | **GET** /accounts/{account_id}/pricing_schedules | (DEPRECATED) List pricing schedules of an account |
|
|
14
|
+
| [**get_proposal**](AccountsApi.md#get_proposal) | **GET** /purchase_proposals/{purchase_proposal_id} | (DEPRECATED) Get proposal information |
|
|
15
|
+
| [**get_purchase**](AccountsApi.md#get_purchase) | **GET** /purchases/{purchase_id} | (DEPRECATED) Get a specific purchase of an account |
|
|
16
|
+
| [**initiate_one_time_entitlement_plan**](AccountsApi.md#initiate_one_time_entitlement_plan) | **POST** /accounts/{account_id}/purchases | (DEPRECATED) Initiate a purchase |
|
|
17
|
+
| [**list_account_aliases**](AccountsApi.md#list_account_aliases) | **GET** /accounts/{account_id}/account_aliases | Get all aliases of an account |
|
|
18
|
+
| [**list_account_proposals**](AccountsApi.md#list_account_proposals) | **GET** /accounts/{account_id}/purchase_proposals | (DEPRECATED) List all proposals of an account |
|
|
19
|
+
| [**list_account_purchases**](AccountsApi.md#list_account_purchases) | **GET** /accounts/{account_id}/purchases | (DEPRECATED) Get all purchases for an account |
|
|
20
|
+
| [**remove_aliases**](AccountsApi.md#remove_aliases) | **POST** /accounts/{account_id}/remove_aliases | Remove Aliases to account |
|
|
21
|
+
| [**update_account**](AccountsApi.md#update_account) | **PATCH** /accounts/{account_id} | Update an account |
|
|
22
|
+
| [**update_pricing_schedule**](AccountsApi.md#update_pricing_schedule) | **POST** /accounts/{account_id}/price_plans | (DEPRECATED) Dissociate or associate a price plan with an account |
|
|
23
|
+
| [**update_pricing_schedule_batch**](AccountsApi.md#update_pricing_schedule_batch) | **POST** /accounts/{account_id}/edit_schedules | (DEPRECATED) Edit schedules of an account. |
|
|
24
|
+
| [**update_proposal_status**](AccountsApi.md#update_proposal_status) | **POST** /purchase_proposals/{purchase_proposal_id}/update_status | (DEPRECATED) Approve or decline a purchase of a billing plan |
|
|
15
25
|
|
|
16
26
|
|
|
17
27
|
## add_aliases
|
|
18
28
|
|
|
19
|
-
> <Account> add_aliases(
|
|
29
|
+
> <Account> add_aliases(account_id, add_account_aliases_request)
|
|
20
30
|
|
|
21
31
|
Add Aliases to account
|
|
22
32
|
|
|
23
|
-
Add
|
|
33
|
+
Add aliases to an account using customer_id and account_id.
|
|
24
34
|
|
|
25
35
|
### Examples
|
|
26
36
|
|
|
@@ -34,13 +44,12 @@ TogaiClient.configure do |config|
|
|
|
34
44
|
end
|
|
35
45
|
|
|
36
46
|
api_instance = TogaiClient::AccountsApi.new
|
|
37
|
-
|
|
38
|
-
account_id = 'account_id_example' # String |
|
|
47
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
39
48
|
add_account_aliases_request = TogaiClient::AddAccountAliasesRequest.new # AddAccountAliasesRequest | Payload to add aliases to account
|
|
40
49
|
|
|
41
50
|
begin
|
|
42
51
|
# Add Aliases to account
|
|
43
|
-
result = api_instance.add_aliases(
|
|
52
|
+
result = api_instance.add_aliases(account_id, add_account_aliases_request)
|
|
44
53
|
p result
|
|
45
54
|
rescue TogaiClient::ApiError => e
|
|
46
55
|
puts "Error when calling AccountsApi->add_aliases: #{e}"
|
|
@@ -51,12 +60,12 @@ end
|
|
|
51
60
|
|
|
52
61
|
This returns an Array which contains the response data, status code and headers.
|
|
53
62
|
|
|
54
|
-
> <Array(<Account>, Integer, Hash)> add_aliases_with_http_info(
|
|
63
|
+
> <Array(<Account>, Integer, Hash)> add_aliases_with_http_info(account_id, add_account_aliases_request)
|
|
55
64
|
|
|
56
65
|
```ruby
|
|
57
66
|
begin
|
|
58
67
|
# Add Aliases to account
|
|
59
|
-
data, status_code, headers = api_instance.add_aliases_with_http_info(
|
|
68
|
+
data, status_code, headers = api_instance.add_aliases_with_http_info(account_id, add_account_aliases_request)
|
|
60
69
|
p status_code # => 2xx
|
|
61
70
|
p headers # => { ... }
|
|
62
71
|
p data # => <Account>
|
|
@@ -69,8 +78,7 @@ end
|
|
|
69
78
|
|
|
70
79
|
| Name | Type | Description | Notes |
|
|
71
80
|
| ---- | ---- | ----------- | ----- |
|
|
72
|
-
| **
|
|
73
|
-
| **account_id** | **String** | | |
|
|
81
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
74
82
|
| **add_account_aliases_request** | [**AddAccountAliasesRequest**](AddAccountAliasesRequest.md) | Payload to add aliases to account | |
|
|
75
83
|
|
|
76
84
|
### Return type
|
|
@@ -87,13 +95,13 @@ end
|
|
|
87
95
|
- **Accept**: application/json
|
|
88
96
|
|
|
89
97
|
|
|
90
|
-
##
|
|
98
|
+
## create_account
|
|
91
99
|
|
|
92
|
-
> <
|
|
100
|
+
> <Account> create_account(create_account_request)
|
|
93
101
|
|
|
94
|
-
|
|
102
|
+
Create an account
|
|
95
103
|
|
|
96
|
-
|
|
104
|
+
This API let’s you to create an account for a customer using customer_id.
|
|
97
105
|
|
|
98
106
|
### Examples
|
|
99
107
|
|
|
@@ -107,34 +115,32 @@ TogaiClient.configure do |config|
|
|
|
107
115
|
end
|
|
108
116
|
|
|
109
117
|
api_instance = TogaiClient::AccountsApi.new
|
|
110
|
-
|
|
111
|
-
account_id = 'account_id_example' # String |
|
|
112
|
-
associate_price_plan_request = TogaiClient::AssociatePricePlanRequest.new({price_plan_name: 'price_plan_name_example', effective_from: Date.today, effective_until: Date.today}) # AssociatePricePlanRequest | Payload to associate a price plan to an account
|
|
118
|
+
create_account_request = TogaiClient::CreateAccountRequest.new({id: 'ACC00001', name: 'Primary Account', customer_id: 'C1234ewf'}) # CreateAccountRequest | Payload to create account
|
|
113
119
|
|
|
114
120
|
begin
|
|
115
|
-
#
|
|
116
|
-
result = api_instance.
|
|
121
|
+
# Create an account
|
|
122
|
+
result = api_instance.create_account(create_account_request)
|
|
117
123
|
p result
|
|
118
124
|
rescue TogaiClient::ApiError => e
|
|
119
|
-
puts "Error when calling AccountsApi->
|
|
125
|
+
puts "Error when calling AccountsApi->create_account: #{e}"
|
|
120
126
|
end
|
|
121
127
|
```
|
|
122
128
|
|
|
123
|
-
#### Using the
|
|
129
|
+
#### Using the create_account_with_http_info variant
|
|
124
130
|
|
|
125
131
|
This returns an Array which contains the response data, status code and headers.
|
|
126
132
|
|
|
127
|
-
> <Array(<
|
|
133
|
+
> <Array(<Account>, Integer, Hash)> create_account_with_http_info(create_account_request)
|
|
128
134
|
|
|
129
135
|
```ruby
|
|
130
136
|
begin
|
|
131
|
-
#
|
|
132
|
-
data, status_code, headers = api_instance.
|
|
137
|
+
# Create an account
|
|
138
|
+
data, status_code, headers = api_instance.create_account_with_http_info(create_account_request)
|
|
133
139
|
p status_code # => 2xx
|
|
134
140
|
p headers # => { ... }
|
|
135
|
-
p data # => <
|
|
141
|
+
p data # => <Account>
|
|
136
142
|
rescue TogaiClient::ApiError => e
|
|
137
|
-
puts "Error when calling AccountsApi->
|
|
143
|
+
puts "Error when calling AccountsApi->create_account_with_http_info: #{e}"
|
|
138
144
|
end
|
|
139
145
|
```
|
|
140
146
|
|
|
@@ -142,13 +148,11 @@ end
|
|
|
142
148
|
|
|
143
149
|
| Name | Type | Description | Notes |
|
|
144
150
|
| ---- | ---- | ----------- | ----- |
|
|
145
|
-
| **
|
|
146
|
-
| **account_id** | **String** | | |
|
|
147
|
-
| **associate_price_plan_request** | [**AssociatePricePlanRequest**](AssociatePricePlanRequest.md) | Payload to associate a price plan to an account | |
|
|
151
|
+
| **create_account_request** | [**CreateAccountRequest**](CreateAccountRequest.md) | Payload to create account | |
|
|
148
152
|
|
|
149
153
|
### Return type
|
|
150
154
|
|
|
151
|
-
[**
|
|
155
|
+
[**Account**](Account.md)
|
|
152
156
|
|
|
153
157
|
### Authorization
|
|
154
158
|
|
|
@@ -160,13 +164,13 @@ end
|
|
|
160
164
|
- **Accept**: application/json
|
|
161
165
|
|
|
162
166
|
|
|
163
|
-
##
|
|
167
|
+
## create_proposal
|
|
164
168
|
|
|
165
|
-
> <
|
|
169
|
+
> <Proposal> create_proposal(account_id, create_proposal_request)
|
|
166
170
|
|
|
167
|
-
|
|
171
|
+
(DEPRECATED) Propose a purchase of a plan
|
|
168
172
|
|
|
169
|
-
|
|
173
|
+
This API let’s you to create a proposal of a billing/entitlement plan for an account
|
|
170
174
|
|
|
171
175
|
### Examples
|
|
172
176
|
|
|
@@ -180,33 +184,33 @@ TogaiClient.configure do |config|
|
|
|
180
184
|
end
|
|
181
185
|
|
|
182
186
|
api_instance = TogaiClient::AccountsApi.new
|
|
183
|
-
|
|
184
|
-
|
|
187
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
188
|
+
create_proposal_request = TogaiClient::CreateProposalRequest.new({type: TogaiClient::PurchaseType::ENTITLEMENT_GRANT, payment_mode: 'PREPAID'}) # CreateProposalRequest | Payload to initiate a proposal
|
|
185
189
|
|
|
186
190
|
begin
|
|
187
|
-
#
|
|
188
|
-
result = api_instance.
|
|
191
|
+
# (DEPRECATED) Propose a purchase of a plan
|
|
192
|
+
result = api_instance.create_proposal(account_id, create_proposal_request)
|
|
189
193
|
p result
|
|
190
194
|
rescue TogaiClient::ApiError => e
|
|
191
|
-
puts "Error when calling AccountsApi->
|
|
195
|
+
puts "Error when calling AccountsApi->create_proposal: #{e}"
|
|
192
196
|
end
|
|
193
197
|
```
|
|
194
198
|
|
|
195
|
-
#### Using the
|
|
199
|
+
#### Using the create_proposal_with_http_info variant
|
|
196
200
|
|
|
197
201
|
This returns an Array which contains the response data, status code and headers.
|
|
198
202
|
|
|
199
|
-
> <Array(<
|
|
203
|
+
> <Array(<Proposal>, Integer, Hash)> create_proposal_with_http_info(account_id, create_proposal_request)
|
|
200
204
|
|
|
201
205
|
```ruby
|
|
202
206
|
begin
|
|
203
|
-
#
|
|
204
|
-
data, status_code, headers = api_instance.
|
|
207
|
+
# (DEPRECATED) Propose a purchase of a plan
|
|
208
|
+
data, status_code, headers = api_instance.create_proposal_with_http_info(account_id, create_proposal_request)
|
|
205
209
|
p status_code # => 2xx
|
|
206
210
|
p headers # => { ... }
|
|
207
|
-
p data # => <
|
|
211
|
+
p data # => <Proposal>
|
|
208
212
|
rescue TogaiClient::ApiError => e
|
|
209
|
-
puts "Error when calling AccountsApi->
|
|
213
|
+
puts "Error when calling AccountsApi->create_proposal_with_http_info: #{e}"
|
|
210
214
|
end
|
|
211
215
|
```
|
|
212
216
|
|
|
@@ -214,12 +218,12 @@ end
|
|
|
214
218
|
|
|
215
219
|
| Name | Type | Description | Notes |
|
|
216
220
|
| ---- | ---- | ----------- | ----- |
|
|
217
|
-
| **
|
|
218
|
-
| **
|
|
221
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
222
|
+
| **create_proposal_request** | [**CreateProposalRequest**](CreateProposalRequest.md) | Payload to initiate a proposal | |
|
|
219
223
|
|
|
220
224
|
### Return type
|
|
221
225
|
|
|
222
|
-
[**
|
|
226
|
+
[**Proposal**](Proposal.md)
|
|
223
227
|
|
|
224
228
|
### Authorization
|
|
225
229
|
|
|
@@ -233,11 +237,11 @@ end
|
|
|
233
237
|
|
|
234
238
|
## delete_account
|
|
235
239
|
|
|
236
|
-
> <BaseSuccessResponse> delete_account(
|
|
240
|
+
> <BaseSuccessResponse> delete_account(account_id)
|
|
237
241
|
|
|
238
242
|
Delete an account
|
|
239
243
|
|
|
240
|
-
|
|
244
|
+
This API let’s you to delete a customer using customer_id and account_id.
|
|
241
245
|
|
|
242
246
|
### Examples
|
|
243
247
|
|
|
@@ -251,12 +255,11 @@ TogaiClient.configure do |config|
|
|
|
251
255
|
end
|
|
252
256
|
|
|
253
257
|
api_instance = TogaiClient::AccountsApi.new
|
|
254
|
-
|
|
255
|
-
account_id = 'account_id_example' # String |
|
|
258
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
256
259
|
|
|
257
260
|
begin
|
|
258
261
|
# Delete an account
|
|
259
|
-
result = api_instance.delete_account(
|
|
262
|
+
result = api_instance.delete_account(account_id)
|
|
260
263
|
p result
|
|
261
264
|
rescue TogaiClient::ApiError => e
|
|
262
265
|
puts "Error when calling AccountsApi->delete_account: #{e}"
|
|
@@ -267,12 +270,12 @@ end
|
|
|
267
270
|
|
|
268
271
|
This returns an Array which contains the response data, status code and headers.
|
|
269
272
|
|
|
270
|
-
> <Array(<BaseSuccessResponse>, Integer, Hash)> delete_account_with_http_info(
|
|
273
|
+
> <Array(<BaseSuccessResponse>, Integer, Hash)> delete_account_with_http_info(account_id)
|
|
271
274
|
|
|
272
275
|
```ruby
|
|
273
276
|
begin
|
|
274
277
|
# Delete an account
|
|
275
|
-
data, status_code, headers = api_instance.delete_account_with_http_info(
|
|
278
|
+
data, status_code, headers = api_instance.delete_account_with_http_info(account_id)
|
|
276
279
|
p status_code # => 2xx
|
|
277
280
|
p headers # => { ... }
|
|
278
281
|
p data # => <BaseSuccessResponse>
|
|
@@ -285,8 +288,7 @@ end
|
|
|
285
288
|
|
|
286
289
|
| Name | Type | Description | Notes |
|
|
287
290
|
| ---- | ---- | ----------- | ----- |
|
|
288
|
-
| **
|
|
289
|
-
| **account_id** | **String** | | |
|
|
291
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
290
292
|
|
|
291
293
|
### Return type
|
|
292
294
|
|
|
@@ -304,11 +306,11 @@ end
|
|
|
304
306
|
|
|
305
307
|
## get_account
|
|
306
308
|
|
|
307
|
-
> <Account> get_account(
|
|
309
|
+
> <Account> get_account(account_id, opts)
|
|
308
310
|
|
|
309
311
|
Get an account
|
|
310
312
|
|
|
311
|
-
Get
|
|
313
|
+
Get account information using customer_id and account_id.
|
|
312
314
|
|
|
313
315
|
### Examples
|
|
314
316
|
|
|
@@ -322,12 +324,15 @@ TogaiClient.configure do |config|
|
|
|
322
324
|
end
|
|
323
325
|
|
|
324
326
|
api_instance = TogaiClient::AccountsApi.new
|
|
325
|
-
|
|
326
|
-
|
|
327
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
328
|
+
opts = {
|
|
329
|
+
effective_on: Time.parse('2013-10-20T19:20:30+01:00'), # Time |
|
|
330
|
+
include_group_details: true # Boolean |
|
|
331
|
+
}
|
|
327
332
|
|
|
328
333
|
begin
|
|
329
334
|
# Get an account
|
|
330
|
-
result = api_instance.get_account(
|
|
335
|
+
result = api_instance.get_account(account_id, opts)
|
|
331
336
|
p result
|
|
332
337
|
rescue TogaiClient::ApiError => e
|
|
333
338
|
puts "Error when calling AccountsApi->get_account: #{e}"
|
|
@@ -338,12 +343,12 @@ end
|
|
|
338
343
|
|
|
339
344
|
This returns an Array which contains the response data, status code and headers.
|
|
340
345
|
|
|
341
|
-
> <Array(<Account>, Integer, Hash)> get_account_with_http_info(
|
|
346
|
+
> <Array(<Account>, Integer, Hash)> get_account_with_http_info(account_id, opts)
|
|
342
347
|
|
|
343
348
|
```ruby
|
|
344
349
|
begin
|
|
345
350
|
# Get an account
|
|
346
|
-
data, status_code, headers = api_instance.get_account_with_http_info(
|
|
351
|
+
data, status_code, headers = api_instance.get_account_with_http_info(account_id, opts)
|
|
347
352
|
p status_code # => 2xx
|
|
348
353
|
p headers # => { ... }
|
|
349
354
|
p data # => <Account>
|
|
@@ -356,8 +361,9 @@ end
|
|
|
356
361
|
|
|
357
362
|
| Name | Type | Description | Notes |
|
|
358
363
|
| ---- | ---- | ----------- | ----- |
|
|
359
|
-
| **
|
|
360
|
-
| **
|
|
364
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
365
|
+
| **effective_on** | **Time** | | [optional] |
|
|
366
|
+
| **include_group_details** | **Boolean** | | [optional] |
|
|
361
367
|
|
|
362
368
|
### Return type
|
|
363
369
|
|
|
@@ -375,11 +381,11 @@ end
|
|
|
375
381
|
|
|
376
382
|
## get_accounts
|
|
377
383
|
|
|
378
|
-
> <AccountPaginatedResponse> get_accounts(
|
|
384
|
+
> <AccountPaginatedResponse> get_accounts(opts)
|
|
379
385
|
|
|
380
386
|
List accounts of customer
|
|
381
387
|
|
|
382
|
-
|
|
388
|
+
Returns a list of accounts of a customer with pagination and sort.
|
|
383
389
|
|
|
384
390
|
### Examples
|
|
385
391
|
|
|
@@ -393,15 +399,14 @@ TogaiClient.configure do |config|
|
|
|
393
399
|
end
|
|
394
400
|
|
|
395
401
|
api_instance = TogaiClient::AccountsApi.new
|
|
396
|
-
customer_id = 'customer_id_example' # String |
|
|
397
402
|
opts = {
|
|
398
|
-
next_token: '
|
|
399
|
-
page_size:
|
|
403
|
+
next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String |
|
|
404
|
+
page_size: 10 # Float |
|
|
400
405
|
}
|
|
401
406
|
|
|
402
407
|
begin
|
|
403
408
|
# List accounts of customer
|
|
404
|
-
result = api_instance.get_accounts(
|
|
409
|
+
result = api_instance.get_accounts(opts)
|
|
405
410
|
p result
|
|
406
411
|
rescue TogaiClient::ApiError => e
|
|
407
412
|
puts "Error when calling AccountsApi->get_accounts: #{e}"
|
|
@@ -412,12 +417,12 @@ end
|
|
|
412
417
|
|
|
413
418
|
This returns an Array which contains the response data, status code and headers.
|
|
414
419
|
|
|
415
|
-
> <Array(<AccountPaginatedResponse>, Integer, Hash)> get_accounts_with_http_info(
|
|
420
|
+
> <Array(<AccountPaginatedResponse>, Integer, Hash)> get_accounts_with_http_info(opts)
|
|
416
421
|
|
|
417
422
|
```ruby
|
|
418
423
|
begin
|
|
419
424
|
# List accounts of customer
|
|
420
|
-
data, status_code, headers = api_instance.get_accounts_with_http_info(
|
|
425
|
+
data, status_code, headers = api_instance.get_accounts_with_http_info(opts)
|
|
421
426
|
p status_code # => 2xx
|
|
422
427
|
p headers # => { ... }
|
|
423
428
|
p data # => <AccountPaginatedResponse>
|
|
@@ -430,9 +435,8 @@ end
|
|
|
430
435
|
|
|
431
436
|
| Name | Type | Description | Notes |
|
|
432
437
|
| ---- | ---- | ----------- | ----- |
|
|
433
|
-
| **customer_id** | **String** | | |
|
|
434
438
|
| **next_token** | **String** | | [optional] |
|
|
435
|
-
| **page_size** | **
|
|
439
|
+
| **page_size** | **Float** | | [optional] |
|
|
436
440
|
|
|
437
441
|
### Return type
|
|
438
442
|
|
|
@@ -448,13 +452,13 @@ end
|
|
|
448
452
|
- **Accept**: application/json
|
|
449
453
|
|
|
450
454
|
|
|
451
|
-
##
|
|
455
|
+
## get_pricing_schedules
|
|
452
456
|
|
|
453
|
-
> <
|
|
457
|
+
> <PricingSchedulePaginatedResponse> get_pricing_schedules(account_id, opts)
|
|
454
458
|
|
|
455
|
-
|
|
459
|
+
(DEPRECATED) List pricing schedules of an account
|
|
456
460
|
|
|
457
|
-
|
|
461
|
+
Returns a list of pricing schedules of an account with pagination and sort.
|
|
458
462
|
|
|
459
463
|
### Examples
|
|
460
464
|
|
|
@@ -468,34 +472,40 @@ TogaiClient.configure do |config|
|
|
|
468
472
|
end
|
|
469
473
|
|
|
470
474
|
api_instance = TogaiClient::AccountsApi.new
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
475
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
476
|
+
opts = {
|
|
477
|
+
next_token: 'eyJsYXN0SXRlbUlkIjogInN0cmluZyIsICJwYWdlU2l6ZSI6IDEwMCwgInNvcnRPcmRlciI6ICJhc2MifQ==', # String |
|
|
478
|
+
page_size: 10, # Float |
|
|
479
|
+
start_date: '2023-03-30T10:41:10.088499', # String |
|
|
480
|
+
end_date: '2099-03-30T10:41:10.088499', # String |
|
|
481
|
+
include_price_plan_info: true, # Boolean |
|
|
482
|
+
compact: false # Boolean |
|
|
483
|
+
}
|
|
474
484
|
|
|
475
485
|
begin
|
|
476
|
-
#
|
|
477
|
-
result = api_instance.
|
|
486
|
+
# (DEPRECATED) List pricing schedules of an account
|
|
487
|
+
result = api_instance.get_pricing_schedules(account_id, opts)
|
|
478
488
|
p result
|
|
479
489
|
rescue TogaiClient::ApiError => e
|
|
480
|
-
puts "Error when calling AccountsApi->
|
|
490
|
+
puts "Error when calling AccountsApi->get_pricing_schedules: #{e}"
|
|
481
491
|
end
|
|
482
492
|
```
|
|
483
493
|
|
|
484
|
-
#### Using the
|
|
494
|
+
#### Using the get_pricing_schedules_with_http_info variant
|
|
485
495
|
|
|
486
496
|
This returns an Array which contains the response data, status code and headers.
|
|
487
497
|
|
|
488
|
-
> <Array(<
|
|
498
|
+
> <Array(<PricingSchedulePaginatedResponse>, Integer, Hash)> get_pricing_schedules_with_http_info(account_id, opts)
|
|
489
499
|
|
|
490
500
|
```ruby
|
|
491
501
|
begin
|
|
492
|
-
#
|
|
493
|
-
data, status_code, headers = api_instance.
|
|
502
|
+
# (DEPRECATED) List pricing schedules of an account
|
|
503
|
+
data, status_code, headers = api_instance.get_pricing_schedules_with_http_info(account_id, opts)
|
|
494
504
|
p status_code # => 2xx
|
|
495
505
|
p headers # => { ... }
|
|
496
|
-
p data # => <
|
|
506
|
+
p data # => <PricingSchedulePaginatedResponse>
|
|
497
507
|
rescue TogaiClient::ApiError => e
|
|
498
|
-
puts "Error when calling AccountsApi->
|
|
508
|
+
puts "Error when calling AccountsApi->get_pricing_schedules_with_http_info: #{e}"
|
|
499
509
|
end
|
|
500
510
|
```
|
|
501
511
|
|
|
@@ -503,13 +513,226 @@ end
|
|
|
503
513
|
|
|
504
514
|
| Name | Type | Description | Notes |
|
|
505
515
|
| ---- | ---- | ----------- | ----- |
|
|
506
|
-
| **
|
|
507
|
-
| **
|
|
508
|
-
| **
|
|
516
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
517
|
+
| **next_token** | **String** | | [optional] |
|
|
518
|
+
| **page_size** | **Float** | | [optional] |
|
|
519
|
+
| **start_date** | **String** | | [optional] |
|
|
520
|
+
| **end_date** | **String** | | [optional] |
|
|
521
|
+
| **include_price_plan_info** | **Boolean** | | [optional] |
|
|
522
|
+
| **compact** | **Boolean** | | [optional] |
|
|
509
523
|
|
|
510
524
|
### Return type
|
|
511
525
|
|
|
512
|
-
[**
|
|
526
|
+
[**PricingSchedulePaginatedResponse**](PricingSchedulePaginatedResponse.md)
|
|
527
|
+
|
|
528
|
+
### Authorization
|
|
529
|
+
|
|
530
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
531
|
+
|
|
532
|
+
### HTTP request headers
|
|
533
|
+
|
|
534
|
+
- **Content-Type**: Not defined
|
|
535
|
+
- **Accept**: application/json
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
## get_proposal
|
|
539
|
+
|
|
540
|
+
> <GetProposalResponse> get_proposal(purchase_proposal_id)
|
|
541
|
+
|
|
542
|
+
(DEPRECATED) Get proposal information
|
|
543
|
+
|
|
544
|
+
Get proposal information
|
|
545
|
+
|
|
546
|
+
### Examples
|
|
547
|
+
|
|
548
|
+
```ruby
|
|
549
|
+
require 'time'
|
|
550
|
+
require 'togai_client'
|
|
551
|
+
# setup authorization
|
|
552
|
+
TogaiClient.configure do |config|
|
|
553
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
554
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
555
|
+
end
|
|
556
|
+
|
|
557
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
558
|
+
purchase_proposal_id = 'purchase.20rqjgFJf2O.ejl25' # String |
|
|
559
|
+
|
|
560
|
+
begin
|
|
561
|
+
# (DEPRECATED) Get proposal information
|
|
562
|
+
result = api_instance.get_proposal(purchase_proposal_id)
|
|
563
|
+
p result
|
|
564
|
+
rescue TogaiClient::ApiError => e
|
|
565
|
+
puts "Error when calling AccountsApi->get_proposal: #{e}"
|
|
566
|
+
end
|
|
567
|
+
```
|
|
568
|
+
|
|
569
|
+
#### Using the get_proposal_with_http_info variant
|
|
570
|
+
|
|
571
|
+
This returns an Array which contains the response data, status code and headers.
|
|
572
|
+
|
|
573
|
+
> <Array(<GetProposalResponse>, Integer, Hash)> get_proposal_with_http_info(purchase_proposal_id)
|
|
574
|
+
|
|
575
|
+
```ruby
|
|
576
|
+
begin
|
|
577
|
+
# (DEPRECATED) Get proposal information
|
|
578
|
+
data, status_code, headers = api_instance.get_proposal_with_http_info(purchase_proposal_id)
|
|
579
|
+
p status_code # => 2xx
|
|
580
|
+
p headers # => { ... }
|
|
581
|
+
p data # => <GetProposalResponse>
|
|
582
|
+
rescue TogaiClient::ApiError => e
|
|
583
|
+
puts "Error when calling AccountsApi->get_proposal_with_http_info: #{e}"
|
|
584
|
+
end
|
|
585
|
+
```
|
|
586
|
+
|
|
587
|
+
### Parameters
|
|
588
|
+
|
|
589
|
+
| Name | Type | Description | Notes |
|
|
590
|
+
| ---- | ---- | ----------- | ----- |
|
|
591
|
+
| **purchase_proposal_id** | **String** | | |
|
|
592
|
+
|
|
593
|
+
### Return type
|
|
594
|
+
|
|
595
|
+
[**GetProposalResponse**](GetProposalResponse.md)
|
|
596
|
+
|
|
597
|
+
### Authorization
|
|
598
|
+
|
|
599
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
600
|
+
|
|
601
|
+
### HTTP request headers
|
|
602
|
+
|
|
603
|
+
- **Content-Type**: Not defined
|
|
604
|
+
- **Accept**: application/json
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
## get_purchase
|
|
608
|
+
|
|
609
|
+
> <GetPurchaseResponse> get_purchase(purchase_id)
|
|
610
|
+
|
|
611
|
+
(DEPRECATED) Get a specific purchase of an account
|
|
612
|
+
|
|
613
|
+
Get purchase information of an account for a specific plan using account_id and price_plan_id
|
|
614
|
+
|
|
615
|
+
### Examples
|
|
616
|
+
|
|
617
|
+
```ruby
|
|
618
|
+
require 'time'
|
|
619
|
+
require 'togai_client'
|
|
620
|
+
# setup authorization
|
|
621
|
+
TogaiClient.configure do |config|
|
|
622
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
623
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
624
|
+
end
|
|
625
|
+
|
|
626
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
627
|
+
purchase_id = 'purchase.1zYnCiM9Bpg.lv25y' # String |
|
|
628
|
+
|
|
629
|
+
begin
|
|
630
|
+
# (DEPRECATED) Get a specific purchase of an account
|
|
631
|
+
result = api_instance.get_purchase(purchase_id)
|
|
632
|
+
p result
|
|
633
|
+
rescue TogaiClient::ApiError => e
|
|
634
|
+
puts "Error when calling AccountsApi->get_purchase: #{e}"
|
|
635
|
+
end
|
|
636
|
+
```
|
|
637
|
+
|
|
638
|
+
#### Using the get_purchase_with_http_info variant
|
|
639
|
+
|
|
640
|
+
This returns an Array which contains the response data, status code and headers.
|
|
641
|
+
|
|
642
|
+
> <Array(<GetPurchaseResponse>, Integer, Hash)> get_purchase_with_http_info(purchase_id)
|
|
643
|
+
|
|
644
|
+
```ruby
|
|
645
|
+
begin
|
|
646
|
+
# (DEPRECATED) Get a specific purchase of an account
|
|
647
|
+
data, status_code, headers = api_instance.get_purchase_with_http_info(purchase_id)
|
|
648
|
+
p status_code # => 2xx
|
|
649
|
+
p headers # => { ... }
|
|
650
|
+
p data # => <GetPurchaseResponse>
|
|
651
|
+
rescue TogaiClient::ApiError => e
|
|
652
|
+
puts "Error when calling AccountsApi->get_purchase_with_http_info: #{e}"
|
|
653
|
+
end
|
|
654
|
+
```
|
|
655
|
+
|
|
656
|
+
### Parameters
|
|
657
|
+
|
|
658
|
+
| Name | Type | Description | Notes |
|
|
659
|
+
| ---- | ---- | ----------- | ----- |
|
|
660
|
+
| **purchase_id** | **String** | | |
|
|
661
|
+
|
|
662
|
+
### Return type
|
|
663
|
+
|
|
664
|
+
[**GetPurchaseResponse**](GetPurchaseResponse.md)
|
|
665
|
+
|
|
666
|
+
### Authorization
|
|
667
|
+
|
|
668
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
669
|
+
|
|
670
|
+
### HTTP request headers
|
|
671
|
+
|
|
672
|
+
- **Content-Type**: Not defined
|
|
673
|
+
- **Accept**: application/json
|
|
674
|
+
|
|
675
|
+
|
|
676
|
+
## initiate_one_time_entitlement_plan
|
|
677
|
+
|
|
678
|
+
> <Purchase> initiate_one_time_entitlement_plan(account_id, create_purchase_request)
|
|
679
|
+
|
|
680
|
+
(DEPRECATED) Initiate a purchase
|
|
681
|
+
|
|
682
|
+
This API let’s you to initiate a purchase for an account
|
|
683
|
+
|
|
684
|
+
### Examples
|
|
685
|
+
|
|
686
|
+
```ruby
|
|
687
|
+
require 'time'
|
|
688
|
+
require 'togai_client'
|
|
689
|
+
# setup authorization
|
|
690
|
+
TogaiClient.configure do |config|
|
|
691
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
692
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
693
|
+
end
|
|
694
|
+
|
|
695
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
696
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
697
|
+
create_purchase_request = TogaiClient::CreatePurchaseRequest.new # CreatePurchaseRequest | Payload to initiate a purchase
|
|
698
|
+
|
|
699
|
+
begin
|
|
700
|
+
# (DEPRECATED) Initiate a purchase
|
|
701
|
+
result = api_instance.initiate_one_time_entitlement_plan(account_id, create_purchase_request)
|
|
702
|
+
p result
|
|
703
|
+
rescue TogaiClient::ApiError => e
|
|
704
|
+
puts "Error when calling AccountsApi->initiate_one_time_entitlement_plan: #{e}"
|
|
705
|
+
end
|
|
706
|
+
```
|
|
707
|
+
|
|
708
|
+
#### Using the initiate_one_time_entitlement_plan_with_http_info variant
|
|
709
|
+
|
|
710
|
+
This returns an Array which contains the response data, status code and headers.
|
|
711
|
+
|
|
712
|
+
> <Array(<Purchase>, Integer, Hash)> initiate_one_time_entitlement_plan_with_http_info(account_id, create_purchase_request)
|
|
713
|
+
|
|
714
|
+
```ruby
|
|
715
|
+
begin
|
|
716
|
+
# (DEPRECATED) Initiate a purchase
|
|
717
|
+
data, status_code, headers = api_instance.initiate_one_time_entitlement_plan_with_http_info(account_id, create_purchase_request)
|
|
718
|
+
p status_code # => 2xx
|
|
719
|
+
p headers # => { ... }
|
|
720
|
+
p data # => <Purchase>
|
|
721
|
+
rescue TogaiClient::ApiError => e
|
|
722
|
+
puts "Error when calling AccountsApi->initiate_one_time_entitlement_plan_with_http_info: #{e}"
|
|
723
|
+
end
|
|
724
|
+
```
|
|
725
|
+
|
|
726
|
+
### Parameters
|
|
727
|
+
|
|
728
|
+
| Name | Type | Description | Notes |
|
|
729
|
+
| ---- | ---- | ----------- | ----- |
|
|
730
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
731
|
+
| **create_purchase_request** | [**CreatePurchaseRequest**](CreatePurchaseRequest.md) | Payload to initiate a purchase | |
|
|
732
|
+
|
|
733
|
+
### Return type
|
|
734
|
+
|
|
735
|
+
[**Purchase**](Purchase.md)
|
|
513
736
|
|
|
514
737
|
### Authorization
|
|
515
738
|
|
|
@@ -521,13 +744,13 @@ end
|
|
|
521
744
|
- **Accept**: application/json
|
|
522
745
|
|
|
523
746
|
|
|
524
|
-
##
|
|
747
|
+
## list_account_aliases
|
|
525
748
|
|
|
526
|
-
> <
|
|
749
|
+
> <AccountAliasesPaginatedResponse> list_account_aliases(account_id)
|
|
527
750
|
|
|
528
|
-
|
|
751
|
+
Get all aliases of an account
|
|
529
752
|
|
|
530
|
-
|
|
753
|
+
Get all aliases of an account using account_id
|
|
531
754
|
|
|
532
755
|
### Examples
|
|
533
756
|
|
|
@@ -541,34 +764,32 @@ TogaiClient.configure do |config|
|
|
|
541
764
|
end
|
|
542
765
|
|
|
543
766
|
api_instance = TogaiClient::AccountsApi.new
|
|
544
|
-
|
|
545
|
-
account_id = 'account_id_example' # String |
|
|
546
|
-
update_account_request = TogaiClient::UpdateAccountRequest.new # UpdateAccountRequest | Payload to update account
|
|
767
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
547
768
|
|
|
548
769
|
begin
|
|
549
|
-
#
|
|
550
|
-
result = api_instance.
|
|
770
|
+
# Get all aliases of an account
|
|
771
|
+
result = api_instance.list_account_aliases(account_id)
|
|
551
772
|
p result
|
|
552
773
|
rescue TogaiClient::ApiError => e
|
|
553
|
-
puts "Error when calling AccountsApi->
|
|
774
|
+
puts "Error when calling AccountsApi->list_account_aliases: #{e}"
|
|
554
775
|
end
|
|
555
776
|
```
|
|
556
777
|
|
|
557
|
-
#### Using the
|
|
778
|
+
#### Using the list_account_aliases_with_http_info variant
|
|
558
779
|
|
|
559
780
|
This returns an Array which contains the response data, status code and headers.
|
|
560
781
|
|
|
561
|
-
> <Array(<
|
|
782
|
+
> <Array(<AccountAliasesPaginatedResponse>, Integer, Hash)> list_account_aliases_with_http_info(account_id)
|
|
562
783
|
|
|
563
784
|
```ruby
|
|
564
785
|
begin
|
|
565
|
-
#
|
|
566
|
-
data, status_code, headers = api_instance.
|
|
786
|
+
# Get all aliases of an account
|
|
787
|
+
data, status_code, headers = api_instance.list_account_aliases_with_http_info(account_id)
|
|
567
788
|
p status_code # => 2xx
|
|
568
789
|
p headers # => { ... }
|
|
569
|
-
p data # => <
|
|
790
|
+
p data # => <AccountAliasesPaginatedResponse>
|
|
570
791
|
rescue TogaiClient::ApiError => e
|
|
571
|
-
puts "Error when calling AccountsApi->
|
|
792
|
+
puts "Error when calling AccountsApi->list_account_aliases_with_http_info: #{e}"
|
|
572
793
|
end
|
|
573
794
|
```
|
|
574
795
|
|
|
@@ -576,13 +797,508 @@ end
|
|
|
576
797
|
|
|
577
798
|
| Name | Type | Description | Notes |
|
|
578
799
|
| ---- | ---- | ----------- | ----- |
|
|
579
|
-
| **
|
|
580
|
-
| **account_id** | **String** | | |
|
|
581
|
-
| **update_account_request** | [**UpdateAccountRequest**](UpdateAccountRequest.md) | Payload to update account | |
|
|
800
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
582
801
|
|
|
583
802
|
### Return type
|
|
584
803
|
|
|
585
|
-
[**
|
|
804
|
+
[**AccountAliasesPaginatedResponse**](AccountAliasesPaginatedResponse.md)
|
|
805
|
+
|
|
806
|
+
### Authorization
|
|
807
|
+
|
|
808
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
809
|
+
|
|
810
|
+
### HTTP request headers
|
|
811
|
+
|
|
812
|
+
- **Content-Type**: Not defined
|
|
813
|
+
- **Accept**: application/json
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
## list_account_proposals
|
|
817
|
+
|
|
818
|
+
> <ProposalsPaginatedResponse> list_account_proposals(account_id)
|
|
819
|
+
|
|
820
|
+
(DEPRECATED) List all proposals of an account
|
|
821
|
+
|
|
822
|
+
List all proposals of an account
|
|
823
|
+
|
|
824
|
+
### Examples
|
|
825
|
+
|
|
826
|
+
```ruby
|
|
827
|
+
require 'time'
|
|
828
|
+
require 'togai_client'
|
|
829
|
+
# setup authorization
|
|
830
|
+
TogaiClient.configure do |config|
|
|
831
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
832
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
833
|
+
end
|
|
834
|
+
|
|
835
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
836
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
837
|
+
|
|
838
|
+
begin
|
|
839
|
+
# (DEPRECATED) List all proposals of an account
|
|
840
|
+
result = api_instance.list_account_proposals(account_id)
|
|
841
|
+
p result
|
|
842
|
+
rescue TogaiClient::ApiError => e
|
|
843
|
+
puts "Error when calling AccountsApi->list_account_proposals: #{e}"
|
|
844
|
+
end
|
|
845
|
+
```
|
|
846
|
+
|
|
847
|
+
#### Using the list_account_proposals_with_http_info variant
|
|
848
|
+
|
|
849
|
+
This returns an Array which contains the response data, status code and headers.
|
|
850
|
+
|
|
851
|
+
> <Array(<ProposalsPaginatedResponse>, Integer, Hash)> list_account_proposals_with_http_info(account_id)
|
|
852
|
+
|
|
853
|
+
```ruby
|
|
854
|
+
begin
|
|
855
|
+
# (DEPRECATED) List all proposals of an account
|
|
856
|
+
data, status_code, headers = api_instance.list_account_proposals_with_http_info(account_id)
|
|
857
|
+
p status_code # => 2xx
|
|
858
|
+
p headers # => { ... }
|
|
859
|
+
p data # => <ProposalsPaginatedResponse>
|
|
860
|
+
rescue TogaiClient::ApiError => e
|
|
861
|
+
puts "Error when calling AccountsApi->list_account_proposals_with_http_info: #{e}"
|
|
862
|
+
end
|
|
863
|
+
```
|
|
864
|
+
|
|
865
|
+
### Parameters
|
|
866
|
+
|
|
867
|
+
| Name | Type | Description | Notes |
|
|
868
|
+
| ---- | ---- | ----------- | ----- |
|
|
869
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
870
|
+
|
|
871
|
+
### Return type
|
|
872
|
+
|
|
873
|
+
[**ProposalsPaginatedResponse**](ProposalsPaginatedResponse.md)
|
|
874
|
+
|
|
875
|
+
### Authorization
|
|
876
|
+
|
|
877
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
878
|
+
|
|
879
|
+
### HTTP request headers
|
|
880
|
+
|
|
881
|
+
- **Content-Type**: Not defined
|
|
882
|
+
- **Accept**: application/json
|
|
883
|
+
|
|
884
|
+
|
|
885
|
+
## list_account_purchases
|
|
886
|
+
|
|
887
|
+
> <PurchasePaginatedListData> list_account_purchases(account_id)
|
|
888
|
+
|
|
889
|
+
(DEPRECATED) Get all purchases for an account
|
|
890
|
+
|
|
891
|
+
Get Purchase information for an account using account_id and price_plan_id
|
|
892
|
+
|
|
893
|
+
### Examples
|
|
894
|
+
|
|
895
|
+
```ruby
|
|
896
|
+
require 'time'
|
|
897
|
+
require 'togai_client'
|
|
898
|
+
# setup authorization
|
|
899
|
+
TogaiClient.configure do |config|
|
|
900
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
901
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
902
|
+
end
|
|
903
|
+
|
|
904
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
905
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
906
|
+
|
|
907
|
+
begin
|
|
908
|
+
# (DEPRECATED) Get all purchases for an account
|
|
909
|
+
result = api_instance.list_account_purchases(account_id)
|
|
910
|
+
p result
|
|
911
|
+
rescue TogaiClient::ApiError => e
|
|
912
|
+
puts "Error when calling AccountsApi->list_account_purchases: #{e}"
|
|
913
|
+
end
|
|
914
|
+
```
|
|
915
|
+
|
|
916
|
+
#### Using the list_account_purchases_with_http_info variant
|
|
917
|
+
|
|
918
|
+
This returns an Array which contains the response data, status code and headers.
|
|
919
|
+
|
|
920
|
+
> <Array(<PurchasePaginatedListData>, Integer, Hash)> list_account_purchases_with_http_info(account_id)
|
|
921
|
+
|
|
922
|
+
```ruby
|
|
923
|
+
begin
|
|
924
|
+
# (DEPRECATED) Get all purchases for an account
|
|
925
|
+
data, status_code, headers = api_instance.list_account_purchases_with_http_info(account_id)
|
|
926
|
+
p status_code # => 2xx
|
|
927
|
+
p headers # => { ... }
|
|
928
|
+
p data # => <PurchasePaginatedListData>
|
|
929
|
+
rescue TogaiClient::ApiError => e
|
|
930
|
+
puts "Error when calling AccountsApi->list_account_purchases_with_http_info: #{e}"
|
|
931
|
+
end
|
|
932
|
+
```
|
|
933
|
+
|
|
934
|
+
### Parameters
|
|
935
|
+
|
|
936
|
+
| Name | Type | Description | Notes |
|
|
937
|
+
| ---- | ---- | ----------- | ----- |
|
|
938
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
939
|
+
|
|
940
|
+
### Return type
|
|
941
|
+
|
|
942
|
+
[**PurchasePaginatedListData**](PurchasePaginatedListData.md)
|
|
943
|
+
|
|
944
|
+
### Authorization
|
|
945
|
+
|
|
946
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
947
|
+
|
|
948
|
+
### HTTP request headers
|
|
949
|
+
|
|
950
|
+
- **Content-Type**: Not defined
|
|
951
|
+
- **Accept**: application/json
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
## remove_aliases
|
|
955
|
+
|
|
956
|
+
> <Account> remove_aliases(account_id, remove_account_aliases_request)
|
|
957
|
+
|
|
958
|
+
Remove Aliases to account
|
|
959
|
+
|
|
960
|
+
Remove existing aliases tagged to an account using this API
|
|
961
|
+
|
|
962
|
+
### Examples
|
|
963
|
+
|
|
964
|
+
```ruby
|
|
965
|
+
require 'time'
|
|
966
|
+
require 'togai_client'
|
|
967
|
+
# setup authorization
|
|
968
|
+
TogaiClient.configure do |config|
|
|
969
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
970
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
971
|
+
end
|
|
972
|
+
|
|
973
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
974
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
975
|
+
remove_account_aliases_request = TogaiClient::RemoveAccountAliasesRequest.new # RemoveAccountAliasesRequest | Payload to remove aliases from account
|
|
976
|
+
|
|
977
|
+
begin
|
|
978
|
+
# Remove Aliases to account
|
|
979
|
+
result = api_instance.remove_aliases(account_id, remove_account_aliases_request)
|
|
980
|
+
p result
|
|
981
|
+
rescue TogaiClient::ApiError => e
|
|
982
|
+
puts "Error when calling AccountsApi->remove_aliases: #{e}"
|
|
983
|
+
end
|
|
984
|
+
```
|
|
985
|
+
|
|
986
|
+
#### Using the remove_aliases_with_http_info variant
|
|
987
|
+
|
|
988
|
+
This returns an Array which contains the response data, status code and headers.
|
|
989
|
+
|
|
990
|
+
> <Array(<Account>, Integer, Hash)> remove_aliases_with_http_info(account_id, remove_account_aliases_request)
|
|
991
|
+
|
|
992
|
+
```ruby
|
|
993
|
+
begin
|
|
994
|
+
# Remove Aliases to account
|
|
995
|
+
data, status_code, headers = api_instance.remove_aliases_with_http_info(account_id, remove_account_aliases_request)
|
|
996
|
+
p status_code # => 2xx
|
|
997
|
+
p headers # => { ... }
|
|
998
|
+
p data # => <Account>
|
|
999
|
+
rescue TogaiClient::ApiError => e
|
|
1000
|
+
puts "Error when calling AccountsApi->remove_aliases_with_http_info: #{e}"
|
|
1001
|
+
end
|
|
1002
|
+
```
|
|
1003
|
+
|
|
1004
|
+
### Parameters
|
|
1005
|
+
|
|
1006
|
+
| Name | Type | Description | Notes |
|
|
1007
|
+
| ---- | ---- | ----------- | ----- |
|
|
1008
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
1009
|
+
| **remove_account_aliases_request** | [**RemoveAccountAliasesRequest**](RemoveAccountAliasesRequest.md) | Payload to remove aliases from account | |
|
|
1010
|
+
|
|
1011
|
+
### Return type
|
|
1012
|
+
|
|
1013
|
+
[**Account**](Account.md)
|
|
1014
|
+
|
|
1015
|
+
### Authorization
|
|
1016
|
+
|
|
1017
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1018
|
+
|
|
1019
|
+
### HTTP request headers
|
|
1020
|
+
|
|
1021
|
+
- **Content-Type**: application/json
|
|
1022
|
+
- **Accept**: application/json
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
## update_account
|
|
1026
|
+
|
|
1027
|
+
> <Account> update_account(account_id, update_account_request)
|
|
1028
|
+
|
|
1029
|
+
Update an account
|
|
1030
|
+
|
|
1031
|
+
This API let’s you to update an account’s information using customer_id and account_id.
|
|
1032
|
+
|
|
1033
|
+
### Examples
|
|
1034
|
+
|
|
1035
|
+
```ruby
|
|
1036
|
+
require 'time'
|
|
1037
|
+
require 'togai_client'
|
|
1038
|
+
# setup authorization
|
|
1039
|
+
TogaiClient.configure do |config|
|
|
1040
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
1041
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1042
|
+
end
|
|
1043
|
+
|
|
1044
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
1045
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
1046
|
+
update_account_request = TogaiClient::UpdateAccountRequest.new # UpdateAccountRequest | Payload to update account
|
|
1047
|
+
|
|
1048
|
+
begin
|
|
1049
|
+
# Update an account
|
|
1050
|
+
result = api_instance.update_account(account_id, update_account_request)
|
|
1051
|
+
p result
|
|
1052
|
+
rescue TogaiClient::ApiError => e
|
|
1053
|
+
puts "Error when calling AccountsApi->update_account: #{e}"
|
|
1054
|
+
end
|
|
1055
|
+
```
|
|
1056
|
+
|
|
1057
|
+
#### Using the update_account_with_http_info variant
|
|
1058
|
+
|
|
1059
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1060
|
+
|
|
1061
|
+
> <Array(<Account>, Integer, Hash)> update_account_with_http_info(account_id, update_account_request)
|
|
1062
|
+
|
|
1063
|
+
```ruby
|
|
1064
|
+
begin
|
|
1065
|
+
# Update an account
|
|
1066
|
+
data, status_code, headers = api_instance.update_account_with_http_info(account_id, update_account_request)
|
|
1067
|
+
p status_code # => 2xx
|
|
1068
|
+
p headers # => { ... }
|
|
1069
|
+
p data # => <Account>
|
|
1070
|
+
rescue TogaiClient::ApiError => e
|
|
1071
|
+
puts "Error when calling AccountsApi->update_account_with_http_info: #{e}"
|
|
1072
|
+
end
|
|
1073
|
+
```
|
|
1074
|
+
|
|
1075
|
+
### Parameters
|
|
1076
|
+
|
|
1077
|
+
| Name | Type | Description | Notes |
|
|
1078
|
+
| ---- | ---- | ----------- | ----- |
|
|
1079
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
1080
|
+
| **update_account_request** | [**UpdateAccountRequest**](UpdateAccountRequest.md) | Payload to update account | |
|
|
1081
|
+
|
|
1082
|
+
### Return type
|
|
1083
|
+
|
|
1084
|
+
[**Account**](Account.md)
|
|
1085
|
+
|
|
1086
|
+
### Authorization
|
|
1087
|
+
|
|
1088
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1089
|
+
|
|
1090
|
+
### HTTP request headers
|
|
1091
|
+
|
|
1092
|
+
- **Content-Type**: application/json
|
|
1093
|
+
- **Accept**: application/json
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
## update_pricing_schedule
|
|
1097
|
+
|
|
1098
|
+
> <UpdatePricingScheduleResponse> update_pricing_schedule(account_id, update_pricing_schedule_request_with_actions)
|
|
1099
|
+
|
|
1100
|
+
(DEPRECATED) Dissociate or associate a price plan with an account
|
|
1101
|
+
|
|
1102
|
+
This API let’s you to detach or attach a price plan with an existing account
|
|
1103
|
+
|
|
1104
|
+
### Examples
|
|
1105
|
+
|
|
1106
|
+
```ruby
|
|
1107
|
+
require 'time'
|
|
1108
|
+
require 'togai_client'
|
|
1109
|
+
# setup authorization
|
|
1110
|
+
TogaiClient.configure do |config|
|
|
1111
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
1112
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1113
|
+
end
|
|
1114
|
+
|
|
1115
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
1116
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
1117
|
+
update_pricing_schedule_request_with_actions = TogaiClient::UpdatePricingScheduleRequestWithActions.new({effective_from: Date.today, effective_until: Date.today}) # UpdatePricingScheduleRequestWithActions | Payload to associate or dissociate a price plan to an account with actions
|
|
1118
|
+
|
|
1119
|
+
begin
|
|
1120
|
+
# (DEPRECATED) Dissociate or associate a price plan with an account
|
|
1121
|
+
result = api_instance.update_pricing_schedule(account_id, update_pricing_schedule_request_with_actions)
|
|
1122
|
+
p result
|
|
1123
|
+
rescue TogaiClient::ApiError => e
|
|
1124
|
+
puts "Error when calling AccountsApi->update_pricing_schedule: #{e}"
|
|
1125
|
+
end
|
|
1126
|
+
```
|
|
1127
|
+
|
|
1128
|
+
#### Using the update_pricing_schedule_with_http_info variant
|
|
1129
|
+
|
|
1130
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1131
|
+
|
|
1132
|
+
> <Array(<UpdatePricingScheduleResponse>, Integer, Hash)> update_pricing_schedule_with_http_info(account_id, update_pricing_schedule_request_with_actions)
|
|
1133
|
+
|
|
1134
|
+
```ruby
|
|
1135
|
+
begin
|
|
1136
|
+
# (DEPRECATED) Dissociate or associate a price plan with an account
|
|
1137
|
+
data, status_code, headers = api_instance.update_pricing_schedule_with_http_info(account_id, update_pricing_schedule_request_with_actions)
|
|
1138
|
+
p status_code # => 2xx
|
|
1139
|
+
p headers # => { ... }
|
|
1140
|
+
p data # => <UpdatePricingScheduleResponse>
|
|
1141
|
+
rescue TogaiClient::ApiError => e
|
|
1142
|
+
puts "Error when calling AccountsApi->update_pricing_schedule_with_http_info: #{e}"
|
|
1143
|
+
end
|
|
1144
|
+
```
|
|
1145
|
+
|
|
1146
|
+
### Parameters
|
|
1147
|
+
|
|
1148
|
+
| Name | Type | Description | Notes |
|
|
1149
|
+
| ---- | ---- | ----------- | ----- |
|
|
1150
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
1151
|
+
| **update_pricing_schedule_request_with_actions** | [**UpdatePricingScheduleRequestWithActions**](UpdatePricingScheduleRequestWithActions.md) | Payload to associate or dissociate a price plan to an account with actions | |
|
|
1152
|
+
|
|
1153
|
+
### Return type
|
|
1154
|
+
|
|
1155
|
+
[**UpdatePricingScheduleResponse**](UpdatePricingScheduleResponse.md)
|
|
1156
|
+
|
|
1157
|
+
### Authorization
|
|
1158
|
+
|
|
1159
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1160
|
+
|
|
1161
|
+
### HTTP request headers
|
|
1162
|
+
|
|
1163
|
+
- **Content-Type**: application/json
|
|
1164
|
+
- **Accept**: application/json
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
## update_pricing_schedule_batch
|
|
1168
|
+
|
|
1169
|
+
> <UpdatePricingScheduleResponse> update_pricing_schedule_batch(account_id, edit_pricing_schedule_request, opts)
|
|
1170
|
+
|
|
1171
|
+
(DEPRECATED) Edit schedules of an account.
|
|
1172
|
+
|
|
1173
|
+
This API let’s you to detach/attach one or more price plans from/to an existing account
|
|
1174
|
+
|
|
1175
|
+
### Examples
|
|
1176
|
+
|
|
1177
|
+
```ruby
|
|
1178
|
+
require 'time'
|
|
1179
|
+
require 'togai_client'
|
|
1180
|
+
# setup authorization
|
|
1181
|
+
TogaiClient.configure do |config|
|
|
1182
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
1183
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1184
|
+
end
|
|
1185
|
+
|
|
1186
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
1187
|
+
account_id = 'ACC00001' # String | account_id corresponding to an account
|
|
1188
|
+
edit_pricing_schedule_request = TogaiClient::EditPricingScheduleRequest.new({edits: [TogaiClient::UpdatePricingScheduleRequest.new({effective_from: Date.today, effective_until: Date.today})]}) # EditPricingScheduleRequest | Payload to dis/associate one or more price plans to an account
|
|
1189
|
+
opts = {
|
|
1190
|
+
dry_run: false # Boolean |
|
|
1191
|
+
}
|
|
1192
|
+
|
|
1193
|
+
begin
|
|
1194
|
+
# (DEPRECATED) Edit schedules of an account.
|
|
1195
|
+
result = api_instance.update_pricing_schedule_batch(account_id, edit_pricing_schedule_request, opts)
|
|
1196
|
+
p result
|
|
1197
|
+
rescue TogaiClient::ApiError => e
|
|
1198
|
+
puts "Error when calling AccountsApi->update_pricing_schedule_batch: #{e}"
|
|
1199
|
+
end
|
|
1200
|
+
```
|
|
1201
|
+
|
|
1202
|
+
#### Using the update_pricing_schedule_batch_with_http_info variant
|
|
1203
|
+
|
|
1204
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1205
|
+
|
|
1206
|
+
> <Array(<UpdatePricingScheduleResponse>, Integer, Hash)> update_pricing_schedule_batch_with_http_info(account_id, edit_pricing_schedule_request, opts)
|
|
1207
|
+
|
|
1208
|
+
```ruby
|
|
1209
|
+
begin
|
|
1210
|
+
# (DEPRECATED) Edit schedules of an account.
|
|
1211
|
+
data, status_code, headers = api_instance.update_pricing_schedule_batch_with_http_info(account_id, edit_pricing_schedule_request, opts)
|
|
1212
|
+
p status_code # => 2xx
|
|
1213
|
+
p headers # => { ... }
|
|
1214
|
+
p data # => <UpdatePricingScheduleResponse>
|
|
1215
|
+
rescue TogaiClient::ApiError => e
|
|
1216
|
+
puts "Error when calling AccountsApi->update_pricing_schedule_batch_with_http_info: #{e}"
|
|
1217
|
+
end
|
|
1218
|
+
```
|
|
1219
|
+
|
|
1220
|
+
### Parameters
|
|
1221
|
+
|
|
1222
|
+
| Name | Type | Description | Notes |
|
|
1223
|
+
| ---- | ---- | ----------- | ----- |
|
|
1224
|
+
| **account_id** | **String** | account_id corresponding to an account | |
|
|
1225
|
+
| **edit_pricing_schedule_request** | [**EditPricingScheduleRequest**](EditPricingScheduleRequest.md) | Payload to dis/associate one or more price plans to an account | |
|
|
1226
|
+
| **dry_run** | **Boolean** | | [optional] |
|
|
1227
|
+
|
|
1228
|
+
### Return type
|
|
1229
|
+
|
|
1230
|
+
[**UpdatePricingScheduleResponse**](UpdatePricingScheduleResponse.md)
|
|
1231
|
+
|
|
1232
|
+
### Authorization
|
|
1233
|
+
|
|
1234
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1235
|
+
|
|
1236
|
+
### HTTP request headers
|
|
1237
|
+
|
|
1238
|
+
- **Content-Type**: application/json
|
|
1239
|
+
- **Accept**: application/json
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
## update_proposal_status
|
|
1243
|
+
|
|
1244
|
+
> <Proposal> update_proposal_status(purchase_proposal_id, update_proposal_status)
|
|
1245
|
+
|
|
1246
|
+
(DEPRECATED) Approve or decline a purchase of a billing plan
|
|
1247
|
+
|
|
1248
|
+
This API let’s you to approve or decline a proposal of a billing plan for an account
|
|
1249
|
+
|
|
1250
|
+
### Examples
|
|
1251
|
+
|
|
1252
|
+
```ruby
|
|
1253
|
+
require 'time'
|
|
1254
|
+
require 'togai_client'
|
|
1255
|
+
# setup authorization
|
|
1256
|
+
TogaiClient.configure do |config|
|
|
1257
|
+
# Configure Bearer authorization (Bearer <credential>): bearerAuth
|
|
1258
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
1259
|
+
end
|
|
1260
|
+
|
|
1261
|
+
api_instance = TogaiClient::AccountsApi.new
|
|
1262
|
+
purchase_proposal_id = 'purchase.20rqjgFJf2O.ejl25' # String |
|
|
1263
|
+
update_proposal_status = TogaiClient::UpdateProposalStatus.new({status: 'APPROVE'}) # UpdateProposalStatus | Payload to approve or decline a proposal
|
|
1264
|
+
|
|
1265
|
+
begin
|
|
1266
|
+
# (DEPRECATED) Approve or decline a purchase of a billing plan
|
|
1267
|
+
result = api_instance.update_proposal_status(purchase_proposal_id, update_proposal_status)
|
|
1268
|
+
p result
|
|
1269
|
+
rescue TogaiClient::ApiError => e
|
|
1270
|
+
puts "Error when calling AccountsApi->update_proposal_status: #{e}"
|
|
1271
|
+
end
|
|
1272
|
+
```
|
|
1273
|
+
|
|
1274
|
+
#### Using the update_proposal_status_with_http_info variant
|
|
1275
|
+
|
|
1276
|
+
This returns an Array which contains the response data, status code and headers.
|
|
1277
|
+
|
|
1278
|
+
> <Array(<Proposal>, Integer, Hash)> update_proposal_status_with_http_info(purchase_proposal_id, update_proposal_status)
|
|
1279
|
+
|
|
1280
|
+
```ruby
|
|
1281
|
+
begin
|
|
1282
|
+
# (DEPRECATED) Approve or decline a purchase of a billing plan
|
|
1283
|
+
data, status_code, headers = api_instance.update_proposal_status_with_http_info(purchase_proposal_id, update_proposal_status)
|
|
1284
|
+
p status_code # => 2xx
|
|
1285
|
+
p headers # => { ... }
|
|
1286
|
+
p data # => <Proposal>
|
|
1287
|
+
rescue TogaiClient::ApiError => e
|
|
1288
|
+
puts "Error when calling AccountsApi->update_proposal_status_with_http_info: #{e}"
|
|
1289
|
+
end
|
|
1290
|
+
```
|
|
1291
|
+
|
|
1292
|
+
### Parameters
|
|
1293
|
+
|
|
1294
|
+
| Name | Type | Description | Notes |
|
|
1295
|
+
| ---- | ---- | ----------- | ----- |
|
|
1296
|
+
| **purchase_proposal_id** | **String** | | |
|
|
1297
|
+
| **update_proposal_status** | [**UpdateProposalStatus**](UpdateProposalStatus.md) | Payload to approve or decline a proposal | |
|
|
1298
|
+
|
|
1299
|
+
### Return type
|
|
1300
|
+
|
|
1301
|
+
[**Proposal**](Proposal.md)
|
|
586
1302
|
|
|
587
1303
|
### Authorization
|
|
588
1304
|
|