ospgateway

package
v65.77.0 Latest Latest
Warning

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

 Go to latest Published: Oct 22, 2024 License: Apache-2.0, UPL-1.0 Imports: 8 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetAddressQualityTypeEnumStringValues added in v65.43.0 

func GetAddressQualityTypeEnumStringValues() []string

GetAddressQualityTypeEnumStringValues Enumerates the set of values in String for AddressQualityTypeEnum

func GetAddressVerificationCodeEnumStringValues added in v65.43.0 

func GetAddressVerificationCodeEnumStringValues() []string

GetAddressVerificationCodeEnumStringValues Enumerates the set of values in String for AddressVerificationCodeEnum

func GetCreditCardPaymentDetailCreditCardTypeEnumStringValues 

func GetCreditCardPaymentDetailCreditCardTypeEnumStringValues() []string

GetCreditCardPaymentDetailCreditCardTypeEnumStringValues Enumerates the set of values in String for CreditCardPaymentDetailCreditCardTypeEnum

func GetCreditCardTypeEnumStringValues 

func GetCreditCardTypeEnumStringValues() []string

GetCreditCardTypeEnumStringValues Enumerates the set of values in String for CreditCardTypeEnum

func GetEcheckPaymentDetailCardTypeEnumStringValues added in v65.43.0 

func GetEcheckPaymentDetailCardTypeEnumStringValues() []string

GetEcheckPaymentDetailCardTypeEnumStringValues Enumerates the set of values in String for EcheckPaymentDetailCardTypeEnum

func GetInvoiceInvoiceStatusEnumStringValues 

func GetInvoiceInvoiceStatusEnumStringValues() []string

GetInvoiceInvoiceStatusEnumStringValues Enumerates the set of values in String for InvoiceInvoiceStatusEnum

func GetInvoiceInvoiceTypeEnumStringValues 

func GetInvoiceInvoiceTypeEnumStringValues() []string

GetInvoiceInvoiceTypeEnumStringValues Enumerates the set of values in String for InvoiceInvoiceTypeEnum

func GetInvoiceSummaryInvoiceStatusEnumStringValues 

func GetInvoiceSummaryInvoiceStatusEnumStringValues() []string

GetInvoiceSummaryInvoiceStatusEnumStringValues Enumerates the set of values in String for InvoiceSummaryInvoiceStatusEnum

func GetInvoiceSummaryInvoiceTypeEnumStringValues 

func GetInvoiceSummaryInvoiceTypeEnumStringValues() []string

GetInvoiceSummaryInvoiceTypeEnumStringValues Enumerates the set of values in String for InvoiceSummaryInvoiceTypeEnum

func GetListInvoicesSortByEnumStringValues 

func GetListInvoicesSortByEnumStringValues() []string

GetListInvoicesSortByEnumStringValues Enumerates the set of values in String for ListInvoicesSortByEnum

func GetListInvoicesSortOrderEnumStringValues 

func GetListInvoicesSortOrderEnumStringValues() []string

GetListInvoicesSortOrderEnumStringValues Enumerates the set of values in String for ListInvoicesSortOrderEnum

func GetListInvoicesStatusEnumStringValues 

func GetListInvoicesStatusEnumStringValues() []string

GetListInvoicesStatusEnumStringValues Enumerates the set of values in String for ListInvoicesStatusEnum

func GetListInvoicesTypeEnumStringValues 

func GetListInvoicesTypeEnumStringValues() []string

GetListInvoicesTypeEnumStringValues Enumerates the set of values in String for ListInvoicesTypeEnum

func GetListSubscriptionsSortByEnumStringValues 

func GetListSubscriptionsSortByEnumStringValues() []string

GetListSubscriptionsSortByEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortOrderEnumStringValues 

func GetListSubscriptionsSortOrderEnumStringValues() []string

GetListSubscriptionsSortOrderEnumStringValues Enumerates the set of values in String for ListSubscriptionsSortOrderEnum

func GetOtherPaymentDetailCreditCardTypeEnumStringValues 

func GetOtherPaymentDetailCreditCardTypeEnumStringValues() []string

GetOtherPaymentDetailCreditCardTypeEnumStringValues Enumerates the set of values in String for OtherPaymentDetailCreditCardTypeEnum

func GetPaymentDetailPaymentMethodEnumStringValues 

func GetPaymentDetailPaymentMethodEnumStringValues() []string

GetPaymentDetailPaymentMethodEnumStringValues Enumerates the set of values in String for PaymentDetailPaymentMethodEnum

func GetPaymentMethodEnumStringValues 

func GetPaymentMethodEnumStringValues() []string

GetPaymentMethodEnumStringValues Enumerates the set of values in String for PaymentMethodEnum

func GetSubscriptionAccountTypeEnumStringValues added in v65.43.0 

func GetSubscriptionAccountTypeEnumStringValues() []string

GetSubscriptionAccountTypeEnumStringValues Enumerates the set of values in String for SubscriptionAccountTypeEnum

func GetSubscriptionPlanTypeEnumStringValues 

func GetSubscriptionPlanTypeEnumStringValues() []string

GetSubscriptionPlanTypeEnumStringValues Enumerates the set of values in String for SubscriptionPlanTypeEnum

func GetSubscriptionSummaryAccountTypeEnumStringValues added in v65.43.0 

func GetSubscriptionSummaryAccountTypeEnumStringValues() []string

GetSubscriptionSummaryAccountTypeEnumStringValues Enumerates the set of values in String for SubscriptionSummaryAccountTypeEnum

func GetSubscriptionSummaryPlanTypeEnumStringValues 

func GetSubscriptionSummaryPlanTypeEnumStringValues() []string

GetSubscriptionSummaryPlanTypeEnumStringValues Enumerates the set of values in String for SubscriptionSummaryPlanTypeEnum

func GetSubscriptionSummaryUpgradeStateDetailsEnumStringValues 

func GetSubscriptionSummaryUpgradeStateDetailsEnumStringValues() []string

GetSubscriptionSummaryUpgradeStateDetailsEnumStringValues Enumerates the set of values in String for SubscriptionSummaryUpgradeStateDetailsEnum

func GetSubscriptionSummaryUpgradeStateEnumStringValues 

func GetSubscriptionSummaryUpgradeStateEnumStringValues() []string

GetSubscriptionSummaryUpgradeStateEnumStringValues Enumerates the set of values in String for SubscriptionSummaryUpgradeStateEnum

func GetSubscriptionUpgradeStateDetailsEnumStringValues 

func GetSubscriptionUpgradeStateDetailsEnumStringValues() []string

GetSubscriptionUpgradeStateDetailsEnumStringValues Enumerates the set of values in String for SubscriptionUpgradeStateDetailsEnum

func GetSubscriptionUpgradeStateEnumStringValues 

func GetSubscriptionUpgradeStateEnumStringValues() []string

GetSubscriptionUpgradeStateEnumStringValues Enumerates the set of values in String for SubscriptionUpgradeStateEnum

func GetThirdPartyValidationTypeEnumStringValues added in v65.43.0 

func GetThirdPartyValidationTypeEnumStringValues() []string

GetThirdPartyValidationTypeEnumStringValues Enumerates the set of values in String for ThirdPartyValidationTypeEnum

Types

type Address added in v65.43.0 

type Address struct {

	// Address identifier.
	AddressKey *string `mandatory:"false" json:"addressKey"`

	// Address line 1.
	Line1 *string `mandatory:"false" json:"line1"`

	// Address line 2.
	Line2 *string `mandatory:"false" json:"line2"`

	// Address line 3.
	Line3 *string `mandatory:"false" json:"line3"`

	// Address line 4.
	Line4 *string `mandatory:"false" json:"line4"`

	// Street name of the address.
	StreetName *string `mandatory:"false" json:"streetName"`

	// Street number of the address.
	StreetNumber *string `mandatory:"false" json:"streetNumber"`

	// Name of the city.
	City *string `mandatory:"false" json:"city"`

	// County of the address.
	County *string `mandatory:"false" json:"county"`

	// Country of the address.
	Country *string `mandatory:"false" json:"country"`

	// Province of the address.
	Province *string `mandatory:"false" json:"province"`

	// Post code of the address.
	PostalCode *string `mandatory:"false" json:"postalCode"`

	// State of the address.
	State *string `mandatory:"false" json:"state"`

	// Contact person email address.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`

	// Name of the customer company.
	CompanyName *string `mandatory:"false" json:"companyName"`

	// First name of the contact person.
	FirstName *string `mandatory:"false" json:"firstName"`

	// Middle name of the contact person.
	MiddleName *string `mandatory:"false" json:"middleName"`

	// Last name of the contact person.
	LastName *string `mandatory:"false" json:"lastName"`

	// Phone country code of the contact person.
	PhoneCountryCode *string `mandatory:"false" json:"phoneCountryCode"`

	// Phone number of the contact person.
	PhoneNumber *string `mandatory:"false" json:"phoneNumber"`

	// Job title of the contact person.
	JobTitle *string `mandatory:"false" json:"jobTitle"`

	// Department name of the customer company.
	DepartmentName *string `mandatory:"false" json:"departmentName"`

	// Internal number of the customer company.
	InternalNumber *string `mandatory:"false" json:"internalNumber"`

	// Contributor class of the customer company.
	ContributorClass *string `mandatory:"false" json:"contributorClass"`

	// State Inscription.
	StateInscription *string `mandatory:"false" json:"stateInscription"`

	// Municipal Inscription.
	MunicipalInscription *string `mandatory:"false" json:"municipalInscription"`
}

Address Address details model.

func (Address) String added in v65.43.0 

func (m Address) String() string

func (Address) ValidateEnumValue added in v65.43.0 

func (m Address) 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 AddressQualityTypeEnum added in v65.43.0 

type AddressQualityTypeEnum string

AddressQualityTypeEnum Enum with underlying type: string 

const (
	AddressQualityTypeExcellent AddressQualityTypeEnum = "EXCELLENT"
	AddressQualityTypeGood      AddressQualityTypeEnum = "GOOD"
	AddressQualityTypeAverage   AddressQualityTypeEnum = "AVERAGE"
	AddressQualityTypePoor      AddressQualityTypeEnum = "POOR"
	AddressQualityTypeBad       AddressQualityTypeEnum = "BAD"
)

Set of constants representing the allowable values for AddressQualityTypeEnum

func GetAddressQualityTypeEnumValues added in v65.43.0 

func GetAddressQualityTypeEnumValues() []AddressQualityTypeEnum

GetAddressQualityTypeEnumValues Enumerates the set of values for AddressQualityTypeEnum

func GetMappingAddressQualityTypeEnum added in v65.43.0 

func GetMappingAddressQualityTypeEnum(val string) (AddressQualityTypeEnum, bool)

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

type AddressRule added in v65.43.0 

type AddressRule struct {

	// Country code for the address rule in ISO-3166-1 2-letter format
	CountryCode *string `mandatory:"true" json:"countryCode"`

	Address *AddressTypeRule `mandatory:"true" json:"address"`

	Contact *ContactTypeRule `mandatory:"false" json:"contact"`

	Tax *TaxTypeRule `mandatory:"false" json:"tax"`
}

AddressRule Addres rule information

func (AddressRule) String added in v65.43.0 

func (m AddressRule) String() string

func (AddressRule) ValidateEnumValue added in v65.43.0 

func (m AddressRule) 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 AddressRuleServiceClient added in v65.43.0 

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

AddressRuleServiceClient a client for AddressRuleService

func NewAddressRuleServiceClientWithConfigurationProvider added in v65.43.0 

func NewAddressRuleServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AddressRuleServiceClient, err error)

NewAddressRuleServiceClientWithConfigurationProvider Creates a new default AddressRuleService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewAddressRuleServiceClientWithOboToken added in v65.43.0 

func NewAddressRuleServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AddressRuleServiceClient, err error)

NewAddressRuleServiceClientWithOboToken Creates a new default AddressRuleService 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 (*AddressRuleServiceClient) ConfigurationProvider added in v65.43.0 

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

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

func (AddressRuleServiceClient) GetAddressRule added in v65.43.0 

func (client AddressRuleServiceClient) GetAddressRule(ctx context.Context, request GetAddressRuleRequest) (response GetAddressRuleResponse, err error)

GetAddressRule Get the address rule for the compartment based on the country code

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/GetAddressRule.go.html to see an example of how to use GetAddressRule API. A default retry strategy applies to this operation GetAddressRule()

func (*AddressRuleServiceClient) SetRegion added in v65.43.0 

func (client *AddressRuleServiceClient) SetRegion(region string)

SetRegion overrides the region of this client.

type AddressServiceClient added in v65.43.0 

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

AddressServiceClient a client for AddressService

func NewAddressServiceClientWithConfigurationProvider added in v65.43.0 

func NewAddressServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client AddressServiceClient, err error)

NewAddressServiceClientWithConfigurationProvider Creates a new default AddressService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewAddressServiceClientWithOboToken added in v65.43.0 

func NewAddressServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client AddressServiceClient, err error)

NewAddressServiceClientWithOboToken Creates a new default AddressService 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 (*AddressServiceClient) ConfigurationProvider added in v65.43.0 

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

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

func (AddressServiceClient) GetAddress added in v65.43.0 

func (client AddressServiceClient) GetAddress(ctx context.Context, request GetAddressRequest) (response GetAddressResponse, err error)

GetAddress Get the address by id for the compartment

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/GetAddress.go.html to see an example of how to use GetAddress API. A default retry strategy applies to this operation GetAddress()

func (*AddressServiceClient) SetRegion added in v65.43.0 

