osubbillingschedule

package
v65.70.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 30, 2024 License: Apache-2.0, UPL-1.0 Imports: 6 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetBillingScheduleSummaryInvoiceStatusEnumStringValues 

func GetBillingScheduleSummaryInvoiceStatusEnumStringValues() []string

GetBillingScheduleSummaryInvoiceStatusEnumStringValues Enumerates the set of values in String for BillingScheduleSummaryInvoiceStatusEnum

func GetListBillingSchedulesSortByEnumStringValues 

func GetListBillingSchedulesSortByEnumStringValues() []string

GetListBillingSchedulesSortByEnumStringValues Enumerates the set of values in String for ListBillingSchedulesSortByEnum

func GetListBillingSchedulesSortOrderEnumStringValues 

func GetListBillingSchedulesSortOrderEnumStringValues() []string

GetListBillingSchedulesSortOrderEnumStringValues Enumerates the set of values in String for ListBillingSchedulesSortOrderEnum

Types

type BillingScheduleClient 

type BillingScheduleClient struct {
	common.BaseClient
	// contains filtered or unexported fields
}

BillingScheduleClient a client for BillingSchedule

func NewBillingScheduleClientWithConfigurationProvider 

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 

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 (*BillingScheduleClient) ConfigurationProvider 

func (client *BillingScheduleClient) ConfigurationProvider() *common.ConfigurationProvider

ConfigurationProvider the ConfigurationProvider used in this client, or null if none set

func (BillingScheduleClient) ListBillingSchedules 

func (client BillingScheduleClient) ListBillingSchedules(ctx context.Context, request ListBillingSchedulesRequest) (response ListBillingSchedulesResponse, err error)

ListBillingSchedules This list API returns all billing schedules for given subscription id and for a particular Subscribed Service if provided

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubbillingschedule/ListBillingSchedules.go.html to see an example of how to use ListBillingSchedules API.

func (*BillingScheduleClient) SetRegion 

func (client *BillingScheduleClient) SetRegion(region string)

SetRegion overrides the region of this client.

type BillingScheduleSummary 

type BillingScheduleSummary struct {

	// 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 AR Invoice Number
	ArInvoiceNumber *string `mandatory:"false" json:"arInvoiceNumber"`

	// Indicates the associated AR Customer transaction id a unique identifier existing on AR.
	ArCustomerTransactionId *string `mandatory:"false" json:"arCustomerTransactionId"`

	// Order number associated with the Subscribed Service
	OrderNumber *string `mandatory:"false" json:"orderNumber"`

	Product *Product `mandatory:"false" json:"product"`
}

BillingScheduleSummary Billing schedule details related to Subscription Id

func (BillingScheduleSummary) String 

func (m BillingScheduleSummary) String() string

func (BillingScheduleSummary) ValidateEnumValue 

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

type BillingScheduleSummaryInvoiceStatusEnum 

type BillingScheduleSummaryInvoiceStatusEnum string

BillingScheduleSummaryInvoiceStatusEnum Enum with underlying type: string 

const (
	BillingScheduleSummaryInvoiceStatusInvoiced    BillingScheduleSummaryInvoiceStatusEnum = "INVOICED"
	BillingScheduleSummaryInvoiceStatusNotInvoiced BillingScheduleSummaryInvoiceStatusEnum = "NOT_INVOICED"
)

Set of constants representing the allowable values for BillingScheduleSummaryInvoiceStatusEnum

func GetBillingScheduleSummaryInvoiceStatusEnumValues 

func GetBillingScheduleSummaryInvoiceStatusEnumValues() []BillingScheduleSummaryInvoiceStatusEnum

GetBillingScheduleSummaryInvoiceStatusEnumValues Enumerates the set of values for BillingScheduleSummaryInvoiceStatusEnum

func GetMappingBillingScheduleSummaryInvoiceStatusEnum 

func GetMappingBillingScheduleSummaryInvoiceStatusEnum(val string) (BillingScheduleSummaryInvoiceStatusEnum, bool)

GetMappingBillingScheduleSummaryInvoiceStatusEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBillingSchedulesRequest 

