func GetAggregatedComputedUsageSummaryPricingModelEnumStringValues() []string
GetAggregatedComputedUsageSummaryPricingModelEnumStringValues Enumerates the set of values in String for AggregatedComputedUsageSummaryPricingModelEnum
func GetBillingScheduleSummaryInvoiceStatusEnumStringValues() []string
GetBillingScheduleSummaryInvoiceStatusEnumStringValues Enumerates the set of values in String for BillingScheduleSummaryInvoiceStatusEnum
func GetComputedUsageAggregationTypeEnumStringValues() []string
GetComputedUsageAggregationTypeEnumStringValues Enumerates the set of values in String for ComputedUsageAggregationTypeEnum
func GetComputedUsageSummaryTypeEnumStringValues() []string
GetComputedUsageSummaryTypeEnumStringValues Enumerates the set of values in String for ComputedUsageSummaryTypeEnum
func GetComputedUsageTypeEnumStringValues() []string
GetComputedUsageTypeEnumStringValues Enumerates the set of values in String for ComputedUsageTypeEnum
func GetInvoicelineComputedUsageSummaryTypeEnumStringValues() []string
GetInvoicelineComputedUsageSummaryTypeEnumStringValues Enumerates the set of values in String for InvoicelineComputedUsageSummaryTypeEnum
func GetListAggregatedComputedUsagesGroupingEnumStringValues() []string
GetListAggregatedComputedUsagesGroupingEnumStringValues Enumerates the set of values in String for ListAggregatedComputedUsagesGroupingEnum
func GetListBillingSchedulesSortByEnumStringValues() []string
GetListBillingSchedulesSortByEnumStringValues Enumerates the set of values in String for ListBillingSchedulesSortByEnum
func GetListBillingSchedulesSortOrderEnumStringValues() []string
GetListBillingSchedulesSortOrderEnumStringValues Enumerates the set of values in String for ListBillingSchedulesSortOrderEnum
func GetListCommitmentsSortByEnumStringValues() []string
GetListCommitmentsSortByEnumStringValues Enumerates the set of values in String for ListCommitmentsSortByEnum
func GetListCommitmentsSortOrderEnumStringValues() []string
GetListCommitmentsSortOrderEnumStringValues Enumerates the set of values in String for ListCommitmentsSortOrderEnum
func GetListComputedUsagesSortByEnumStringValues() []string
GetListComputedUsagesSortByEnumStringValues Enumerates the set of values in String for ListComputedUsagesSortByEnum
func GetListComputedUsagesSortOrderEnumStringValues() []string
GetListComputedUsagesSortOrderEnumStringValues Enumerates the set of values in String for ListComputedUsagesSortOrderEnum
func GetListInvoicelineComputedUsagesSortByEnumStringValues() []string
GetListInvoicelineComputedUsagesSortByEnumStringValues Enumerates the set of values in String for ListInvoicelineComputedUsagesSortByEnum
func GetListInvoicelineComputedUsagesSortOrderEnumStringValues() []string
GetListInvoicelineComputedUsagesSortOrderEnumStringValues Enumerates the set of values in String for ListInvoicelineComputedUsagesSortOrderEnum
func GetListInvoicesSortByEnumStringValues() []string
GetListInvoicesSortByEnumStringValues Enumerates the set of values in String for ListInvoicesSortByEnum
func GetListInvoicesSortOrderEnumStringValues() []string
GetListInvoicesSortOrderEnumStringValues Enumerates the set of values in String for ListInvoicesSortOrderEnum
func GetListOrganizationSubscriptionsSortByEnumStringValues() []string
GetListOrganizationSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListOrganizationSubscriptionsSortByEnum
func GetListOrganizationSubscriptionsSortOrderEnumStringValues() []string
GetListOrganizationSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListOrganizationSubscriptionsSortOrderEnum
func GetListRateCardsSortByEnumStringValues() []string
GetListRateCardsSortByEnumStringValues Enumerates the set of values in String for ListRateCardsSortByEnum
func GetListRateCardsSortOrderEnumStringValues() []string
GetListRateCardsSortOrderEnumStringValues Enumerates the set of values in String for ListRateCardsSortOrderEnum
func GetListSubscribedServicesSortByEnumStringValues() []string
GetListSubscribedServicesSortByEnumStringValues Enumerates the set of values in String for ListSubscribedServicesSortByEnum
func GetListSubscribedServicesSortOrderEnumStringValues() []string
GetListSubscribedServicesSortOrderEnumStringValues Enumerates the set of values in String for ListSubscribedServicesSortOrderEnum
func GetListSubscriptionsSortByEnumStringValues() []string
GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum
func GetListSubscriptionsSortOrderEnumStringValues() []string
GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum
func GetListUsageLedgersSortByEnumStringValues() []string
GetListUsageLedgersSortByEnumStringValues Enumerates the set of values in String for ListUsageLedgersSortByEnum
func GetListUsageLedgersSortOrderEnumStringValues() []string
GetListUsageLedgersSortOrderEnumStringValues Enumerates the set of values in String for ListUsageLedgersSortOrderEnum
AggregatedComputedUsageSummary Subscribed service contract details.
type AggregatedComputedUsageSummary struct {
// Subscription ID is an identifier associated with the service used for filtering the computed usage in SPM (Subscription Plan Management).
SubscriptionId *string `mandatory:"true" json:"subscriptionId"`
// Subscribed service line parent ID.
ParentSubscribedServiceId *string `mandatory:"false" json:"parentSubscribedServiceId"`
ParentProduct *ComputedUsageProduct `mandatory:"false" json:"parentProduct"`
// Subscribed services contract line start date, expressed in RFC 3339 timestamp format.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Subscribed services contract line end date, expressed in RFC 3339 timestamp format.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Subscribed service asociated subscription plan number.
PlanNumber *string `mandatory:"false" json:"planNumber"`
// Currency code.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// Inernal SPM rate card ID at line level.
RateCardId *string `mandatory:"false" json:"rateCardId"`
// Subscribed services pricing model.
PricingModel AggregatedComputedUsageSummaryPricingModelEnum `mandatory:"false" json:"pricingModel,omitempty"`
// Aggregation of computed usages for the subscribed service.
AggregatedComputedUsages []ComputedUsageAggregation `mandatory:"false" json:"aggregatedComputedUsages"`
}
func (m AggregatedComputedUsageSummary) String() string
func (m AggregatedComputedUsageSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
AggregatedComputedUsageSummaryPricingModelEnum Enum with underlying type: string
type AggregatedComputedUsageSummaryPricingModelEnum string
Set of constants representing the allowable values for AggregatedComputedUsageSummaryPricingModelEnum
const (
AggregatedComputedUsageSummaryPricingModelPayAsYouGo AggregatedComputedUsageSummaryPricingModelEnum = "PAY_AS_YOU_GO"
AggregatedComputedUsageSummaryPricingModelMonthly AggregatedComputedUsageSummaryPricingModelEnum = "MONTHLY"
AggregatedComputedUsageSummaryPricingModelAnnual AggregatedComputedUsageSummaryPricingModelEnum = "ANNUAL"
AggregatedComputedUsageSummaryPricingModelPrepaid AggregatedComputedUsageSummaryPricingModelEnum = "PREPAID"
AggregatedComputedUsageSummaryPricingModelFundedAllocation AggregatedComputedUsageSummaryPricingModelEnum = "FUNDED_ALLOCATION"
)
func GetAggregatedComputedUsageSummaryPricingModelEnumValues() []AggregatedComputedUsageSummaryPricingModelEnum
GetAggregatedComputedUsageSummaryPricingModelEnumValues Enumerates the set of values for AggregatedComputedUsageSummaryPricingModelEnum
func GetMappingAggregatedComputedUsageSummaryPricingModelEnum(val string) (AggregatedComputedUsageSummaryPricingModelEnum, bool)
GetMappingAggregatedComputedUsageSummaryPricingModelEnum performs case Insensitive comparison on enum value and return the desired enum
AssociatedSubscriptions Associated Subscriptions
type AssociatedSubscriptions struct {
// Subscription Number
SubscriptionNumber *string `mandatory:"false" json:"subscriptionNumber"`
// Represents the valid from date of the subscription
TimeValidFrom *common.SDKTime `mandatory:"false" json:"timeValidFrom"`
// Represents the valid to date of the subscription
TimeValidTo *common.SDKTime `mandatory:"false" json:"timeValidTo"`
// Lifecycle status of the subscription
LifecycleState *string `mandatory:"false" json:"lifecycleState"`
}
func (m AssociatedSubscriptions) String() string
func (m AssociatedSubscriptions) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BillingScheduleClient a client for BillingSchedule
type BillingScheduleClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewBillingScheduleClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client BillingScheduleClient, err error)
NewBillingScheduleClientWithConfigurationProvider Creates a new default BillingSchedule client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewBillingScheduleClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client BillingScheduleClient, err error)
NewBillingScheduleClientWithOboToken Creates a new default BillingSchedule client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *BillingScheduleClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client BillingScheduleClient) ListBillingSchedules(ctx context.Context, request ListBillingSchedulesRequest) (response ListBillingSchedulesResponse, err error)
ListBillingSchedules This list API returns all billing schedules for a given subscription ID, and for a particular subscribed service if provided.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListBillingSchedules.go.html to see an example of how to use ListBillingSchedules API.
func (client *BillingScheduleClient) SetRegion(region string)
SetRegion overrides the region of this client.
BillingScheduleProduct Product description.
type BillingScheduleProduct struct {
// Indicates the associated accounts receivable invoice number.
PartNumber *string `mandatory:"true" json:"partNumber"`
// Product name.
Name *string `mandatory:"true" json:"name"`
}
func (m BillingScheduleProduct) String() string
func (m BillingScheduleProduct) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BillingScheduleSummary Billing schedule details related to subscription ID.
type BillingScheduleSummary struct {
// SPM (Subscription Plan Management) internal subscribed service ID.
SubscribedServiceId *string `mandatory:"false" json:"subscribedServiceId"`
// Billing schedule start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Billing schedule end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Billing schedule invoicing date.
TimeInvoicing *common.SDKTime `mandatory:"false" json:"timeInvoicing"`
// Billing schedule invoice status.
InvoiceStatus BillingScheduleSummaryInvoiceStatusEnum `mandatory:"false" json:"invoiceStatus,omitempty"`
// Billing schedule quantity.
Quantity *string `mandatory:"false" json:"quantity"`
// Billing schedule net unit price.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Billing schedule line net amount.
Amount *string `mandatory:"false" json:"amount"`
// Billing frequency.
BillingFrequency *string `mandatory:"false" json:"billingFrequency"`
// Indicates the associated accounts receivable invoice number.
ArInvoiceNumber *string `mandatory:"false" json:"arInvoiceNumber"`
// Indicates the associated accounts receivable customer transaction ID, which is a unique identifier existing on the accounts receivable.
ArCustomerTransactionId *string `mandatory:"false" json:"arCustomerTransactionId"`
// Order number associated with the subscribed service.
OrderNumber *string `mandatory:"false" json:"orderNumber"`
Product *BillingScheduleProduct `mandatory:"false" json:"product"`
}
func (m BillingScheduleSummary) String() string
func (m BillingScheduleSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
BillingScheduleSummaryInvoiceStatusEnum Enum with underlying type: string
type BillingScheduleSummaryInvoiceStatusEnum string
Set of constants representing the allowable values for BillingScheduleSummaryInvoiceStatusEnum
const (
BillingScheduleSummaryInvoiceStatusInvoiced BillingScheduleSummaryInvoiceStatusEnum = "INVOICED"
BillingScheduleSummaryInvoiceStatusNotInvoiced BillingScheduleSummaryInvoiceStatusEnum = "NOT_INVOICED"
)
func GetBillingScheduleSummaryInvoiceStatusEnumValues() []BillingScheduleSummaryInvoiceStatusEnum
GetBillingScheduleSummaryInvoiceStatusEnumValues Enumerates the set of values for BillingScheduleSummaryInvoiceStatusEnum
func GetMappingBillingScheduleSummaryInvoiceStatusEnum(val string) (BillingScheduleSummaryInvoiceStatusEnum, bool)
GetMappingBillingScheduleSummaryInvoiceStatusEnum performs case Insensitive comparison on enum value and return the desired enum
Commitment Subscribed service commitment summary.
type Commitment struct {
// SPM (Subscription Plan Management) internal commitment ID.
Id *string `mandatory:"true" json:"id"`
// SPM internal subscribed service ID.
SubscribedServiceId *string `mandatory:"false" json:"subscribedServiceId"`
// Commitment start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Commitment end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Commitment quantity.
Quantity *string `mandatory:"false" json:"quantity"`
// Commitment used amount.
UsedAmount *string `mandatory:"false" json:"usedAmount"`
// Commitment available amount.
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Funded allocation line value.
// Example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
}
func (m Commitment) String() string
func (m Commitment) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CommitmentClient a client for Commitment
type CommitmentClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewCommitmentClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client CommitmentClient, err error)
NewCommitmentClientWithConfigurationProvider Creates a new default Commitment client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewCommitmentClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client CommitmentClient, err error)
NewCommitmentClientWithOboToken Creates a new default Commitment client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *CommitmentClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client CommitmentClient) GetCommitment(ctx context.Context, request GetCommitmentRequest) (response GetCommitmentResponse, err error)
GetCommitment Returns the commitment details corresponding to the provided ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetCommitment.go.html to see an example of how to use GetCommitment API.
func (client CommitmentClient) ListCommitments(ctx context.Context, request ListCommitmentsRequest) (response ListCommitmentsResponse, err error)
ListCommitments Returns all commitments for a particular subscribed service.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListCommitments.go.html to see an example of how to use ListCommitments API.
func (client *CommitmentClient) SetRegion(region string)
SetRegion overrides the region of this client.
CommitmentPeriod Commitment period for the subscription.
type CommitmentPeriod struct {
// Identifier for the commitment period.
CommitmentPeriod *string `mandatory:"false" json:"commitmentPeriod"`
// Start date and time of the commitment period.
TimeCommitmentPeriodStart *common.SDKTime `mandatory:"false" json:"timeCommitmentPeriodStart"`
// End date and time of the commitment period.
TimeCommitmentPeriodEnd *common.SDKTime `mandatory:"false" json:"timeCommitmentPeriodEnd"`
// Total committed amount for the commitment period.
AmountCommitment *float64 `mandatory:"false" json:"amountCommitment"`
// Amount consumed during the commitment period.
AmountConsumed *float64 `mandatory:"false" json:"amountConsumed"`
// Amount remaining and available for the commitment period.
AmountAvailable *float64 `mandatory:"false" json:"amountAvailable"`
}
func (m CommitmentPeriod) String() string
func (m CommitmentPeriod) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CommitmentService Subscribed service commitment details.
type CommitmentService struct {
// Commitment start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Commitment end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Commitment quantity.
Quantity *string `mandatory:"false" json:"quantity"`
// Commitment available amount.
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Commitment line net amount.
LineNetAmount *string `mandatory:"false" json:"lineNetAmount"`
// Funded allocation line value.
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
}
func (m CommitmentService) String() string
func (m CommitmentService) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
CommitmentSummary Subscribed service commitment summary.
type CommitmentSummary struct {
// SPM (Subscription Plan Management) internal commitment ID.
Id *string `mandatory:"true" json:"id"`
// SPM internal subscribed service ID.
SubscribedServiceId *string `mandatory:"false" json:"subscribedServiceId"`
// Commitment start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Commitment end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Commitment quantity.
Quantity *string `mandatory:"false" json:"quantity"`
// Commitment used amount.
UsedAmount *string `mandatory:"false" json:"usedAmount"`
// Commitment available amount.
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Funded allocation line value.
// Example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
}
func (m CommitmentSummary) String() string
func (m CommitmentSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ComputedUsage Computed usage summary object.
type ComputedUsage struct {
// SPM internal computed usage ID, which is a 32-character string.
Id *string `mandatory:"true" json:"id"`
// Computed usage created time, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Computed usage updated time, expressed in RFC 3339 timestamp format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Subscribed service line parent ID.
ParentSubscribedServiceId *string `mandatory:"false" json:"parentSubscribedServiceId"`
ParentProduct *ComputedUsageProduct `mandatory:"false" json:"parentProduct"`
// Subscription plan number.
PlanNumber *string `mandatory:"false" json:"planNumber"`
// Currency code.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// References the tier in the rate card for the associated usage (OCI uses the same reference to cross-reference for correctness in CSV Usage Reports), obtained from the OBSCNTR_IPT_PRODUCTTIER entity.
RateCardTierdId *string `mandatory:"false" json:"rateCardTierdId"`
// Ratecard ID at subscribed service level.
RateCardId *string `mandatory:"false" json:"rateCardId"`
// SPM (Subscription Plan Management) internal compute records source.
ComputeSource *string `mandatory:"false" json:"computeSource"`
// Data center attribute as sent by the meterering system to SPM.
DataCenter *string `mandatory:"false" json:"dataCenter"`
// The meterering system identfier sent to SPM. SPM does not transform this attribute and is received as-is.
MqsMessageId *string `mandatory:"false" json:"mqsMessageId"`
// Total quantity that was used for computation.
Quantity *string `mandatory:"false" json:"quantity"`
// SPM internal usage line number identifier in SPM, originating from the metered services entity.
UsageNumber *string `mandatory:"false" json:"usageNumber"`
// SPM internal original usage line number identifier in SPM, originating from the metered services entity.
OriginalUsageNumber *string `mandatory:"false" json:"originalUsageNumber"`
// Subscribed service commitment ID.
CommitmentServiceId *string `mandatory:"false" json:"commitmentServiceId"`
// Invoicing status for the aggregated compute usage.
IsInvoiced *bool `mandatory:"false" json:"isInvoiced"`
// Usage compute type in SPM.
Type ComputedUsageTypeEnum `mandatory:"false" json:"type,omitempty"`
// Usage computation date, expressed in RFC 3339 timestamp format.
TimeOfArrival *common.SDKTime `mandatory:"false" json:"timeOfArrival"`
// Metered service date, expressed in RFC 3339 timestamp format.
TimeMeteredOn *common.SDKTime `mandatory:"false" json:"timeMeteredOn"`
// Net unit price for the product in consideration, price actual.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Computed rounded line amount.
CostRounded *string `mandatory:"false" json:"costRounded"`
// Computed unrounded line Amount.
Cost *string `mandatory:"false" json:"cost"`
Product *ComputedUsageProduct `mandatory:"false" json:"product"`
// Unit of measure.
UnitOfMeasure *string `mandatory:"false" json:"unitOfMeasure"`
}
func (m ComputedUsage) String() string
func (m ComputedUsage) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ComputedUsageAggregation Computed usage aggregation object.
type ComputedUsageAggregation struct {
// Total quantity that was used for computation.
Quantity *string `mandatory:"false" json:"quantity"`
Product *ComputedUsageProduct `mandatory:"false" json:"product"`
// Data center attribute as sent by the meterering system to SPM (Subscription Plan Management).
DataCenter *string `mandatory:"false" json:"dataCenter"`
// Metered service date, expressed in RFC 3339 timestamp format.
TimeMeteredOn *common.SDKTime `mandatory:"false" json:"timeMeteredOn"`
// Net unit price for the product in consideration.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Sum of unrounded computed line amount.
CostUnrounded *string `mandatory:"false" json:"costUnrounded"`
// Sum of rounded computed line amount.
Cost *string `mandatory:"false" json:"cost"`
// Usage compute type in SPM.
Type ComputedUsageAggregationTypeEnum `mandatory:"false" json:"type,omitempty"`
}
func (m ComputedUsageAggregation) String() string
func (m ComputedUsageAggregation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ComputedUsageAggregationTypeEnum Enum with underlying type: string
type ComputedUsageAggregationTypeEnum string
Set of constants representing the allowable values for ComputedUsageAggregationTypeEnum
const (
ComputedUsageAggregationTypePromotion ComputedUsageAggregationTypeEnum = "PROMOTION"
ComputedUsageAggregationTypeDoNotBill ComputedUsageAggregationTypeEnum = "DO_NOT_BILL"
ComputedUsageAggregationTypeUsage ComputedUsageAggregationTypeEnum = "USAGE"
ComputedUsageAggregationTypeCommit ComputedUsageAggregationTypeEnum = "COMMIT"
ComputedUsageAggregationTypeOverage ComputedUsageAggregationTypeEnum = "OVERAGE"
ComputedUsageAggregationTypePayAsYouGo ComputedUsageAggregationTypeEnum = "PAY_AS_YOU_GO"
ComputedUsageAggregationTypeMonthlyMinimum ComputedUsageAggregationTypeEnum = "MONTHLY_MINIMUM"
ComputedUsageAggregationTypeDelayedUsageInvoiceTiming ComputedUsageAggregationTypeEnum = "DELAYED_USAGE_INVOICE_TIMING"
ComputedUsageAggregationTypeDelayedUsageCommitmentExp ComputedUsageAggregationTypeEnum = "DELAYED_USAGE_COMMITMENT_EXP"
ComputedUsageAggregationTypeOnAccountCredit ComputedUsageAggregationTypeEnum = "ON_ACCOUNT_CREDIT"
ComputedUsageAggregationTypeServiceCredit ComputedUsageAggregationTypeEnum = "SERVICE_CREDIT"
ComputedUsageAggregationTypeCommitmentExpiration ComputedUsageAggregationTypeEnum = "COMMITMENT_EXPIRATION"
ComputedUsageAggregationTypeFundedAllocation ComputedUsageAggregationTypeEnum = "FUNDED_ALLOCATION"
ComputedUsageAggregationTypeDonotBillUsagePostTermination ComputedUsageAggregationTypeEnum = "DONOT_BILL_USAGE_POST_TERMINATION"
ComputedUsageAggregationTypeDelayedUsagePostTermination ComputedUsageAggregationTypeEnum = "DELAYED_USAGE_POST_TERMINATION"
)
func GetComputedUsageAggregationTypeEnumValues() []ComputedUsageAggregationTypeEnum
GetComputedUsageAggregationTypeEnumValues Enumerates the set of values for ComputedUsageAggregationTypeEnum
func GetMappingComputedUsageAggregationTypeEnum(val string) (ComputedUsageAggregationTypeEnum, bool)
GetMappingComputedUsageAggregationTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ComputedUsageClient a client for ComputedUsage
type ComputedUsageClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewComputedUsageClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client ComputedUsageClient, err error)
NewComputedUsageClientWithConfigurationProvider Creates a new default ComputedUsage client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewComputedUsageClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client ComputedUsageClient, err error)
NewComputedUsageClientWithOboToken Creates a new default ComputedUsage client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *ComputedUsageClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client ComputedUsageClient) GetComputedUsage(ctx context.Context, request GetComputedUsageRequest) (response GetComputedUsageResponse, err error)
GetComputedUsage Returns computed usage corresponding to the passed ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetComputedUsage.go.html to see an example of how to use GetComputedUsage API.
func (client ComputedUsageClient) ListAggregatedComputedUsages(ctx context.Context, request ListAggregatedComputedUsagesRequest) (response ListAggregatedComputedUsagesResponse, err error)
ListAggregatedComputedUsages Collection API that returns a list of aggregated computed usage details (there can be multiple parent products under a given SubID, each of which is represented under the subscription service line # in SPM).
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListAggregatedComputedUsages.go.html to see an example of how to use ListAggregatedComputedUsages API.
func (client ComputedUsageClient) ListComputedUsages(ctx context.Context, request ListComputedUsagesRequest) (response ListComputedUsagesResponse, err error)
ListComputedUsages Collection API that returns a list of computed usages for the given filters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListComputedUsages.go.html to see an example of how to use ListComputedUsages API.
func (client *ComputedUsageClient) SetRegion(region string)
SetRegion overrides the region of this client.
ComputedUsageProduct Product description.
type ComputedUsageProduct struct {
// Product part number.
PartNumber *string `mandatory:"true" json:"partNumber"`
// Product name.
Name *string `mandatory:"true" json:"name"`
// Unit of measure.
UnitOfMeasure *string `mandatory:"false" json:"unitOfMeasure"`
// Product provisioning group.
ProvisioningGroup *string `mandatory:"false" json:"provisioningGroup"`
// Metered service billing category.
BillingCategory *string `mandatory:"false" json:"billingCategory"`
// Product category.
ProductCategory *string `mandatory:"false" json:"productCategory"`
// Rate card part type of product.
UcmRateCardPartType *string `mandatory:"false" json:"ucmRateCardPartType"`
}
func (m ComputedUsageProduct) String() string
func (m ComputedUsageProduct) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ComputedUsageSummary Computed usage summary object.
type ComputedUsageSummary struct {
// SPM internal computed usage ID, which is a 32-character string.
ComputedUsageId *string `mandatory:"true" json:"computedUsageId"`
// Computed usage created time, expressed in RFC 3339 timestamp format.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// Computed usage updated time, expressed in RFC 3339 timestamp format.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// Subscribed service line parent ID.
ParentSubscribedServiceId *string `mandatory:"false" json:"parentSubscribedServiceId"`
ParentProduct *ComputedUsageProduct `mandatory:"false" json:"parentProduct"`
// Subscription plan number.
PlanNumber *string `mandatory:"false" json:"planNumber"`
// Currency code.
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// References the tier in the rate card for the associated usage (OCI uses the same reference to cross-reference for correctness in CSV Usage Reports), obtained from the OBSCNTR_IPT_PRODUCTTIER entity.
RateCardTierdId *string `mandatory:"false" json:"rateCardTierdId"`
// Rate card ID at the subscribed service level.
RateCardId *string `mandatory:"false" json:"rateCardId"`
// SPM (Subscription Plan Management) internal compute records source.
ComputeSource *string `mandatory:"false" json:"computeSource"`
// Data center attribute as sent by the meterering system to SPM.
DataCenter *string `mandatory:"false" json:"dataCenter"`
// The meterering system identfier sent to SPM. SPM does not transform this attribute and is received as-is.
MqsMessageId *string `mandatory:"false" json:"mqsMessageId"`
// Total quantity that was used for computation.
Quantity *string `mandatory:"false" json:"quantity"`
// SPM internal usage line number identifier in SPM, originating from the metered services entity.
UsageNumber *string `mandatory:"false" json:"usageNumber"`
// SPM internal original usage Line number identifier in SPM, originating from the metered services entity.
OriginalUsageNumber *string `mandatory:"false" json:"originalUsageNumber"`
// Subscribed service commitment ID.
CommitmentServiceId *string `mandatory:"false" json:"commitmentServiceId"`
// Invoicing status for the aggregated compute usage.
IsInvoiced *bool `mandatory:"false" json:"isInvoiced"`
// Usage compute type in SPM.
Type ComputedUsageSummaryTypeEnum `mandatory:"false" json:"type,omitempty"`
// Usage computation date, expressed in RFC 3339 timestamp format.
TimeOfArrival *common.SDKTime `mandatory:"false" json:"timeOfArrival"`
// Metered service date, expressed in RFC 3339 timestamp format.
TimeMeteredOn *common.SDKTime `mandatory:"false" json:"timeMeteredOn"`
// Net unit price for the product in consideration, price actual.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Computed rounded line amount.
CostRounded *string `mandatory:"false" json:"costRounded"`
// Computed unrounded line amount.
Cost *string `mandatory:"false" json:"cost"`
Product *ComputedUsageProduct `mandatory:"false" json:"product"`
// Unit of measure.
UnitOfMeasure *string `mandatory:"false" json:"unitOfMeasure"`
}
func (m ComputedUsageSummary) String() string
func (m ComputedUsageSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ComputedUsageSummaryTypeEnum Enum with underlying type: string
type ComputedUsageSummaryTypeEnum string
Set of constants representing the allowable values for ComputedUsageSummaryTypeEnum
const (
ComputedUsageSummaryTypePromotion ComputedUsageSummaryTypeEnum = "PROMOTION"
ComputedUsageSummaryTypeDoNotBill ComputedUsageSummaryTypeEnum = "DO_NOT_BILL"
ComputedUsageSummaryTypeUsage ComputedUsageSummaryTypeEnum = "USAGE"
ComputedUsageSummaryTypeCommit ComputedUsageSummaryTypeEnum = "COMMIT"
ComputedUsageSummaryTypeOverage ComputedUsageSummaryTypeEnum = "OVERAGE"
ComputedUsageSummaryTypePayAsYouGo ComputedUsageSummaryTypeEnum = "PAY_AS_YOU_GO"
ComputedUsageSummaryTypeMonthlyMinimum ComputedUsageSummaryTypeEnum = "MONTHLY_MINIMUM"
ComputedUsageSummaryTypeDelayedUsageInvoiceTiming ComputedUsageSummaryTypeEnum = "DELAYED_USAGE_INVOICE_TIMING"
ComputedUsageSummaryTypeDelayedUsageCommitmentExp ComputedUsageSummaryTypeEnum = "DELAYED_USAGE_COMMITMENT_EXP"
ComputedUsageSummaryTypeOnAccountCredit ComputedUsageSummaryTypeEnum = "ON_ACCOUNT_CREDIT"
ComputedUsageSummaryTypeServiceCredit ComputedUsageSummaryTypeEnum = "SERVICE_CREDIT"
ComputedUsageSummaryTypeCommitmentExpiration ComputedUsageSummaryTypeEnum = "COMMITMENT_EXPIRATION"
ComputedUsageSummaryTypeFundedAllocation ComputedUsageSummaryTypeEnum = "FUNDED_ALLOCATION"
ComputedUsageSummaryTypeDonotBillUsagePostTermination ComputedUsageSummaryTypeEnum = "DONOT_BILL_USAGE_POST_TERMINATION"
ComputedUsageSummaryTypeDelayedUsagePostTermination ComputedUsageSummaryTypeEnum = "DELAYED_USAGE_POST_TERMINATION"
)
func GetComputedUsageSummaryTypeEnumValues() []ComputedUsageSummaryTypeEnum
GetComputedUsageSummaryTypeEnumValues Enumerates the set of values for ComputedUsageSummaryTypeEnum
func GetMappingComputedUsageSummaryTypeEnum(val string) (ComputedUsageSummaryTypeEnum, bool)
GetMappingComputedUsageSummaryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
ComputedUsageTypeEnum Enum with underlying type: string
type ComputedUsageTypeEnum string
Set of constants representing the allowable values for ComputedUsageTypeEnum
const (
ComputedUsageTypePromotion ComputedUsageTypeEnum = "PROMOTION"
ComputedUsageTypeDoNotBill ComputedUsageTypeEnum = "DO_NOT_BILL"
ComputedUsageTypeUsage ComputedUsageTypeEnum = "USAGE"
ComputedUsageTypeCommit ComputedUsageTypeEnum = "COMMIT"
ComputedUsageTypeOverage ComputedUsageTypeEnum = "OVERAGE"
ComputedUsageTypePayAsYouGo ComputedUsageTypeEnum = "PAY_AS_YOU_GO"
ComputedUsageTypeMonthlyMinimum ComputedUsageTypeEnum = "MONTHLY_MINIMUM"
ComputedUsageTypeDelayedUsageInvoiceTiming ComputedUsageTypeEnum = "DELAYED_USAGE_INVOICE_TIMING"
ComputedUsageTypeDelayedUsageCommitmentExp ComputedUsageTypeEnum = "DELAYED_USAGE_COMMITMENT_EXP"
ComputedUsageTypeOnAccountCredit ComputedUsageTypeEnum = "ON_ACCOUNT_CREDIT"
ComputedUsageTypeServiceCredit ComputedUsageTypeEnum = "SERVICE_CREDIT"
ComputedUsageTypeCommitmentExpiration ComputedUsageTypeEnum = "COMMITMENT_EXPIRATION"
ComputedUsageTypeFundedAllocation ComputedUsageTypeEnum = "FUNDED_ALLOCATION"
ComputedUsageTypeDonotBillUsagePostTermination ComputedUsageTypeEnum = "DONOT_BILL_USAGE_POST_TERMINATION"
ComputedUsageTypeDelayedUsagePostTermination ComputedUsageTypeEnum = "DELAYED_USAGE_POST_TERMINATION"
)
func GetComputedUsageTypeEnumValues() []ComputedUsageTypeEnum
GetComputedUsageTypeEnumValues Enumerates the set of values for ComputedUsageTypeEnum
func GetMappingComputedUsageTypeEnum(val string) (ComputedUsageTypeEnum, bool)
GetMappingComputedUsageTypeEnum performs case Insensitive comparison on enum value and return the desired enum
GetCommitmentRequest wrapper for the GetCommitment operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetCommitment.go.html to see an example of how to use GetCommitmentRequest.
type GetCommitmentRequest struct {
// The commitment ID.
CommitmentId *string `mandatory:"true" contributesTo:"path" name:"commitmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetCommitmentRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetCommitmentRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetCommitmentRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetCommitmentRequest) String() string
func (request GetCommitmentRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetCommitmentResponse wrapper for the GetCommitment operation
type GetCommitmentResponse struct {
// The underlying http response
RawResponse *http.Response
// The Commitment instance
Commitment `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetCommitmentResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetCommitmentResponse) String() string
GetComputedUsageRequest wrapper for the GetComputedUsage operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetComputedUsage.go.html to see an example of how to use GetComputedUsageRequest.
type GetComputedUsageRequest struct {
// The computed usage ID.
ComputedUsageId *string `mandatory:"true" contributesTo:"path" name:"computedUsageId"`
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Partial response refers to an optimization technique offered
// by the RESTful web APIs, to return only the information
// (fields) required by the client. This parameter controls which fields to
// return.
Fields []string `contributesTo:"query" name:"fields" collectionFormat:"multi"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetComputedUsageRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetComputedUsageRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetComputedUsageRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetComputedUsageRequest) String() string
func (request GetComputedUsageRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetComputedUsageResponse wrapper for the GetComputedUsage operation
type GetComputedUsageResponse struct {
// The underlying http response
RawResponse *http.Response
// The ComputedUsage instance
ComputedUsage `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetComputedUsageResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetComputedUsageResponse) String() string
GetSubscribedServiceRequest wrapper for the GetSubscribedService operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetSubscribedService.go.html to see an example of how to use GetSubscribedServiceRequest.
type GetSubscribedServiceRequest struct {
// The subscribed service ID.
SubscribedServiceId *string `mandatory:"true" contributesTo:"path" name:"subscribedServiceId"`
// Partial response refers to an optimization technique offered
// by the RESTful web APIs, to return only the information
// (fields) required by the client. In this mechanism, the client
// sends the required field names as the query parameters for
// an API to the server, and the server trims down the default
// response content by removing the fields that are not required
// by the client. The parameter used to control which fields to
// return should be a query string parameter called "fields", of
// an array type, and use collectionFormat.
Fields []string `contributesTo:"query" name:"fields" collectionFormat:"multi"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSubscribedServiceRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscribedServiceRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscribedServiceRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscribedServiceRequest) String() string
func (request GetSubscribedServiceRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSubscribedServiceResponse wrapper for the GetSubscribedService operation
type GetSubscribedServiceResponse struct {
// The underlying http response
RawResponse *http.Response
// The SubscribedService instance
SubscribedService `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSubscribedServiceResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscribedServiceResponse) String() string
GetSubscriptionDetailsRequest wrapper for the GetSubscriptionDetails operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetSubscriptionDetails.go.html to see an example of how to use GetSubscriptionDetailsRequest.
type GetSubscriptionDetailsRequest struct {
// Subscription identifier.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request GetSubscriptionDetailsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request GetSubscriptionDetailsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request GetSubscriptionDetailsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request GetSubscriptionDetailsRequest) String() string
func (request GetSubscriptionDetailsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
GetSubscriptionDetailsResponse wrapper for the GetSubscriptionDetails operation
type GetSubscriptionDetailsResponse struct {
// The underlying http response
RawResponse *http.Response
// The SubscriptionDetails instance
SubscriptionDetails `presentIn:"body"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response GetSubscriptionDetailsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response GetSubscriptionDetailsResponse) String() string
InvoiceLineSummary Invoice line.
type InvoiceLineSummary struct {
// SPM (Subscription Plan Management) invoice line internal identifier.
Id *string `mandatory:"true" json:"id"`
Product *InvoicingProduct `mandatory:"true" json:"product"`
// Data center attribute.
DataCenter *string `mandatory:"true" json:"dataCenter"`
// Usage start time.
TimeStart *common.SDKTime `mandatory:"true" json:"timeStart"`
// Usage end time.
TimeEnd *common.SDKTime `mandatory:"true" json:"timeEnd"`
// Accounts receivable invoice number for invoice line.
ArInvoiceNumber *string `mandatory:"false" json:"arInvoiceNumber"`
}
func (m InvoiceLineSummary) String() string
func (m InvoiceLineSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoiceSummary Invoice details.
type InvoiceSummary struct {
// SPM (Subscription Plan Management) document number is a functional identifier for invoicing in SPM.
SpmInvoiceNumber *string `mandatory:"true" json:"spmInvoiceNumber"`
BillToCustomer *InvoicingBusinessPartner `mandatory:"true" json:"billToCustomer"`
BillToContact *InvoicingUser `mandatory:"true" json:"billToContact"`
BillToAddress *InvoicingAddress `mandatory:"true" json:"billToAddress"`
// Payment method.
PaymentMethod *string `mandatory:"true" json:"paymentMethod"`
PaymentTerm *InvoicingPaymentTerm `mandatory:"true" json:"paymentTerm"`
Currency *InvoicingCurrency `mandatory:"true" json:"currency"`
Organization *InvoicingOrganization `mandatory:"true" json:"organization"`
// Document type in SPM, such as SPM Invoice, SPM Credit Memo, and so on.
Type *string `mandatory:"true" json:"type"`
// Document status in SPM, which depicts the current invoice state.
Status *string `mandatory:"true" json:"status"`
// Invoice associated subscription plan number.
SubscriptionNumber *string `mandatory:"true" json:"subscriptionNumber"`
// Invoice date.
TimeInvoiceDate *common.SDKTime `mandatory:"true" json:"timeInvoiceDate"`
// Accounts receivable invoice numbers, comma-separated under one invoice.
ArInvoices *string `mandatory:"false" json:"arInvoices"`
// Receipt method of payment mode.
ReceiptMethod *string `mandatory:"false" json:"receiptMethod"`
// SPM invocie creation date.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// User that executed the SPM invoice process.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// SPM invoice updated date.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// User that updated the SPM invoice.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// Invoice lines under a particular invoice.
InvoiceLines []InvoiceLineSummary `mandatory:"false" json:"invoiceLines"`
}
func (m InvoiceSummary) String() string
func (m InvoiceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoiceSummaryClient a client for InvoiceSummary
type InvoiceSummaryClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewInvoiceSummaryClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client InvoiceSummaryClient, err error)
NewInvoiceSummaryClientWithConfigurationProvider Creates a new default InvoiceSummary client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewInvoiceSummaryClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client InvoiceSummaryClient, err error)
NewInvoiceSummaryClientWithOboToken Creates a new default InvoiceSummary client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *InvoiceSummaryClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client InvoiceSummaryClient) ListInvoicelineComputedUsages(ctx context.Context, request ListInvoicelineComputedUsagesRequest) (response ListInvoicelineComputedUsagesResponse, err error)
ListInvoicelineComputedUsages Collection API that returns a list of invoiced computed usages for the given invoice line ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListInvoicelineComputedUsages.go.html to see an example of how to use ListInvoicelineComputedUsages API.
func (client InvoiceSummaryClient) ListInvoices(ctx context.Context, request ListInvoicesRequest) (response ListInvoicesResponse, err error)
ListInvoices Collection API that returns a list of invoices according to the given filters.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListInvoices.go.html to see an example of how to use ListInvoices API.
func (client *InvoiceSummaryClient) SetRegion(region string)
SetRegion overrides the region of this client.
InvoicelineComputedUsageSummary Computed usage summary object.
type InvoicelineComputedUsageSummary struct {
ParentProduct *InvoicingProduct `mandatory:"true" json:"parentProduct"`
// Total quantity that was used for computation.
Quantity *float64 `mandatory:"true" json:"quantity"`
// Net unit price for the product in consideration, price actual.
NetUnitPrice *float64 `mandatory:"true" json:"netUnitPrice"`
// Metered service date.
TimeMeteredOn *common.SDKTime `mandatory:"true" json:"timeMeteredOn"`
// Usage compute type in SPM (Subscription Plan Management).
Type InvoicelineComputedUsageSummaryTypeEnum `mandatory:"true" json:"type"`
// Computed rounded line amount.
CostRounded *float64 `mandatory:"true" json:"costRounded"`
Product *InvoicingProduct `mandatory:"false" json:"product"`
// Sum of usage/service billing line net amount.
Cost *float64 `mandatory:"false" json:"cost"`
}
func (m InvoicelineComputedUsageSummary) String() string
func (m InvoicelineComputedUsageSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicelineComputedUsageSummaryTypeEnum Enum with underlying type: string
type InvoicelineComputedUsageSummaryTypeEnum string
Set of constants representing the allowable values for InvoicelineComputedUsageSummaryTypeEnum
const (
InvoicelineComputedUsageSummaryTypePromotion InvoicelineComputedUsageSummaryTypeEnum = "PROMOTION"
InvoicelineComputedUsageSummaryTypeDoNotBill InvoicelineComputedUsageSummaryTypeEnum = "DO_NOT_BILL"
InvoicelineComputedUsageSummaryTypeUsage InvoicelineComputedUsageSummaryTypeEnum = "USAGE"
InvoicelineComputedUsageSummaryTypeCommit InvoicelineComputedUsageSummaryTypeEnum = "COMMIT"
InvoicelineComputedUsageSummaryTypeOverage InvoicelineComputedUsageSummaryTypeEnum = "OVERAGE"
InvoicelineComputedUsageSummaryTypePayAsYouGo InvoicelineComputedUsageSummaryTypeEnum = "PAY_AS_YOU_GO"
InvoicelineComputedUsageSummaryTypeMonthlyMinimum InvoicelineComputedUsageSummaryTypeEnum = "MONTHLY_MINIMUM"
InvoicelineComputedUsageSummaryTypeDelayedUsageInvoiceTiming InvoicelineComputedUsageSummaryTypeEnum = "DELAYED_USAGE_INVOICE_TIMING"
InvoicelineComputedUsageSummaryTypeDelayedUsageCommitmentExp InvoicelineComputedUsageSummaryTypeEnum = "DELAYED_USAGE_COMMITMENT_EXP"
InvoicelineComputedUsageSummaryTypeOnAccountCredit InvoicelineComputedUsageSummaryTypeEnum = "ON_ACCOUNT_CREDIT"
InvoicelineComputedUsageSummaryTypeServiceCredit InvoicelineComputedUsageSummaryTypeEnum = "SERVICE_CREDIT"
)
func GetInvoicelineComputedUsageSummaryTypeEnumValues() []InvoicelineComputedUsageSummaryTypeEnum
GetInvoicelineComputedUsageSummaryTypeEnumValues Enumerates the set of values for InvoicelineComputedUsageSummaryTypeEnum
func GetMappingInvoicelineComputedUsageSummaryTypeEnum(val string) (InvoicelineComputedUsageSummaryTypeEnum, bool)
GetMappingInvoicelineComputedUsageSummaryTypeEnum performs case Insensitive comparison on enum value and return the desired enum
InvoicingAddress Address.
type InvoicingAddress struct {
Location *InvoicingLocation `mandatory:"false" json:"location"`
// Address name identifier.
Name *string `mandatory:"false" json:"name"`
// Phone.
Phone *string `mandatory:"false" json:"phone"`
// Identify as the customer's billing address.
IsBillTo *bool `mandatory:"false" json:"isBillTo"`
// Identify as the customer's shipping address.
IsShipTo *bool `mandatory:"false" json:"isShipTo"`
// Bill to site use ID.
BillSiteUseId *int64 `mandatory:"false" json:"billSiteUseId"`
// Service to site use ID.
Service2SiteUseId *int64 `mandatory:"false" json:"service2SiteUseId"`
// TCA (Trading Community Architecture) customer account site ID.
TcaCustAcctSiteId *int64 `mandatory:"false" json:"tcaCustAcctSiteId"`
// Party site number.
TcaPartySiteNumber *string `mandatory:"false" json:"tcaPartySiteNumber"`
}
func (m InvoicingAddress) String() string
func (m InvoicingAddress) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicingBusinessPartner Business partner.
type InvoicingBusinessPartner struct {
// Commercial name, also referred to as customer name.
Name *string `mandatory:"false" json:"name"`
// Phonetic name.
NamePhonetic *string `mandatory:"false" json:"namePhonetic"`
// TCA (Trading Community Architecture) customer account number.
TcaCustomerAccountNumber *string `mandatory:"false" json:"tcaCustomerAccountNumber"`
// Specifies whether or not the business partner is part of the public sector.
IsPublicSector *bool `mandatory:"false" json:"isPublicSector"`
// Specifies whether or not the business partner is a chain customer.
IsChainCustomer *bool `mandatory:"false" json:"isChainCustomer"`
// Customer chain type.
CustomerChainType *string `mandatory:"false" json:"customerChainType"`
// TCA party number.
TcaPartyNumber *string `mandatory:"false" json:"tcaPartyNumber"`
// TCA party ID.
TcaPartyId *int64 `mandatory:"false" json:"tcaPartyId"`
// TCA customer account ID.
TcaCustomerAccountId *int64 `mandatory:"false" json:"tcaCustomerAccountId"`
}
func (m InvoicingBusinessPartner) String() string
func (m InvoicingBusinessPartner) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicingCurrency Currency details.
type InvoicingCurrency struct {
// Currency code.
IsoCode *string `mandatory:"true" json:"isoCode"`
// Currency name.
Name *string `mandatory:"false" json:"name"`
// Standard precision of the currency.
StdPrecision *int64 `mandatory:"false" json:"stdPrecision"`
}
func (m InvoicingCurrency) String() string
func (m InvoicingCurrency) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicingLocation Address location.
type InvoicingLocation struct {
// Address first line.
Address1 *string `mandatory:"false" json:"address1"`
// Address second line.
Address2 *string `mandatory:"false" json:"address2"`
// Postal code.
PostalCode *string `mandatory:"false" json:"postalCode"`
// City.
City *string `mandatory:"false" json:"city"`
// Country.
Country *string `mandatory:"false" json:"country"`
// Region.
Region *string `mandatory:"false" json:"region"`
// TCA (Trading Community Architecture) location identifier.
TcaLocationId *int64 `mandatory:"false" json:"tcaLocationId"`
}
func (m InvoicingLocation) String() string
func (m InvoicingLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicingOrganization Organization details.
type InvoicingOrganization struct {
// Organization name.
Name *string `mandatory:"true" json:"name"`
// Organization ID.
Number *float64 `mandatory:"true" json:"number"`
}
func (m InvoicingOrganization) String() string
func (m InvoicingOrganization) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicingPaymentTerm Payment term details.
type InvoicingPaymentTerm struct {
// Payment term name.
Name *string `mandatory:"true" json:"name"`
// Payment term value.
Value *string `mandatory:"false" json:"value"`
// Payment term description.
Description *string `mandatory:"false" json:"description"`
// Payment term active parameter.
IsActive *bool `mandatory:"false" json:"isActive"`
// Payment term last update date.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// User that created the payment term.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Payment term last update date.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// User that updated the payment term.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
}
func (m InvoicingPaymentTerm) String() string
func (m InvoicingPaymentTerm) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicingProduct Product description.
type InvoicingProduct struct {
// Product part number.
PartNumber *string `mandatory:"true" json:"partNumber"`
// Product name.
Name *string `mandatory:"true" json:"name"`
// Unit of measure.
UnitOfMeasure *string `mandatory:"true" json:"unitOfMeasure"`
// Rate card part type of product.
UcmRateCardPartType *string `mandatory:"true" json:"ucmRateCardPartType"`
// Metered service billing category.
BillingCategory *string `mandatory:"false" json:"billingCategory"`
// Product category.
ProductCategory *string `mandatory:"false" json:"productCategory"`
}
func (m InvoicingProduct) String() string
func (m InvoicingProduct) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
InvoicingUser User.
type InvoicingUser struct {
// Name.
Name *string `mandatory:"false" json:"name"`
// User name.
UserName *string `mandatory:"false" json:"userName"`
// First name.
FirstName *string `mandatory:"false" json:"firstName"`
// Last name.
LastName *string `mandatory:"false" json:"lastName"`
// Email.
Email *string `mandatory:"false" json:"email"`
// TCA (Trading Community Architecture) contact ID.
TcaContactId *int64 `mandatory:"false" json:"tcaContactId"`
// TCA customer account site ID.
TcaCustAccntSiteId *int64 `mandatory:"false" json:"tcaCustAccntSiteId"`
// TCA party ID.
TcaPartyId *int64 `mandatory:"false" json:"tcaPartyId"`
}
func (m InvoicingUser) String() string
func (m InvoicingUser) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAggregatedComputedUsagesGroupingEnum Enum with underlying type: string
type ListAggregatedComputedUsagesGroupingEnum string
Set of constants representing the allowable values for ListAggregatedComputedUsagesGroupingEnum
const (
ListAggregatedComputedUsagesGroupingHourly ListAggregatedComputedUsagesGroupingEnum = "HOURLY"
ListAggregatedComputedUsagesGroupingDaily ListAggregatedComputedUsagesGroupingEnum = "DAILY"
ListAggregatedComputedUsagesGroupingMonthly ListAggregatedComputedUsagesGroupingEnum = "MONTHLY"
ListAggregatedComputedUsagesGroupingNone ListAggregatedComputedUsagesGroupingEnum = "NONE"
)
func GetListAggregatedComputedUsagesGroupingEnumValues() []ListAggregatedComputedUsagesGroupingEnum
GetListAggregatedComputedUsagesGroupingEnumValues Enumerates the set of values for ListAggregatedComputedUsagesGroupingEnum
func GetMappingListAggregatedComputedUsagesGroupingEnum(val string) (ListAggregatedComputedUsagesGroupingEnum, bool)
GetMappingListAggregatedComputedUsagesGroupingEnum performs case Insensitive comparison on enum value and return the desired enum
ListAggregatedComputedUsagesRequest wrapper for the ListAggregatedComputedUsages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListAggregatedComputedUsages.go.html to see an example of how to use ListAggregatedComputedUsagesRequest.
type ListAggregatedComputedUsagesRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Subscription ID is an identifier associated with the service, used for filtering the computed usage in SPM.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// Initial date to filter computed usage data in SPM. For non-aggregated data, the time period between fromDate and toDate, expressed in RFC 3339 timestamp format.
TimeFrom *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeFrom"`
// Final date to filter computed usage data in SPM, expressed in RFC 3339 timestamp format.
TimeTo *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeTo"`
// Product part number for the subscribed service line, referred to as the parent product.
ParentProduct *string `mandatory:"false" contributesTo:"query" name:"parentProduct"`
// Grouping criteria to use for aggregating the computed usage, whether hourly (`HOURLY`), daily (`DAILY`), monthly (`MONTHLY`), or none (`NONE`), so as not to follow a grouping criteria by date.
Grouping ListAggregatedComputedUsagesGroupingEnum `mandatory:"false" contributesTo:"query" name:"grouping" omitEmpty:"true"`
// The maximum number of aggregatedComputedUsages items to return within the Subscription "List" call, this
// counts the overall count across all items.
// Example: `500`
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListAggregatedComputedUsagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListAggregatedComputedUsagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListAggregatedComputedUsagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListAggregatedComputedUsagesRequest) String() string
func (request ListAggregatedComputedUsagesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListAggregatedComputedUsagesResponse wrapper for the ListAggregatedComputedUsages operation
type ListAggregatedComputedUsagesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []AggregatedComputedUsageSummary instances
Items []AggregatedComputedUsageSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListAggregatedComputedUsagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListAggregatedComputedUsagesResponse) String() string
ListBillingSchedulesRequest wrapper for the ListBillingSchedules operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListBillingSchedules.go.html to see an example of how to use ListBillingSchedulesRequest.
type ListBillingSchedulesRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// This parameter gets the billing schedules for a particular subscription ID.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// This parameter gets the billing schedules for a particular subscribed service.
SubscribedServiceId *string `mandatory:"false" contributesTo:"query" name:"subscribedServiceId"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListBillingSchedulesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order ('sortOrder').
SortBy ListBillingSchedulesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListBillingSchedulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListBillingSchedulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListBillingSchedulesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListBillingSchedulesRequest) String() string
func (request ListBillingSchedulesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListBillingSchedulesResponse wrapper for the ListBillingSchedules operation
type ListBillingSchedulesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []BillingScheduleSummary instances
Items []BillingScheduleSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the 'page' parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListBillingSchedulesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListBillingSchedulesResponse) String() string
ListBillingSchedulesSortByEnum Enum with underlying type: string
type ListBillingSchedulesSortByEnum string
Set of constants representing the allowable values for ListBillingSchedulesSortByEnum
const (
ListBillingSchedulesSortByOrdernumber ListBillingSchedulesSortByEnum = "ORDERNUMBER"
ListBillingSchedulesSortByTimeinvoicing ListBillingSchedulesSortByEnum = "TIMEINVOICING"
)
func GetListBillingSchedulesSortByEnumValues() []ListBillingSchedulesSortByEnum
GetListBillingSchedulesSortByEnumValues Enumerates the set of values for ListBillingSchedulesSortByEnum
func GetMappingListBillingSchedulesSortByEnum(val string) (ListBillingSchedulesSortByEnum, bool)
GetMappingListBillingSchedulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListBillingSchedulesSortOrderEnum Enum with underlying type: string
type ListBillingSchedulesSortOrderEnum string
Set of constants representing the allowable values for ListBillingSchedulesSortOrderEnum
const (
ListBillingSchedulesSortOrderAsc ListBillingSchedulesSortOrderEnum = "ASC"
ListBillingSchedulesSortOrderDesc ListBillingSchedulesSortOrderEnum = "DESC"
)
func GetListBillingSchedulesSortOrderEnumValues() []ListBillingSchedulesSortOrderEnum
GetListBillingSchedulesSortOrderEnumValues Enumerates the set of values for ListBillingSchedulesSortOrderEnum
func GetMappingListBillingSchedulesSortOrderEnum(val string) (ListBillingSchedulesSortOrderEnum, bool)
GetMappingListBillingSchedulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListCommitmentsRequest wrapper for the ListCommitments operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListCommitments.go.html to see an example of how to use ListCommitmentsRequest.
type ListCommitmentsRequest struct {
// Obtains the commitments for a particular subscribed service.
SubscribedServiceId *string `mandatory:"true" contributesTo:"query" name:"subscribedServiceId"`
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListCommitmentsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order ('sortOrder').
SortBy ListCommitmentsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListCommitmentsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListCommitmentsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListCommitmentsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListCommitmentsRequest) String() string
func (request ListCommitmentsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListCommitmentsResponse wrapper for the ListCommitments operation
type ListCommitmentsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []CommitmentSummary instances
Items []CommitmentSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListCommitmentsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListCommitmentsResponse) String() string
ListCommitmentsSortByEnum Enum with underlying type: string
type ListCommitmentsSortByEnum string
Set of constants representing the allowable values for ListCommitmentsSortByEnum
const (
ListCommitmentsSortByOrdernumber ListCommitmentsSortByEnum = "ORDERNUMBER"
ListCommitmentsSortByTimeinvoicing ListCommitmentsSortByEnum = "TIMEINVOICING"
)
func GetListCommitmentsSortByEnumValues() []ListCommitmentsSortByEnum
GetListCommitmentsSortByEnumValues Enumerates the set of values for ListCommitmentsSortByEnum
func GetMappingListCommitmentsSortByEnum(val string) (ListCommitmentsSortByEnum, bool)
GetMappingListCommitmentsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListCommitmentsSortOrderEnum Enum with underlying type: string
type ListCommitmentsSortOrderEnum string
Set of constants representing the allowable values for ListCommitmentsSortOrderEnum
const (
ListCommitmentsSortOrderAsc ListCommitmentsSortOrderEnum = "ASC"
ListCommitmentsSortOrderDesc ListCommitmentsSortOrderEnum = "DESC"
)
func GetListCommitmentsSortOrderEnumValues() []ListCommitmentsSortOrderEnum
GetListCommitmentsSortOrderEnumValues Enumerates the set of values for ListCommitmentsSortOrderEnum
func GetMappingListCommitmentsSortOrderEnum(val string) (ListCommitmentsSortOrderEnum, bool)
GetMappingListCommitmentsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListComputedUsagesRequest wrapper for the ListComputedUsages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListComputedUsages.go.html to see an example of how to use ListComputedUsagesRequest.
type ListComputedUsagesRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Subscription ID is an identifier associated with the service, used for filtering the computed usage in SPM.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// Initial date to filter computed usage data in SPM. For non-aggregated data, the time period between fromDate and toDate, expressed in RFC 3339 timestamp format.
TimeFrom *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeFrom"`
// Final date to filter computed usage data in SPM, expressed in RFC 3339 timestamp format.
TimeTo *common.SDKTime `mandatory:"true" contributesTo:"query" name:"timeTo"`
// Product part number for the subscribed service line, called the parent product.
ParentProduct *string `mandatory:"false" contributesTo:"query" name:"parentProduct"`
// Product part number for the computed usage.
ComputedProduct *string `mandatory:"false" contributesTo:"query" name:"computedProduct"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListComputedUsagesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order (`sortOrder`).
SortBy ListComputedUsagesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListComputedUsagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListComputedUsagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListComputedUsagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListComputedUsagesRequest) String() string
func (request ListComputedUsagesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListComputedUsagesResponse wrapper for the ListComputedUsages operation
type ListComputedUsagesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []ComputedUsageSummary instances
Items []ComputedUsageSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListComputedUsagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListComputedUsagesResponse) String() string
ListComputedUsagesSortByEnum Enum with underlying type: string
type ListComputedUsagesSortByEnum string
Set of constants representing the allowable values for ListComputedUsagesSortByEnum
const (
ListComputedUsagesSortByTimecreated ListComputedUsagesSortByEnum = "timeCreated"
ListComputedUsagesSortByTimeofarrival ListComputedUsagesSortByEnum = "timeOfArrival"
ListComputedUsagesSortByTimemeteredon ListComputedUsagesSortByEnum = "timeMeteredOn"
)
func GetListComputedUsagesSortByEnumValues() []ListComputedUsagesSortByEnum
GetListComputedUsagesSortByEnumValues Enumerates the set of values for ListComputedUsagesSortByEnum
func GetMappingListComputedUsagesSortByEnum(val string) (ListComputedUsagesSortByEnum, bool)
GetMappingListComputedUsagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListComputedUsagesSortOrderEnum Enum with underlying type: string
type ListComputedUsagesSortOrderEnum string
Set of constants representing the allowable values for ListComputedUsagesSortOrderEnum
const (
ListComputedUsagesSortOrderAsc ListComputedUsagesSortOrderEnum = "ASC"
ListComputedUsagesSortOrderDesc ListComputedUsagesSortOrderEnum = "DESC"
)
func GetListComputedUsagesSortOrderEnumValues() []ListComputedUsagesSortOrderEnum
GetListComputedUsagesSortOrderEnumValues Enumerates the set of values for ListComputedUsagesSortOrderEnum
func GetMappingListComputedUsagesSortOrderEnum(val string) (ListComputedUsagesSortOrderEnum, bool)
GetMappingListComputedUsagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListInvoicelineComputedUsagesRequest wrapper for the ListInvoicelineComputedUsages operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListInvoicelineComputedUsages.go.html to see an example of how to use ListInvoicelineComputedUsagesRequest.
type ListInvoicelineComputedUsagesRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Invoice line identifier - Primary Key SPM (Subscription Plan Management).
InvoiceLineId *string `mandatory:"true" contributesTo:"query" name:"invoiceLineId"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListInvoicelineComputedUsagesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by invoiced computed usages. You can provide one sort order (`sortOrder`).
SortBy ListInvoicelineComputedUsagesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Partial response refers to an optimization technique offered
// by the RESTful web APIs, to return only the information
// (fields) required by the client. This parameter controls which fields to
// return.
Fields []string `contributesTo:"query" name:"fields" collectionFormat:"multi"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListInvoicelineComputedUsagesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInvoicelineComputedUsagesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInvoicelineComputedUsagesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInvoicelineComputedUsagesRequest) String() string
func (request ListInvoicelineComputedUsagesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListInvoicelineComputedUsagesResponse wrapper for the ListInvoicelineComputedUsages operation
type ListInvoicelineComputedUsagesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []InvoicelineComputedUsageSummary instances
Items []InvoicelineComputedUsageSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListInvoicelineComputedUsagesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInvoicelineComputedUsagesResponse) String() string
ListInvoicelineComputedUsagesSortByEnum Enum with underlying type: string
type ListInvoicelineComputedUsagesSortByEnum string
Set of constants representing the allowable values for ListInvoicelineComputedUsagesSortByEnum
const (
ListInvoicelineComputedUsagesSortByTimecreated ListInvoicelineComputedUsagesSortByEnum = "timeCreated"
ListInvoicelineComputedUsagesSortByMeteredondate ListInvoicelineComputedUsagesSortByEnum = "meteredOnDate"
)
func GetListInvoicelineComputedUsagesSortByEnumValues() []ListInvoicelineComputedUsagesSortByEnum
GetListInvoicelineComputedUsagesSortByEnumValues Enumerates the set of values for ListInvoicelineComputedUsagesSortByEnum
func GetMappingListInvoicelineComputedUsagesSortByEnum(val string) (ListInvoicelineComputedUsagesSortByEnum, bool)
GetMappingListInvoicelineComputedUsagesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListInvoicelineComputedUsagesSortOrderEnum Enum with underlying type: string
type ListInvoicelineComputedUsagesSortOrderEnum string
Set of constants representing the allowable values for ListInvoicelineComputedUsagesSortOrderEnum
const (
ListInvoicelineComputedUsagesSortOrderAsc ListInvoicelineComputedUsagesSortOrderEnum = "ASC"
ListInvoicelineComputedUsagesSortOrderDesc ListInvoicelineComputedUsagesSortOrderEnum = "DESC"
)
func GetListInvoicelineComputedUsagesSortOrderEnumValues() []ListInvoicelineComputedUsagesSortOrderEnum
GetListInvoicelineComputedUsagesSortOrderEnumValues Enumerates the set of values for ListInvoicelineComputedUsagesSortOrderEnum
func GetMappingListInvoicelineComputedUsagesSortOrderEnum(val string) (ListInvoicelineComputedUsagesSortOrderEnum, bool)
GetMappingListInvoicelineComputedUsagesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListInvoicesRequest wrapper for the ListInvoices operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListInvoices.go.html to see an example of how to use ListInvoicesRequest.
type ListInvoicesRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Accounts receivable unique identifier for an invoice.
ArCustomerTransactionId *string `mandatory:"true" contributesTo:"query" name:"arCustomerTransactionId"`
// Initial date to filter invoice data in SPM (Subscription Plan Management).
TimeFrom *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeFrom"`
// Final date to filter invoice data in SPM (Subscription Plan Management).
TimeTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeTo"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListInvoicesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order ('sortOrder').
SortBy ListInvoicesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// Partial response refers to an optimization technique offered
// by the RESTful web APIs, to return only the information
// (fields) required by the client. This parameter controls which fields to
// return.
Fields []string `contributesTo:"query" name:"fields" collectionFormat:"multi"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListInvoicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListInvoicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListInvoicesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListInvoicesRequest) String() string
func (request ListInvoicesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListInvoicesResponse wrapper for the ListInvoices operation
type ListInvoicesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []InvoiceSummary instances
Items []InvoiceSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListInvoicesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListInvoicesResponse) String() string
ListInvoicesSortByEnum Enum with underlying type: string
type ListInvoicesSortByEnum string
Set of constants representing the allowable values for ListInvoicesSortByEnum
const (
ListInvoicesSortByOrdernumber ListInvoicesSortByEnum = "ORDERNUMBER"
ListInvoicesSortByTimeinvoicing ListInvoicesSortByEnum = "TIMEINVOICING"
)
func GetListInvoicesSortByEnumValues() []ListInvoicesSortByEnum
GetListInvoicesSortByEnumValues Enumerates the set of values for ListInvoicesSortByEnum
func GetMappingListInvoicesSortByEnum(val string) (ListInvoicesSortByEnum, bool)
GetMappingListInvoicesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListInvoicesSortOrderEnum Enum with underlying type: string
type ListInvoicesSortOrderEnum string
Set of constants representing the allowable values for ListInvoicesSortOrderEnum
const (
ListInvoicesSortOrderAsc ListInvoicesSortOrderEnum = "ASC"
ListInvoicesSortOrderDesc ListInvoicesSortOrderEnum = "DESC"
)
func GetListInvoicesSortOrderEnumValues() []ListInvoicesSortOrderEnum
GetListInvoicesSortOrderEnumValues Enumerates the set of values for ListInvoicesSortOrderEnum
func GetMappingListInvoicesSortOrderEnum(val string) (ListInvoicesSortOrderEnum, bool)
GetMappingListInvoicesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListOrganizationSubscriptionsRequest wrapper for the ListOrganizationSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListOrganizationSubscriptions.go.html to see an example of how to use ListOrganizationSubscriptionsRequest.
type ListOrganizationSubscriptionsRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListOrganizationSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order ('sortOrder').
SortBy ListOrganizationSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListOrganizationSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListOrganizationSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListOrganizationSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListOrganizationSubscriptionsRequest) String() string
func (request ListOrganizationSubscriptionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListOrganizationSubscriptionsResponse wrapper for the ListOrganizationSubscriptions operation
type ListOrganizationSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []OrganizationSubscriptionSummary instances
Items []OrganizationSubscriptionSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListOrganizationSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListOrganizationSubscriptionsResponse) String() string
ListOrganizationSubscriptionsSortByEnum Enum with underlying type: string
type ListOrganizationSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListOrganizationSubscriptionsSortByEnum
const (
ListOrganizationSubscriptionsSortByOrdernumber ListOrganizationSubscriptionsSortByEnum = "ORDERNUMBER"
ListOrganizationSubscriptionsSortByTimeinvoicing ListOrganizationSubscriptionsSortByEnum = "TIMEINVOICING"
)
func GetListOrganizationSubscriptionsSortByEnumValues() []ListOrganizationSubscriptionsSortByEnum
GetListOrganizationSubscriptionsSortByEnumValues Enumerates the set of values for ListOrganizationSubscriptionsSortByEnum
func GetMappingListOrganizationSubscriptionsSortByEnum(val string) (ListOrganizationSubscriptionsSortByEnum, bool)
GetMappingListOrganizationSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListOrganizationSubscriptionsSortOrderEnum Enum with underlying type: string
type ListOrganizationSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListOrganizationSubscriptionsSortOrderEnum
const (
ListOrganizationSubscriptionsSortOrderAsc ListOrganizationSubscriptionsSortOrderEnum = "ASC"
ListOrganizationSubscriptionsSortOrderDesc ListOrganizationSubscriptionsSortOrderEnum = "DESC"
)
func GetListOrganizationSubscriptionsSortOrderEnumValues() []ListOrganizationSubscriptionsSortOrderEnum
GetListOrganizationSubscriptionsSortOrderEnumValues Enumerates the set of values for ListOrganizationSubscriptionsSortOrderEnum
func GetMappingListOrganizationSubscriptionsSortOrderEnum(val string) (ListOrganizationSubscriptionsSortOrderEnum, bool)
GetMappingListOrganizationSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListRateCardsRequest wrapper for the ListRateCards operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListRateCards.go.html to see an example of how to use ListRateCardsRequest.
type ListRateCardsRequest struct {
// Line-level subscription ID.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Gets the rate cards whose effective start date starts on or after a particular date.
TimeFrom *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeFrom"`
// Gets the rate cards whose effective end date ends on or before a particular date.
TimeTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeTo"`
// Gets the rate cards filterd by the part number.
PartNumber *string `mandatory:"false" contributesTo:"query" name:"partNumber"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListRateCardsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order ('sortOrder').
SortBy ListRateCardsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListRateCardsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListRateCardsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListRateCardsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListRateCardsRequest) String() string
func (request ListRateCardsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListRateCardsResponse wrapper for the ListRateCards operation
type ListRateCardsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []RateCardSummary instances
Items []RateCardSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListRateCardsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListRateCardsResponse) String() string
ListRateCardsSortByEnum Enum with underlying type: string
type ListRateCardsSortByEnum string
Set of constants representing the allowable values for ListRateCardsSortByEnum
const (
ListRateCardsSortByOrdernumber ListRateCardsSortByEnum = "ORDERNUMBER"
ListRateCardsSortByTimeinvoicing ListRateCardsSortByEnum = "TIMEINVOICING"
)
func GetListRateCardsSortByEnumValues() []ListRateCardsSortByEnum
GetListRateCardsSortByEnumValues Enumerates the set of values for ListRateCardsSortByEnum
func GetMappingListRateCardsSortByEnum(val string) (ListRateCardsSortByEnum, bool)
GetMappingListRateCardsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListRateCardsSortOrderEnum Enum with underlying type: string
type ListRateCardsSortOrderEnum string
Set of constants representing the allowable values for ListRateCardsSortOrderEnum
const (
ListRateCardsSortOrderAsc ListRateCardsSortOrderEnum = "ASC"
ListRateCardsSortOrderDesc ListRateCardsSortOrderEnum = "DESC"
)
func GetListRateCardsSortOrderEnumValues() []ListRateCardsSortOrderEnum
GetListRateCardsSortOrderEnumValues Enumerates the set of values for ListRateCardsSortOrderEnum
func GetMappingListRateCardsSortOrderEnum(val string) (ListRateCardsSortOrderEnum, bool)
GetMappingListRateCardsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscribedServicesRequest wrapper for the ListSubscribedServices operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListSubscribedServices.go.html to see an example of how to use ListSubscribedServicesRequest.
type ListSubscribedServicesRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// Line level subscription ID.
SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`
// Order line identifier at subscribed service level. This identifier originates from the order management module. Default is null.
OrderLineId *int64 `mandatory:"false" contributesTo:"query" name:"orderLineId"`
// This parameter filters subscribed services based on its status.
Status *string `mandatory:"false" contributesTo:"query" name:"status"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListSubscribedServicesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order ('sortOrder').
SortBy ListSubscribedServicesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSubscribedServicesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscribedServicesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscribedServicesRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscribedServicesRequest) String() string
func (request ListSubscribedServicesRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSubscribedServicesResponse wrapper for the ListSubscribedServices operation
type ListSubscribedServicesResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []SubscribedServiceSummary instances
Items []SubscribedServiceSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListSubscribedServicesResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscribedServicesResponse) String() string
ListSubscribedServicesSortByEnum Enum with underlying type: string
type ListSubscribedServicesSortByEnum string
Set of constants representing the allowable values for ListSubscribedServicesSortByEnum
const (
ListSubscribedServicesSortByOrdernumber ListSubscribedServicesSortByEnum = "ORDERNUMBER"
ListSubscribedServicesSortByTimeinvoicing ListSubscribedServicesSortByEnum = "TIMEINVOICING"
)
func GetListSubscribedServicesSortByEnumValues() []ListSubscribedServicesSortByEnum
GetListSubscribedServicesSortByEnumValues Enumerates the set of values for ListSubscribedServicesSortByEnum
func GetMappingListSubscribedServicesSortByEnum(val string) (ListSubscribedServicesSortByEnum, bool)
GetMappingListSubscribedServicesSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscribedServicesSortOrderEnum Enum with underlying type: string
type ListSubscribedServicesSortOrderEnum string
Set of constants representing the allowable values for ListSubscribedServicesSortOrderEnum
const (
ListSubscribedServicesSortOrderAsc ListSubscribedServicesSortOrderEnum = "ASC"
ListSubscribedServicesSortOrderDesc ListSubscribedServicesSortOrderEnum = "DESC"
)
func GetListSubscribedServicesSortOrderEnumValues() []ListSubscribedServicesSortOrderEnum
GetListSubscribedServicesSortOrderEnumValues Enumerates the set of values for ListSubscribedServicesSortOrderEnum
func GetMappingListSubscribedServicesSortOrderEnum(val string) (ListSubscribedServicesSortOrderEnum, bool)
GetMappingListSubscribedServicesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsRequest wrapper for the ListSubscriptions operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListSubscriptions.go.html to see an example of how to use ListSubscriptionsRequest.
type ListSubscriptionsRequest struct {
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The plan number.
PlanNumber *string `mandatory:"false" contributesTo:"query" name:"planNumber"`
// Line level subscription ID.
SubscriptionId *string `mandatory:"false" contributesTo:"query" name:"subscriptionId"`
// Buyer email ID.
BuyerEmail *string `mandatory:"false" contributesTo:"query" name:"buyerEmail"`
// Boolean value to determine whether commitment services are shown.
IsCommitInfoRequired *bool `mandatory:"false" contributesTo:"query" name:"isCommitInfoRequired"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The field to sort by. You can provide one sort order ('sortOrder').
SortBy ListSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListSubscriptionsRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListSubscriptionsRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListSubscriptionsRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListSubscriptionsRequest) String() string
func (request ListSubscriptionsRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListSubscriptionsResponse wrapper for the ListSubscriptions operation
type ListSubscriptionsResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []SubscriptionSummary instances
Items []SubscriptionSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListSubscriptionsResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListSubscriptionsResponse) String() string
ListSubscriptionsSortByEnum Enum with underlying type: string
type ListSubscriptionsSortByEnum string
Set of constants representing the allowable values for ListSubscriptionsSortByEnum
const (
ListSubscriptionsSortByOrdernumber ListSubscriptionsSortByEnum = "ORDERNUMBER"
ListSubscriptionsSortByTimeinvoicing ListSubscriptionsSortByEnum = "TIMEINVOICING"
)
func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum
GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum
func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)
GetMappingListSubscriptionsSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListSubscriptionsSortOrderEnum Enum with underlying type: string
type ListSubscriptionsSortOrderEnum string
Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum
const (
ListSubscriptionsSortOrderAsc ListSubscriptionsSortOrderEnum = "ASC"
ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)
func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum
GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum
func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)
GetMappingListSubscriptionsSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsageLedgersRequest wrapper for the ListUsageLedgers operation
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListUsageLedgers.go.html to see an example of how to use ListUsageLedgersRequest.
type ListUsageLedgersRequest struct {
// Subscription identifier.
SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`
// The OCID of the root compartment.
CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`
// The maximum number of items to return in a paginated "List" call. Default: (`50`)
// Example: '500'
Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`
// The value of the 'opc-next-page' response header from the previous "List" call.
Page *string `mandatory:"false" contributesTo:"query" name:"page"`
// The usage-ledger sort order to use, either ascending ('ASC') or descending ('DESC').
SortOrder ListUsageLedgersSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`
// The usage-ledger field to sort by. You can provide one sort order ('sortOrder').
SortBy ListUsageLedgersSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`
// The lower bound of the consumption-date range, expressed in RFC 3339 timestamp format. The value is inclusive (>=).
TimeConsumptionGreaterThanOrEqualTo *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeConsumptionGreaterThanOrEqualTo"`
// The upper bound of the consumption-date range, expressed in RFC 3339 timestamp format. The value is exclusive (<).
TimeConsumptionLessThan *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeConsumptionLessThan"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
OpcRequestId *string `mandatory:"false" contributesTo:"header" name:"opc-request-id"`
// Metadata about the request. This information will not be transmitted to the service, but
// represents information that the SDK will consume to drive retry behavior.
RequestMetadata common.RequestMetadata
}
func (request ListUsageLedgersRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)
BinaryRequestBody implements the OCIRequest interface
func (request ListUsageLedgersRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)
HTTPRequest implements the OCIRequest interface
func (request ListUsageLedgersRequest) RetryPolicy() *common.RetryPolicy
RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.
func (request ListUsageLedgersRequest) String() string
func (request ListUsageLedgersRequest) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ListUsageLedgersResponse wrapper for the ListUsageLedgers operation
type ListUsageLedgersResponse struct {
// The underlying http response
RawResponse *http.Response
// A list of []UsageLedgerSummary instances
Items []UsageLedgerSummary `presentIn:"body"`
// For pagination of a list of items. When paging through a list, if this header appears in the response,
// then a partial list might have been returned. Include this value as the `page` parameter for the
// subsequent GET request to get the next batch of items.
OpcNextPage *string `presentIn:"header" name:"opc-next-page"`
// Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a
// particular request, please provide the request ID.
OpcRequestId *string `presentIn:"header" name:"opc-request-id"`
}
func (response ListUsageLedgersResponse) HTTPResponse() *http.Response
HTTPResponse implements the OCIResponse interface
func (response ListUsageLedgersResponse) String() string
ListUsageLedgersSortByEnum Enum with underlying type: string
type ListUsageLedgersSortByEnum string
Set of constants representing the allowable values for ListUsageLedgersSortByEnum
const (
ListUsageLedgersSortByTimeconsumption ListUsageLedgersSortByEnum = "timeConsumption"
ListUsageLedgersSortByConsumptionamount ListUsageLedgersSortByEnum = "consumptionAmount"
)
func GetListUsageLedgersSortByEnumValues() []ListUsageLedgersSortByEnum
GetListUsageLedgersSortByEnumValues Enumerates the set of values for ListUsageLedgersSortByEnum
func GetMappingListUsageLedgersSortByEnum(val string) (ListUsageLedgersSortByEnum, bool)
GetMappingListUsageLedgersSortByEnum performs case Insensitive comparison on enum value and return the desired enum
ListUsageLedgersSortOrderEnum Enum with underlying type: string
type ListUsageLedgersSortOrderEnum string
Set of constants representing the allowable values for ListUsageLedgersSortOrderEnum
const (
ListUsageLedgersSortOrderAsc ListUsageLedgersSortOrderEnum = "ASC"
ListUsageLedgersSortOrderDesc ListUsageLedgersSortOrderEnum = "DESC"
)
func GetListUsageLedgersSortOrderEnumValues() []ListUsageLedgersSortOrderEnum
GetListUsageLedgersSortOrderEnumValues Enumerates the set of values for ListUsageLedgersSortOrderEnum
func GetMappingListUsageLedgersSortOrderEnum(val string) (ListUsageLedgersSortOrderEnum, bool)
GetMappingListUsageLedgersSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum
OrganizationSubscriptionClient a client for OrganizationSubscription
type OrganizationSubscriptionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewOrganizationSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client OrganizationSubscriptionClient, err error)
NewOrganizationSubscriptionClientWithConfigurationProvider Creates a new default OrganizationSubscription client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewOrganizationSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client OrganizationSubscriptionClient, err error)
NewOrganizationSubscriptionClientWithOboToken Creates a new default OrganizationSubscription client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *OrganizationSubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client OrganizationSubscriptionClient) ListOrganizationSubscriptions(ctx context.Context, request ListOrganizationSubscriptionsRequest) (response ListOrganizationSubscriptionsResponse, err error)
ListOrganizationSubscriptions Returns data for the list of subscription IDs returned from the Organizations API.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListOrganizationSubscriptions.go.html to see an example of how to use ListOrganizationSubscriptions API.
func (client *OrganizationSubscriptionClient) SetRegion(region string)
SetRegion overrides the region of this client.
OrganizationSubscriptionSummary Subscription summary.
type OrganizationSubscriptionSummary struct {
// SPM (Subscription Plan Management) internal subscription ID.
Id *string `mandatory:"true" json:"id"`
// Customer-friendly service name provided by the PRG (Product Release Group).
ServiceName *string `mandatory:"false" json:"serviceName"`
// Subscription type, whether IaaS, SaaS, PaaS.
Type *string `mandatory:"false" json:"type"`
// Plan status.
Status *string `mandatory:"false" json:"status"`
// The date when the first service of the subscription was activated.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// The date when the last service of the subscription ends.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
Currency *OrgnizationSubsCurrency `mandatory:"false" json:"currency"`
// Total aggregate TCLV of all lines for the subscription, including expired, active, and signed.
TotalValue *string `mandatory:"false" json:"totalValue"`
}
func (m OrganizationSubscriptionSummary) String() string
func (m OrganizationSubscriptionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
OrgnizationSubsCurrency Currency details.
type OrgnizationSubsCurrency struct {
// Currency code.
IsoCode *string `mandatory:"true" json:"isoCode"`
// Currency name.
Name *string `mandatory:"false" json:"name"`
// Standard precision of the currency.
StdPrecision *int64 `mandatory:"false" json:"stdPrecision"`
}
func (m OrgnizationSubsCurrency) String() string
func (m OrgnizationSubsCurrency) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
ProductAndService Authorization-order product or service that draws down from the subscription.
type ProductAndService struct {
// Subscription identifier; may be blank for non-cloud transactions.
SubId *string `mandatory:"false" json:"subId"`
// Name of the product or service.
ServiceName *string `mandatory:"false" json:"serviceName"`
// Start date and time for the product or service.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// End date and time for the product or service.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Amount authorized for the product or service.
AmountAuthorized *float64 `mandatory:"false" json:"amountAuthorized"`
// Amount provisioned for the product or service.
AmountProvisioned *float64 `mandatory:"false" json:"amountProvisioned"`
// Amount consumed by the product or service.
AmountConsumed *float64 `mandatory:"false" json:"amountConsumed"`
}
func (m ProductAndService) String() string
func (m ProductAndService) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RateCardProduct Product description.
type RateCardProduct struct {
// Product part number.
PartNumber *string `mandatory:"true" json:"partNumber"`
// Product name.
Name *string `mandatory:"true" json:"name"`
// Unit of measure.
UnitOfMeasure *string `mandatory:"true" json:"unitOfMeasure"`
// Metered service billing category.
BillingCategory *string `mandatory:"false" json:"billingCategory"`
// Product category.
ProductCategory *string `mandatory:"false" json:"productCategory"`
// Rate card part type of product.
UcmRateCardPartType *string `mandatory:"false" json:"ucmRateCardPartType"`
}
func (m RateCardProduct) String() string
func (m RateCardProduct) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RateCardSummary Rate card summary.
type RateCardSummary struct {
Product *RateCardProduct `mandatory:"true" json:"product"`
// Rate card net unit price.
NetUnitPrice *string `mandatory:"true" json:"netUnitPrice"`
// Rate card overage price.
OveragePrice *string `mandatory:"true" json:"overagePrice"`
// SPM (Subscription Plan Management) internal subscribed service ID.
SubscribedServiceId *string `mandatory:"false" json:"subscribedServiceId"`
// Rate card start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Rate card end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Rate card discretionary discount percentage.
DiscretionaryDiscountPercentage *string `mandatory:"false" json:"discretionaryDiscountPercentage"`
// Rate card price tier parameter.
IsTier *bool `mandatory:"false" json:"isTier"`
Currency *SubscriptionCurrency `mandatory:"false" json:"currency"`
// List of tiered rate card prices.
RateCardTiers []RateCardTier `mandatory:"false" json:"rateCardTiers"`
}
func (m RateCardSummary) String() string
func (m RateCardSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RateCardTier Rate card tier details.
type RateCardTier struct {
// Rate card tier quantity range.
UpToQuantity *string `mandatory:"false" json:"upToQuantity"`
// Rate card tier net unit price.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Rate card tier overage price.
OveragePrice *string `mandatory:"false" json:"overagePrice"`
}
func (m RateCardTier) String() string
func (m RateCardTier) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
RatecardClient a client for Ratecard
type RatecardClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewRatecardClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client RatecardClient, err error)
NewRatecardClientWithConfigurationProvider Creates a new default Ratecard client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewRatecardClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client RatecardClient, err error)
NewRatecardClientWithOboToken Creates a new default Ratecard client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *RatecardClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client RatecardClient) ListRateCards(ctx context.Context, request ListRateCardsRequest) (response ListRateCardsResponse, err error)
ListRateCards Returns all rate cards for a given subscription ID and account ID (if provided), and for a particular date range.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListRateCards.go.html to see an example of how to use ListRateCards API.
func (client *RatecardClient) SetRegion(region string)
SetRegion overrides the region of this client.
SubscribedService Subscribed service contract details.
type SubscribedService struct {
// SPM (Subscription Plan Management) internal Subscribed Service ID
Id *string `mandatory:"false" json:"id"`
// Subscribed service line type.
Type *string `mandatory:"false" json:"type"`
// Subscribed service line number.
SerialNumber *string `mandatory:"false" json:"serialNumber"`
// Subscription ID associated with the subscribed service.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
Product *RateCardProduct `mandatory:"false" json:"product"`
// Subscribed service start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Subscribed service end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Subscribed service quantity.
Quantity *string `mandatory:"false" json:"quantity"`
// Subscribed service status.
Status *string `mandatory:"false" json:"status"`
// Subscribed service operation type.
OperationType *string `mandatory:"false" json:"operationType"`
// Subscribed service net unit price.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Indicates the period for which the commitment amount can be utilized, exceeding which, the amount lapses. Also used in calculation of total contract line value.
PricePeriod *string `mandatory:"false" json:"pricePeriod"`
// Subscribed service line net amount.
LineNetAmount *string `mandatory:"false" json:"lineNetAmount"`
// Indicates if the commitment lines can have different quantities.
IsVariableCommitment *bool `mandatory:"false" json:"isVariableCommitment"`
// Indicates if a service can recieve usages and consequently have the available amounts computed.
IsAllowance *bool `mandatory:"false" json:"isAllowance"`
// Subscribed service used amount.
UsedAmount *string `mandatory:"false" json:"usedAmount"`
// Subscribed sercice available or remaining amount.
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Funded allocation line value.
// Example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
// Indicates whether or not there has been usage for the subscribed service.
IsHavingUsage *bool `mandatory:"false" json:"isHavingUsage"`
// If true compares rate between the rate card and the active price list, and the minimum rate would be fetched.
IsCapToPriceList *bool `mandatory:"false" json:"isCapToPriceList"`
// Subscribed service credit percentage.
CreditPercentage *string `mandatory:"false" json:"creditPercentage"`
// Contains the name of the partner to which the subscription belongs, however depending on which subscription, the invoicing can differ.
PartnerTransactionType *string `mandatory:"false" json:"partnerTransactionType"`
// Used in context of service credit lines.
IsCreditEnabled *bool `mandatory:"false" json:"isCreditEnabled"`
// Overage policy of subscribed service.
OveragePolicy *string `mandatory:"false" json:"overagePolicy"`
// Overage bill to of subscribed service.
OverageBillTo *string `mandatory:"false" json:"overageBillTo"`
// Pay As You Go policy of the subscribed service. Can be null, indicating no PAYG policy.
PaygPolicy *string `mandatory:"false" json:"paygPolicy"`
// Not null if this service has an associated promotion line in SPM (Subscription Plan Management). Contains the line identifier from order management of
// the associated promo line.
PromoOrderLineId *int64 `mandatory:"false" json:"promoOrderLineId"`
// Promotion pricing type of subscribed service. Can be null, indicating no promotional pricing.
PromotionPricingType *string `mandatory:"false" json:"promotionPricingType"`
// Subscribed service rate card discount percentage.
RateCardDiscountPercentage *string `mandatory:"false" json:"rateCardDiscountPercentage"`
// Subscribed service overage discount percentage.
OverageDiscountPercentage *string `mandatory:"false" json:"overageDiscountPercentage"`
BillToCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"billToCustomer"`
BillToContact *SubscribedServiceUser `mandatory:"false" json:"billToContact"`
BillToAddress *SubscribedServiceAddress `mandatory:"false" json:"billToAddress"`
// Payment number of the subscribed service.
PaymentNumber *string `mandatory:"false" json:"paymentNumber"`
// Subscribed service payment expiration date.
TimePaymentExpiry *common.SDKTime `mandatory:"false" json:"timePaymentExpiry"`
PaymentTerm *SubscribedServicePaymentTerm `mandatory:"false" json:"paymentTerm"`
// Payment method of the subscribed service.
PaymentMethod *string `mandatory:"false" json:"paymentMethod"`
// Subscribed service transaction extension ID.
TransactionExtensionId *int64 `mandatory:"false" json:"transactionExtensionId"`
// Sales channel of the subscribed service.
SalesChannel *string `mandatory:"false" json:"salesChannel"`
// Subscribed service eligible to renew field.
EligibleToRenew *string `mandatory:"false" json:"eligibleToRenew"`
// SPM (Subscription Plan Management) renewed subscription ID.
RenewedSubscribedServiceId *string `mandatory:"false" json:"renewedSubscribedServiceId"`
// Term value in months.
TermValue *int64 `mandatory:"false" json:"termValue"`
// Term value UOM (Unit of Measure).
TermValueUom *string `mandatory:"false" json:"termValueUom"`
// Subscribed service opportunity ID.
RenewalOptyId *int64 `mandatory:"false" json:"renewalOptyId"`
// Renewal opportunity number of the subscribed service.
RenewalOptyNumber *string `mandatory:"false" json:"renewalOptyNumber"`
// Renewal opportunity type of the subscribed service.
RenewalOptyType *string `mandatory:"false" json:"renewalOptyType"`
// Booking opportunity number of the subscribed service.
BookingOptyNumber *string `mandatory:"false" json:"bookingOptyNumber"`
// Subscribed service revenue line ID.
RevenueLineId *int64 `mandatory:"false" json:"revenueLineId"`
// Revenue line number of the subscribed service.
RevenueLineNumber *string `mandatory:"false" json:"revenueLineNumber"`
// Subscribed service major set.
MajorSet *int64 `mandatory:"false" json:"majorSet"`
// Subscribed service major set start date.
TimeMajorsetStart *common.SDKTime `mandatory:"false" json:"timeMajorsetStart"`
// Subscribed service major set end date.
TimeMajorsetEnd *common.SDKTime `mandatory:"false" json:"timeMajorsetEnd"`
// Subscribed service system ARR (Annualized Recurring Revenue).
SystemArrInLc *string `mandatory:"false" json:"systemArrInLc"`
// Subscribed service system ARR in standard currency.
SystemArrInSc *string `mandatory:"false" json:"systemArrInSc"`
// Subscribed service system ATR-ARR (Annualized Recurring Revenue - Available to Renew).
SystemAtrArrInLc *string `mandatory:"false" json:"systemAtrArrInLc"`
// Subscribed service system ATR-ARR in standard currency.
SystemAtrArrInSc *string `mandatory:"false" json:"systemAtrArrInSc"`
// Subscribed service revised ARR.
RevisedArrInLc *string `mandatory:"false" json:"revisedArrInLc"`
// Subscribed service revised ARR in standard currency.
RevisedArrInSc *string `mandatory:"false" json:"revisedArrInSc"`
// Subscribed service total value.
TotalValue *string `mandatory:"false" json:"totalValue"`
// Subscribed service promotion amount.
OriginalPromoAmount *string `mandatory:"false" json:"originalPromoAmount"`
// Sales order header associated to the subscribed service.
OrderHeaderId *int64 `mandatory:"false" json:"orderHeaderId"`
// Sales order number associated to the subscribed service.
OrderNumber *int64 `mandatory:"false" json:"orderNumber"`
// Order type of subscribed service.
OrderType *string `mandatory:"false" json:"orderType"`
// Sales order line ID associated with the subscribed service.
OrderLineId *int64 `mandatory:"false" json:"orderLineId"`
// Sales order line number associated with the subscribed service.
OrderLineNumber *int `mandatory:"false" json:"orderLineNumber"`
// Subscribed service commitment schedule ID.
CommitmentScheduleId *string `mandatory:"false" json:"commitmentScheduleId"`
// Subscribed service sales account party ID.
SalesAccountPartyId *int64 `mandatory:"false" json:"salesAccountPartyId"`
// Subscribed service data center.
DataCenter *string `mandatory:"false" json:"dataCenter"`
// Subscribed service data center region.
DataCenterRegion *string `mandatory:"false" json:"dataCenterRegion"`
// Subscribed service admin email ID.
AdminEmail *string `mandatory:"false" json:"adminEmail"`
// Subscribed service buyer email ID.
BuyerEmail *string `mandatory:"false" json:"buyerEmail"`
// Subscribed service source.
SubscriptionSource *string `mandatory:"false" json:"subscriptionSource"`
// Subscribed service provisioning source.
ProvisioningSource *string `mandatory:"false" json:"provisioningSource"`
// Subscribed service fulfillment set.
FulfillmentSet *string `mandatory:"false" json:"fulfillmentSet"`
// Subscribed service intent to pay parameter.
IsIntentToPay *bool `mandatory:"false" json:"isIntentToPay"`
// Subscribed service PAYG parameter.
IsPayg *bool `mandatory:"false" json:"isPayg"`
// Subscribed service pricing model.
PricingModel *string `mandatory:"false" json:"pricingModel"`
// Subscribed service program type.
ProgramType *string `mandatory:"false" json:"programType"`
// Subscribed service start date type.
StartDateType *string `mandatory:"false" json:"startDateType"`
// Subscribed service provisioning date.
TimeProvisioned *common.SDKTime `mandatory:"false" json:"timeProvisioned"`
// Subscribed service promotion type.
PromoType *string `mandatory:"false" json:"promoType"`
ServiceToCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"serviceToCustomer"`
ServiceToContact *SubscribedServiceUser `mandatory:"false" json:"serviceToContact"`
ServiceToAddress *SubscribedServiceAddress `mandatory:"false" json:"serviceToAddress"`
SoldToCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"soldToCustomer"`
SoldToContact *SubscribedServiceUser `mandatory:"false" json:"soldToContact"`
EndUserCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"endUserCustomer"`
EndUserContact *SubscribedServiceUser `mandatory:"false" json:"endUserContact"`
EndUserAddress *SubscribedServiceAddress `mandatory:"false" json:"endUserAddress"`
ResellerCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"resellerCustomer"`
ResellerContact *SubscribedServiceUser `mandatory:"false" json:"resellerContact"`
ResellerAddress *SubscribedServiceAddress `mandatory:"false" json:"resellerAddress"`
// Subscribed service CSI number.
Csi *int64 `mandatory:"false" json:"csi"`
// Identifier for a customer's transactions, for purchase of any Oracle services.
CustomerTransactionReference *string `mandatory:"false" json:"customerTransactionReference"`
// Subscribed service partner credit amount.
PartnerCreditAmount *string `mandatory:"false" json:"partnerCreditAmount"`
// Indicates if the subscribed service has a single rate card.
IsSingleRateCard *bool `mandatory:"false" json:"isSingleRateCard"`
// Subscribed service agreement ID.
AgreementId *int64 `mandatory:"false" json:"agreementId"`
// Subscribed service agreement name.
AgreementName *string `mandatory:"false" json:"agreementName"`
// Subscribed service agreement type.
AgreementType *string `mandatory:"false" json:"agreementType"`
// Subscribed service invoice frequency.
BillingFrequency *string `mandatory:"false" json:"billingFrequency"`
// Subscribed service welcome email sent date.
TimeWelcomeEmailSent *common.SDKTime `mandatory:"false" json:"timeWelcomeEmailSent"`
// Subscribed service configuration email sent date.
TimeServiceConfigurationEmailSent *common.SDKTime `mandatory:"false" json:"timeServiceConfigurationEmailSent"`
// Subscribed service customer configuration date.
TimeCustomerConfig *common.SDKTime `mandatory:"false" json:"timeCustomerConfig"`
// Subscribed service agreement end date.
TimeAgreementEnd *common.SDKTime `mandatory:"false" json:"timeAgreementEnd"`
// List of commitment services of a line.
CommitmentServices []CommitmentService `mandatory:"false" json:"commitmentServices"`
// List of rate cards of a subscribed service.
RateCards []RateCardSummary `mandatory:"false" json:"rateCards"`
// Subscribed service creation date.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// User that created the subscribed service.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Subscribed service last update date.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// User that updated the subscribed service.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// SPM (Subscription Plan Management) rate card type.
RatecardType *string `mandatory:"false" json:"ratecardType"`
}
func (m SubscribedService) String() string
func (m SubscribedService) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscribedServiceAddress Address.
type SubscribedServiceAddress struct {
Location *SubscribedServiceLocation `mandatory:"false" json:"location"`
// Address name identifier.
Name *string `mandatory:"false" json:"name"`
// Phone.
Phone *string `mandatory:"false" json:"phone"`
// Identify as the customer shipping address.
IsBillTo *bool `mandatory:"false" json:"isBillTo"`
// Identify as the customer invoicing address.
IsShipTo *bool `mandatory:"false" json:"isShipTo"`
// Bill to site use ID.
BillSiteUseId *int64 `mandatory:"false" json:"billSiteUseId"`
// Service-to-site use ID.
Service2SiteUseId *int64 `mandatory:"false" json:"service2SiteUseId"`
// TCA (Trading Community Architecture) customer account site ID.
TcaCustAcctSiteId *int64 `mandatory:"false" json:"tcaCustAcctSiteId"`
// Party site number.
TcaPartySiteNumber *string `mandatory:"false" json:"tcaPartySiteNumber"`
}
func (m SubscribedServiceAddress) String() string
func (m SubscribedServiceAddress) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscribedServiceBusinessPartner Business partner.
type SubscribedServiceBusinessPartner struct {
// Commercial name, also referred to as customer name.
Name *string `mandatory:"false" json:"name"`
// Phonetic name.
NamePhonetic *string `mandatory:"false" json:"namePhonetic"`
// TCA (Trading Community Architecture) customer account number.
TcaCustAccountNumber *string `mandatory:"false" json:"tcaCustAccountNumber"`
// Specifies whether or not the business partner is part of the public sector.
IsPublicSector *bool `mandatory:"false" json:"isPublicSector"`
// Specifies whether or not the business partner is a chain customer.
IsChainCustomer *bool `mandatory:"false" json:"isChainCustomer"`
// Customer chain type.
CustomerChainType *string `mandatory:"false" json:"customerChainType"`
// TCA party number.
TcaPartyNumber *string `mandatory:"false" json:"tcaPartyNumber"`
// TCA party ID.
TcaPartyId *int64 `mandatory:"false" json:"tcaPartyId"`
// TCA customer account ID.
TcaCustomerAccountId *int64 `mandatory:"false" json:"tcaCustomerAccountId"`
}
func (m SubscribedServiceBusinessPartner) String() string
func (m SubscribedServiceBusinessPartner) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscribedServiceClient a client for SubscribedService
type SubscribedServiceClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSubscribedServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscribedServiceClient, err error)
NewSubscribedServiceClientWithConfigurationProvider Creates a new default SubscribedService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSubscribedServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscribedServiceClient, err error)
NewSubscribedServiceClientWithOboToken Creates a new default SubscribedService client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *SubscribedServiceClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SubscribedServiceClient) GetSubscribedService(ctx context.Context, request GetSubscribedServiceRequest) (response GetSubscribedServiceResponse, err error)
GetSubscribedService Returns the subscribed service details corresponding to the provided ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetSubscribedService.go.html to see an example of how to use GetSubscribedService API.
func (client SubscribedServiceClient) ListSubscribedServices(ctx context.Context, request ListSubscribedServicesRequest) (response ListSubscribedServicesResponse, err error)
ListSubscribedServices Returns all subscribed services for a given Subscription ID.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListSubscribedServices.go.html to see an example of how to use ListSubscribedServices API.
func (client *SubscribedServiceClient) SetRegion(region string)
SetRegion overrides the region of this client.
SubscribedServiceLocation Address location.
type SubscribedServiceLocation struct {
// Address first line.
Address1 *string `mandatory:"false" json:"address1"`
// Address second line.
Address2 *string `mandatory:"false" json:"address2"`
// Postal code.
PostalCode *string `mandatory:"false" json:"postalCode"`
// City.
City *string `mandatory:"false" json:"city"`
// Country.
Country *string `mandatory:"false" json:"country"`
// Region.
Region *string `mandatory:"false" json:"region"`
// TCA (Trading Community Architecture) location identifier.
TcaLocationId *int64 `mandatory:"false" json:"tcaLocationId"`
}
func (m SubscribedServiceLocation) String() string
func (m SubscribedServiceLocation) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscribedServicePaymentTerm Payment term details.
type SubscribedServicePaymentTerm struct {
// Payment term name.
Name *string `mandatory:"false" json:"name"`
// Payment term value.
Value *string `mandatory:"false" json:"value"`
// Payment term description.
Description *string `mandatory:"false" json:"description"`
// Payment term active parameter.
IsActive *bool `mandatory:"false" json:"isActive"`
// Payment term last update date.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// User that created the payment term.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Payment term last update date.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// User that updated the payment term.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
}
func (m SubscribedServicePaymentTerm) String() string
func (m SubscribedServicePaymentTerm) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscribedServiceSummary Subscribed service contract details.
type SubscribedServiceSummary struct {
// SPM (Subscription Plan Management) internal subscribed service ID.
Id *string `mandatory:"true" json:"id"`
// Subscribed service line type.
Type *string `mandatory:"false" json:"type"`
// Subscribed service line number.
SerialNumber *string `mandatory:"false" json:"serialNumber"`
// Subscription ID associated with the subscribed service.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
Product *RateCardProduct `mandatory:"false" json:"product"`
// Subscribed service start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Subscribed service end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// Subscribed service quantity.
Quantity *string `mandatory:"false" json:"quantity"`
// Subscribed service status.
Status *string `mandatory:"false" json:"status"`
// Subscribed service operation type.
OperationType *string `mandatory:"false" json:"operationType"`
// Subscribed service net unit price.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Indicates the period for which the commitment amount can be utilized, exceeding which, the amount lapses. Also used in calculation of total contract line value.
PricePeriod *string `mandatory:"false" json:"pricePeriod"`
// Subscribed service line net amount.
LineNetAmount *string `mandatory:"false" json:"lineNetAmount"`
// Indicates if the commitment lines can have different quantities.
IsVariableCommitment *bool `mandatory:"false" json:"isVariableCommitment"`
// Indicates if a service can recieve usages and consequently have available amounts computed.
IsAllowance *bool `mandatory:"false" json:"isAllowance"`
// Subscribed service used amount.
UsedAmount *string `mandatory:"false" json:"usedAmount"`
// Subscribed sercice available or remaining amount.
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Funded allocation line value.
// Example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
// Indicates whether or not there has been usage for the subscribed service.
IsHavingUsage *bool `mandatory:"false" json:"isHavingUsage"`
// If true compares the rate between the rate card and the active price list, and the minimum rate would be fetched.
IsCapToPriceList *bool `mandatory:"false" json:"isCapToPriceList"`
// Subscribed service credit percentage.
CreditPercentage *string `mandatory:"false" json:"creditPercentage"`
// Contains the name of the partner to which the subscription belongs, however depending on which subscription, the invoicing can differ.
PartnerTransactionType *string `mandatory:"false" json:"partnerTransactionType"`
// Used in context of service credit lines.
IsCreditEnabled *bool `mandatory:"false" json:"isCreditEnabled"`
// Overage policy of subscribed service.
OveragePolicy *string `mandatory:"false" json:"overagePolicy"`
// Overage bill to of subscribed service.
OverageBillTo *string `mandatory:"false" json:"overageBillTo"`
// Pay As You Go policy of subscribed service. Can be null, indicating no PAYG policy.
PaygPolicy *string `mandatory:"false" json:"paygPolicy"`
// Not null if this service has an associated promotion line in SPM (Subscription Plan Management). Contains the line identifier from order management of
// the associated promo line.
PromoOrderLineId *int64 `mandatory:"false" json:"promoOrderLineId"`
// Promotion pricing type of subscribed service. Can be null, indicating no promotional pricing.
PromotionPricingType *string `mandatory:"false" json:"promotionPricingType"`
// Subscribed service rate card ciscount percentage.
RateCardDiscountPercentage *string `mandatory:"false" json:"rateCardDiscountPercentage"`
// Subscribed service overage discount percentage.
OverageDiscountPercentage *string `mandatory:"false" json:"overageDiscountPercentage"`
BillToCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"billToCustomer"`
BillToContact *SubscribedServiceUser `mandatory:"false" json:"billToContact"`
BillToAddress *SubscribedServiceAddress `mandatory:"false" json:"billToAddress"`
// Payment number of subscribed service.
PaymentNumber *string `mandatory:"false" json:"paymentNumber"`
// Subscribed service payment expiration date.
TimePaymentExpiry *common.SDKTime `mandatory:"false" json:"timePaymentExpiry"`
PaymentTerm *SubscribedServicePaymentTerm `mandatory:"false" json:"paymentTerm"`
// Payment method of subscribed service.
PaymentMethod *string `mandatory:"false" json:"paymentMethod"`
// Subscribed service transaction extension ID.
TransactionExtensionId *int64 `mandatory:"false" json:"transactionExtensionId"`
// Sales channel of subscribed service.
SalesChannel *string `mandatory:"false" json:"salesChannel"`
// Subscribed service eligible to renew field.
EligibleToRenew *string `mandatory:"false" json:"eligibleToRenew"`
// SPM (Subscription Plan Management) renewed subscription ID.
RenewedSubscribedServiceId *string `mandatory:"false" json:"renewedSubscribedServiceId"`
// Term value in months.
TermValue *int64 `mandatory:"false" json:"termValue"`
// Term value UOM (Unit of Measure).
TermValueUom *string `mandatory:"false" json:"termValueUom"`
// Subscribed service opportunity ID.
RenewalOptyId *int64 `mandatory:"false" json:"renewalOptyId"`
// Renewal opportunity number of subscribed service.
RenewalOptyNumber *string `mandatory:"false" json:"renewalOptyNumber"`
// Renewal opportunity type of subscribed service.
RenewalOptyType *string `mandatory:"false" json:"renewalOptyType"`
// Booking opportunity number of subscribed service.
BookingOptyNumber *string `mandatory:"false" json:"bookingOptyNumber"`
// Subscribed service revenue line ID.
RevenueLineId *int64 `mandatory:"false" json:"revenueLineId"`
// Revenue line number of subscribed service.
RevenueLineNumber *string `mandatory:"false" json:"revenueLineNumber"`
// Subscribed service major set.
MajorSet *int64 `mandatory:"false" json:"majorSet"`
// Subscribed service major set start date.
TimeMajorsetStart *common.SDKTime `mandatory:"false" json:"timeMajorsetStart"`
// Subscribed service major set end date.
TimeMajorsetEnd *common.SDKTime `mandatory:"false" json:"timeMajorsetEnd"`
// Subscribed service system ARR (Annualized Recurring Revenue).
SystemArrInLc *string `mandatory:"false" json:"systemArrInLc"`
// Subscribed service system ARR in standard currency.
SystemArrInSc *string `mandatory:"false" json:"systemArrInSc"`
// Subscribed service system ATR-ARR (Annualized Recurring Revenue - Available to Renew).
SystemAtrArrInLc *string `mandatory:"false" json:"systemAtrArrInLc"`
// Subscribed service system ATR-ARR in standard currency.
SystemAtrArrInSc *string `mandatory:"false" json:"systemAtrArrInSc"`
// Subscribed service revised ARR.
RevisedArrInLc *string `mandatory:"false" json:"revisedArrInLc"`
// Subscribed service revised ARR in standard currency.
RevisedArrInSc *string `mandatory:"false" json:"revisedArrInSc"`
// Subscribed service total value.
TotalValue *string `mandatory:"false" json:"totalValue"`
// Subscribed service promotion amount.
OriginalPromoAmount *string `mandatory:"false" json:"originalPromoAmount"`
// Sales order header associated with the subscribed service.
OrderHeaderId *int64 `mandatory:"false" json:"orderHeaderId"`
// Sales order number associated with the subscribed service.
OrderNumber *int64 `mandatory:"false" json:"orderNumber"`
// Order type of subscribed service.
OrderType *string `mandatory:"false" json:"orderType"`
// Sales order line ID associated with the subscribed service.
OrderLineId *int64 `mandatory:"false" json:"orderLineId"`
// Sales order line number associated with the subscribed service.
OrderLineNumber *int `mandatory:"false" json:"orderLineNumber"`
// Subscribed service commitment schedule ID.
CommitmentScheduleId *string `mandatory:"false" json:"commitmentScheduleId"`
// Subscribed service sales account party ID.
SalesAccountPartyId *int64 `mandatory:"false" json:"salesAccountPartyId"`
// Subscribed service data center.
DataCenter *string `mandatory:"false" json:"dataCenter"`
// Subscribed service data center region.
DataCenterRegion *string `mandatory:"false" json:"dataCenterRegion"`
// Subscribed service admin email ID.
AdminEmail *string `mandatory:"false" json:"adminEmail"`
// Subscribed service buyer email ID.
BuyerEmail *string `mandatory:"false" json:"buyerEmail"`
// Subscribed service source.
SubscriptionSource *string `mandatory:"false" json:"subscriptionSource"`
// Subscribed service provisioning source.
ProvisioningSource *string `mandatory:"false" json:"provisioningSource"`
// Subscribed service fulfillment set.
FulfillmentSet *string `mandatory:"false" json:"fulfillmentSet"`
// Subscribed service intent to pay parameter.
IsIntentToPay *bool `mandatory:"false" json:"isIntentToPay"`
// Subscribed service PAYG parameter.
IsPayg *bool `mandatory:"false" json:"isPayg"`
// Subscribed service pricing model.
PricingModel *string `mandatory:"false" json:"pricingModel"`
// Subscribed service program type.
ProgramType *string `mandatory:"false" json:"programType"`
// Subscribed service start date type.
StartDateType *string `mandatory:"false" json:"startDateType"`
// Subscribed service provisioning date.
TimeProvisioned *common.SDKTime `mandatory:"false" json:"timeProvisioned"`
// Subscribed service promotion type.
PromoType *string `mandatory:"false" json:"promoType"`
ServiceToCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"serviceToCustomer"`
ServiceToContact *SubscribedServiceUser `mandatory:"false" json:"serviceToContact"`
ServiceToAddress *SubscribedServiceAddress `mandatory:"false" json:"serviceToAddress"`
SoldToCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"soldToCustomer"`
SoldToContact *SubscribedServiceUser `mandatory:"false" json:"soldToContact"`
EndUserCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"endUserCustomer"`
EndUserContact *SubscribedServiceUser `mandatory:"false" json:"endUserContact"`
EndUserAddress *SubscribedServiceAddress `mandatory:"false" json:"endUserAddress"`
ResellerCustomer *SubscribedServiceBusinessPartner `mandatory:"false" json:"resellerCustomer"`
ResellerContact *SubscribedServiceUser `mandatory:"false" json:"resellerContact"`
ResellerAddress *SubscribedServiceAddress `mandatory:"false" json:"resellerAddress"`
// Subscribed service CSI number.
Csi *int64 `mandatory:"false" json:"csi"`
// Identifier for a customer's transactions for purchase of any Oracle services.
CustomerTransactionReference *string `mandatory:"false" json:"customerTransactionReference"`
// Subscribed service partner credit amount.
PartnerCreditAmount *string `mandatory:"false" json:"partnerCreditAmount"`
// Indicates if the subscribed service has a single rate card.
IsSingleRateCard *bool `mandatory:"false" json:"isSingleRateCard"`
// Subscribed service agreement ID.
AgreementId *int64 `mandatory:"false" json:"agreementId"`
// Subscribed service agreement name.
AgreementName *string `mandatory:"false" json:"agreementName"`
// Subscribed service agreement type.
AgreementType *string `mandatory:"false" json:"agreementType"`
// Subscribed service invoice frequency.
BillingFrequency *string `mandatory:"false" json:"billingFrequency"`
// Subscribed service welcome email sent date.
TimeWelcomeEmailSent *common.SDKTime `mandatory:"false" json:"timeWelcomeEmailSent"`
// Subscribed service configuration email sent date.
TimeServiceConfigurationEmailSent *common.SDKTime `mandatory:"false" json:"timeServiceConfigurationEmailSent"`
// Subscribed service customer configuration date.
TimeCustomerConfig *common.SDKTime `mandatory:"false" json:"timeCustomerConfig"`
// Subscribed service agreement end date.
TimeAgreementEnd *common.SDKTime `mandatory:"false" json:"timeAgreementEnd"`
// Subscribed service creation date.
TimeCreated *common.SDKTime `mandatory:"false" json:"timeCreated"`
// User that created the subscribed service.
CreatedBy *string `mandatory:"false" json:"createdBy"`
// Subscribed service last update date.
TimeUpdated *common.SDKTime `mandatory:"false" json:"timeUpdated"`
// User that updated the subscribed service.
UpdatedBy *string `mandatory:"false" json:"updatedBy"`
// SPM (Subscription Plan Management) rate card type.
RatecardType *string `mandatory:"false" json:"ratecardType"`
}
func (m SubscribedServiceSummary) String() string
func (m SubscribedServiceSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscribedServiceUser User.
type SubscribedServiceUser struct {
// Name.
Name *string `mandatory:"false" json:"name"`
// User name.
Username *string `mandatory:"false" json:"username"`
// First name.
FirstName *string `mandatory:"false" json:"firstName"`
// Last name.
LastName *string `mandatory:"false" json:"lastName"`
// Email.
Email *string `mandatory:"false" json:"email"`
// TCA (Trading Community Architecture) contact ID.
TcaContactId *int64 `mandatory:"false" json:"tcaContactId"`
// TCA customer account site ID.
TcaCustAccntSiteId *int64 `mandatory:"false" json:"tcaCustAccntSiteId"`
// TCA party ID.
TcaPartyId *int64 `mandatory:"false" json:"tcaPartyId"`
}
func (m SubscribedServiceUser) String() string
func (m SubscribedServiceUser) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionClient a client for Subscription
type SubscriptionClient struct {
common.BaseClient
// contains filtered or unexported fields
}
func NewSubscriptionClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscriptionClient, err error)
NewSubscriptionClientWithConfigurationProvider Creates a new default Subscription client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region
func NewSubscriptionClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscriptionClient, err error)
NewSubscriptionClientWithOboToken Creates a new default Subscription client with the given configuration provider. The obotoken will be added to default headers and signed; the configuration provider will be used for the signer
as well as reading the region
func (client *SubscriptionClient) ConfigurationProvider() *common.ConfigurationProvider
ConfigurationProvider the ConfigurationProvider used in this client, or null if none set
func (client SubscriptionClient) GetSubscriptionDetails(ctx context.Context, request GetSubscriptionDetailsRequest) (response GetSubscriptionDetailsResponse, err error)
GetSubscriptionDetails Returns the commitment summary for a subscription.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/GetSubscriptionDetails.go.html to see an example of how to use GetSubscriptionDetails API.
func (client SubscriptionClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)
ListSubscriptions Returns all subscriptions for a given plan number, subscription ID, or buyer email, and provides additional parameters, to include rate card and commitment details. Exactly one of the these parameters is expected as input. If more than one parameter is provided, a 400 - invalid parameters exception is thrown, and if no parameters are provided, a 400 - missing parameter exception is thrown.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListSubscriptions.go.html to see an example of how to use ListSubscriptions API.
func (client SubscriptionClient) ListUsageLedgers(ctx context.Context, request ListUsageLedgersRequest) (response ListUsageLedgersResponse, err error)
ListUsageLedgers Returns revenue invoice consumption details for authorization orders that draw down from the requested subscription. It includes authorization-order subscription IDs but excludes the requested subscription ID itself.
Click https://docs.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/onesubscription/ListUsageLedgers.go.html to see an example of how to use ListUsageLedgers API.
func (client *SubscriptionClient) SetRegion(region string)
SetRegion overrides the region of this client.
SubscriptionCurrency Currency details.
type SubscriptionCurrency struct {
// Currency code.
IsoCode *string `mandatory:"true" json:"isoCode"`
// Currency name.
Name *string `mandatory:"false" json:"name"`
// Standard precision of the currency.
StdPrecision *int64 `mandatory:"false" json:"stdPrecision"`
}
func (m SubscriptionCurrency) String() string
func (m SubscriptionCurrency) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionDetails Commitment summary for a subscription.
type SubscriptionDetails struct {
// Contract identifier.
ContractId *string `mandatory:"false" json:"contractId"`
// Subscription identifier.
SubscriptionId *string `mandatory:"false" json:"subscriptionId"`
// Sold-to customer name.
CustomerName *string `mandatory:"false" json:"customerName"`
// The currency of the subscription, in the format specified by ISO-4217 (https://www.iso.org/iso-4217-currency-codes.html).
CurrencyCode *string `mandatory:"false" json:"currencyCode"`
// Start date and time of the subscription commitment.
TimeCommitmentStart *common.SDKTime `mandatory:"false" json:"timeCommitmentStart"`
// End date and time of the subscription commitment.
TimeCommitmentEnd *common.SDKTime `mandatory:"false" json:"timeCommitmentEnd"`
// Total committed amount for the subscription.
AmountCommitment *float64 `mandatory:"false" json:"amountCommitment"`
// Amount authorized for the subscription.
AmountAuthorized *float64 `mandatory:"false" json:"amountAuthorized"`
// Amount provisioned for the subscription.
AmountProvisioned *float64 `mandatory:"false" json:"amountProvisioned"`
// Amount consumed from the subscription commitment.
AmountConsumed *float64 `mandatory:"false" json:"amountConsumed"`
// Amount remaining and available for the subscription.
AmountAvailable *float64 `mandatory:"false" json:"amountAvailable"`
// Commitment periods associated with the subscription.
CommitmentPeriods []CommitmentPeriod `mandatory:"false" json:"commitmentPeriods"`
// Products and services that draw down from the subscription.
ProductsAndServices []ProductAndService `mandatory:"false" json:"productsAndServices"`
}
func (m SubscriptionDetails) String() string
func (m SubscriptionDetails) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionProduct Product description.
type SubscriptionProduct struct {
// Product part number.
PartNumber *string `mandatory:"true" json:"partNumber"`
// Product name.
Name *string `mandatory:"true" json:"name"`
// Unit of measure.
UnitOfMeasure *string `mandatory:"true" json:"unitOfMeasure"`
// Product provisioning group.
ProvisioningGroup *string `mandatory:"false" json:"provisioningGroup"`
}
func (m SubscriptionProduct) String() string
func (m SubscriptionProduct) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionSubscribedService Subscribed service summary.
type SubscriptionSubscribedService struct {
// SPM (Subscription Plan Management) internal subscribed service ID.
Id *string `mandatory:"true" json:"id"`
Product *SubscriptionProduct `mandatory:"false" json:"product"`
// Subscribed service quantity.
Quantity *string `mandatory:"false" json:"quantity"`
// Subscribed service status.
Status *string `mandatory:"false" json:"status"`
// Subscribed service operation type.
OperationType *string `mandatory:"false" json:"operationType"`
// Subscribed service net unit price.
NetUnitPrice *string `mandatory:"false" json:"netUnitPrice"`
// Subscribed service used amount.
UsedAmount *string `mandatory:"false" json:"usedAmount"`
// Subscribed sercice available or remaining amount.
AvailableAmount *string `mandatory:"false" json:"availableAmount"`
// Funded allocation line value.
// Example: 12000.00
FundedAllocationValue *string `mandatory:"false" json:"fundedAllocationValue"`
// The name of the partner to which the subscription belongs, however depending on which subscription, the invoicing can differ.
PartnerTransactionType *string `mandatory:"false" json:"partnerTransactionType"`
// Term value in months.
TermValue *int64 `mandatory:"false" json:"termValue"`
// Term value UOM (Unit of Measure).
TermValueUom *string `mandatory:"false" json:"termValueUom"`
// Booking opportunity number of subscribed service.
BookingOptyNumber *string `mandatory:"false" json:"bookingOptyNumber"`
// Subscribed service total value.
TotalValue *string `mandatory:"false" json:"totalValue"`
// Subscribed service promotion amount.
OriginalPromoAmount *string `mandatory:"false" json:"originalPromoAmount"`
// Sales order number associated with the subscribed service.
OrderNumber *int64 `mandatory:"false" json:"orderNumber"`
// Subscribed service data center region.
DataCenterRegion *string `mandatory:"false" json:"dataCenterRegion"`
// Subscribed service pricing model.
PricingModel *string `mandatory:"false" json:"pricingModel"`
// Subscribed service program type.
ProgramType *string `mandatory:"false" json:"programType"`
// Subscribed service promotion type.
PromoType *string `mandatory:"false" json:"promoType"`
// Subscribed service CSI (Customer Service Identifier) number.
Csi *int64 `mandatory:"false" json:"csi"`
// Subscribed service intent to pay parameter.
IsIntentToPay *bool `mandatory:"false" json:"isIntentToPay"`
// Subscribed service start date.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// Subscribed service end date.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
// List of commitment services of a line.
CommitmentServices []CommitmentService `mandatory:"false" json:"commitmentServices"`
// List of Associated Subscriptions
AssociatedSubscriptions []AssociatedSubscriptions `mandatory:"false" json:"associatedSubscriptions"`
}
func (m SubscriptionSubscribedService) String() string
func (m SubscriptionSubscribedService) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
SubscriptionSummary Subscription summary.
type SubscriptionSummary struct {
// Plan status.
Status *string `mandatory:"false" json:"status"`
// The date when the first service of the subscription was activated.
TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`
// The date when the last service of the subscription ends.
TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`
Currency *SubscriptionCurrency `mandatory:"false" json:"currency"`
// Customer-friendly service name provided by the PRG (Product Release Group).
ServiceName *string `mandatory:"false" json:"serviceName"`
// Hold reason of the plan.
HoldReason *string `mandatory:"false" json:"holdReason"`
// The date of the hold release.
TimeHoldReleaseEta *common.SDKTime `mandatory:"false" json:"timeHoldReleaseEta"`
// List of plan's subscribed services.
SubscribedServices []SubscriptionSubscribedService `mandatory:"false" json:"subscribedServices"`
}
func (m SubscriptionSummary) String() string
func (m SubscriptionSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly
UsageLedgerSummary Revenue invoice consumption detail for a subscription.
type UsageLedgerSummary struct {
// Commitment period from the subscription details summary.
CommitmentPeriod *string `mandatory:"false" json:"commitmentPeriod"`
// Revenue invoice consumption date.
TimeConsumption *common.SDKTime `mandatory:"false" json:"timeConsumption"`
// Authorization-order subscription identifier.
SubId *string `mandatory:"false" json:"subId"`
// Name of the consumed product or service.
ServiceName *string `mandatory:"false" json:"serviceName"`
// Amount consumed on the consumption date.
ConsumptionAmount *float64 `mandatory:"false" json:"consumptionAmount"`
// Consumption category. Known values include Consumption, Commitment Expiration, and Overage.
Type *string `mandatory:"false" json:"type"`
}
func (m UsageLedgerSummary) String() string
func (m UsageLedgerSummary) ValidateEnumValue() (bool, error)
ValidateEnumValue returns an error when providing an unsupported enum value This function is being called during constructing API request process Not recommended for calling this function directly