func (client *AddressServiceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (AddressServiceClient) VerifyAddress added in v65.43.0 

func (client AddressServiceClient) VerifyAddress(ctx context.Context, request VerifyAddressRequest) (response VerifyAddressResponse, err error)

VerifyAddress Verify address

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/VerifyAddress.go.html to see an example of how to use VerifyAddress API. A default retry strategy applies to this operation VerifyAddress()

type AddressTypeRule added in v65.43.0 

type AddressTypeRule struct {

	// Address type rule fields
	Fields []Field `mandatory:"true" json:"fields"`

	// Third party validation.
	ThirdPartyValidation ThirdPartyValidationTypeEnum `mandatory:"false" json:"thirdPartyValidation,omitempty"`
}

AddressTypeRule Address type rule information

func (AddressTypeRule) String added in v65.43.0 

func (m AddressTypeRule) String() string

func (AddressTypeRule) ValidateEnumValue added in v65.43.0 

func (m AddressTypeRule) 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 AddressVerificationCodeEnum added in v65.43.0 

type AddressVerificationCodeEnum string

AddressVerificationCodeEnum Enum with underlying type: string 

const (
	AddressVerificationCodeVerified          AddressVerificationCodeEnum = "VERIFIED"
	AddressVerificationCodePartiallyVerified AddressVerificationCodeEnum = "PARTIALLY_VERIFIED"
	AddressVerificationCodeAmbiguous         AddressVerificationCodeEnum = "AMBIGUOUS"
	AddressVerificationCodeReverted          AddressVerificationCodeEnum = "REVERTED"
	AddressVerificationCodeUnverified        AddressVerificationCodeEnum = "UNVERIFIED"
)

Set of constants representing the allowable values for AddressVerificationCodeEnum

func GetAddressVerificationCodeEnumValues added in v65.43.0 

func GetAddressVerificationCodeEnumValues() []AddressVerificationCodeEnum

GetAddressVerificationCodeEnumValues Enumerates the set of values for AddressVerificationCodeEnum

func GetMappingAddressVerificationCodeEnum added in v65.43.0 

func GetMappingAddressVerificationCodeEnum(val string) (AddressVerificationCodeEnum, bool)

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

type AuthorizeSubscriptionPaymentDetails 

type AuthorizeSubscriptionPaymentDetails struct {
	Subscription *Subscription `mandatory:"true" json:"subscription"`

	// Language code
	LanguageCode *string `mandatory:"true" json:"languageCode"`

	// User email
	Email *string `mandatory:"true" json:"email"`
}

AuthorizeSubscriptionPaymentDetails Request object for a subscription payment authorization

func (AuthorizeSubscriptionPaymentDetails) String 

func (m AuthorizeSubscriptionPaymentDetails) String() string

func (AuthorizeSubscriptionPaymentDetails) ValidateEnumValue 

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

type AuthorizeSubscriptionPaymentReceipt struct {

	// Payment header id
	HeaderId *string `mandatory:"true" json:"headerId"`

	// Parameters in a token for Payment Service
	ApiToken *string `mandatory:"false" json:"apiToken"`

	// Session token created for Payment Service
	UserToken *string `mandatory:"false" json:"userToken"`
}

AuthorizeSubscriptionPaymentReceipt Subscription payment authorization response

func (AuthorizeSubscriptionPaymentReceipt) String 

func (m AuthorizeSubscriptionPaymentReceipt) String() string

func (AuthorizeSubscriptionPaymentReceipt) ValidateEnumValue 

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

type AuthorizeSubscriptionPaymentRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// Subscription id(OCID).
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// subscription payment request.
	AuthorizeSubscriptionPaymentDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header
	// called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

AuthorizeSubscriptionPaymentRequest wrapper for the AuthorizeSubscriptionPayment operation

See also

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

func (AuthorizeSubscriptionPaymentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (AuthorizeSubscriptionPaymentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (AuthorizeSubscriptionPaymentRequest) RetryPolicy 

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

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

func (AuthorizeSubscriptionPaymentRequest) String 

func (request AuthorizeSubscriptionPaymentRequest) String() string

func (AuthorizeSubscriptionPaymentRequest) ValidateEnumValue 

func (request AuthorizeSubscriptionPaymentRequest) 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 AuthorizeSubscriptionPaymentResponse 

type AuthorizeSubscriptionPaymentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AuthorizeSubscriptionPaymentReceipt instance
	AuthorizeSubscriptionPaymentReceipt `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

AuthorizeSubscriptionPaymentResponse wrapper for the AuthorizeSubscriptionPayment operation

func (AuthorizeSubscriptionPaymentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (AuthorizeSubscriptionPaymentResponse) String 

func (response AuthorizeSubscriptionPaymentResponse) String() string

type BillToAddress 

type BillToAddress struct {

	// Name of the contact person
	ContactName *string `mandatory:"false" json:"contactName"`

	// Name of the customer company
	CompanyName *string `mandatory:"false" json:"companyName"`

	// Address line 1
	AddressLine1 *string `mandatory:"false" json:"addressLine1"`

	// Address line 2
	AddressLine2 *string `mandatory:"false" json:"addressLine2"`

	// Address line 3
	AddressLine3 *string `mandatory:"false" json:"addressLine3"`

	// Address line 4
	AddressLine4 *string `mandatory:"false" json:"addressLine4"`

	// Street name
	StreetName *string `mandatory:"false" json:"streetName"`

	// House no
	StreetNumber *string `mandatory:"false" json:"streetNumber"`

	// Name of the city
	City *string `mandatory:"false" json:"city"`

	Country *Country `mandatory:"false" json:"country"`

	// County name
	County *string `mandatory:"false" json:"county"`

	// Name of the state
	State *string `mandatory:"false" json:"state"`

	// ZIP no
	PostalCode *string `mandatory:"false" json:"postalCode"`

	// Name of the province
	Province *string `mandatory:"false" json:"province"`
}

BillToAddress Address details model

func (BillToAddress) String 

func (m BillToAddress) String() string

func (BillToAddress) ValidateEnumValue 

func (m BillToAddress) 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 ContactTypeRule added in v65.43.0 

type ContactTypeRule struct {

	// Contact type rule fields
	Fields []Field `mandatory:"true" json:"fields"`
}

ContactTypeRule Contact type rule information

func (ContactTypeRule) String added in v65.43.0 

func (m ContactTypeRule) String() string

func (ContactTypeRule) ValidateEnumValue added in v65.43.0 

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

type Country struct {

	// Indentifier of the country. This is a DB side unique id which was generated when the entity was created in the table
	CountryId *float32 `mandatory:"false" json:"countryId"`

	// Country code in ISO-3166-1 2-letter format
	CountryCode *string `mandatory:"false" json:"countryCode"`

	// Name of the country
	CountryName *string `mandatory:"false" json:"countryName"`

	// Language identifier
	LanguageId *float32 `mandatory:"false" json:"languageId"`

	// Country code in ISO-3166-1 3-letter format
	Ascii3CountryCode *string `mandatory:"false" json:"ascii3CountryCode"`
}

Country Country details model

func (Country) String 

func (m Country) String() string

func (Country) ValidateEnumValue 

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

type CreditCardPaymentDetail struct {

	// Paid the invoice on this day
	TimePaidOn *common.SDKTime `mandatory:"false" json:"timePaidOn"`

	// example
	PaidBy *string `mandatory:"false" json:"paidBy"`

	// Amount that paid
	AmountPaid *float32 `mandatory:"false" json:"amountPaid"`

	// Name on the credit card
	NameOnCard *string `mandatory:"false" json:"nameOnCard"`

	// Last four digits of the card
	LastDigits *string `mandatory:"false" json:"lastDigits"`

	// Expired date of the credit card
	TimeExpiration *common.SDKTime `mandatory:"false" json:"timeExpiration"`

	// Credit card type
	CreditCardType CreditCardPaymentDetailCreditCardTypeEnum `mandatory:"false" json:"creditCardType,omitempty"`
}

CreditCardPaymentDetail Credit card Payment related details

func (CreditCardPaymentDetail) GetAmountPaid 

func (m CreditCardPaymentDetail) GetAmountPaid() *float32

GetAmountPaid returns AmountPaid

func (CreditCardPaymentDetail) GetPaidBy 

func (m CreditCardPaymentDetail) GetPaidBy() *string

GetPaidBy returns PaidBy

func (CreditCardPaymentDetail) GetTimePaidOn 

func (m CreditCardPaymentDetail) GetTimePaidOn() *common.SDKTime

GetTimePaidOn returns TimePaidOn

func (CreditCardPaymentDetail) MarshalJSON 

func (m CreditCardPaymentDetail) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreditCardPaymentDetail) String 

func (m CreditCardPaymentDetail) String() string

func (CreditCardPaymentDetail) ValidateEnumValue 

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

type CreditCardPaymentDetailCreditCardTypeEnum string

CreditCardPaymentDetailCreditCardTypeEnum Enum with underlying type: string 

const (
	CreditCardPaymentDetailCreditCardTypeVisa       CreditCardPaymentDetailCreditCardTypeEnum = "VISA"
	CreditCardPaymentDetailCreditCardTypeAmex       CreditCardPaymentDetailCreditCardTypeEnum = "AMEX"
	CreditCardPaymentDetailCreditCardTypeMastercard CreditCardPaymentDetailCreditCardTypeEnum = "MASTERCARD"
	CreditCardPaymentDetailCreditCardTypeDiscover   CreditCardPaymentDetailCreditCardTypeEnum = "DISCOVER"
	CreditCardPaymentDetailCreditCardTypeJcb        CreditCardPaymentDetailCreditCardTypeEnum = "JCB"
	CreditCardPaymentDetailCreditCardTypeDiner      CreditCardPaymentDetailCreditCardTypeEnum = "DINER"
	CreditCardPaymentDetailCreditCardTypeElo        CreditCardPaymentDetailCreditCardTypeEnum = "ELO"
)

Set of constants representing the allowable values for CreditCardPaymentDetailCreditCardTypeEnum

func GetCreditCardPaymentDetailCreditCardTypeEnumValues 

func GetCreditCardPaymentDetailCreditCardTypeEnumValues() []CreditCardPaymentDetailCreditCardTypeEnum

GetCreditCardPaymentDetailCreditCardTypeEnumValues Enumerates the set of values for CreditCardPaymentDetailCreditCardTypeEnum

func GetMappingCreditCardPaymentDetailCreditCardTypeEnum 

func GetMappingCreditCardPaymentDetailCreditCardTypeEnum(val string) (CreditCardPaymentDetailCreditCardTypeEnum, bool)

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

type CreditCardPaymentOption 

type CreditCardPaymentOption struct {

	// Wallet instrument internal id.
	WalletInstrumentId *string `mandatory:"false" json:"walletInstrumentId"`

	// Wallet transaction id.
	WalletTransactionId *string `mandatory:"false" json:"walletTransactionId"`

	// Last four digits of the card.
	LastDigits *string `mandatory:"false" json:"lastDigits"`

	// Name on the credit card.
	NameOnCard *string `mandatory:"false" json:"nameOnCard"`

	// Expired date of the credit card.
	TimeExpiration *common.SDKTime `mandatory:"false" json:"timeExpiration"`

	// Credit card type.
	CreditCardType CreditCardTypeEnum `mandatory:"false" json:"creditCardType,omitempty"`
}

CreditCardPaymentOption Credit card Payment related details

func (CreditCardPaymentOption) GetWalletInstrumentId 

func (m CreditCardPaymentOption) GetWalletInstrumentId() *string

GetWalletInstrumentId returns WalletInstrumentId

func (CreditCardPaymentOption) GetWalletTransactionId 

func (m CreditCardPaymentOption) GetWalletTransactionId() *string

GetWalletTransactionId returns WalletTransactionId

func (CreditCardPaymentOption) MarshalJSON 

func (m CreditCardPaymentOption) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (CreditCardPaymentOption) String 

func (m CreditCardPaymentOption) String() string

func (CreditCardPaymentOption) ValidateEnumValue 

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

type CreditCardTypeEnum string

CreditCardTypeEnum Enum with underlying type: string 

const (
	CreditCardTypeVisa       CreditCardTypeEnum = "VISA"
	CreditCardTypeAmex       CreditCardTypeEnum = "AMEX"
	CreditCardTypeMastercard CreditCardTypeEnum = "MASTERCARD"
	CreditCardTypeDiscover   CreditCardTypeEnum = "DISCOVER"
	CreditCardTypeJcb        CreditCardTypeEnum = "JCB"
	CreditCardTypeDiner      CreditCardTypeEnum = "DINER"
	CreditCardTypeElo        CreditCardTypeEnum = "ELO"
)

Set of constants representing the allowable values for CreditCardTypeEnum

func GetCreditCardTypeEnumValues 

func GetCreditCardTypeEnumValues() []CreditCardTypeEnum

GetCreditCardTypeEnumValues Enumerates the set of values for CreditCardTypeEnum

func GetMappingCreditCardTypeEnum 

func GetMappingCreditCardTypeEnum(val string) (CreditCardTypeEnum, bool)

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

type Currency 

type Currency struct {

	// Currency code
	CurrencyCode *string `mandatory:"false" json:"currencyCode"`

	// Currency symbol
	CurrencySymbol *string `mandatory:"false" json:"currencySymbol"`

	// Name of the currency
	Name *string `mandatory:"false" json:"name"`

	// USD conversion rate of the currency
	UsdConversion *float32 `mandatory:"false" json:"usdConversion"`

	// Round decimal point
	RoundDecimalPoint *float32 `mandatory:"false" json:"roundDecimalPoint"`
}

Currency Currency details model

func (Currency) String 

func (m Currency) String() string

func (Currency) ValidateEnumValue 

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

type DownloadPdfContentRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The identifier of the invoice.
	InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"`

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

DownloadPdfContentRequest wrapper for the DownloadPdfContent operation

See also

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

func (DownloadPdfContentRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (DownloadPdfContentRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (DownloadPdfContentRequest) RetryPolicy 

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

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

func (DownloadPdfContentRequest) String 

func (request DownloadPdfContentRequest) String() string

func (DownloadPdfContentRequest) ValidateEnumValue 

func (request DownloadPdfContentRequest) 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 DownloadPdfContentResponse 

type DownloadPdfContentResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The io.ReadCloser instance
	Content io.ReadCloser `presentIn:"body" encoding:"binary"`

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

	// Set content to download
	ContentDisposition *string `presentIn:"header" name:"content-disposition"`

	// Set the content type to download
	ContentType *string `presentIn:"header" name:"content-type"`

	// Set the content length to download
	ContentLength *int `presentIn:"header" name:"content-length"`
}

DownloadPdfContentResponse wrapper for the DownloadPdfContent operation

func (DownloadPdfContentResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (DownloadPdfContentResponse) String 

func (response DownloadPdfContentResponse) String() string

type EcheckPaymentDetail added in v65.43.0 

type EcheckPaymentDetail struct {

	// Paid the invoice on this day
	TimePaidOn *common.SDKTime `mandatory:"false" json:"timePaidOn"`

	// example
	PaidBy *string `mandatory:"false" json:"paidBy"`

	// Amount that paid
	AmountPaid *float32 `mandatory:"false" json:"amountPaid"`

	// Name on the echeck card
	NameOnCard *string `mandatory:"false" json:"nameOnCard"`

	// Account number of the card owner
	AccountNumber *string `mandatory:"false" json:"accountNumber"`

	// Routing number of the echeck card
	RoutingNumber *string `mandatory:"false" json:"routingNumber"`

	// Echeck card type
	CardType EcheckPaymentDetailCardTypeEnum `mandatory:"false" json:"cardType,omitempty"`
}

EcheckPaymentDetail Echeck Payment related details

func (EcheckPaymentDetail) GetAmountPaid added in v65.43.0 

func (m EcheckPaymentDetail) GetAmountPaid() *float32

GetAmountPaid returns AmountPaid

func (EcheckPaymentDetail) GetPaidBy added in v65.43.0 

func (m EcheckPaymentDetail) GetPaidBy() *string

GetPaidBy returns PaidBy

func (EcheckPaymentDetail) GetTimePaidOn added in v65.43.0 

func (m EcheckPaymentDetail) GetTimePaidOn() *common.SDKTime

GetTimePaidOn returns TimePaidOn

func (EcheckPaymentDetail) MarshalJSON added in v65.43.0 

func (m EcheckPaymentDetail) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (EcheckPaymentDetail) String added in v65.43.0 

func (m EcheckPaymentDetail) String() string

func (EcheckPaymentDetail) ValidateEnumValue added in v65.43.0 

func (m EcheckPaymentDetail) 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 EcheckPaymentDetailCardTypeEnum added in v65.43.0 

type EcheckPaymentDetailCardTypeEnum string

EcheckPaymentDetailCardTypeEnum Enum with underlying type: string 

const (
	EcheckPaymentDetailCardTypeSaving            EcheckPaymentDetailCardTypeEnum = "SAVING"
	EcheckPaymentDetailCardTypeChecking          EcheckPaymentDetailCardTypeEnum = "CHECKING"
	EcheckPaymentDetailCardTypeCorporateChecking EcheckPaymentDetailCardTypeEnum = "CORPORATE_CHECKING"
)

Set of constants representing the allowable values for EcheckPaymentDetailCardTypeEnum

func GetEcheckPaymentDetailCardTypeEnumValues added in v65.43.0 

func GetEcheckPaymentDetailCardTypeEnumValues() []EcheckPaymentDetailCardTypeEnum

GetEcheckPaymentDetailCardTypeEnumValues Enumerates the set of values for EcheckPaymentDetailCardTypeEnum

func GetMappingEcheckPaymentDetailCardTypeEnum added in v65.43.0 

func GetMappingEcheckPaymentDetailCardTypeEnum(val string) (EcheckPaymentDetailCardTypeEnum, bool)

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

type Field added in v65.43.0 

type Field struct {

	// The field name
	Name *string `mandatory:"true" json:"name"`

	// The given field is requeired or not
	IsRequired *bool `mandatory:"true" json:"isRequired"`

	Format *Format `mandatory:"false" json:"format"`

	Label *Label `mandatory:"false" json:"label"`

	// Locale code (rfc4646 format) of a forced language (e.g.: jp addresses require jp always)
	Language *string `mandatory:"false" json:"language"`
}

Field Field information

func (Field) String added in v65.43.0 

func (m Field) String() string

func (Field) ValidateEnumValue added in v65.43.0 

func (m Field) 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 Format added in v65.43.0 

type Format struct {

	// Regex format specification
	Value *string `mandatory:"true" json:"value"`

	// Example of the desired format that matches the regex
	Example *string `mandatory:"false" json:"example"`
}

Format Format information

func (Format) String added in v65.43.0 

func (m Format) String() string

func (Format) ValidateEnumValue added in v65.43.0 

func (m Format) 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 GetAddressRequest added in v65.43.0 

type GetAddressRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The identifier of the address.
	AddressId *string `mandatory:"true" contributesTo:"path" name:"addressId"`

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

GetAddressRequest wrapper for the GetAddress operation

See also

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

func (GetAddressRequest) BinaryRequestBody added in v65.43.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetAddressRequest) HTTPRequest added in v65.43.0 

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

HTTPRequest implements the OCIRequest interface

func (GetAddressRequest) RetryPolicy added in v65.43.0 

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

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

func (GetAddressRequest) String added in v65.43.0 

func (request GetAddressRequest) String() string

func (GetAddressRequest) ValidateEnumValue added in v65.43.0 

func (request GetAddressRequest) 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 GetAddressResponse added in v65.43.0 

type GetAddressResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Address instance
	Address `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"`
}

GetAddressResponse wrapper for the GetAddress operation

func (GetAddressResponse) HTTPResponse added in v65.43.0 

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

HTTPResponse implements the OCIResponse interface

func (GetAddressResponse) String added in v65.43.0 

func (response GetAddressResponse) String() string

type GetAddressRuleRequest added in v65.43.0 

type GetAddressRuleRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Country code for the address rule in ISO-3166-1 2-letter format.
	CountryCode *string `mandatory:"true" contributesTo:"path" name:"countryCode"`

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

GetAddressRuleRequest wrapper for the GetAddressRule operation

See also

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

func (GetAddressRuleRequest) BinaryRequestBody added in v65.43.0 

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

BinaryRequestBody implements the OCIRequest interface

func (GetAddressRuleRequest) HTTPRequest added in v65.43.0 

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

HTTPRequest implements the OCIRequest interface

func (GetAddressRuleRequest) RetryPolicy added in v65.43.0 

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

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

func (GetAddressRuleRequest) String added in v65.43.0 

func (request GetAddressRuleRequest) String() string

func (GetAddressRuleRequest) ValidateEnumValue added in v65.43.0 

func (request GetAddressRuleRequest) 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 GetAddressRuleResponse added in v65.43.0 

type GetAddressRuleResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The AddressRule instance
	AddressRule `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"`
}

GetAddressRuleResponse wrapper for the GetAddressRule operation

func (GetAddressRuleResponse) HTTPResponse added in v65.43.0 

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

HTTPResponse implements the OCIResponse interface

func (GetAddressRuleResponse) String added in v65.43.0 

func (response GetAddressRuleResponse) String() string

type GetInvoiceRequest 

type GetInvoiceRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The identifier of the invoice.
	InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"`

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

GetInvoiceRequest wrapper for the GetInvoice operation

See also

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

func (GetInvoiceRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetInvoiceRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetInvoiceRequest) RetryPolicy 

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

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

func (GetInvoiceRequest) String 

func (request GetInvoiceRequest) String() string

func (GetInvoiceRequest) ValidateEnumValue 

func (request GetInvoiceRequest) 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 GetInvoiceResponse 

type GetInvoiceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Invoice instance
	Invoice `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

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

GetInvoiceResponse wrapper for the GetInvoice operation

func (GetInvoiceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetInvoiceResponse) String 

func (response GetInvoiceResponse) String() string

type GetSubscriptionRequest 

type GetSubscriptionRequest struct {

	// Subscription id(OCID).
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

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

GetSubscriptionRequest wrapper for the GetSubscription operation

See also

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

func (GetSubscriptionRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (GetSubscriptionRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (GetSubscriptionRequest) RetryPolicy 

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

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

func (GetSubscriptionRequest) String 

func (request GetSubscriptionRequest) String() string

func (GetSubscriptionRequest) ValidateEnumValue 

func (request GetSubscriptionRequest) 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 GetSubscriptionResponse 

type GetSubscriptionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Subscription instance
	Subscription `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

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

GetSubscriptionResponse wrapper for the GetSubscription operation

func (GetSubscriptionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (GetSubscriptionResponse) String 

func (response GetSubscriptionResponse) String() string

type Invoice 

type Invoice struct {

	// Invoice identifier which is generated on the on-premise sie. Pls note this is not an OCID
	InvoiceId *string `mandatory:"true" json:"invoiceId"`

	// Invoice external reference
	InvoiceNumber *string `mandatory:"false" json:"invoiceNumber"`

	// Transaction identifier
	InternalInvoiceId *string `mandatory:"false" json:"internalInvoiceId"`

	// Is credit card payment eligible
	IsCreditCardPayable *bool `mandatory:"false" json:"isCreditCardPayable"`

	// Date of invoice
	TimeInvoice *common.SDKTime `mandatory:"false" json:"timeInvoice"`

	// Tax of invoice amount
	Tax *float32 `mandatory:"false" json:"tax"`

	// Total amount of invoice
	InvoiceAmount *float32 `mandatory:"false" json:"invoiceAmount"`

	// Balance of invoice
	InvoiceAmountDue *float32 `mandatory:"false" json:"invoiceAmountDue"`

	// Invoice amount credit
	InvoiceAmountCredited *float32 `mandatory:"false" json:"invoiceAmountCredited"`

	// Invoice amount adjust
	InvoiceAmountAdjusted *float32 `mandatory:"false" json:"invoiceAmountAdjusted"`

	// Invoice amount applied
	InvoiceAmountApplied *float32 `mandatory:"false" json:"invoiceAmountApplied"`

	Currency *Currency `mandatory:"false" json:"currency"`

	// Type of invoice
	InvoiceType InvoiceInvoiceTypeEnum `mandatory:"false" json:"invoiceType,omitempty"`

	// Due date of invoice
	TimeInvoiceDue *common.SDKTime `mandatory:"false" json:"timeInvoiceDue"`

	// Invoice reference number
	InvoiceRefNumber *string `mandatory:"false" json:"invoiceRefNumber"`

	// Invoice PO number
	InvoicePoNumber *string `mandatory:"false" json:"invoicePoNumber"`

	// Invoice status
	InvoiceStatus InvoiceInvoiceStatusEnum `mandatory:"false" json:"invoiceStatus,omitempty"`

	// Preferred Email on the invoice
	PreferredEmail *string `mandatory:"false" json:"preferredEmail"`

	// Is emailing pdf allowed
	IsPdfEmailAvailable *bool `mandatory:"false" json:"isPdfEmailAvailable"`

	// Is pdf download access allowed
	IsDisplayDownloadPdf *bool `mandatory:"false" json:"isDisplayDownloadPdf"`

	// Whether invoice can be payed
	IsPayable *bool `mandatory:"false" json:"isPayable"`

	// Payment terms
	PaymentTerms *string `mandatory:"false" json:"paymentTerms"`

	LastPaymentDetail PaymentDetail `mandatory:"false" json:"lastPaymentDetail"`

	BillToAddress *BillToAddress `mandatory:"false" json:"billToAddress"`

	// List of subscription identifiers
	SubscriptionIds []string `mandatory:"false" json:"subscriptionIds"`
}

Invoice Invoice details

func (Invoice) String 

func (m Invoice) String() string

func (*Invoice) UnmarshalJSON 

func (m *Invoice) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Invoice) ValidateEnumValue 

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

type InvoiceCollection struct {

	// Invoice list elements
	Items []InvoiceSummary `mandatory:"true" json:"items"`
}

InvoiceCollection Invoice list

func (InvoiceCollection) String 

func (m InvoiceCollection) String() string

func (InvoiceCollection) ValidateEnumValue 

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

type InvoiceInvoiceStatusEnum string

InvoiceInvoiceStatusEnum Enum with underlying type: string 

const (
	InvoiceInvoiceStatusOpen             InvoiceInvoiceStatusEnum = "OPEN"
	InvoiceInvoiceStatusPastDue          InvoiceInvoiceStatusEnum = "PAST_DUE"
	InvoiceInvoiceStatusPaymentSubmitted InvoiceInvoiceStatusEnum = "PAYMENT_SUBMITTED"
	InvoiceInvoiceStatusClosed           InvoiceInvoiceStatusEnum = "CLOSED"
)

Set of constants representing the allowable values for InvoiceInvoiceStatusEnum

func GetInvoiceInvoiceStatusEnumValues 

func GetInvoiceInvoiceStatusEnumValues() []InvoiceInvoiceStatusEnum

GetInvoiceInvoiceStatusEnumValues Enumerates the set of values for InvoiceInvoiceStatusEnum

func GetMappingInvoiceInvoiceStatusEnum 

func GetMappingInvoiceInvoiceStatusEnum(val string) (InvoiceInvoiceStatusEnum, bool)

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

type InvoiceInvoiceTypeEnum 

type InvoiceInvoiceTypeEnum string

InvoiceInvoiceTypeEnum Enum with underlying type: string 

const (
	InvoiceInvoiceTypeHardware     InvoiceInvoiceTypeEnum = "HARDWARE"
	InvoiceInvoiceTypeSubscription InvoiceInvoiceTypeEnum = "SUBSCRIPTION"
	InvoiceInvoiceTypeSupport      InvoiceInvoiceTypeEnum = "SUPPORT"
	InvoiceInvoiceTypeLicense      InvoiceInvoiceTypeEnum = "LICENSE"
	InvoiceInvoiceTypeEducation    InvoiceInvoiceTypeEnum = "EDUCATION"
	InvoiceInvoiceTypeConsulting   InvoiceInvoiceTypeEnum = "CONSULTING"
	InvoiceInvoiceTypeService      InvoiceInvoiceTypeEnum = "SERVICE"
	InvoiceInvoiceTypeUsage        InvoiceInvoiceTypeEnum = "USAGE"
)

Set of constants representing the allowable values for InvoiceInvoiceTypeEnum

func GetInvoiceInvoiceTypeEnumValues 

func GetInvoiceInvoiceTypeEnumValues() []InvoiceInvoiceTypeEnum

GetInvoiceInvoiceTypeEnumValues Enumerates the set of values for InvoiceInvoiceTypeEnum

func GetMappingInvoiceInvoiceTypeEnum 

func GetMappingInvoiceInvoiceTypeEnum(val string) (InvoiceInvoiceTypeEnum, bool)

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

type InvoiceLineCollection 

type InvoiceLineCollection struct {

	// Invoice line list elements
	Items []InvoiceLineSummary `mandatory:"true" json:"items"`
}

InvoiceLineCollection Invoice line list

func (InvoiceLineCollection) String 

func (m InvoiceLineCollection) String() string

func (InvoiceLineCollection) ValidateEnumValue 

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

type InvoiceLineSummary struct {

	// Product of the item
	Product *string `mandatory:"true" json:"product"`

	// Product of the item
	OrderNo *string `mandatory:"false" json:"orderNo"`

	// Part number
	PartNumber *string `mandatory:"false" json:"partNumber"`

	// Start date
	TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`

	// End date
	TimeEnd *common.SDKTime `mandatory:"false" json:"timeEnd"`

	// Quantity of the ordered product
	Quantity *float32 `mandatory:"false" json:"quantity"`

	// Unit price of the ordered product
	NetUnitPrice *float32 `mandatory:"false" json:"netUnitPrice"`

	// Total price of the ordered product (Net unit price x quantity)
	TotalPrice *float32 `mandatory:"false" json:"totalPrice"`

	Currency *Currency `mandatory:"false" json:"currency"`
}

InvoiceLineSummary Product items of the invoice

func (InvoiceLineSummary) String 

func (m InvoiceLineSummary) String() string

func (InvoiceLineSummary) ValidateEnumValue 

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

type InvoiceServiceClient 

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

InvoiceServiceClient a client for InvoiceService

func NewInvoiceServiceClientWithConfigurationProvider 

func NewInvoiceServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client InvoiceServiceClient, err error)

NewInvoiceServiceClientWithConfigurationProvider Creates a new default InvoiceService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewInvoiceServiceClientWithOboToken 

func NewInvoiceServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client InvoiceServiceClient, err error)

NewInvoiceServiceClientWithOboToken Creates a new default InvoiceService 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 (*InvoiceServiceClient) ConfigurationProvider 

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

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

func (InvoiceServiceClient) DownloadPdfContent 

func (client InvoiceServiceClient) DownloadPdfContent(ctx context.Context, request DownloadPdfContentRequest) (response DownloadPdfContentResponse, err error)

DownloadPdfContent Returns an invoice in pdf format

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/DownloadPdfContent.go.html to see an example of how to use DownloadPdfContent API. A default retry strategy applies to this operation DownloadPdfContent()

func (InvoiceServiceClient) GetInvoice 

func (client InvoiceServiceClient) GetInvoice(ctx context.Context, request GetInvoiceRequest) (response GetInvoiceResponse, err error)

GetInvoice Returns an invoice by invoice id

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/GetInvoice.go.html to see an example of how to use GetInvoice API. A default retry strategy applies to this operation GetInvoice()

func (InvoiceServiceClient) ListInvoiceLines 

func (client InvoiceServiceClient) ListInvoiceLines(ctx context.Context, request ListInvoiceLinesRequest) (response ListInvoiceLinesResponse, err error)

ListInvoiceLines Returns the invoice product list by invoice id

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/ListInvoiceLines.go.html to see an example of how to use ListInvoiceLines API. A default retry strategy applies to this operation ListInvoiceLines()

func (InvoiceServiceClient) ListInvoices 

func (client InvoiceServiceClient) ListInvoices(ctx context.Context, request ListInvoicesRequest) (response ListInvoicesResponse, err error)

ListInvoices Returns a list of invoices

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/ListInvoices.go.html to see an example of how to use ListInvoices API. A default retry strategy applies to this operation ListInvoices()

func (InvoiceServiceClient) PayInvoice 

func (client InvoiceServiceClient) PayInvoice(ctx context.Context, request PayInvoiceRequest) (response PayInvoiceResponse, err error)

PayInvoice Pay an invoice

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/PayInvoice.go.html to see an example of how to use PayInvoice API. A default retry strategy applies to this operation PayInvoice()

func (*InvoiceServiceClient) SetRegion 

func (client *InvoiceServiceClient) SetRegion(region string)

SetRegion overrides the region of this client.

type InvoiceSummary 

type InvoiceSummary struct {

	// Invoice identifier
	InvoiceId *string `mandatory:"true" json:"invoiceId"`

	// Invoice external reference
	InvoiceNumber *string `mandatory:"false" json:"invoiceNumber"`

	// PC invoice identifier
	InternalInvoiceId *string `mandatory:"false" json:"internalInvoiceId"`

	// Is credit card payment eligible
	IsCreditCardPayable *bool `mandatory:"false" json:"isCreditCardPayable"`

	// Invoice status
	InvoiceStatus InvoiceSummaryInvoiceStatusEnum `mandatory:"false" json:"invoiceStatus,omitempty"`

	// Type of invoice
	InvoiceType InvoiceSummaryInvoiceTypeEnum `mandatory:"false" json:"invoiceType,omitempty"`

	// Is the invoice has been already payed
	IsPaid *bool `mandatory:"false" json:"isPaid"`

	// Whether invoice can be payed
	IsPayable *bool `mandatory:"false" json:"isPayable"`

	// Invoice amount
	InvoiceAmount *float32 `mandatory:"false" json:"invoiceAmount"`

	// Invoice amount due
	InvoiceAmountDue *float32 `mandatory:"false" json:"invoiceAmountDue"`

	// Invoice amount credit
	InvoiceAmountCredited *float32 `mandatory:"false" json:"invoiceAmountCredited"`

	// Invoice amount adjust
	InvoiceAmountAdjusted *float32 `mandatory:"false" json:"invoiceAmountAdjusted"`

	// Invoice amount applied
	InvoiceAmountApplied *float32 `mandatory:"false" json:"invoiceAmountApplied"`

	// Due date of invoice amount
	TimeInvoiceDue *common.SDKTime `mandatory:"false" json:"timeInvoiceDue"`

	// Is the last payment failed
	IsPaymentFailed *bool `mandatory:"false" json:"isPaymentFailed"`

	// Invoice amount in dispute
	InvoiceAmountInDispute *float32 `mandatory:"false" json:"invoiceAmountInDispute"`

	// Invoice reference number
	InvoiceRefNumber *string `mandatory:"false" json:"invoiceRefNumber"`

	// Invoice PO number
	InvoicePoNumber *string `mandatory:"false" json:"invoicePoNumber"`

	// Date of invoice
	TimeInvoice *common.SDKTime `mandatory:"false" json:"timeInvoice"`

	Currency *Currency `mandatory:"false" json:"currency"`

	// Is emailing pdf allowed
	IsPdfEmailAvailable *bool `mandatory:"false" json:"isPdfEmailAvailable"`

	// Is view access allowed
	IsDisplayViewPdf *bool `mandatory:"false" json:"isDisplayViewPdf"`

	// Is pdf download access allowed
	IsDisplayDownloadPdf *bool `mandatory:"false" json:"isDisplayDownloadPdf"`

	LastPaymentDetail PaymentDetail `mandatory:"false" json:"lastPaymentDetail"`

	// Name of the bill to customer
	PartyName *string `mandatory:"false" json:"partyName"`

	// List of subscription identifiers
	SubscriptionIds []string `mandatory:"false" json:"subscriptionIds"`
}

InvoiceSummary Invoice list elements

func (InvoiceSummary) String 

func (m InvoiceSummary) String() string

func (*InvoiceSummary) UnmarshalJSON 

func (m *InvoiceSummary) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (InvoiceSummary) ValidateEnumValue 

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

type InvoiceSummaryInvoiceStatusEnum 

type InvoiceSummaryInvoiceStatusEnum string

InvoiceSummaryInvoiceStatusEnum Enum with underlying type: string 

const (
	InvoiceSummaryInvoiceStatusOpen             InvoiceSummaryInvoiceStatusEnum = "OPEN"
	InvoiceSummaryInvoiceStatusPastDue          InvoiceSummaryInvoiceStatusEnum = "PAST_DUE"
	InvoiceSummaryInvoiceStatusPaymentSubmitted InvoiceSummaryInvoiceStatusEnum = "PAYMENT_SUBMITTED"
	InvoiceSummaryInvoiceStatusClosed           InvoiceSummaryInvoiceStatusEnum = "CLOSED"
)

Set of constants representing the allowable values for InvoiceSummaryInvoiceStatusEnum

func GetInvoiceSummaryInvoiceStatusEnumValues 

func GetInvoiceSummaryInvoiceStatusEnumValues() []InvoiceSummaryInvoiceStatusEnum

GetInvoiceSummaryInvoiceStatusEnumValues Enumerates the set of values for InvoiceSummaryInvoiceStatusEnum

func GetMappingInvoiceSummaryInvoiceStatusEnum 

func GetMappingInvoiceSummaryInvoiceStatusEnum(val string) (InvoiceSummaryInvoiceStatusEnum, bool)

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

type InvoiceSummaryInvoiceTypeEnum 

type InvoiceSummaryInvoiceTypeEnum string

InvoiceSummaryInvoiceTypeEnum Enum with underlying type: string 

const (
	InvoiceSummaryInvoiceTypeHardware     InvoiceSummaryInvoiceTypeEnum = "HARDWARE"
	InvoiceSummaryInvoiceTypeSubscription InvoiceSummaryInvoiceTypeEnum = "SUBSCRIPTION"
	InvoiceSummaryInvoiceTypeSupport      InvoiceSummaryInvoiceTypeEnum = "SUPPORT"
	InvoiceSummaryInvoiceTypeLicense      InvoiceSummaryInvoiceTypeEnum = "LICENSE"
	InvoiceSummaryInvoiceTypeEducation    InvoiceSummaryInvoiceTypeEnum = "EDUCATION"
	InvoiceSummaryInvoiceTypeConsulting   InvoiceSummaryInvoiceTypeEnum = "CONSULTING"
	InvoiceSummaryInvoiceTypeService      InvoiceSummaryInvoiceTypeEnum = "SERVICE"
	InvoiceSummaryInvoiceTypeUsage        InvoiceSummaryInvoiceTypeEnum = "USAGE"
)

Set of constants representing the allowable values for InvoiceSummaryInvoiceTypeEnum

func GetInvoiceSummaryInvoiceTypeEnumValues 

func GetInvoiceSummaryInvoiceTypeEnumValues() []InvoiceSummaryInvoiceTypeEnum

GetInvoiceSummaryInvoiceTypeEnumValues Enumerates the set of values for InvoiceSummaryInvoiceTypeEnum

func GetMappingInvoiceSummaryInvoiceTypeEnum 

func GetMappingInvoiceSummaryInvoiceTypeEnum(val string) (InvoiceSummaryInvoiceTypeEnum, bool)

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

type Label added in v65.43.0 

type Label struct {

	// Language token of the required label
	Value *string `mandatory:"true" json:"value"`

	// English translation of the label (for reference only - translation is not provided)
	Example *string `mandatory:"false" json:"example"`
}

Label Label information

func (Label) String added in v65.43.0 

func (m Label) String() string

func (Label) ValidateEnumValue added in v65.43.0 

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

type ListInvoiceLinesRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The identifier of the invoice.
	InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"`

	// The 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"`

	// For list pagination. The value of the opc-next-page response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

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

ListInvoiceLinesRequest wrapper for the ListInvoiceLines operation

See also

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

func (ListInvoiceLinesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListInvoiceLinesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListInvoiceLinesRequest) RetryPolicy 

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

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

func (ListInvoiceLinesRequest) String 

func (request ListInvoiceLinesRequest) String() string

func (ListInvoiceLinesRequest) ValidateEnumValue 

func (request ListInvoiceLinesRequest) 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 ListInvoiceLinesResponse 

type ListInvoiceLinesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of InvoiceLineCollection instances
	InvoiceLineCollection `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

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

	// For list pagination. If this header appears in the response, then this
	// is a partial list of invoices. Include this value as the `page` parameter in a subsequent
	// GET request to get the next batch of invoices.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// The total number of items that match the query.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}

ListInvoiceLinesResponse wrapper for the ListInvoiceLines operation

func (ListInvoiceLinesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListInvoiceLinesResponse) String 

func (response ListInvoiceLinesResponse) String() string

type ListInvoicesRequest 

type ListInvoicesRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The 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 invoice query param (not unique).
	InvoiceId *string `mandatory:"false" contributesTo:"query" name:"invoiceId"`

	// A filter to only return resources that match the given type exactly.
	Type []ListInvoicesTypeEnum `contributesTo:"query" name:"type" omitEmpty:"true" collectionFormat:"multi"`

	// A filter to only return resources that match the given value.
	// Looking for partial matches in the following fileds:
	// Invoice No., Reference No. (plan number), Payment Ref, Total Amount(plan number), Balance Due(plan number)
	// and Party/Customer Name
	SearchText *string `mandatory:"false" contributesTo:"query" name:"searchText"`

	// description: Start time (UTC) of the target invoice date range for which to fetch invoice data (inclusive).
	TimeInvoiceStart *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeInvoiceStart"`

	// description: End time (UTC) of the target invoice date range for which to fetch invoice data (exclusive).
	TimeInvoiceEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timeInvoiceEnd"`

	// description: Start time (UTC) of the target payment date range for which to fetch invoice data (inclusive).
	TimePaymentStart *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timePaymentStart"`

	// description: End time (UTC) of the target payment date range for which to fetch invoice data (exclusive).
	TimePaymentEnd *common.SDKTime `mandatory:"false" contributesTo:"query" name:"timePaymentEnd"`

	// A filter to only return resources that match one of the status elements.
	Status []ListInvoicesStatusEnum `contributesTo:"query" name:"status" omitEmpty:"true" collectionFormat:"multi"`

	// For list pagination. The value of the opc-next-page response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one field can be selected for sorting.
	SortBy ListInvoicesSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use (ascending or descending).
	SortOrder ListInvoicesSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListInvoicesRequest wrapper for the ListInvoices operation

See also

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

func (ListInvoicesRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListInvoicesRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListInvoicesRequest) RetryPolicy 

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

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

func (ListInvoicesRequest) String 

func (request ListInvoicesRequest) String() string

func (ListInvoicesRequest) ValidateEnumValue 

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

type ListInvoicesResponse 

type ListInvoicesResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of InvoiceCollection instances
	InvoiceCollection `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"`

	// For list pagination. If this header appears in the response, then this
	// is a partial list of invoices. Include this value as the `page` parameter in a subsequent
	// GET request to get the next batch of invoices.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// The total number of items that match the query.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}

ListInvoicesResponse wrapper for the ListInvoices operation

func (ListInvoicesResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListInvoicesResponse) String 

func (response ListInvoicesResponse) String() string

type ListInvoicesSortByEnum 

type ListInvoicesSortByEnum string

ListInvoicesSortByEnum Enum with underlying type: string 

const (
	ListInvoicesSortByInvoiceNo   ListInvoicesSortByEnum = "INVOICE_NO"
	ListInvoicesSortByRefNo       ListInvoicesSortByEnum = "REF_NO"
	ListInvoicesSortByStatus      ListInvoicesSortByEnum = "STATUS"
	ListInvoicesSortByType        ListInvoicesSortByEnum = "TYPE"
	ListInvoicesSortByInvoiceDate ListInvoicesSortByEnum = "INVOICE_DATE"
	ListInvoicesSortByDueDate     ListInvoicesSortByEnum = "DUE_DATE"
	ListInvoicesSortByPaymRef     ListInvoicesSortByEnum = "PAYM_REF"
	ListInvoicesSortByTotalAmount ListInvoicesSortByEnum = "TOTAL_AMOUNT"
	ListInvoicesSortByBalanceDue  ListInvoicesSortByEnum = "BALANCE_DUE"
)

Set of constants representing the allowable values for ListInvoicesSortByEnum

func GetListInvoicesSortByEnumValues 

func GetListInvoicesSortByEnumValues() []ListInvoicesSortByEnum

GetListInvoicesSortByEnumValues Enumerates the set of values for ListInvoicesSortByEnum

func GetMappingListInvoicesSortByEnum 

func GetMappingListInvoicesSortByEnum(val string) (ListInvoicesSortByEnum, bool)

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

type ListInvoicesSortOrderEnum 

type ListInvoicesSortOrderEnum string

ListInvoicesSortOrderEnum Enum with underlying type: string 

const (
	ListInvoicesSortOrderAsc  ListInvoicesSortOrderEnum = "ASC"
	ListInvoicesSortOrderDesc ListInvoicesSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListInvoicesSortOrderEnum

func GetListInvoicesSortOrderEnumValues 

func GetListInvoicesSortOrderEnumValues() []ListInvoicesSortOrderEnum

GetListInvoicesSortOrderEnumValues Enumerates the set of values for ListInvoicesSortOrderEnum

func GetMappingListInvoicesSortOrderEnum 

func GetMappingListInvoicesSortOrderEnum(val string) (ListInvoicesSortOrderEnum, bool)

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

type ListInvoicesStatusEnum 

type ListInvoicesStatusEnum string

ListInvoicesStatusEnum Enum with underlying type: string 

const (
	ListInvoicesStatusOpen             ListInvoicesStatusEnum = "OPEN"
	ListInvoicesStatusPastDue          ListInvoicesStatusEnum = "PAST_DUE"
	ListInvoicesStatusPaymentSubmitted ListInvoicesStatusEnum = "PAYMENT_SUBMITTED"
	ListInvoicesStatusClosed           ListInvoicesStatusEnum = "CLOSED"
)

Set of constants representing the allowable values for ListInvoicesStatusEnum

func GetListInvoicesStatusEnumValues 

func GetListInvoicesStatusEnumValues() []ListInvoicesStatusEnum

GetListInvoicesStatusEnumValues Enumerates the set of values for ListInvoicesStatusEnum

func GetMappingListInvoicesStatusEnum 

func GetMappingListInvoicesStatusEnum(val string) (ListInvoicesStatusEnum, bool)

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

type ListInvoicesTypeEnum 

type ListInvoicesTypeEnum string

ListInvoicesTypeEnum Enum with underlying type: string 

const (
	ListInvoicesTypeHardware     ListInvoicesTypeEnum = "HARDWARE"
	ListInvoicesTypeSubscription ListInvoicesTypeEnum = "SUBSCRIPTION"
	ListInvoicesTypeSupport      ListInvoicesTypeEnum = "SUPPORT"
	ListInvoicesTypeLicense      ListInvoicesTypeEnum = "LICENSE"
	ListInvoicesTypeEducation    ListInvoicesTypeEnum = "EDUCATION"
	ListInvoicesTypeConsulting   ListInvoicesTypeEnum = "CONSULTING"
	ListInvoicesTypeService      ListInvoicesTypeEnum = "SERVICE"
	ListInvoicesTypeUsage        ListInvoicesTypeEnum = "USAGE"
)

Set of constants representing the allowable values for ListInvoicesTypeEnum

func GetListInvoicesTypeEnumValues 

func GetListInvoicesTypeEnumValues() []ListInvoicesTypeEnum

GetListInvoicesTypeEnumValues Enumerates the set of values for ListInvoicesTypeEnum

func GetMappingListInvoicesTypeEnum 

func GetMappingListInvoicesTypeEnum(val string) (ListInvoicesTypeEnum, bool)

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

type ListSubscriptionsRequest 

type ListSubscriptionsRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// The 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"`

	// For list pagination. The value of the opc-next-page response header from the previous "List" call.
	Page *string `mandatory:"false" contributesTo:"query" name:"page"`

	// For list pagination. The maximum number of results per page, or items to return in a paginated "List" call.
	Limit *int `mandatory:"false" contributesTo:"query" name:"limit"`

	// The field to sort by. Only one field can be selected for sorting.
	SortBy ListSubscriptionsSortByEnum `mandatory:"false" contributesTo:"query" name:"sortBy" omitEmpty:"true"`

	// The sort order to use (ascending or descending).
	SortOrder ListSubscriptionsSortOrderEnum `mandatory:"false" contributesTo:"query" name:"sortOrder" omitEmpty:"true"`

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

ListSubscriptionsRequest wrapper for the ListSubscriptions operation

See also

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

func (ListSubscriptionsRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (ListSubscriptionsRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (ListSubscriptionsRequest) RetryPolicy 

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

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

func (ListSubscriptionsRequest) String 

func (request ListSubscriptionsRequest) String() string

func (ListSubscriptionsRequest) ValidateEnumValue 

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

type ListSubscriptionsResponse 

type ListSubscriptionsResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// A list of SubscriptionCollection instances
	SubscriptionCollection `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"`

	// For list pagination. If this header appears in the response, then this
	// is a partial list of invoices. Include this value as the `page` parameter in a subsequent
	// GET request to get the next batch of invoices.
	OpcNextPage *string `presentIn:"header" name:"opc-next-page"`

	// The total number of items that match the query.
	OpcTotalItems *int `presentIn:"header" name:"opc-total-items"`
}

ListSubscriptionsResponse wrapper for the ListSubscriptions operation

func (ListSubscriptionsResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (ListSubscriptionsResponse) String 

func (response ListSubscriptionsResponse) String() string

type ListSubscriptionsSortByEnum 

type ListSubscriptionsSortByEnum string

ListSubscriptionsSortByEnum Enum with underlying type: string 

const (
	ListSubscriptionsSortByInvoiceNo   ListSubscriptionsSortByEnum = "INVOICE_NO"
	ListSubscriptionsSortByRefNo       ListSubscriptionsSortByEnum = "REF_NO"
	ListSubscriptionsSortByStatus      ListSubscriptionsSortByEnum = "STATUS"
	ListSubscriptionsSortByType        ListSubscriptionsSortByEnum = "TYPE"
	ListSubscriptionsSortByInvoiceDate ListSubscriptionsSortByEnum = "INVOICE_DATE"
	ListSubscriptionsSortByDueDate     ListSubscriptionsSortByEnum = "DUE_DATE"
	ListSubscriptionsSortByPaymRef     ListSubscriptionsSortByEnum = "PAYM_REF"
	ListSubscriptionsSortByTotalAmount ListSubscriptionsSortByEnum = "TOTAL_AMOUNT"
	ListSubscriptionsSortByBalanceDue  ListSubscriptionsSortByEnum = "BALANCE_DUE"
)

Set of constants representing the allowable values for ListSubscriptionsSortByEnum

func GetListSubscriptionsSortByEnumValues 

func GetListSubscriptionsSortByEnumValues() []ListSubscriptionsSortByEnum

GetListSubscriptionsSortByEnumValues Enumerates the set of values for ListSubscriptionsSortByEnum

func GetMappingListSubscriptionsSortByEnum 

func GetMappingListSubscriptionsSortByEnum(val string) (ListSubscriptionsSortByEnum, bool)

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

type ListSubscriptionsSortOrderEnum 

type ListSubscriptionsSortOrderEnum string

ListSubscriptionsSortOrderEnum Enum with underlying type: string 

const (
	ListSubscriptionsSortOrderAsc  ListSubscriptionsSortOrderEnum = "ASC"
	ListSubscriptionsSortOrderDesc ListSubscriptionsSortOrderEnum = "DESC"
)

Set of constants representing the allowable values for ListSubscriptionsSortOrderEnum

func GetListSubscriptionsSortOrderEnumValues 

func GetListSubscriptionsSortOrderEnumValues() []ListSubscriptionsSortOrderEnum

GetListSubscriptionsSortOrderEnumValues Enumerates the set of values for ListSubscriptionsSortOrderEnum

func GetMappingListSubscriptionsSortOrderEnum 

func GetMappingListSubscriptionsSortOrderEnum(val string) (ListSubscriptionsSortOrderEnum, bool)

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

type MerchantDefinedData 

type MerchantDefinedData struct {

	// Promotion type code.
	PromoType *string `mandatory:"false" json:"promoType"`

	// Cloud account name.
	CloudAccountName *string `mandatory:"false" json:"cloudAccountName"`
}

MerchantDefinedData Merchant details.

func (MerchantDefinedData) String 

func (m MerchantDefinedData) String() string

func (MerchantDefinedData) ValidateEnumValue 

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

type OtherPaymentDetail struct {

	// Paid the invoice on this day
	TimePaidOn *common.SDKTime `mandatory:"false" json:"timePaidOn"`

	// example
	PaidBy *string `mandatory:"false" json:"paidBy"`

	// Amount that paid
	AmountPaid *float32 `mandatory:"false" json:"amountPaid"`

	// Last four routing digits of the card
	EcheckRouting *string `mandatory:"false" json:"echeckRouting"`

	// Name on the echeck card
	NameOnCard *string `mandatory:"false" json:"nameOnCard"`

	// Last four digits of the card
	LastDigits *string `mandatory:"false" json:"lastDigits"`

	// Expired date of the echeck card
	TimeExpiration *common.SDKTime `mandatory:"false" json:"timeExpiration"`

	// Echeck card type
	CreditCardType OtherPaymentDetailCreditCardTypeEnum `mandatory:"false" json:"creditCardType,omitempty"`
}

OtherPaymentDetail Other Payment related details

func (OtherPaymentDetail) GetAmountPaid 

func (m OtherPaymentDetail) GetAmountPaid() *float32

GetAmountPaid returns AmountPaid

func (OtherPaymentDetail) GetPaidBy 

func (m OtherPaymentDetail) GetPaidBy() *string

GetPaidBy returns PaidBy

func (OtherPaymentDetail) GetTimePaidOn 

func (m OtherPaymentDetail) GetTimePaidOn() *common.SDKTime

GetTimePaidOn returns TimePaidOn

func (OtherPaymentDetail) MarshalJSON 

func (m OtherPaymentDetail) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (OtherPaymentDetail) String 

func (m OtherPaymentDetail) String() string

func (OtherPaymentDetail) ValidateEnumValue 

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

type OtherPaymentDetailCreditCardTypeEnum string

OtherPaymentDetailCreditCardTypeEnum Enum with underlying type: string 

const (
	OtherPaymentDetailCreditCardTypeVisa              OtherPaymentDetailCreditCardTypeEnum = "VISA"
	OtherPaymentDetailCreditCardTypeAmex              OtherPaymentDetailCreditCardTypeEnum = "AMEX"
	OtherPaymentDetailCreditCardTypeMastercard        OtherPaymentDetailCreditCardTypeEnum = "MASTERCARD"
	OtherPaymentDetailCreditCardTypeDiscover          OtherPaymentDetailCreditCardTypeEnum = "DISCOVER"
	OtherPaymentDetailCreditCardTypeJcb               OtherPaymentDetailCreditCardTypeEnum = "JCB"
	OtherPaymentDetailCreditCardTypeDiner             OtherPaymentDetailCreditCardTypeEnum = "DINER"
	OtherPaymentDetailCreditCardTypeElo               OtherPaymentDetailCreditCardTypeEnum = "ELO"
	OtherPaymentDetailCreditCardTypeSaving            OtherPaymentDetailCreditCardTypeEnum = "SAVING"
	OtherPaymentDetailCreditCardTypeChecking          OtherPaymentDetailCreditCardTypeEnum = "CHECKING"
	OtherPaymentDetailCreditCardTypeCorporateChecking OtherPaymentDetailCreditCardTypeEnum = "CORPORATE_CHECKING"
)

Set of constants representing the allowable values for OtherPaymentDetailCreditCardTypeEnum

func GetMappingOtherPaymentDetailCreditCardTypeEnum 

func GetMappingOtherPaymentDetailCreditCardTypeEnum(val string) (OtherPaymentDetailCreditCardTypeEnum, bool)

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

func GetOtherPaymentDetailCreditCardTypeEnumValues 

func GetOtherPaymentDetailCreditCardTypeEnumValues() []OtherPaymentDetailCreditCardTypeEnum

GetOtherPaymentDetailCreditCardTypeEnumValues Enumerates the set of values for OtherPaymentDetailCreditCardTypeEnum

type PayInvoiceDetails 

type PayInvoiceDetails struct {

	// User email
	Email *string `mandatory:"true" json:"email"`

	// Language code
	LanguageCode *string `mandatory:"false" json:"languageCode"`

	// Callback URL
	ReturnUrl *string `mandatory:"false" json:"returnUrl"`
}

PayInvoiceDetails Request object for invoice payment

func (PayInvoiceDetails) String 

func (m PayInvoiceDetails) String() string

func (PayInvoiceDetails) ValidateEnumValue 

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

type PayInvoiceReceipt struct {

	// Payment header id
	HeaderId *string `mandatory:"true" json:"headerId"`

	// Url of the Payment Service
	Url *string `mandatory:"false" json:"url"`

	// Token created for Payment Service
	Token *string `mandatory:"false" json:"token"`
}

PayInvoiceReceipt Invoice payment action response

func (PayInvoiceReceipt) String 

func (m PayInvoiceReceipt) String() string

func (PayInvoiceReceipt) ValidateEnumValue 

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

type PayInvoiceRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The identifier of the invoice.
	InternalInvoiceId *string `mandatory:"true" contributesTo:"path" name:"internalInvoiceId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Invoice payment request.
	PayInvoiceDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header
	// called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

PayInvoiceRequest wrapper for the PayInvoice operation

See also

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

func (PayInvoiceRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (PayInvoiceRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (PayInvoiceRequest) RetryPolicy 

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

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

func (PayInvoiceRequest) String 

func (request PayInvoiceRequest) String() string

func (PayInvoiceRequest) ValidateEnumValue 

func (request PayInvoiceRequest) 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 PayInvoiceResponse 

type PayInvoiceResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PayInvoiceReceipt instance
	PayInvoiceReceipt `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

PayInvoiceResponse wrapper for the PayInvoice operation

func (PayInvoiceResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (PayInvoiceResponse) String 

func (response PayInvoiceResponse) String() string

type PaySubscriptionDetails 

type PaySubscriptionDetails struct {
	Subscription *Subscription `mandatory:"true" json:"subscription"`

	// Language code
	LanguageCode *string `mandatory:"true" json:"languageCode"`

	// User email
	Email *string `mandatory:"true" json:"email"`
}

PaySubscriptionDetails Request object for paying a subscription

func (PaySubscriptionDetails) String 

func (m PaySubscriptionDetails) String() string

func (PaySubscriptionDetails) ValidateEnumValue 

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

type PaySubscriptionReceipt struct {

	// Payment header id
	HeaderId *string `mandatory:"true" json:"headerId"`

	// Parameters in a token for Payment Service
	ApiToken *string `mandatory:"false" json:"apiToken"`

	// Session token created for Payment Service
	UserToken *string `mandatory:"false" json:"userToken"`
}

PaySubscriptionReceipt Subscription payment action response

func (PaySubscriptionReceipt) String 

func (m PaySubscriptionReceipt) String() string

func (PaySubscriptionReceipt) ValidateEnumValue 

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

type PaySubscriptionRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// Subscription id(OCID).
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// subscription payment request.
	PaySubscriptionDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header
	// called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

PaySubscriptionRequest wrapper for the PaySubscription operation

See also

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

func (PaySubscriptionRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (PaySubscriptionRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (PaySubscriptionRequest) RetryPolicy 

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

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

func (PaySubscriptionRequest) String 

func (request PaySubscriptionRequest) String() string

func (PaySubscriptionRequest) ValidateEnumValue 

func (request PaySubscriptionRequest) 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 PaySubscriptionResponse 

type PaySubscriptionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The PaySubscriptionReceipt instance
	PaySubscriptionReceipt `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

PaySubscriptionResponse wrapper for the PaySubscription operation

func (PaySubscriptionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (PaySubscriptionResponse) String 

func (response PaySubscriptionResponse) String() string

type PaymentDetail 

type PaymentDetail interface {

	// Paid the invoice on this day
	GetTimePaidOn() *common.SDKTime

	// example
	GetPaidBy() *string

	// Amount that paid
	GetAmountPaid() *float32
}

PaymentDetail Payment related details

type PaymentDetailPaymentMethodEnum 

type PaymentDetailPaymentMethodEnum string

PaymentDetailPaymentMethodEnum Enum with underlying type: string 

const (
	PaymentDetailPaymentMethodCreditCard PaymentDetailPaymentMethodEnum = "CREDIT_CARD"
	PaymentDetailPaymentMethodPaypal     PaymentDetailPaymentMethodEnum = "PAYPAL"
	PaymentDetailPaymentMethodEcheck     PaymentDetailPaymentMethodEnum = "ECHECK"
	PaymentDetailPaymentMethodOther      PaymentDetailPaymentMethodEnum = "OTHER"
)

Set of constants representing the allowable values for PaymentDetailPaymentMethodEnum

func GetMappingPaymentDetailPaymentMethodEnum 

func GetMappingPaymentDetailPaymentMethodEnum(val string) (PaymentDetailPaymentMethodEnum, bool)

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

func GetPaymentDetailPaymentMethodEnumValues 

func GetPaymentDetailPaymentMethodEnumValues() []PaymentDetailPaymentMethodEnum

GetPaymentDetailPaymentMethodEnumValues Enumerates the set of values for PaymentDetailPaymentMethodEnum

type PaymentGateway 

type PaymentGateway struct {
	MerchantDefinedData *MerchantDefinedData `mandatory:"false" json:"merchantDefinedData"`
}

PaymentGateway Payment gateway details.

func (PaymentGateway) String 

func (m PaymentGateway) String() string

func (PaymentGateway) ValidateEnumValue 

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

type PaymentMethodEnum string

PaymentMethodEnum Enum with underlying type: string 

const (
	PaymentMethodCreditCard PaymentMethodEnum = "CREDIT_CARD"
	PaymentMethodPaypal     PaymentMethodEnum = "PAYPAL"
)

Set of constants representing the allowable values for PaymentMethodEnum

func GetMappingPaymentMethodEnum 

func GetMappingPaymentMethodEnum(val string) (PaymentMethodEnum, bool)

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

func GetPaymentMethodEnumValues 

func GetPaymentMethodEnumValues() []PaymentMethodEnum

GetPaymentMethodEnumValues Enumerates the set of values for PaymentMethodEnum

type PaymentOption 

type PaymentOption interface {

	// Wallet instrument internal id.
	GetWalletInstrumentId() *string

	// Wallet transaction id.
	GetWalletTransactionId() *string
}

PaymentOption Payment option of a subscription.

type PaypalPaymentDetail 

type PaypalPaymentDetail struct {

	// Paid the invoice on this day
	TimePaidOn *common.SDKTime `mandatory:"false" json:"timePaidOn"`

	// example
	PaidBy *string `mandatory:"false" json:"paidBy"`

	// Amount that paid
	AmountPaid *float32 `mandatory:"false" json:"amountPaid"`

	// The id (email address) of the paypal payment
	PaypalId *string `mandatory:"false" json:"paypalId"`

	// paypal payment reference
	PaypalReference *string `mandatory:"false" json:"paypalReference"`
}

PaypalPaymentDetail PayPal Payment related details

func (PaypalPaymentDetail) GetAmountPaid 

func (m PaypalPaymentDetail) GetAmountPaid() *float32

GetAmountPaid returns AmountPaid

func (PaypalPaymentDetail) GetPaidBy 

func (m PaypalPaymentDetail) GetPaidBy() *string

GetPaidBy returns PaidBy

func (PaypalPaymentDetail) GetTimePaidOn 

func (m PaypalPaymentDetail) GetTimePaidOn() *common.SDKTime

GetTimePaidOn returns TimePaidOn

func (PaypalPaymentDetail) MarshalJSON 

func (m PaypalPaymentDetail) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PaypalPaymentDetail) String 

func (m PaypalPaymentDetail) String() string

func (PaypalPaymentDetail) ValidateEnumValue 

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

type PaypalPaymentOption struct {

	// Wallet instrument internal id.
	WalletInstrumentId *string `mandatory:"false" json:"walletInstrumentId"`

	// Wallet transaction id.
	WalletTransactionId *string `mandatory:"false" json:"walletTransactionId"`

	// The email address of the paypal user.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`

	// First name of the paypal user.
	FirstName *string `mandatory:"false" json:"firstName"`

	// Last name of the paypal user.
	LastName *string `mandatory:"false" json:"lastName"`

	// Agreement id for the paypal account.
	ExtBillingAgreementId *string `mandatory:"false" json:"extBillingAgreementId"`
}

PaypalPaymentOption PayPal Payment related details

func (PaypalPaymentOption) GetWalletInstrumentId 

func (m PaypalPaymentOption) GetWalletInstrumentId() *string

GetWalletInstrumentId returns WalletInstrumentId

func (PaypalPaymentOption) GetWalletTransactionId 

func (m PaypalPaymentOption) GetWalletTransactionId() *string

GetWalletTransactionId returns WalletTransactionId

func (PaypalPaymentOption) MarshalJSON 

func (m PaypalPaymentOption) MarshalJSON() (buff []byte, e error)

MarshalJSON marshals to json representation

func (PaypalPaymentOption) String 

func (m PaypalPaymentOption) String() string

func (PaypalPaymentOption) ValidateEnumValue 

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

type Subscription struct {

	// Subscription plan number.
	SubscriptionPlanNumber *string `mandatory:"true" json:"subscriptionPlanNumber"`

	// Subscription id identifier (OCID).
	Id *string `mandatory:"false" json:"id"`

	// Subscription plan type.
	PlanType SubscriptionPlanTypeEnum `mandatory:"false" json:"planType,omitempty"`

	// Start date of the subscription.
	TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`

	// Ship to customer account site address id.
	ShipToCustAcctSiteId *string `mandatory:"false" json:"shipToCustAcctSiteId"`

	// Ship to customer account role.
	ShipToCustAcctRoleId *string `mandatory:"false" json:"shipToCustAcctRoleId"`

	// Bill to customer Account id.
	BillToCustAccountId *string `mandatory:"false" json:"billToCustAccountId"`

	// Payment intension.
	IsIntentToPay *bool `mandatory:"false" json:"isIntentToPay"`

	// Currency code
	CurrencyCode *string `mandatory:"false" json:"currencyCode"`

	// GSI Subscription external code.
	GsiOrgCode *string `mandatory:"false" json:"gsiOrgCode"`

	// Language short code (en, de, hu, etc)
	LanguageCode *string `mandatory:"false" json:"languageCode"`

	// GSI organization external identifier.
	OrganizationId *string `mandatory:"false" json:"organizationId"`

	// Status of the upgrade.
	UpgradeState SubscriptionUpgradeStateEnum `mandatory:"false" json:"upgradeState,omitempty"`

	// This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
	UpgradeStateDetails SubscriptionUpgradeStateDetailsEnum `mandatory:"false" json:"upgradeStateDetails,omitempty"`

	// Account type.
	AccountType SubscriptionAccountTypeEnum `mandatory:"false" json:"accountType,omitempty"`

	TaxInfo *TaxInfo `mandatory:"false" json:"taxInfo"`

	// Payment option list of a subscription.
	PaymentOptions []PaymentOption `mandatory:"false" json:"paymentOptions"`

	PaymentGateway *PaymentGateway `mandatory:"false" json:"paymentGateway"`

	BillingAddress *Address `mandatory:"false" json:"billingAddress"`

	// Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
	TimePlanUpgrade *common.SDKTime `mandatory:"false" json:"timePlanUpgrade"`

	// Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
	TimePersonalToCorporateConv *common.SDKTime `mandatory:"false" json:"timePersonalToCorporateConv"`
}

Subscription Subscription details object which extends the SubscriptionSummary

func (Subscription) String 

func (m Subscription) String() string

func (*Subscription) UnmarshalJSON 

func (m *Subscription) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (Subscription) ValidateEnumValue 

func (m Subscription) 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 SubscriptionAccountTypeEnum added in v65.43.0 

type SubscriptionAccountTypeEnum string

SubscriptionAccountTypeEnum Enum with underlying type: string 

const (
	SubscriptionAccountTypePersonal           SubscriptionAccountTypeEnum = "PERSONAL"
	SubscriptionAccountTypeCorporate          SubscriptionAccountTypeEnum = "CORPORATE"
	SubscriptionAccountTypeCorporateSubmitted SubscriptionAccountTypeEnum = "CORPORATE_SUBMITTED"
)

Set of constants representing the allowable values for SubscriptionAccountTypeEnum

func GetMappingSubscriptionAccountTypeEnum added in v65.43.0 

func GetMappingSubscriptionAccountTypeEnum(val string) (SubscriptionAccountTypeEnum, bool)

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

func GetSubscriptionAccountTypeEnumValues added in v65.43.0 

func GetSubscriptionAccountTypeEnumValues() []SubscriptionAccountTypeEnum

GetSubscriptionAccountTypeEnumValues Enumerates the set of values for SubscriptionAccountTypeEnum

type SubscriptionCollection 

type SubscriptionCollection struct {

	// Subscription list elements
	Items []SubscriptionSummary `mandatory:"true" json:"items"`
}

SubscriptionCollection Subscription list

func (SubscriptionCollection) String 

func (m SubscriptionCollection) String() string

func (SubscriptionCollection) ValidateEnumValue 

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

type SubscriptionPlanTypeEnum string

SubscriptionPlanTypeEnum Enum with underlying type: string 

const (
	SubscriptionPlanTypeFreeTier SubscriptionPlanTypeEnum = "FREE_TIER"
	SubscriptionPlanTypePayg     SubscriptionPlanTypeEnum = "PAYG"
)

Set of constants representing the allowable values for SubscriptionPlanTypeEnum

func GetMappingSubscriptionPlanTypeEnum 

func GetMappingSubscriptionPlanTypeEnum(val string) (SubscriptionPlanTypeEnum, bool)

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

func GetSubscriptionPlanTypeEnumValues 

func GetSubscriptionPlanTypeEnumValues() []SubscriptionPlanTypeEnum

GetSubscriptionPlanTypeEnumValues Enumerates the set of values for SubscriptionPlanTypeEnum

type SubscriptionServiceClient 

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

SubscriptionServiceClient a client for SubscriptionService

func NewSubscriptionServiceClientWithConfigurationProvider 

func NewSubscriptionServiceClientWithConfigurationProvider(configProvider common.ConfigurationProvider) (client SubscriptionServiceClient, err error)

NewSubscriptionServiceClientWithConfigurationProvider Creates a new default SubscriptionService client with the given configuration provider. the configuration provider will be used for the default signer as well as reading the region

func NewSubscriptionServiceClientWithOboToken 

func NewSubscriptionServiceClientWithOboToken(configProvider common.ConfigurationProvider, oboToken string) (client SubscriptionServiceClient, err error)

NewSubscriptionServiceClientWithOboToken Creates a new default SubscriptionService 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 (SubscriptionServiceClient) AuthorizeSubscriptionPayment 

func (client SubscriptionServiceClient) AuthorizeSubscriptionPayment(ctx context.Context, request AuthorizeSubscriptionPaymentRequest) (response AuthorizeSubscriptionPaymentResponse, err error)

AuthorizeSubscriptionPayment PSD2 authorization for subscription payment

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/AuthorizeSubscriptionPayment.go.html to see an example of how to use AuthorizeSubscriptionPayment API. A default retry strategy applies to this operation AuthorizeSubscriptionPayment()

func (*SubscriptionServiceClient) ConfigurationProvider 

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

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

func (SubscriptionServiceClient) GetSubscription 

func (client SubscriptionServiceClient) GetSubscription(ctx context.Context, request GetSubscriptionRequest) (response GetSubscriptionResponse, err error)

GetSubscription Get the subscription plan.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/GetSubscription.go.html to see an example of how to use GetSubscription API. A default retry strategy applies to this operation GetSubscription()

func (SubscriptionServiceClient) ListSubscriptions 

func (client SubscriptionServiceClient) ListSubscriptions(ctx context.Context, request ListSubscriptionsRequest) (response ListSubscriptionsResponse, err error)

ListSubscriptions Get the subscription data for the compartment

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/ListSubscriptions.go.html to see an example of how to use ListSubscriptions API. A default retry strategy applies to this operation ListSubscriptions()

func (SubscriptionServiceClient) PaySubscription 

func (client SubscriptionServiceClient) PaySubscription(ctx context.Context, request PaySubscriptionRequest) (response PaySubscriptionResponse, err error)

PaySubscription Pay a subscription

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/PaySubscription.go.html to see an example of how to use PaySubscription API. A default retry strategy applies to this operation PaySubscription()

func (*SubscriptionServiceClient) SetRegion 

func (client *SubscriptionServiceClient) SetRegion(region string)

SetRegion overrides the region of this client.

func (SubscriptionServiceClient) UpdateSubscription 

func (client SubscriptionServiceClient) UpdateSubscription(ctx context.Context, request UpdateSubscriptionRequest) (response UpdateSubscriptionResponse, err error)

UpdateSubscription Update plan of the subscription.

See also

Click https://docs.cloud.oracle.com/en-us/iaas/tools/go-sdk-examples/latest/ospgateway/UpdateSubscription.go.html to see an example of how to use UpdateSubscription API. A default retry strategy applies to this operation UpdateSubscription()

type SubscriptionSummary 

type SubscriptionSummary struct {

	// Subscription plan number.
	SubscriptionPlanNumber *string `mandatory:"true" json:"subscriptionPlanNumber"`

	// Subscription id identifier (OCID).
	Id *string `mandatory:"false" json:"id"`

	// Subscription plan type.
	PlanType SubscriptionSummaryPlanTypeEnum `mandatory:"false" json:"planType,omitempty"`

	// Start date of the subscription.
	TimeStart *common.SDKTime `mandatory:"false" json:"timeStart"`

	// Ship to customer account site address id.
	ShipToCustAcctSiteId *string `mandatory:"false" json:"shipToCustAcctSiteId"`

	// Ship to customer account role.
	ShipToCustAcctRoleId *string `mandatory:"false" json:"shipToCustAcctRoleId"`

	// Bill to customer Account id.
	BillToCustAccountId *string `mandatory:"false" json:"billToCustAccountId"`

	// Payment intension.
	IsIntentToPay *bool `mandatory:"false" json:"isIntentToPay"`

	// Currency code
	CurrencyCode *string `mandatory:"false" json:"currencyCode"`

	// GSI Subscription external code.
	GsiOrgCode *string `mandatory:"false" json:"gsiOrgCode"`

	// Language short code (en, de, hu, etc)
	LanguageCode *string `mandatory:"false" json:"languageCode"`

	// GSI organization external identifier.
	OrganizationId *string `mandatory:"false" json:"organizationId"`

	// Status of the upgrade.
	UpgradeState SubscriptionSummaryUpgradeStateEnum `mandatory:"false" json:"upgradeState,omitempty"`

	// This field is used to describe the Upgrade State in case of error (E.g. Upgrade failure caused by interfacing Tax details- TaxError)
	UpgradeStateDetails SubscriptionSummaryUpgradeStateDetailsEnum `mandatory:"false" json:"upgradeStateDetails,omitempty"`

	// Account type.
	AccountType SubscriptionSummaryAccountTypeEnum `mandatory:"false" json:"accountType,omitempty"`

	TaxInfo *TaxInfo `mandatory:"false" json:"taxInfo"`

	// Payment option list of a subscription.
	PaymentOptions []PaymentOption `mandatory:"false" json:"paymentOptions"`

	PaymentGateway *PaymentGateway `mandatory:"false" json:"paymentGateway"`

	BillingAddress *Address `mandatory:"false" json:"billingAddress"`

	// Date of upgrade/conversion when planType changed from FREE_TIER to PAYG
	TimePlanUpgrade *common.SDKTime `mandatory:"false" json:"timePlanUpgrade"`

	// Date of upgrade/conversion when account type changed from PERSONAL to CORPORATE
	TimePersonalToCorporateConv *common.SDKTime `mandatory:"false" json:"timePersonalToCorporateConv"`
}

SubscriptionSummary Subscription object which contains the common subscription data.

func (SubscriptionSummary) String 

func (m SubscriptionSummary) String() string

func (*SubscriptionSummary) UnmarshalJSON 

func (m *SubscriptionSummary) UnmarshalJSON(data []byte) (e error)

UnmarshalJSON unmarshals from json

func (SubscriptionSummary) ValidateEnumValue 

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

type SubscriptionSummaryAccountTypeEnum added in v65.43.0 

type SubscriptionSummaryAccountTypeEnum string

SubscriptionSummaryAccountTypeEnum Enum with underlying type: string 

const (
	SubscriptionSummaryAccountTypePersonal           SubscriptionSummaryAccountTypeEnum = "PERSONAL"
	SubscriptionSummaryAccountTypeCorporate          SubscriptionSummaryAccountTypeEnum = "CORPORATE"
	SubscriptionSummaryAccountTypeCorporateSubmitted SubscriptionSummaryAccountTypeEnum = "CORPORATE_SUBMITTED"
)

Set of constants representing the allowable values for SubscriptionSummaryAccountTypeEnum

func GetMappingSubscriptionSummaryAccountTypeEnum added in v65.43.0 

func GetMappingSubscriptionSummaryAccountTypeEnum(val string) (SubscriptionSummaryAccountTypeEnum, bool)

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

func GetSubscriptionSummaryAccountTypeEnumValues added in v65.43.0 

func GetSubscriptionSummaryAccountTypeEnumValues() []SubscriptionSummaryAccountTypeEnum

GetSubscriptionSummaryAccountTypeEnumValues Enumerates the set of values for SubscriptionSummaryAccountTypeEnum

type SubscriptionSummaryPlanTypeEnum 

type SubscriptionSummaryPlanTypeEnum string

SubscriptionSummaryPlanTypeEnum Enum with underlying type: string 

const (
	SubscriptionSummaryPlanTypeFreeTier SubscriptionSummaryPlanTypeEnum = "FREE_TIER"
	SubscriptionSummaryPlanTypePayg     SubscriptionSummaryPlanTypeEnum = "PAYG"
)

Set of constants representing the allowable values for SubscriptionSummaryPlanTypeEnum

func GetMappingSubscriptionSummaryPlanTypeEnum 

func GetMappingSubscriptionSummaryPlanTypeEnum(val string) (SubscriptionSummaryPlanTypeEnum, bool)

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

func GetSubscriptionSummaryPlanTypeEnumValues 

func GetSubscriptionSummaryPlanTypeEnumValues() []SubscriptionSummaryPlanTypeEnum

GetSubscriptionSummaryPlanTypeEnumValues Enumerates the set of values for SubscriptionSummaryPlanTypeEnum

type SubscriptionSummaryUpgradeStateDetailsEnum 

type SubscriptionSummaryUpgradeStateDetailsEnum string

SubscriptionSummaryUpgradeStateDetailsEnum Enum with underlying type: string 

const (
	SubscriptionSummaryUpgradeStateDetailsTaxError     SubscriptionSummaryUpgradeStateDetailsEnum = "TAX_ERROR"
	SubscriptionSummaryUpgradeStateDetailsUpgradeError SubscriptionSummaryUpgradeStateDetailsEnum = "UPGRADE_ERROR"
)

Set of constants representing the allowable values for SubscriptionSummaryUpgradeStateDetailsEnum

func GetMappingSubscriptionSummaryUpgradeStateDetailsEnum 

func GetMappingSubscriptionSummaryUpgradeStateDetailsEnum(val string) (SubscriptionSummaryUpgradeStateDetailsEnum, bool)

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

func GetSubscriptionSummaryUpgradeStateDetailsEnumValues 

func GetSubscriptionSummaryUpgradeStateDetailsEnumValues() []SubscriptionSummaryUpgradeStateDetailsEnum

GetSubscriptionSummaryUpgradeStateDetailsEnumValues Enumerates the set of values for SubscriptionSummaryUpgradeStateDetailsEnum

type SubscriptionSummaryUpgradeStateEnum 

type SubscriptionSummaryUpgradeStateEnum string

SubscriptionSummaryUpgradeStateEnum Enum with underlying type: string 

const (
	SubscriptionSummaryUpgradeStatePromo     SubscriptionSummaryUpgradeStateEnum = "PROMO"
	SubscriptionSummaryUpgradeStateSubmitted SubscriptionSummaryUpgradeStateEnum = "SUBMITTED"
	SubscriptionSummaryUpgradeStateError     SubscriptionSummaryUpgradeStateEnum = "ERROR"
	SubscriptionSummaryUpgradeStateUpgraded  SubscriptionSummaryUpgradeStateEnum = "UPGRADED"
)

Set of constants representing the allowable values for SubscriptionSummaryUpgradeStateEnum

func GetMappingSubscriptionSummaryUpgradeStateEnum 

func GetMappingSubscriptionSummaryUpgradeStateEnum(val string) (SubscriptionSummaryUpgradeStateEnum, bool)

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

func GetSubscriptionSummaryUpgradeStateEnumValues 

func GetSubscriptionSummaryUpgradeStateEnumValues() []SubscriptionSummaryUpgradeStateEnum

GetSubscriptionSummaryUpgradeStateEnumValues Enumerates the set of values for SubscriptionSummaryUpgradeStateEnum

type SubscriptionUpgradeStateDetailsEnum 

type SubscriptionUpgradeStateDetailsEnum string

SubscriptionUpgradeStateDetailsEnum Enum with underlying type: string 

const (
	SubscriptionUpgradeStateDetailsTaxError     SubscriptionUpgradeStateDetailsEnum = "TAX_ERROR"
	SubscriptionUpgradeStateDetailsUpgradeError SubscriptionUpgradeStateDetailsEnum = "UPGRADE_ERROR"
)

Set of constants representing the allowable values for SubscriptionUpgradeStateDetailsEnum

func GetMappingSubscriptionUpgradeStateDetailsEnum 

func GetMappingSubscriptionUpgradeStateDetailsEnum(val string) (SubscriptionUpgradeStateDetailsEnum, bool)

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

func GetSubscriptionUpgradeStateDetailsEnumValues 

func GetSubscriptionUpgradeStateDetailsEnumValues() []SubscriptionUpgradeStateDetailsEnum

GetSubscriptionUpgradeStateDetailsEnumValues Enumerates the set of values for SubscriptionUpgradeStateDetailsEnum

type SubscriptionUpgradeStateEnum 

type SubscriptionUpgradeStateEnum string

SubscriptionUpgradeStateEnum Enum with underlying type: string 

const (
	SubscriptionUpgradeStatePromo     SubscriptionUpgradeStateEnum = "PROMO"
	SubscriptionUpgradeStateSubmitted SubscriptionUpgradeStateEnum = "SUBMITTED"
	SubscriptionUpgradeStateError     SubscriptionUpgradeStateEnum = "ERROR"
	SubscriptionUpgradeStateUpgraded  SubscriptionUpgradeStateEnum = "UPGRADED"
)

Set of constants representing the allowable values for SubscriptionUpgradeStateEnum

func GetMappingSubscriptionUpgradeStateEnum 

func GetMappingSubscriptionUpgradeStateEnum(val string) (SubscriptionUpgradeStateEnum, bool)

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

func GetSubscriptionUpgradeStateEnumValues 

func GetSubscriptionUpgradeStateEnumValues() []SubscriptionUpgradeStateEnum

GetSubscriptionUpgradeStateEnumValues Enumerates the set of values for SubscriptionUpgradeStateEnum

type TaxInfo 

type TaxInfo struct {

	// Tay payer identifier.
	TaxPayerId *string `mandatory:"false" json:"taxPayerId"`

	// Tax registration number.
	TaxRegNumber *string `mandatory:"false" json:"taxRegNumber"`

	// Tax exemption reason code.
	NoTaxReasonCode *string `mandatory:"false" json:"noTaxReasonCode"`

	// Tax exemption reason description.
	NoTaxReasonCodeDetails *string `mandatory:"false" json:"noTaxReasonCodeDetails"`

	// Brazilian companies' CNPJ number.
	TaxCnpj *string `mandatory:"false" json:"taxCnpj"`

	// Companies' GIRO code
	Giro *string `mandatory:"false" json:"giro"`
}

TaxInfo Tax details.

func (TaxInfo) String 

func (m TaxInfo) String() string

func (TaxInfo) ValidateEnumValue 

func (m TaxInfo) 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 TaxTypeRule added in v65.43.0 

type TaxTypeRule struct {

	// Tax type rule fields
	Fields []Field `mandatory:"true" json:"fields"`

	// Label value pair for allowed values. Used for GIRO
	ValueSet []ValueSetEntity `mandatory:"false" json:"valueSet"`
}

TaxTypeRule Tax type rule information

func (TaxTypeRule) String added in v65.43.0 

func (m TaxTypeRule) String() string

func (TaxTypeRule) ValidateEnumValue added in v65.43.0 

func (m TaxTypeRule) 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 ThirdPartyValidationTypeEnum added in v65.43.0 

type ThirdPartyValidationTypeEnum string

ThirdPartyValidationTypeEnum Enum with underlying type: string 

const (
	ThirdPartyValidationTypeOptional ThirdPartyValidationTypeEnum = "OPTIONAL"
	ThirdPartyValidationTypeRequired ThirdPartyValidationTypeEnum = "REQUIRED"
	ThirdPartyValidationTypeNever    ThirdPartyValidationTypeEnum = "NEVER"
)

Set of constants representing the allowable values for ThirdPartyValidationTypeEnum

func GetMappingThirdPartyValidationTypeEnum added in v65.43.0 

func GetMappingThirdPartyValidationTypeEnum(val string) (ThirdPartyValidationTypeEnum, bool)

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

func GetThirdPartyValidationTypeEnumValues added in v65.43.0 

func GetThirdPartyValidationTypeEnumValues() []ThirdPartyValidationTypeEnum

GetThirdPartyValidationTypeEnumValues Enumerates the set of values for ThirdPartyValidationTypeEnum

type UpdateSubscriptionDetails 

type UpdateSubscriptionDetails struct {
	Subscription *Subscription `mandatory:"true" json:"subscription"`

	// User email
	Email *string `mandatory:"true" json:"email"`
}

UpdateSubscriptionDetails Request object for updating a subscription

func (UpdateSubscriptionDetails) String 

func (m UpdateSubscriptionDetails) String() string

func (UpdateSubscriptionDetails) ValidateEnumValue 

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

type UpdateSubscriptionRequest struct {

	// Subscription id(OCID).
	SubscriptionId *string `mandatory:"true" contributesTo:"path" name:"subscriptionId"`

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Subscription update request.
	UpdateSubscriptionDetails `contributesTo:"body"`

	// The 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"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

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

UpdateSubscriptionRequest wrapper for the UpdateSubscription operation

See also

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

func (UpdateSubscriptionRequest) BinaryRequestBody 

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

BinaryRequestBody implements the OCIRequest interface

func (UpdateSubscriptionRequest) HTTPRequest 

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

HTTPRequest implements the OCIRequest interface

func (UpdateSubscriptionRequest) RetryPolicy 

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

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

func (UpdateSubscriptionRequest) String 

func (request UpdateSubscriptionRequest) String() string

func (UpdateSubscriptionRequest) ValidateEnumValue 

func (request UpdateSubscriptionRequest) 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 UpdateSubscriptionResponse 

type UpdateSubscriptionResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The Subscription instance
	Subscription `presentIn:"body"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`

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

UpdateSubscriptionResponse wrapper for the UpdateSubscription operation

func (UpdateSubscriptionResponse) HTTPResponse 

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

HTTPResponse implements the OCIResponse interface

func (UpdateSubscriptionResponse) String 

func (response UpdateSubscriptionResponse) String() string

type ValueSetEntity added in v65.57.0 

type ValueSetEntity struct {

	// User friendly name
	Name *string `mandatory:"false" json:"name"`

	// Value
	Value *string `mandatory:"false" json:"value"`
}

ValueSetEntity LOV for allowed values

func (ValueSetEntity) String added in v65.57.0 

func (m ValueSetEntity) String() string

func (ValueSetEntity) ValidateEnumValue added in v65.57.0 

func (m ValueSetEntity) 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 VerifyAddressDetails added in v65.43.0 

type VerifyAddressDetails struct {

	// Address identifier.
	AddressKey *string `mandatory:"false" json:"addressKey"`

	// Address line 1.
	Line1 *string `mandatory:"false" json:"line1"`

	// Address line 2.
	Line2 *string `mandatory:"false" json:"line2"`

	// Address line 3.
	Line3 *string `mandatory:"false" json:"line3"`

	// Address line 4.
	Line4 *string `mandatory:"false" json:"line4"`

	// Street name of the address.
	StreetName *string `mandatory:"false" json:"streetName"`

	// Street number of the address.
	StreetNumber *string `mandatory:"false" json:"streetNumber"`

	// Name of the city.
	City *string `mandatory:"false" json:"city"`

	// County of the address.
	County *string `mandatory:"false" json:"county"`

	// Country of the address.
	Country *string `mandatory:"false" json:"country"`

	// Province of the address.
	Province *string `mandatory:"false" json:"province"`

	// Post code of the address.
	PostalCode *string `mandatory:"false" json:"postalCode"`

	// State of the address.
	State *string `mandatory:"false" json:"state"`

	// Contact person email address.
	EmailAddress *string `mandatory:"false" json:"emailAddress"`

	// Name of the customer company.
	CompanyName *string `mandatory:"false" json:"companyName"`

	// First name of the contact person.
	FirstName *string `mandatory:"false" json:"firstName"`

	// Middle name of the contact person.
	MiddleName *string `mandatory:"false" json:"middleName"`

	// Last name of the contact person.
	LastName *string `mandatory:"false" json:"lastName"`

	// Phone country code of the contact person.
	PhoneCountryCode *string `mandatory:"false" json:"phoneCountryCode"`

	// Phone number of the contact person.
	PhoneNumber *string `mandatory:"false" json:"phoneNumber"`

	// Job title of the contact person.
	JobTitle *string `mandatory:"false" json:"jobTitle"`

	// Department name of the customer company.
	DepartmentName *string `mandatory:"false" json:"departmentName"`

	// Internal number of the customer company.
	InternalNumber *string `mandatory:"false" json:"internalNumber"`

	// Contributor class of the customer company.
	ContributorClass *string `mandatory:"false" json:"contributorClass"`

	// State Inscription.
	StateInscription *string `mandatory:"false" json:"stateInscription"`

	// Municipal Inscription.
	MunicipalInscription *string `mandatory:"false" json:"municipalInscription"`
}

VerifyAddressDetails Verify address related details

func (VerifyAddressDetails) String added in v65.43.0 

func (m VerifyAddressDetails) String() string

func (VerifyAddressDetails) ValidateEnumValue added in v65.43.0 

func (m VerifyAddressDetails) 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 VerifyAddressReceipt added in v65.43.0 

type VerifyAddressReceipt struct {
	Address *Address `mandatory:"true" json:"address"`

	// Address quality type.
	Quality AddressQualityTypeEnum `mandatory:"true" json:"quality"`

	// Address verification code.
	VerificationCode AddressVerificationCodeEnum `mandatory:"true" json:"verificationCode"`
}

VerifyAddressReceipt Address verficiation result

func (VerifyAddressReceipt) String added in v65.43.0 

func (m VerifyAddressReceipt) String() string

func (VerifyAddressReceipt) ValidateEnumValue added in v65.43.0 

func (m VerifyAddressReceipt) 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 VerifyAddressRequest added in v65.43.0 

type VerifyAddressRequest struct {

	// The home region's public name of the logged in user.
	OspHomeRegion *string `mandatory:"true" contributesTo:"query" name:"ospHomeRegion"`

	// The OCID (https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment.
	CompartmentId *string `mandatory:"true" contributesTo:"query" name:"compartmentId"`

	// Address request.
	VerifyAddressDetails `contributesTo:"body"`

	// For optimistic concurrency control. In the PUT or DELETE call
	// for a resource, set the `if-match` parameter to the value of the
	// etag from a previous GET or POST response for that resource.
	// The resource will be updated or deleted only if the etag you
	// provide matches the resource's current etag value.
	IfMatch *string `mandatory:"false" contributesTo:"header" name:"if-match"`

	// For requests that are not idempotent (creates being the main place of interest), THE APIs should take a header
	// called opc-retry-token to identify the customer desire across requests, to introduce some level of idempotency.
	OpcRetryToken *string `mandatory:"false" contributesTo:"header" name:"opc-retry-token"`

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

VerifyAddressRequest wrapper for the VerifyAddress operation

See also

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

func (VerifyAddressRequest) BinaryRequestBody added in v65.43.0 

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

BinaryRequestBody implements the OCIRequest interface

func (VerifyAddressRequest) HTTPRequest added in v65.43.0 

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

HTTPRequest implements the OCIRequest interface

func (VerifyAddressRequest) RetryPolicy added in v65.43.0 

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

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

func (VerifyAddressRequest) String added in v65.43.0 

func (request VerifyAddressRequest) String() string

func (VerifyAddressRequest) ValidateEnumValue added in v65.43.0 

func (request VerifyAddressRequest) 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 VerifyAddressResponse added in v65.43.0 

type VerifyAddressResponse struct {

	// The underlying http response
	RawResponse *http.Response

	// The VerifyAddressReceipt instance
	VerifyAddressReceipt `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"`

	// For optimistic concurrency control. See `if-match`.
	Etag *string `presentIn:"header" name:"etag"`
}

VerifyAddressResponse wrapper for the VerifyAddress operation

func (VerifyAddressResponse) HTTPResponse added in v65.43.0 

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

HTTPResponse implements the OCIResponse interface

func (VerifyAddressResponse) String added in v65.43.0 

func (response VerifyAddressResponse) String() string

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.