type ListBillingSchedulesRequest struct {

	// The OCID of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// This param is used to get only the billing schedules for a particular Subscription Id
	SubscriptionId *string `mandatory:"true" contributesTo:"query" name:"subscriptionId"`

	// This param is used to get only 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"`

	// The OCI home region name in case home region is not us-ashburn-1 (IAD), e.g. ap-mumbai-1, us-phoenix-1 etc.
	XOneOriginRegion *string `mandatory:"false" contributesTo:"header" name:"x-one-origin-region"`

	// 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
}

ListBillingSchedulesRequest wrapper for the ListBillingSchedules operation

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/osubbillingschedule/ListBillingSchedules.go.html to see an example of how to use ListBillingSchedulesRequest.

func (ListBillingSchedulesRequest) BinaryRequestBody 

func (request ListBillingSchedulesRequest) BinaryRequestBody() (*common.OCIReadSeekCloser, bool)

BinaryRequestBody implements the OCIRequest interface

func (ListBillingSchedulesRequest) HTTPRequest 

func (request ListBillingSchedulesRequest) HTTPRequest(method, path string, binaryRequestBody *common.OCIReadSeekCloser, extraHeaders map[string]string) (http.Request, error)

HTTPRequest implements the OCIRequest interface

func (ListBillingSchedulesRequest) RetryPolicy 

func (request ListBillingSchedulesRequest) RetryPolicy() *common.RetryPolicy

RetryPolicy implements the OCIRetryableRequest interface. This retrieves the specified retry policy.

func (ListBillingSchedulesRequest) String 

func (request ListBillingSchedulesRequest) String() string

func (ListBillingSchedulesRequest) ValidateEnumValue 

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

type ListBillingSchedulesResponse 

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"`
}

ListBillingSchedulesResponse wrapper for the ListBillingSchedules operation

func (ListBillingSchedulesResponse) HTTPResponse 

func (response ListBillingSchedulesResponse) HTTPResponse() *http.Response

HTTPResponse implements the OCIResponse interface

func (ListBillingSchedulesResponse) String 

func (response ListBillingSchedulesResponse) String() string

type ListBillingSchedulesSortByEnum 

type ListBillingSchedulesSortByEnum string

ListBillingSchedulesSortByEnum Enum with underlying type: string 

const (
	ListBillingSchedulesSortByOrdernumber   ListBillingSchedulesSortByEnum = "ORDERNUMBER"
	ListBillingSchedulesSortByTimeinvoicing ListBillingSchedulesSortByEnum = "TIMEINVOICING"
)

Set of constants representing the allowable values for ListBillingSchedulesSortByEnum

func GetListBillingSchedulesSortByEnumValues 

func GetListBillingSchedulesSortByEnumValues() []ListBillingSchedulesSortByEnum

GetListBillingSchedulesSortByEnumValues Enumerates the set of values for ListBillingSchedulesSortByEnum

func GetMappingListBillingSchedulesSortByEnum 

func GetMappingListBillingSchedulesSortByEnum(val string) (ListBillingSchedulesSortByEnum, bool)

GetMappingListBillingSchedulesSortByEnum performs case Insensitive comparison on enum value and return the desired enum

type ListBillingSchedulesSortOrderEnum 

type ListBillingSchedulesSortOrderEnum string

ListBillingSchedulesSortOrderEnum Enum with underlying type: string 

const (
	ListBillingSchedulesSortOrderAsc  ListBillingSchedulesSortOrderEnum = "ASC"
	ListBillingSchedulesSortOrderDesc ListBillingSchedulesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListBillingSchedulesSortOrderEnum

func GetListBillingSchedulesSortOrderEnumValues 

func GetListBillingSchedulesSortOrderEnumValues() []ListBillingSchedulesSortOrderEnum

GetListBillingSchedulesSortOrderEnumValues Enumerates the set of values for ListBillingSchedulesSortOrderEnum

func GetMappingListBillingSchedulesSortOrderEnum 

func GetMappingListBillingSchedulesSortOrderEnum(val string) (ListBillingSchedulesSortOrderEnum, bool)

GetMappingListBillingSchedulesSortOrderEnum performs case Insensitive comparison on enum value and return the desired enum

type Product 

type Product struct {

	// Indicates the associated AR Invoice Number
	PartNumber *string `mandatory:"true" json:"partNumber"`

	// Product name
	Name *string `mandatory:"true" json:"name"`
}

Product Product description

func (Product) String 

func (m Product) String() string

func (Product) ValidateEnumValue 

func (m Product) 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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.