operations

package
v0.16.0 Latest Latest
Warning

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

Go to latest
Published: Apr 3, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SupportedOptionRetries              = "retries"
	SupportedOptionTimeout              = "timeout"
	SupportedOptionAcceptHeaderOverride = "acceptHeaderOverride"
	SupportedOptionURLOverride          = "urlOverride"
)

Variables

View Source
var ErrUnsupportedOption = errors.New("unsupported option")

Functions

This section is empty.

Types

type AcceptHeaderEnum added in v0.13.0

type AcceptHeaderEnum string
const (
	AcceptHeaderEnumApplicationJson AcceptHeaderEnum = "application/json"
	AcceptHeaderEnumTextCsv         AcceptHeaderEnum = "text/csv"
)

func (AcceptHeaderEnum) ToPointer added in v0.13.0

func (e AcceptHeaderEnum) ToPointer() *AcceptHeaderEnum

type BenefitGrantsListQueryParamCustomerIDFilter added in v0.9.0

type BenefitGrantsListQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type BenefitGrantsListQueryParamCustomerIDFilterType
}

BenefitGrantsListQueryParamCustomerIDFilter - Filter by customer ID.

func CreateBenefitGrantsListQueryParamCustomerIDFilterArrayOfStr added in v0.9.0

func CreateBenefitGrantsListQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) BenefitGrantsListQueryParamCustomerIDFilter

func CreateBenefitGrantsListQueryParamCustomerIDFilterStr added in v0.9.0

func CreateBenefitGrantsListQueryParamCustomerIDFilterStr(str string) BenefitGrantsListQueryParamCustomerIDFilter

func (BenefitGrantsListQueryParamCustomerIDFilter) MarshalJSON added in v0.9.0

func (*BenefitGrantsListQueryParamCustomerIDFilter) UnmarshalJSON added in v0.9.0

func (u *BenefitGrantsListQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type BenefitGrantsListQueryParamCustomerIDFilterType added in v0.9.0

type BenefitGrantsListQueryParamCustomerIDFilterType string
const (
	BenefitGrantsListQueryParamCustomerIDFilterTypeStr        BenefitGrantsListQueryParamCustomerIDFilterType = "str"
	BenefitGrantsListQueryParamCustomerIDFilterTypeArrayOfStr BenefitGrantsListQueryParamCustomerIDFilterType = "arrayOfStr"
)

type BenefitGrantsListQueryParamOrganizationIDFilter added in v0.9.0

type BenefitGrantsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type BenefitGrantsListQueryParamOrganizationIDFilterType
}

BenefitGrantsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateBenefitGrantsListQueryParamOrganizationIDFilterArrayOfStr added in v0.9.0

func CreateBenefitGrantsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) BenefitGrantsListQueryParamOrganizationIDFilter

func CreateBenefitGrantsListQueryParamOrganizationIDFilterStr added in v0.9.0

func CreateBenefitGrantsListQueryParamOrganizationIDFilterStr(str string) BenefitGrantsListQueryParamOrganizationIDFilter

func (BenefitGrantsListQueryParamOrganizationIDFilter) MarshalJSON added in v0.9.0

func (*BenefitGrantsListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.9.0

type BenefitGrantsListQueryParamOrganizationIDFilterType added in v0.9.0

type BenefitGrantsListQueryParamOrganizationIDFilterType string
const (
	BenefitGrantsListQueryParamOrganizationIDFilterTypeStr        BenefitGrantsListQueryParamOrganizationIDFilterType = "str"
	BenefitGrantsListQueryParamOrganizationIDFilterTypeArrayOfStr BenefitGrantsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type BenefitGrantsListRequest added in v0.9.0

type BenefitGrantsListRequest struct {
	// Filter by organization ID.
	OrganizationID *BenefitGrantsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by customer ID.
	CustomerID *BenefitGrantsListQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by customer external ID.
	ExternalCustomerID *QueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned.
	IsGranted *bool `queryParam:"style=form,explode=true,name=is_granted"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.BenefitGrantSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*BenefitGrantsListRequest) GetCustomerID added in v0.9.0

func (*BenefitGrantsListRequest) GetExternalCustomerID added in v0.13.0

func (*BenefitGrantsListRequest) GetIsGranted added in v0.9.0

func (b *BenefitGrantsListRequest) GetIsGranted() *bool

func (*BenefitGrantsListRequest) GetLimit added in v0.9.0

func (b *BenefitGrantsListRequest) GetLimit() *int64

func (*BenefitGrantsListRequest) GetOrganizationID added in v0.9.0

func (*BenefitGrantsListRequest) GetPage added in v0.9.0

func (b *BenefitGrantsListRequest) GetPage() *int64

func (*BenefitGrantsListRequest) GetSorting added in v0.9.0

func (BenefitGrantsListRequest) MarshalJSON added in v0.9.0

func (b BenefitGrantsListRequest) MarshalJSON() ([]byte, error)

func (*BenefitGrantsListRequest) UnmarshalJSON added in v0.9.0

func (b *BenefitGrantsListRequest) UnmarshalJSON(data []byte) error

type BenefitGrantsListResponse added in v0.9.0

type BenefitGrantsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceBenefitGrant *components.ListResourceBenefitGrant

	Next func() (*BenefitGrantsListResponse, error)
}

func (*BenefitGrantsListResponse) GetHTTPMeta added in v0.9.0

func (*BenefitGrantsListResponse) GetListResourceBenefitGrant added in v0.9.0

func (b *BenefitGrantsListResponse) GetListResourceBenefitGrant() *components.ListResourceBenefitGrant

type BenefitIDFilter

type BenefitIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type BenefitIDFilterType
}

BenefitIDFilter - Filter products granting specific benefit.

func CreateBenefitIDFilterArrayOfStr

func CreateBenefitIDFilterArrayOfStr(arrayOfStr []string) BenefitIDFilter

func CreateBenefitIDFilterStr

func CreateBenefitIDFilterStr(str string) BenefitIDFilter

func (BenefitIDFilter) MarshalJSON

func (u BenefitIDFilter) MarshalJSON() ([]byte, error)

func (*BenefitIDFilter) UnmarshalJSON

func (u *BenefitIDFilter) UnmarshalJSON(data []byte) error

type BenefitIDFilterType

type BenefitIDFilterType string
const (
	BenefitIDFilterTypeStr        BenefitIDFilterType = "str"
	BenefitIDFilterTypeArrayOfStr BenefitIDFilterType = "arrayOfStr"
)

type BenefitTypeFilter

type BenefitTypeFilter struct {
	BenefitType        *components.BenefitType  `queryParam:"inline" union:"member"`
	ArrayOfBenefitType []components.BenefitType `queryParam:"inline" union:"member"`

	Type BenefitTypeFilterType
}

BenefitTypeFilter - Filter by benefit type.

func CreateBenefitTypeFilterArrayOfBenefitType

func CreateBenefitTypeFilterArrayOfBenefitType(arrayOfBenefitType []components.BenefitType) BenefitTypeFilter

func CreateBenefitTypeFilterBenefitType

func CreateBenefitTypeFilterBenefitType(benefitType components.BenefitType) BenefitTypeFilter

func (BenefitTypeFilter) MarshalJSON

func (u BenefitTypeFilter) MarshalJSON() ([]byte, error)

func (*BenefitTypeFilter) UnmarshalJSON

func (u *BenefitTypeFilter) UnmarshalJSON(data []byte) error

type BenefitTypeFilterType

type BenefitTypeFilterType string
const (
	BenefitTypeFilterTypeBenefitType        BenefitTypeFilterType = "BenefitType"
	BenefitTypeFilterTypeArrayOfBenefitType BenefitTypeFilterType = "arrayOfBenefitType"
)

type BenefitsCreateResponse

type BenefitsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Benefit created.
	Benefit *components.Benefit
}

func (*BenefitsCreateResponse) GetBenefit

func (b *BenefitsCreateResponse) GetBenefit() *components.Benefit

func (*BenefitsCreateResponse) GetBenefitCustom added in v0.13.0

func (b *BenefitsCreateResponse) GetBenefitCustom() *components.BenefitCustom

func (*BenefitsCreateResponse) GetBenefitDiscord added in v0.13.0

func (b *BenefitsCreateResponse) GetBenefitDiscord() *components.BenefitDiscord

func (*BenefitsCreateResponse) GetBenefitDownloadables added in v0.13.0

func (b *BenefitsCreateResponse) GetBenefitDownloadables() *components.BenefitDownloadables

func (*BenefitsCreateResponse) GetBenefitFeatureFlag added in v0.15.0

func (b *BenefitsCreateResponse) GetBenefitFeatureFlag() *components.BenefitFeatureFlag

func (*BenefitsCreateResponse) GetBenefitGithubRepository added in v0.13.0

func (b *BenefitsCreateResponse) GetBenefitGithubRepository() *components.BenefitGitHubRepository

func (*BenefitsCreateResponse) GetBenefitLicenseKeys added in v0.13.0

func (b *BenefitsCreateResponse) GetBenefitLicenseKeys() *components.BenefitLicenseKeys

func (*BenefitsCreateResponse) GetBenefitMeterCredit added in v0.13.0

func (b *BenefitsCreateResponse) GetBenefitMeterCredit() *components.BenefitMeterCredit

func (*BenefitsCreateResponse) GetHTTPMeta

type BenefitsDeleteRequest

type BenefitsDeleteRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*BenefitsDeleteRequest) GetID

func (b *BenefitsDeleteRequest) GetID() string

type BenefitsDeleteResponse

type BenefitsDeleteResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*BenefitsDeleteResponse) GetHTTPMeta

type BenefitsGetRequest

type BenefitsGetRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*BenefitsGetRequest) GetID

func (b *BenefitsGetRequest) GetID() string

type BenefitsGetResponse

type BenefitsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Benefit *components.Benefit
}

func (*BenefitsGetResponse) GetBenefit

func (b *BenefitsGetResponse) GetBenefit() *components.Benefit

func (*BenefitsGetResponse) GetBenefitCustom added in v0.13.0

func (b *BenefitsGetResponse) GetBenefitCustom() *components.BenefitCustom

func (*BenefitsGetResponse) GetBenefitDiscord added in v0.13.0

func (b *BenefitsGetResponse) GetBenefitDiscord() *components.BenefitDiscord

func (*BenefitsGetResponse) GetBenefitDownloadables added in v0.13.0

func (b *BenefitsGetResponse) GetBenefitDownloadables() *components.BenefitDownloadables

func (*BenefitsGetResponse) GetBenefitFeatureFlag added in v0.15.0

func (b *BenefitsGetResponse) GetBenefitFeatureFlag() *components.BenefitFeatureFlag

func (*BenefitsGetResponse) GetBenefitGithubRepository added in v0.13.0

func (b *BenefitsGetResponse) GetBenefitGithubRepository() *components.BenefitGitHubRepository

func (*BenefitsGetResponse) GetBenefitLicenseKeys added in v0.13.0

func (b *BenefitsGetResponse) GetBenefitLicenseKeys() *components.BenefitLicenseKeys

func (*BenefitsGetResponse) GetBenefitMeterCredit added in v0.13.0

func (b *BenefitsGetResponse) GetBenefitMeterCredit() *components.BenefitMeterCredit

func (*BenefitsGetResponse) GetHTTPMeta

func (b *BenefitsGetResponse) GetHTTPMeta() components.HTTPMetadata

type BenefitsGrantsRequest

type BenefitsGrantsRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Filter by granted status. If `true`, only granted benefits will be returned. If `false`, only revoked benefits will be returned.
	IsGranted *bool `queryParam:"style=form,explode=true,name=is_granted"`
	// Filter by customer.
	CustomerID *QueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by member.
	MemberID *MemberIDFilter `queryParam:"style=form,explode=true,name=member_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*BenefitsGrantsRequest) GetCustomerID

func (*BenefitsGrantsRequest) GetID

func (b *BenefitsGrantsRequest) GetID() string

func (*BenefitsGrantsRequest) GetIsGranted

func (b *BenefitsGrantsRequest) GetIsGranted() *bool

func (*BenefitsGrantsRequest) GetLimit

func (b *BenefitsGrantsRequest) GetLimit() *int64

func (*BenefitsGrantsRequest) GetMemberID added in v0.13.0

func (b *BenefitsGrantsRequest) GetMemberID() *MemberIDFilter

func (*BenefitsGrantsRequest) GetPage

func (b *BenefitsGrantsRequest) GetPage() *int64

func (BenefitsGrantsRequest) MarshalJSON

func (b BenefitsGrantsRequest) MarshalJSON() ([]byte, error)

func (*BenefitsGrantsRequest) UnmarshalJSON

func (b *BenefitsGrantsRequest) UnmarshalJSON(data []byte) error

type BenefitsGrantsResponse

type BenefitsGrantsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceBenefitGrant *components.ListResourceBenefitGrant

	Next func() (*BenefitsGrantsResponse, error)
}

func (*BenefitsGrantsResponse) GetHTTPMeta

func (*BenefitsGrantsResponse) GetListResourceBenefitGrant

func (b *BenefitsGrantsResponse) GetListResourceBenefitGrant() *components.ListResourceBenefitGrant

type BenefitsListRequest

type BenefitsListRequest struct {
	// Filter by organization ID.
	OrganizationID *QueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by benefit type.
	TypeFilter *BenefitTypeFilter `queryParam:"style=form,explode=true,name=type"`
	// Filter by benefit IDs.
	ID *FilterIDs `queryParam:"style=form,explode=true,name=id"`
	// Exclude benefits with these IDs.
	ExcludeID *ExcludeIDs `queryParam:"style=form,explode=true,name=exclude_id"`
	// Filter by description.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.BenefitSortProperty `queryParam:"style=form,explode=true,name=sorting"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*BenefitsListRequest) GetExcludeID added in v0.13.0

func (b *BenefitsListRequest) GetExcludeID() *ExcludeIDs

func (*BenefitsListRequest) GetID added in v0.13.0

func (b *BenefitsListRequest) GetID() *FilterIDs

func (*BenefitsListRequest) GetLimit

func (b *BenefitsListRequest) GetLimit() *int64

func (*BenefitsListRequest) GetMetadata added in v0.7.1

func (b *BenefitsListRequest) GetMetadata() map[string]components.MetadataQuery

func (*BenefitsListRequest) GetOrganizationID

func (b *BenefitsListRequest) GetOrganizationID() *QueryParamOrganizationIDFilter

func (*BenefitsListRequest) GetPage

func (b *BenefitsListRequest) GetPage() *int64

func (*BenefitsListRequest) GetQuery added in v0.4.6

func (b *BenefitsListRequest) GetQuery() *string

func (*BenefitsListRequest) GetSorting added in v0.4.9

func (*BenefitsListRequest) GetTypeFilter

func (b *BenefitsListRequest) GetTypeFilter() *BenefitTypeFilter

func (BenefitsListRequest) MarshalJSON

func (b BenefitsListRequest) MarshalJSON() ([]byte, error)

func (*BenefitsListRequest) UnmarshalJSON

func (b *BenefitsListRequest) UnmarshalJSON(data []byte) error

type BenefitsListResponse

type BenefitsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceBenefit *components.ListResourceBenefit

	Next func() (*BenefitsListResponse, error)
}

func (*BenefitsListResponse) GetHTTPMeta

func (b *BenefitsListResponse) GetHTTPMeta() components.HTTPMetadata

func (*BenefitsListResponse) GetListResourceBenefit

func (b *BenefitsListResponse) GetListResourceBenefit() *components.ListResourceBenefit

type BenefitsUpdateBenefitUpdate

type BenefitsUpdateBenefitUpdate struct {
	BenefitCustomUpdate           *components.BenefitCustomUpdate           `queryParam:"inline" union:"member"`
	BenefitDiscordUpdate          *components.BenefitDiscordUpdate          `queryParam:"inline" union:"member"`
	BenefitGitHubRepositoryUpdate *components.BenefitGitHubRepositoryUpdate `queryParam:"inline" union:"member"`
	BenefitDownloadablesUpdate    *components.BenefitDownloadablesUpdate    `queryParam:"inline" union:"member"`
	BenefitLicenseKeysUpdate      *components.BenefitLicenseKeysUpdate      `queryParam:"inline" union:"member"`
	BenefitMeterCreditUpdate      *components.BenefitMeterCreditUpdate      `queryParam:"inline" union:"member"`
	BenefitFeatureFlagUpdate      *components.BenefitFeatureFlagUpdate      `queryParam:"inline" union:"member"`

	Type BenefitsUpdateBenefitUpdateType
}

func CreateBenefitsUpdateBenefitUpdateBenefitCustomUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitCustomUpdate(benefitCustomUpdate components.BenefitCustomUpdate) BenefitsUpdateBenefitUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitDiscordUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitDiscordUpdate(benefitDiscordUpdate components.BenefitDiscordUpdate) BenefitsUpdateBenefitUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitDownloadablesUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitDownloadablesUpdate(benefitDownloadablesUpdate components.BenefitDownloadablesUpdate) BenefitsUpdateBenefitUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitFeatureFlagUpdate added in v0.15.0

func CreateBenefitsUpdateBenefitUpdateBenefitFeatureFlagUpdate(benefitFeatureFlagUpdate components.BenefitFeatureFlagUpdate) BenefitsUpdateBenefitUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitGitHubRepositoryUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitGitHubRepositoryUpdate(benefitGitHubRepositoryUpdate components.BenefitGitHubRepositoryUpdate) BenefitsUpdateBenefitUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitLicenseKeysUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitLicenseKeysUpdate(benefitLicenseKeysUpdate components.BenefitLicenseKeysUpdate) BenefitsUpdateBenefitUpdate

func CreateBenefitsUpdateBenefitUpdateBenefitMeterCreditUpdate added in v0.4.9

func CreateBenefitsUpdateBenefitUpdateBenefitMeterCreditUpdate(benefitMeterCreditUpdate components.BenefitMeterCreditUpdate) BenefitsUpdateBenefitUpdate

func (BenefitsUpdateBenefitUpdate) MarshalJSON

func (u BenefitsUpdateBenefitUpdate) MarshalJSON() ([]byte, error)

func (*BenefitsUpdateBenefitUpdate) UnmarshalJSON

func (u *BenefitsUpdateBenefitUpdate) UnmarshalJSON(data []byte) error

type BenefitsUpdateBenefitUpdateType

type BenefitsUpdateBenefitUpdateType string
const (
	BenefitsUpdateBenefitUpdateTypeBenefitCustomUpdate           BenefitsUpdateBenefitUpdateType = "BenefitCustomUpdate"
	BenefitsUpdateBenefitUpdateTypeBenefitDiscordUpdate          BenefitsUpdateBenefitUpdateType = "BenefitDiscordUpdate"
	BenefitsUpdateBenefitUpdateTypeBenefitGitHubRepositoryUpdate BenefitsUpdateBenefitUpdateType = "BenefitGitHubRepositoryUpdate"
	BenefitsUpdateBenefitUpdateTypeBenefitDownloadablesUpdate    BenefitsUpdateBenefitUpdateType = "BenefitDownloadablesUpdate"
	BenefitsUpdateBenefitUpdateTypeBenefitLicenseKeysUpdate      BenefitsUpdateBenefitUpdateType = "BenefitLicenseKeysUpdate"
	BenefitsUpdateBenefitUpdateTypeBenefitMeterCreditUpdate      BenefitsUpdateBenefitUpdateType = "BenefitMeterCreditUpdate"
	BenefitsUpdateBenefitUpdateTypeBenefitFeatureFlagUpdate      BenefitsUpdateBenefitUpdateType = "BenefitFeatureFlagUpdate"
)

type BenefitsUpdateRequest

type BenefitsUpdateRequest struct {
	ID          string                      `pathParam:"style=simple,explode=false,name=id"`
	RequestBody BenefitsUpdateBenefitUpdate `request:"mediaType=application/json"`
}

func (*BenefitsUpdateRequest) GetID

func (b *BenefitsUpdateRequest) GetID() string

func (*BenefitsUpdateRequest) GetRequestBody

type BenefitsUpdateResponse

type BenefitsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Benefit updated.
	Benefit *components.Benefit
}

func (*BenefitsUpdateResponse) GetBenefit

func (b *BenefitsUpdateResponse) GetBenefit() *components.Benefit

func (*BenefitsUpdateResponse) GetBenefitCustom added in v0.13.0

func (b *BenefitsUpdateResponse) GetBenefitCustom() *components.BenefitCustom

func (*BenefitsUpdateResponse) GetBenefitDiscord added in v0.13.0

func (b *BenefitsUpdateResponse) GetBenefitDiscord() *components.BenefitDiscord

func (*BenefitsUpdateResponse) GetBenefitDownloadables added in v0.13.0

func (b *BenefitsUpdateResponse) GetBenefitDownloadables() *components.BenefitDownloadables

func (*BenefitsUpdateResponse) GetBenefitFeatureFlag added in v0.15.0

func (b *BenefitsUpdateResponse) GetBenefitFeatureFlag() *components.BenefitFeatureFlag

func (*BenefitsUpdateResponse) GetBenefitGithubRepository added in v0.13.0

func (b *BenefitsUpdateResponse) GetBenefitGithubRepository() *components.BenefitGitHubRepository

func (*BenefitsUpdateResponse) GetBenefitLicenseKeys added in v0.13.0

func (b *BenefitsUpdateResponse) GetBenefitLicenseKeys() *components.BenefitLicenseKeys

func (*BenefitsUpdateResponse) GetBenefitMeterCredit added in v0.13.0

func (b *BenefitsUpdateResponse) GetBenefitMeterCredit() *components.BenefitMeterCredit

func (*BenefitsUpdateResponse) GetHTTPMeta

type CheckoutIDFilter

type CheckoutIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CheckoutIDFilterType
}

CheckoutIDFilter - Filter by checkout ID.

func CreateCheckoutIDFilterArrayOfStr

func CreateCheckoutIDFilterArrayOfStr(arrayOfStr []string) CheckoutIDFilter

func CreateCheckoutIDFilterStr

func CreateCheckoutIDFilterStr(str string) CheckoutIDFilter

func (CheckoutIDFilter) MarshalJSON

func (u CheckoutIDFilter) MarshalJSON() ([]byte, error)

func (*CheckoutIDFilter) UnmarshalJSON

func (u *CheckoutIDFilter) UnmarshalJSON(data []byte) error

type CheckoutIDFilterType

type CheckoutIDFilterType string
const (
	CheckoutIDFilterTypeStr        CheckoutIDFilterType = "str"
	CheckoutIDFilterTypeArrayOfStr CheckoutIDFilterType = "arrayOfStr"
)

type CheckoutLinksCreateResponse

type CheckoutLinksCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Checkout link created.
	CheckoutLink *components.CheckoutLink
}
func (c *CheckoutLinksCreateResponse) GetCheckoutLink() *components.CheckoutLink

func (*CheckoutLinksCreateResponse) GetHTTPMeta

type CheckoutLinksDeleteRequest

type CheckoutLinksDeleteRequest struct {
	// The checkout link ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CheckoutLinksDeleteRequest) GetID

type CheckoutLinksDeleteResponse

type CheckoutLinksDeleteResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*CheckoutLinksDeleteResponse) GetHTTPMeta

type CheckoutLinksGetRequest

type CheckoutLinksGetRequest struct {
	// The checkout link ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CheckoutLinksGetRequest) GetID

func (c *CheckoutLinksGetRequest) GetID() string

type CheckoutLinksGetResponse

type CheckoutLinksGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CheckoutLink *components.CheckoutLink
}
func (c *CheckoutLinksGetResponse) GetCheckoutLink() *components.CheckoutLink

func (*CheckoutLinksGetResponse) GetHTTPMeta

type CheckoutLinksListQueryParamOrganizationIDFilter

type CheckoutLinksListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CheckoutLinksListQueryParamOrganizationIDFilterType
}

CheckoutLinksListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateCheckoutLinksListQueryParamOrganizationIDFilterArrayOfStr

func CreateCheckoutLinksListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) CheckoutLinksListQueryParamOrganizationIDFilter

func CreateCheckoutLinksListQueryParamOrganizationIDFilterStr

func CreateCheckoutLinksListQueryParamOrganizationIDFilterStr(str string) CheckoutLinksListQueryParamOrganizationIDFilter

func (CheckoutLinksListQueryParamOrganizationIDFilter) MarshalJSON

func (*CheckoutLinksListQueryParamOrganizationIDFilter) UnmarshalJSON

type CheckoutLinksListQueryParamOrganizationIDFilterType

type CheckoutLinksListQueryParamOrganizationIDFilterType string
const (
	CheckoutLinksListQueryParamOrganizationIDFilterTypeStr        CheckoutLinksListQueryParamOrganizationIDFilterType = "str"
	CheckoutLinksListQueryParamOrganizationIDFilterTypeArrayOfStr CheckoutLinksListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type CheckoutLinksListQueryParamProductIDFilter

type CheckoutLinksListQueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CheckoutLinksListQueryParamProductIDFilterType
}

CheckoutLinksListQueryParamProductIDFilter - Filter by product ID.

func CreateCheckoutLinksListQueryParamProductIDFilterArrayOfStr

func CreateCheckoutLinksListQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) CheckoutLinksListQueryParamProductIDFilter

func CreateCheckoutLinksListQueryParamProductIDFilterStr

func CreateCheckoutLinksListQueryParamProductIDFilterStr(str string) CheckoutLinksListQueryParamProductIDFilter

func (CheckoutLinksListQueryParamProductIDFilter) MarshalJSON

func (*CheckoutLinksListQueryParamProductIDFilter) UnmarshalJSON

func (u *CheckoutLinksListQueryParamProductIDFilter) UnmarshalJSON(data []byte) error

type CheckoutLinksListQueryParamProductIDFilterType

type CheckoutLinksListQueryParamProductIDFilterType string
const (
	CheckoutLinksListQueryParamProductIDFilterTypeStr        CheckoutLinksListQueryParamProductIDFilterType = "str"
	CheckoutLinksListQueryParamProductIDFilterTypeArrayOfStr CheckoutLinksListQueryParamProductIDFilterType = "arrayOfStr"
)

type CheckoutLinksListRequest

type CheckoutLinksListRequest struct {
	// Filter by organization ID.
	OrganizationID *CheckoutLinksListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by product ID.
	ProductID *CheckoutLinksListQueryParamProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CheckoutLinkSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CheckoutLinksListRequest) GetLimit

func (c *CheckoutLinksListRequest) GetLimit() *int64

func (*CheckoutLinksListRequest) GetOrganizationID

func (*CheckoutLinksListRequest) GetPage

func (c *CheckoutLinksListRequest) GetPage() *int64

func (*CheckoutLinksListRequest) GetProductID

func (*CheckoutLinksListRequest) GetSorting

func (CheckoutLinksListRequest) MarshalJSON

func (c CheckoutLinksListRequest) MarshalJSON() ([]byte, error)

func (*CheckoutLinksListRequest) UnmarshalJSON

func (c *CheckoutLinksListRequest) UnmarshalJSON(data []byte) error

type CheckoutLinksListResponse

type CheckoutLinksListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCheckoutLink *components.ListResourceCheckoutLink

	Next func() (*CheckoutLinksListResponse, error)
}

func (*CheckoutLinksListResponse) GetHTTPMeta

func (c *CheckoutLinksListResponse) GetListResourceCheckoutLink() *components.ListResourceCheckoutLink

type CheckoutLinksUpdateRequest

type CheckoutLinksUpdateRequest struct {
	// The checkout link ID.
	ID                 string                        `pathParam:"style=simple,explode=false,name=id"`
	CheckoutLinkUpdate components.CheckoutLinkUpdate `request:"mediaType=application/json"`
}

func (*CheckoutLinksUpdateRequest) GetCheckoutLinkUpdate

func (c *CheckoutLinksUpdateRequest) GetCheckoutLinkUpdate() components.CheckoutLinkUpdate

func (*CheckoutLinksUpdateRequest) GetID

type CheckoutLinksUpdateResponse

type CheckoutLinksUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Checkout link updated.
	CheckoutLink *components.CheckoutLink
}
func (c *CheckoutLinksUpdateResponse) GetCheckoutLink() *components.CheckoutLink

func (*CheckoutLinksUpdateResponse) GetHTTPMeta

type CheckoutsClientConfirmRequest added in v0.2.0

type CheckoutsClientConfirmRequest struct {
	// The checkout session client secret.
	ClientSecret          string                           `pathParam:"style=simple,explode=false,name=client_secret"`
	CheckoutConfirmStripe components.CheckoutConfirmStripe `request:"mediaType=application/json"`
}

func (*CheckoutsClientConfirmRequest) GetCheckoutConfirmStripe added in v0.2.0

func (c *CheckoutsClientConfirmRequest) GetCheckoutConfirmStripe() components.CheckoutConfirmStripe

func (*CheckoutsClientConfirmRequest) GetClientSecret added in v0.2.0

func (c *CheckoutsClientConfirmRequest) GetClientSecret() string

type CheckoutsClientConfirmResponse added in v0.2.0

type CheckoutsClientConfirmResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Checkout session confirmed.
	CheckoutPublicConfirmed *components.CheckoutPublicConfirmed
}

func (*CheckoutsClientConfirmResponse) GetCheckoutPublicConfirmed added in v0.2.0

func (c *CheckoutsClientConfirmResponse) GetCheckoutPublicConfirmed() *components.CheckoutPublicConfirmed

func (*CheckoutsClientConfirmResponse) GetHTTPMeta added in v0.2.0

type CheckoutsClientGetRequest added in v0.2.0

type CheckoutsClientGetRequest struct {
	// The checkout session client secret.
	ClientSecret string `pathParam:"style=simple,explode=false,name=client_secret"`
}

func (*CheckoutsClientGetRequest) GetClientSecret added in v0.2.0

func (c *CheckoutsClientGetRequest) GetClientSecret() string

type CheckoutsClientGetResponse added in v0.2.0

type CheckoutsClientGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CheckoutPublic *components.CheckoutPublic
}

func (*CheckoutsClientGetResponse) GetCheckoutPublic added in v0.2.0

func (c *CheckoutsClientGetResponse) GetCheckoutPublic() *components.CheckoutPublic

func (*CheckoutsClientGetResponse) GetHTTPMeta added in v0.2.0

type CheckoutsClientUpdateRequest added in v0.2.0

type CheckoutsClientUpdateRequest struct {
	// The checkout session client secret.
	ClientSecret         string                          `pathParam:"style=simple,explode=false,name=client_secret"`
	CheckoutUpdatePublic components.CheckoutUpdatePublic `request:"mediaType=application/json"`
}

func (*CheckoutsClientUpdateRequest) GetCheckoutUpdatePublic added in v0.2.0

func (c *CheckoutsClientUpdateRequest) GetCheckoutUpdatePublic() components.CheckoutUpdatePublic

func (*CheckoutsClientUpdateRequest) GetClientSecret added in v0.2.0

func (c *CheckoutsClientUpdateRequest) GetClientSecret() string

type CheckoutsClientUpdateResponse added in v0.2.0

type CheckoutsClientUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Checkout session updated.
	CheckoutPublic *components.CheckoutPublic
}

func (*CheckoutsClientUpdateResponse) GetCheckoutPublic added in v0.2.0

func (*CheckoutsClientUpdateResponse) GetHTTPMeta added in v0.2.0

type CheckoutsCreateResponse

type CheckoutsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Checkout session created.
	Checkout *components.Checkout
}

func (*CheckoutsCreateResponse) GetCheckout added in v0.2.0

func (c *CheckoutsCreateResponse) GetCheckout() *components.Checkout

func (*CheckoutsCreateResponse) GetHTTPMeta

type CheckoutsGetRequest

type CheckoutsGetRequest struct {
	// The checkout session ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CheckoutsGetRequest) GetID

func (c *CheckoutsGetRequest) GetID() string

type CheckoutsGetResponse

type CheckoutsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Checkout *components.Checkout
}

func (*CheckoutsGetResponse) GetCheckout added in v0.2.0

func (c *CheckoutsGetResponse) GetCheckout() *components.Checkout

func (*CheckoutsGetResponse) GetHTTPMeta

func (c *CheckoutsGetResponse) GetHTTPMeta() components.HTTPMetadata

type CheckoutsListQueryParamCustomerIDFilter added in v0.4.17

type CheckoutsListQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CheckoutsListQueryParamCustomerIDFilterType
}

CheckoutsListQueryParamCustomerIDFilter - Filter by customer ID.

func CreateCheckoutsListQueryParamCustomerIDFilterArrayOfStr added in v0.4.17

func CreateCheckoutsListQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) CheckoutsListQueryParamCustomerIDFilter

func CreateCheckoutsListQueryParamCustomerIDFilterStr added in v0.4.17

func CreateCheckoutsListQueryParamCustomerIDFilterStr(str string) CheckoutsListQueryParamCustomerIDFilter

func (CheckoutsListQueryParamCustomerIDFilter) MarshalJSON added in v0.4.17

func (u CheckoutsListQueryParamCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*CheckoutsListQueryParamCustomerIDFilter) UnmarshalJSON added in v0.4.17

func (u *CheckoutsListQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type CheckoutsListQueryParamCustomerIDFilterType added in v0.4.17

type CheckoutsListQueryParamCustomerIDFilterType string
const (
	CheckoutsListQueryParamCustomerIDFilterTypeStr        CheckoutsListQueryParamCustomerIDFilterType = "str"
	CheckoutsListQueryParamCustomerIDFilterTypeArrayOfStr CheckoutsListQueryParamCustomerIDFilterType = "arrayOfStr"
)

type CheckoutsListQueryParamExternalCustomerIDFilter added in v0.13.0

type CheckoutsListQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CheckoutsListQueryParamExternalCustomerIDFilterType
}

CheckoutsListQueryParamExternalCustomerIDFilter - Filter by customer external ID.

func CreateCheckoutsListQueryParamExternalCustomerIDFilterArrayOfStr added in v0.13.0

func CreateCheckoutsListQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) CheckoutsListQueryParamExternalCustomerIDFilter

func CreateCheckoutsListQueryParamExternalCustomerIDFilterStr added in v0.13.0

func CreateCheckoutsListQueryParamExternalCustomerIDFilterStr(str string) CheckoutsListQueryParamExternalCustomerIDFilter

func (CheckoutsListQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.13.0

func (*CheckoutsListQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.13.0

type CheckoutsListQueryParamExternalCustomerIDFilterType added in v0.13.0

type CheckoutsListQueryParamExternalCustomerIDFilterType string
const (
	CheckoutsListQueryParamExternalCustomerIDFilterTypeStr        CheckoutsListQueryParamExternalCustomerIDFilterType = "str"
	CheckoutsListQueryParamExternalCustomerIDFilterTypeArrayOfStr CheckoutsListQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type CheckoutsListQueryParamOrganizationIDFilter added in v0.2.0

type CheckoutsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CheckoutsListQueryParamOrganizationIDFilterType
}

CheckoutsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateCheckoutsListQueryParamOrganizationIDFilterArrayOfStr added in v0.2.0

func CreateCheckoutsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) CheckoutsListQueryParamOrganizationIDFilter

func CreateCheckoutsListQueryParamOrganizationIDFilterStr added in v0.2.0

func CreateCheckoutsListQueryParamOrganizationIDFilterStr(str string) CheckoutsListQueryParamOrganizationIDFilter

func (CheckoutsListQueryParamOrganizationIDFilter) MarshalJSON added in v0.2.0

func (*CheckoutsListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.2.0

func (u *CheckoutsListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type CheckoutsListQueryParamOrganizationIDFilterType added in v0.2.0

type CheckoutsListQueryParamOrganizationIDFilterType string
const (
	CheckoutsListQueryParamOrganizationIDFilterTypeStr        CheckoutsListQueryParamOrganizationIDFilterType = "str"
	CheckoutsListQueryParamOrganizationIDFilterTypeArrayOfStr CheckoutsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type CheckoutsListQueryParamProductIDFilter added in v0.2.0

type CheckoutsListQueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CheckoutsListQueryParamProductIDFilterType
}

CheckoutsListQueryParamProductIDFilter - Filter by product ID.

func CreateCheckoutsListQueryParamProductIDFilterArrayOfStr added in v0.2.0

func CreateCheckoutsListQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) CheckoutsListQueryParamProductIDFilter

func CreateCheckoutsListQueryParamProductIDFilterStr added in v0.2.0

func CreateCheckoutsListQueryParamProductIDFilterStr(str string) CheckoutsListQueryParamProductIDFilter

func (CheckoutsListQueryParamProductIDFilter) MarshalJSON added in v0.2.0

func (u CheckoutsListQueryParamProductIDFilter) MarshalJSON() ([]byte, error)

func (*CheckoutsListQueryParamProductIDFilter) UnmarshalJSON added in v0.2.0

func (u *CheckoutsListQueryParamProductIDFilter) UnmarshalJSON(data []byte) error

type CheckoutsListQueryParamProductIDFilterType added in v0.2.0

type CheckoutsListQueryParamProductIDFilterType string
const (
	CheckoutsListQueryParamProductIDFilterTypeStr        CheckoutsListQueryParamProductIDFilterType = "str"
	CheckoutsListQueryParamProductIDFilterTypeArrayOfStr CheckoutsListQueryParamProductIDFilterType = "arrayOfStr"
)

type CheckoutsListRequest added in v0.2.0

type CheckoutsListRequest struct {
	// Filter by organization ID.
	OrganizationID *CheckoutsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by product ID.
	ProductID *CheckoutsListQueryParamProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
	// Filter by customer ID.
	CustomerID *CheckoutsListQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by customer external ID.
	ExternalCustomerID *CheckoutsListQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by checkout session status.
	Status *QueryParamStatusFilter `queryParam:"style=form,explode=true,name=status"`
	// Filter by customer email.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CheckoutSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CheckoutsListRequest) GetCustomerID added in v0.4.17

func (*CheckoutsListRequest) GetExternalCustomerID added in v0.13.0

func (*CheckoutsListRequest) GetLimit added in v0.2.0

func (c *CheckoutsListRequest) GetLimit() *int64

func (*CheckoutsListRequest) GetOrganizationID added in v0.2.0

func (*CheckoutsListRequest) GetPage added in v0.2.0

func (c *CheckoutsListRequest) GetPage() *int64

func (*CheckoutsListRequest) GetProductID added in v0.2.0

func (*CheckoutsListRequest) GetQuery added in v0.4.17

func (c *CheckoutsListRequest) GetQuery() *string

func (*CheckoutsListRequest) GetSorting added in v0.2.0

func (*CheckoutsListRequest) GetStatus added in v0.4.17

func (CheckoutsListRequest) MarshalJSON added in v0.2.0

func (c CheckoutsListRequest) MarshalJSON() ([]byte, error)

func (*CheckoutsListRequest) UnmarshalJSON added in v0.2.0

func (c *CheckoutsListRequest) UnmarshalJSON(data []byte) error

type CheckoutsListResponse added in v0.2.0

type CheckoutsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCheckout *components.ListResourceCheckout

	Next func() (*CheckoutsListResponse, error)
}

func (*CheckoutsListResponse) GetHTTPMeta added in v0.2.0

func (*CheckoutsListResponse) GetListResourceCheckout added in v0.2.0

func (c *CheckoutsListResponse) GetListResourceCheckout() *components.ListResourceCheckout

type CheckoutsUpdateRequest added in v0.2.0

type CheckoutsUpdateRequest struct {
	// The checkout session ID.
	ID             string                    `pathParam:"style=simple,explode=false,name=id"`
	CheckoutUpdate components.CheckoutUpdate `request:"mediaType=application/json"`
}

func (*CheckoutsUpdateRequest) GetCheckoutUpdate added in v0.2.0

func (c *CheckoutsUpdateRequest) GetCheckoutUpdate() components.CheckoutUpdate

func (*CheckoutsUpdateRequest) GetID added in v0.2.0

func (c *CheckoutsUpdateRequest) GetID() string

type CheckoutsUpdateResponse added in v0.2.0

type CheckoutsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Checkout session updated.
	Checkout *components.Checkout
}

func (*CheckoutsUpdateResponse) GetCheckout added in v0.2.0

func (c *CheckoutsUpdateResponse) GetCheckout() *components.Checkout

func (*CheckoutsUpdateResponse) GetHTTPMeta added in v0.2.0

type CustomFieldTypeFilter

type CustomFieldTypeFilter struct {
	CustomFieldType        *components.CustomFieldType  `queryParam:"inline" union:"member"`
	ArrayOfCustomFieldType []components.CustomFieldType `queryParam:"inline" union:"member"`

	Type CustomFieldTypeFilterType
}

CustomFieldTypeFilter - Filter by custom field type.

func CreateCustomFieldTypeFilterArrayOfCustomFieldType

func CreateCustomFieldTypeFilterArrayOfCustomFieldType(arrayOfCustomFieldType []components.CustomFieldType) CustomFieldTypeFilter

func CreateCustomFieldTypeFilterCustomFieldType

func CreateCustomFieldTypeFilterCustomFieldType(customFieldType components.CustomFieldType) CustomFieldTypeFilter

func (CustomFieldTypeFilter) MarshalJSON

func (u CustomFieldTypeFilter) MarshalJSON() ([]byte, error)

func (*CustomFieldTypeFilter) UnmarshalJSON

func (u *CustomFieldTypeFilter) UnmarshalJSON(data []byte) error

type CustomFieldTypeFilterType

type CustomFieldTypeFilterType string
const (
	CustomFieldTypeFilterTypeCustomFieldType        CustomFieldTypeFilterType = "CustomFieldType"
	CustomFieldTypeFilterTypeArrayOfCustomFieldType CustomFieldTypeFilterType = "arrayOfCustomFieldType"
)

type CustomFieldsCreateResponse

type CustomFieldsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Custom field created.
	CustomField *components.CustomField
}

func (*CustomFieldsCreateResponse) GetCustomField

func (c *CustomFieldsCreateResponse) GetCustomField() *components.CustomField

func (*CustomFieldsCreateResponse) GetCustomFieldCheckbox

func (c *CustomFieldsCreateResponse) GetCustomFieldCheckbox() *components.CustomFieldCheckbox

func (*CustomFieldsCreateResponse) GetCustomFieldDate

func (c *CustomFieldsCreateResponse) GetCustomFieldDate() *components.CustomFieldDate

func (*CustomFieldsCreateResponse) GetCustomFieldNumber

func (c *CustomFieldsCreateResponse) GetCustomFieldNumber() *components.CustomFieldNumber

func (*CustomFieldsCreateResponse) GetCustomFieldSelect

func (c *CustomFieldsCreateResponse) GetCustomFieldSelect() *components.CustomFieldSelect

func (*CustomFieldsCreateResponse) GetCustomFieldText

func (c *CustomFieldsCreateResponse) GetCustomFieldText() *components.CustomFieldText

func (*CustomFieldsCreateResponse) GetHTTPMeta

type CustomFieldsDeleteRequest

type CustomFieldsDeleteRequest struct {
	// The custom field ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomFieldsDeleteRequest) GetID

func (c *CustomFieldsDeleteRequest) GetID() string

type CustomFieldsDeleteResponse

type CustomFieldsDeleteResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*CustomFieldsDeleteResponse) GetHTTPMeta

type CustomFieldsGetRequest

type CustomFieldsGetRequest struct {
	// The custom field ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomFieldsGetRequest) GetID

func (c *CustomFieldsGetRequest) GetID() string

type CustomFieldsGetResponse

type CustomFieldsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomField *components.CustomField
}

func (*CustomFieldsGetResponse) GetCustomField

func (c *CustomFieldsGetResponse) GetCustomField() *components.CustomField

func (*CustomFieldsGetResponse) GetCustomFieldCheckbox

func (c *CustomFieldsGetResponse) GetCustomFieldCheckbox() *components.CustomFieldCheckbox

func (*CustomFieldsGetResponse) GetCustomFieldDate

func (c *CustomFieldsGetResponse) GetCustomFieldDate() *components.CustomFieldDate

func (*CustomFieldsGetResponse) GetCustomFieldNumber

func (c *CustomFieldsGetResponse) GetCustomFieldNumber() *components.CustomFieldNumber

func (*CustomFieldsGetResponse) GetCustomFieldSelect

func (c *CustomFieldsGetResponse) GetCustomFieldSelect() *components.CustomFieldSelect

func (*CustomFieldsGetResponse) GetCustomFieldText

func (c *CustomFieldsGetResponse) GetCustomFieldText() *components.CustomFieldText

func (*CustomFieldsGetResponse) GetHTTPMeta

type CustomFieldsListQueryParamOrganizationIDFilter

type CustomFieldsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomFieldsListQueryParamOrganizationIDFilterType
}

CustomFieldsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateCustomFieldsListQueryParamOrganizationIDFilterArrayOfStr

func CreateCustomFieldsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) CustomFieldsListQueryParamOrganizationIDFilter

func CreateCustomFieldsListQueryParamOrganizationIDFilterStr

func CreateCustomFieldsListQueryParamOrganizationIDFilterStr(str string) CustomFieldsListQueryParamOrganizationIDFilter

func (CustomFieldsListQueryParamOrganizationIDFilter) MarshalJSON

func (*CustomFieldsListQueryParamOrganizationIDFilter) UnmarshalJSON

type CustomFieldsListQueryParamOrganizationIDFilterType

type CustomFieldsListQueryParamOrganizationIDFilterType string
const (
	CustomFieldsListQueryParamOrganizationIDFilterTypeStr        CustomFieldsListQueryParamOrganizationIDFilterType = "str"
	CustomFieldsListQueryParamOrganizationIDFilterTypeArrayOfStr CustomFieldsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type CustomFieldsListRequest

type CustomFieldsListRequest struct {
	// Filter by organization ID.
	OrganizationID *CustomFieldsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by custom field name or slug.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Filter by custom field type.
	TypeFilter *CustomFieldTypeFilter `queryParam:"style=form,explode=true,name=type"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomFieldSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CustomFieldsListRequest) GetLimit

func (c *CustomFieldsListRequest) GetLimit() *int64

func (*CustomFieldsListRequest) GetOrganizationID

func (*CustomFieldsListRequest) GetPage

func (c *CustomFieldsListRequest) GetPage() *int64

func (*CustomFieldsListRequest) GetQuery

func (c *CustomFieldsListRequest) GetQuery() *string

func (*CustomFieldsListRequest) GetSorting

func (*CustomFieldsListRequest) GetTypeFilter

func (c *CustomFieldsListRequest) GetTypeFilter() *CustomFieldTypeFilter

func (CustomFieldsListRequest) MarshalJSON

func (c CustomFieldsListRequest) MarshalJSON() ([]byte, error)

func (*CustomFieldsListRequest) UnmarshalJSON

func (c *CustomFieldsListRequest) UnmarshalJSON(data []byte) error

type CustomFieldsListResponse

type CustomFieldsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomField *components.ListResourceCustomField

	Next func() (*CustomFieldsListResponse, error)
}

func (*CustomFieldsListResponse) GetHTTPMeta

func (*CustomFieldsListResponse) GetListResourceCustomField

func (c *CustomFieldsListResponse) GetListResourceCustomField() *components.ListResourceCustomField

type CustomFieldsUpdateRequest

type CustomFieldsUpdateRequest struct {
	// The custom field ID.
	ID                string                       `pathParam:"style=simple,explode=false,name=id"`
	CustomFieldUpdate components.CustomFieldUpdate `request:"mediaType=application/json"`
}

func (*CustomFieldsUpdateRequest) GetCustomFieldUpdate

func (c *CustomFieldsUpdateRequest) GetCustomFieldUpdate() components.CustomFieldUpdate

func (*CustomFieldsUpdateRequest) GetCustomFieldUpdateCheckbox

func (c *CustomFieldsUpdateRequest) GetCustomFieldUpdateCheckbox() *components.CustomFieldUpdateCheckbox

func (*CustomFieldsUpdateRequest) GetCustomFieldUpdateDate

func (c *CustomFieldsUpdateRequest) GetCustomFieldUpdateDate() *components.CustomFieldUpdateDate

func (*CustomFieldsUpdateRequest) GetCustomFieldUpdateNumber

func (c *CustomFieldsUpdateRequest) GetCustomFieldUpdateNumber() *components.CustomFieldUpdateNumber

func (*CustomFieldsUpdateRequest) GetCustomFieldUpdateSelect

func (c *CustomFieldsUpdateRequest) GetCustomFieldUpdateSelect() *components.CustomFieldUpdateSelect

func (*CustomFieldsUpdateRequest) GetCustomFieldUpdateText

func (c *CustomFieldsUpdateRequest) GetCustomFieldUpdateText() *components.CustomFieldUpdateText

func (*CustomFieldsUpdateRequest) GetID

func (c *CustomFieldsUpdateRequest) GetID() string

type CustomFieldsUpdateResponse

type CustomFieldsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Custom field updated.
	CustomField *components.CustomField
}

func (*CustomFieldsUpdateResponse) GetCustomField

func (c *CustomFieldsUpdateResponse) GetCustomField() *components.CustomField

func (*CustomFieldsUpdateResponse) GetCustomFieldCheckbox

func (c *CustomFieldsUpdateResponse) GetCustomFieldCheckbox() *components.CustomFieldCheckbox

func (*CustomFieldsUpdateResponse) GetCustomFieldDate

func (c *CustomFieldsUpdateResponse) GetCustomFieldDate() *components.CustomFieldDate

func (*CustomFieldsUpdateResponse) GetCustomFieldNumber

func (c *CustomFieldsUpdateResponse) GetCustomFieldNumber() *components.CustomFieldNumber

func (*CustomFieldsUpdateResponse) GetCustomFieldSelect

func (c *CustomFieldsUpdateResponse) GetCustomFieldSelect() *components.CustomFieldSelect

func (*CustomFieldsUpdateResponse) GetCustomFieldText

func (c *CustomFieldsUpdateResponse) GetCustomFieldText() *components.CustomFieldText

func (*CustomFieldsUpdateResponse) GetHTTPMeta

type CustomerCancellationReasonFilter added in v0.16.0

type CustomerCancellationReasonFilter struct {
	CustomerCancellationReason        *components.CustomerCancellationReason  `queryParam:"inline" union:"member"`
	ArrayOfCustomerCancellationReason []components.CustomerCancellationReason `queryParam:"inline" union:"member"`

	Type CustomerCancellationReasonFilterType
}

CustomerCancellationReasonFilter - Filter by customer cancellation reason.

func CreateCustomerCancellationReasonFilterArrayOfCustomerCancellationReason added in v0.16.0

func CreateCustomerCancellationReasonFilterArrayOfCustomerCancellationReason(arrayOfCustomerCancellationReason []components.CustomerCancellationReason) CustomerCancellationReasonFilter

func CreateCustomerCancellationReasonFilterCustomerCancellationReason added in v0.16.0

func CreateCustomerCancellationReasonFilterCustomerCancellationReason(customerCancellationReason components.CustomerCancellationReason) CustomerCancellationReasonFilter

func (CustomerCancellationReasonFilter) MarshalJSON added in v0.16.0

func (u CustomerCancellationReasonFilter) MarshalJSON() ([]byte, error)

func (*CustomerCancellationReasonFilter) UnmarshalJSON added in v0.16.0

func (u *CustomerCancellationReasonFilter) UnmarshalJSON(data []byte) error

type CustomerCancellationReasonFilterType added in v0.16.0

type CustomerCancellationReasonFilterType string
const (
	CustomerCancellationReasonFilterTypeCustomerCancellationReason        CustomerCancellationReasonFilterType = "CustomerCancellationReason"
	CustomerCancellationReasonFilterTypeArrayOfCustomerCancellationReason CustomerCancellationReasonFilterType = "arrayOfCustomerCancellationReason"
)

type CustomerEmailFilter added in v0.4.17

type CustomerEmailFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerEmailFilterType
}

CustomerEmailFilter - Filter by customer email.

func CreateCustomerEmailFilterArrayOfStr added in v0.4.17

func CreateCustomerEmailFilterArrayOfStr(arrayOfStr []string) CustomerEmailFilter

func CreateCustomerEmailFilterStr added in v0.4.17

func CreateCustomerEmailFilterStr(str string) CustomerEmailFilter

func (CustomerEmailFilter) MarshalJSON added in v0.4.17

func (u CustomerEmailFilter) MarshalJSON() ([]byte, error)

func (*CustomerEmailFilter) UnmarshalJSON added in v0.4.17

func (u *CustomerEmailFilter) UnmarshalJSON(data []byte) error

type CustomerEmailFilterType added in v0.4.17

type CustomerEmailFilterType string
const (
	CustomerEmailFilterTypeStr        CustomerEmailFilterType = "str"
	CustomerEmailFilterTypeArrayOfStr CustomerEmailFilterType = "arrayOfStr"
)

type CustomerIDFilter

type CustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerIDFilterType
}

CustomerIDFilter - Filter by customer ID.

func CreateCustomerIDFilterArrayOfStr

func CreateCustomerIDFilterArrayOfStr(arrayOfStr []string) CustomerIDFilter

func CreateCustomerIDFilterStr

func CreateCustomerIDFilterStr(str string) CustomerIDFilter

func (CustomerIDFilter) MarshalJSON

func (u CustomerIDFilter) MarshalJSON() ([]byte, error)

func (*CustomerIDFilter) UnmarshalJSON

func (u *CustomerIDFilter) UnmarshalJSON(data []byte) error

type CustomerIDFilterType

type CustomerIDFilterType string
const (
	CustomerIDFilterTypeStr        CustomerIDFilterType = "str"
	CustomerIDFilterTypeArrayOfStr CustomerIDFilterType = "arrayOfStr"
)

type CustomerMetersGetRequest added in v0.4.10

type CustomerMetersGetRequest struct {
	// The customer meter ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerMetersGetRequest) GetID added in v0.4.10

func (c *CustomerMetersGetRequest) GetID() string

type CustomerMetersGetResponse added in v0.4.10

type CustomerMetersGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerMeter *components.CustomerMeter
}

func (*CustomerMetersGetResponse) GetCustomerMeter added in v0.4.10

func (c *CustomerMetersGetResponse) GetCustomerMeter() *components.CustomerMeter

func (*CustomerMetersGetResponse) GetHTTPMeta added in v0.4.10

type CustomerMetersListQueryParamCustomerIDFilter added in v0.4.10

type CustomerMetersListQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerMetersListQueryParamCustomerIDFilterType
}

CustomerMetersListQueryParamCustomerIDFilter - Filter by customer ID.

func CreateCustomerMetersListQueryParamCustomerIDFilterArrayOfStr added in v0.4.10

func CreateCustomerMetersListQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) CustomerMetersListQueryParamCustomerIDFilter

func CreateCustomerMetersListQueryParamCustomerIDFilterStr added in v0.4.10

func CreateCustomerMetersListQueryParamCustomerIDFilterStr(str string) CustomerMetersListQueryParamCustomerIDFilter

func (CustomerMetersListQueryParamCustomerIDFilter) MarshalJSON added in v0.4.10

func (*CustomerMetersListQueryParamCustomerIDFilter) UnmarshalJSON added in v0.4.10

func (u *CustomerMetersListQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type CustomerMetersListQueryParamCustomerIDFilterType added in v0.4.10

type CustomerMetersListQueryParamCustomerIDFilterType string
const (
	CustomerMetersListQueryParamCustomerIDFilterTypeStr        CustomerMetersListQueryParamCustomerIDFilterType = "str"
	CustomerMetersListQueryParamCustomerIDFilterTypeArrayOfStr CustomerMetersListQueryParamCustomerIDFilterType = "arrayOfStr"
)

type CustomerMetersListQueryParamExternalCustomerIDFilter added in v0.4.10

type CustomerMetersListQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerMetersListQueryParamExternalCustomerIDFilterType
}

CustomerMetersListQueryParamExternalCustomerIDFilter - Filter by external customer ID.

func CreateCustomerMetersListQueryParamExternalCustomerIDFilterArrayOfStr added in v0.4.10

func CreateCustomerMetersListQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) CustomerMetersListQueryParamExternalCustomerIDFilter

func CreateCustomerMetersListQueryParamExternalCustomerIDFilterStr added in v0.4.10

func CreateCustomerMetersListQueryParamExternalCustomerIDFilterStr(str string) CustomerMetersListQueryParamExternalCustomerIDFilter

func (CustomerMetersListQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.4.10

func (*CustomerMetersListQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.4.10

type CustomerMetersListQueryParamExternalCustomerIDFilterType added in v0.4.10

type CustomerMetersListQueryParamExternalCustomerIDFilterType string
const (
	CustomerMetersListQueryParamExternalCustomerIDFilterTypeStr        CustomerMetersListQueryParamExternalCustomerIDFilterType = "str"
	CustomerMetersListQueryParamExternalCustomerIDFilterTypeArrayOfStr CustomerMetersListQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type CustomerMetersListQueryParamOrganizationIDFilter added in v0.4.10

type CustomerMetersListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerMetersListQueryParamOrganizationIDFilterType
}

CustomerMetersListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateCustomerMetersListQueryParamOrganizationIDFilterArrayOfStr added in v0.4.10

func CreateCustomerMetersListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) CustomerMetersListQueryParamOrganizationIDFilter

func CreateCustomerMetersListQueryParamOrganizationIDFilterStr added in v0.4.10

func CreateCustomerMetersListQueryParamOrganizationIDFilterStr(str string) CustomerMetersListQueryParamOrganizationIDFilter

func (CustomerMetersListQueryParamOrganizationIDFilter) MarshalJSON added in v0.4.10

func (*CustomerMetersListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.4.10

type CustomerMetersListQueryParamOrganizationIDFilterType added in v0.4.10

type CustomerMetersListQueryParamOrganizationIDFilterType string
const (
	CustomerMetersListQueryParamOrganizationIDFilterTypeStr        CustomerMetersListQueryParamOrganizationIDFilterType = "str"
	CustomerMetersListQueryParamOrganizationIDFilterTypeArrayOfStr CustomerMetersListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type CustomerMetersListRequest added in v0.4.10

type CustomerMetersListRequest struct {
	// Filter by organization ID.
	OrganizationID *CustomerMetersListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by customer ID.
	CustomerID *CustomerMetersListQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by external customer ID.
	ExternalCustomerID *CustomerMetersListQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by meter ID.
	MeterID *QueryParamMeterIDFilter `queryParam:"style=form,explode=true,name=meter_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomerMeterSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CustomerMetersListRequest) GetCustomerID added in v0.4.10

func (*CustomerMetersListRequest) GetExternalCustomerID added in v0.4.10

func (*CustomerMetersListRequest) GetLimit added in v0.4.10

func (c *CustomerMetersListRequest) GetLimit() *int64

func (*CustomerMetersListRequest) GetMeterID added in v0.4.10

func (*CustomerMetersListRequest) GetOrganizationID added in v0.4.10

func (*CustomerMetersListRequest) GetPage added in v0.4.10

func (c *CustomerMetersListRequest) GetPage() *int64

func (*CustomerMetersListRequest) GetSorting added in v0.4.10

func (CustomerMetersListRequest) MarshalJSON added in v0.4.10

func (c CustomerMetersListRequest) MarshalJSON() ([]byte, error)

func (*CustomerMetersListRequest) UnmarshalJSON added in v0.4.10

func (c *CustomerMetersListRequest) UnmarshalJSON(data []byte) error

type CustomerMetersListResponse added in v0.4.10

type CustomerMetersListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerMeter *components.ListResourceCustomerMeter

	Next func() (*CustomerMetersListResponse, error)
}

func (*CustomerMetersListResponse) GetHTTPMeta added in v0.4.10

func (*CustomerMetersListResponse) GetListResourceCustomerMeter added in v0.4.10

func (c *CustomerMetersListResponse) GetListResourceCustomerMeter() *components.ListResourceCustomerMeter

type CustomerPortalBenefitGrantsGetRequest

type CustomerPortalBenefitGrantsGetRequest struct {
	// The benefit grant ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalBenefitGrantsGetRequest) GetID

type CustomerPortalBenefitGrantsGetResponse

type CustomerPortalBenefitGrantsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerBenefitGrant *components.CustomerBenefitGrant
}

func (*CustomerPortalBenefitGrantsGetResponse) GetCustomerBenefitGrant

func (*CustomerPortalBenefitGrantsGetResponse) GetHTTPMeta

type CustomerPortalBenefitGrantsGetSecurity added in v0.4.0

type CustomerPortalBenefitGrantsGetSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalBenefitGrantsGetSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalBenefitGrantsGetSecurity) GetCustomerSession() *string

func (*CustomerPortalBenefitGrantsGetSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalBenefitGrantsGetSecurity) GetMemberSession() *string

type CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter

type CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerPortalBenefitGrantsListQueryParamBenefitIDFilterType
}

CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter - Filter by benefit ID.

func CreateCustomerPortalBenefitGrantsListQueryParamBenefitIDFilterArrayOfStr

func CreateCustomerPortalBenefitGrantsListQueryParamBenefitIDFilterArrayOfStr(arrayOfStr []string) CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter

func CreateCustomerPortalBenefitGrantsListQueryParamBenefitIDFilterStr

func CreateCustomerPortalBenefitGrantsListQueryParamBenefitIDFilterStr(str string) CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter

func (CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter) MarshalJSON

func (*CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter) UnmarshalJSON

type CustomerPortalBenefitGrantsListQueryParamBenefitIDFilterType

type CustomerPortalBenefitGrantsListQueryParamBenefitIDFilterType string
const (
	CustomerPortalBenefitGrantsListQueryParamBenefitIDFilterTypeStr        CustomerPortalBenefitGrantsListQueryParamBenefitIDFilterType = "str"
	CustomerPortalBenefitGrantsListQueryParamBenefitIDFilterTypeArrayOfStr CustomerPortalBenefitGrantsListQueryParamBenefitIDFilterType = "arrayOfStr"
)

type CustomerPortalBenefitGrantsListQueryParamOrderIDFilter added in v0.13.0

type CustomerPortalBenefitGrantsListQueryParamOrderIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerPortalBenefitGrantsListQueryParamOrderIDFilterType
}

CustomerPortalBenefitGrantsListQueryParamOrderIDFilter - Filter by order ID.

func CreateCustomerPortalBenefitGrantsListQueryParamOrderIDFilterArrayOfStr added in v0.13.0

func CreateCustomerPortalBenefitGrantsListQueryParamOrderIDFilterArrayOfStr(arrayOfStr []string) CustomerPortalBenefitGrantsListQueryParamOrderIDFilter

func CreateCustomerPortalBenefitGrantsListQueryParamOrderIDFilterStr added in v0.13.0

func CreateCustomerPortalBenefitGrantsListQueryParamOrderIDFilterStr(str string) CustomerPortalBenefitGrantsListQueryParamOrderIDFilter

func (CustomerPortalBenefitGrantsListQueryParamOrderIDFilter) MarshalJSON added in v0.13.0

func (*CustomerPortalBenefitGrantsListQueryParamOrderIDFilter) UnmarshalJSON added in v0.13.0

type CustomerPortalBenefitGrantsListQueryParamOrderIDFilterType added in v0.13.0

type CustomerPortalBenefitGrantsListQueryParamOrderIDFilterType string
const (
	CustomerPortalBenefitGrantsListQueryParamOrderIDFilterTypeStr        CustomerPortalBenefitGrantsListQueryParamOrderIDFilterType = "str"
	CustomerPortalBenefitGrantsListQueryParamOrderIDFilterTypeArrayOfStr CustomerPortalBenefitGrantsListQueryParamOrderIDFilterType = "arrayOfStr"
)

type CustomerPortalBenefitGrantsListRequest

type CustomerPortalBenefitGrantsListRequest struct {
	// Filter by benefit description.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Filter by benefit type.
	TypeFilter *QueryParamBenefitTypeFilter `queryParam:"style=form,explode=true,name=type"`
	// Filter by benefit ID.
	BenefitID *CustomerPortalBenefitGrantsListQueryParamBenefitIDFilter `queryParam:"style=form,explode=true,name=benefit_id"`
	// Filter by checkout ID.
	CheckoutID *QueryParamCheckoutIDFilter `queryParam:"style=form,explode=true,name=checkout_id"`
	// Filter by order ID.
	OrderID *CustomerPortalBenefitGrantsListQueryParamOrderIDFilter `queryParam:"style=form,explode=true,name=order_id"`
	// Filter by subscription ID.
	SubscriptionID *QueryParamSubscriptionIDFilter `queryParam:"style=form,explode=true,name=subscription_id"`
	// Filter by member ID.
	MemberID *QueryParamMemberIDFilter `queryParam:"style=form,explode=true,name=member_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomerBenefitGrantSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CustomerPortalBenefitGrantsListRequest) GetBenefitID

func (*CustomerPortalBenefitGrantsListRequest) GetCheckoutID

func (*CustomerPortalBenefitGrantsListRequest) GetLimit

func (*CustomerPortalBenefitGrantsListRequest) GetMemberID added in v0.13.0

func (*CustomerPortalBenefitGrantsListRequest) GetOrderID

func (*CustomerPortalBenefitGrantsListRequest) GetPage

func (*CustomerPortalBenefitGrantsListRequest) GetQuery added in v0.13.0

func (*CustomerPortalBenefitGrantsListRequest) GetSorting

func (*CustomerPortalBenefitGrantsListRequest) GetSubscriptionID

func (*CustomerPortalBenefitGrantsListRequest) GetTypeFilter

func (CustomerPortalBenefitGrantsListRequest) MarshalJSON

func (c CustomerPortalBenefitGrantsListRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalBenefitGrantsListRequest) UnmarshalJSON

func (c *CustomerPortalBenefitGrantsListRequest) UnmarshalJSON(data []byte) error

type CustomerPortalBenefitGrantsListResponse

type CustomerPortalBenefitGrantsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerBenefitGrant *components.ListResourceCustomerBenefitGrant

	Next func() (*CustomerPortalBenefitGrantsListResponse, error)
}

func (*CustomerPortalBenefitGrantsListResponse) GetHTTPMeta

func (*CustomerPortalBenefitGrantsListResponse) GetListResourceCustomerBenefitGrant

type CustomerPortalBenefitGrantsListSecurity added in v0.4.0

type CustomerPortalBenefitGrantsListSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalBenefitGrantsListSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalBenefitGrantsListSecurity) GetCustomerSession() *string

func (*CustomerPortalBenefitGrantsListSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalBenefitGrantsListSecurity) GetMemberSession() *string

type CustomerPortalBenefitGrantsUpdateRequest

type CustomerPortalBenefitGrantsUpdateRequest struct {
	// The benefit grant ID.
	ID                         string                                `pathParam:"style=simple,explode=false,name=id"`
	CustomerBenefitGrantUpdate components.CustomerBenefitGrantUpdate `request:"mediaType=application/json"`
}

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdate

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateCustom

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateDiscord

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateDownloadables

func (c *CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateDownloadables() *components.CustomerBenefitGrantDownloadablesUpdate

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateFeatureFlag added in v0.15.0

func (c *CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateFeatureFlag() *components.CustomerBenefitGrantFeatureFlagUpdate

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateGithubRepository

func (c *CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateGithubRepository() *components.CustomerBenefitGrantGitHubRepositoryUpdate

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateLicenseKeys

func (c *CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateLicenseKeys() *components.CustomerBenefitGrantLicenseKeysUpdate

func (*CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateMeterCredit added in v0.4.10

func (c *CustomerPortalBenefitGrantsUpdateRequest) GetCustomerBenefitGrantUpdateMeterCredit() *components.CustomerBenefitGrantMeterCreditUpdate

func (*CustomerPortalBenefitGrantsUpdateRequest) GetID

type CustomerPortalBenefitGrantsUpdateResponse

type CustomerPortalBenefitGrantsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Benefit grant updated.
	CustomerBenefitGrant *components.CustomerBenefitGrant
}

func (*CustomerPortalBenefitGrantsUpdateResponse) GetCustomerBenefitGrant

func (*CustomerPortalBenefitGrantsUpdateResponse) GetHTTPMeta

type CustomerPortalBenefitGrantsUpdateSecurity added in v0.4.0

type CustomerPortalBenefitGrantsUpdateSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalBenefitGrantsUpdateSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalBenefitGrantsUpdateSecurity) GetCustomerSession() *string

func (*CustomerPortalBenefitGrantsUpdateSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalBenefitGrantsUpdateSecurity) GetMemberSession() *string

type CustomerPortalCustomerMetersGetRequest added in v0.4.10

type CustomerPortalCustomerMetersGetRequest struct {
	// The customer meter ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalCustomerMetersGetRequest) GetID added in v0.4.10

type CustomerPortalCustomerMetersGetResponse added in v0.4.10

type CustomerPortalCustomerMetersGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerCustomerMeter *components.CustomerCustomerMeter
}

func (*CustomerPortalCustomerMetersGetResponse) GetCustomerCustomerMeter added in v0.4.10

func (*CustomerPortalCustomerMetersGetResponse) GetHTTPMeta added in v0.4.10

type CustomerPortalCustomerMetersGetSecurity added in v0.4.10

type CustomerPortalCustomerMetersGetSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomerMetersGetSecurity) GetCustomerSession added in v0.4.10

func (c *CustomerPortalCustomerMetersGetSecurity) GetCustomerSession() *string

func (*CustomerPortalCustomerMetersGetSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalCustomerMetersGetSecurity) GetMemberSession() *string

type CustomerPortalCustomerMetersListRequest added in v0.4.10

type CustomerPortalCustomerMetersListRequest struct {
	// Filter by meter ID.
	MeterID *MeterIDFilter `queryParam:"style=form,explode=true,name=meter_id"`
	// Filter by meter name.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomerCustomerMeterSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CustomerPortalCustomerMetersListRequest) GetLimit added in v0.4.10

func (*CustomerPortalCustomerMetersListRequest) GetMeterID added in v0.4.10

func (*CustomerPortalCustomerMetersListRequest) GetPage added in v0.4.10

func (*CustomerPortalCustomerMetersListRequest) GetQuery added in v0.4.10

func (*CustomerPortalCustomerMetersListRequest) GetSorting added in v0.4.10

func (CustomerPortalCustomerMetersListRequest) MarshalJSON added in v0.4.10

func (c CustomerPortalCustomerMetersListRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalCustomerMetersListRequest) UnmarshalJSON added in v0.4.10

func (c *CustomerPortalCustomerMetersListRequest) UnmarshalJSON(data []byte) error

type CustomerPortalCustomerMetersListResponse added in v0.4.10

type CustomerPortalCustomerMetersListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerCustomerMeter *components.ListResourceCustomerCustomerMeter

	Next func() (*CustomerPortalCustomerMetersListResponse, error)
}

func (*CustomerPortalCustomerMetersListResponse) GetHTTPMeta added in v0.4.10

func (*CustomerPortalCustomerMetersListResponse) GetListResourceCustomerCustomerMeter added in v0.4.10

type CustomerPortalCustomerMetersListSecurity added in v0.4.10

type CustomerPortalCustomerMetersListSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomerMetersListSecurity) GetCustomerSession added in v0.4.10

func (c *CustomerPortalCustomerMetersListSecurity) GetCustomerSession() *string

func (*CustomerPortalCustomerMetersListSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalCustomerMetersListSecurity) GetMemberSession() *string

type CustomerPortalCustomerSessionGetAuthenticatedUserResponse added in v0.13.0

type CustomerPortalCustomerSessionGetAuthenticatedUserResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	PortalAuthenticatedUser *components.PortalAuthenticatedUser
}

func (*CustomerPortalCustomerSessionGetAuthenticatedUserResponse) GetHTTPMeta added in v0.13.0

func (*CustomerPortalCustomerSessionGetAuthenticatedUserResponse) GetPortalAuthenticatedUser added in v0.13.0

type CustomerPortalCustomerSessionGetAuthenticatedUserSecurity added in v0.13.0

type CustomerPortalCustomerSessionGetAuthenticatedUserSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomerSessionGetAuthenticatedUserSecurity) GetCustomerSession added in v0.13.0

func (*CustomerPortalCustomerSessionGetAuthenticatedUserSecurity) GetMemberSession added in v0.13.0

type CustomerPortalCustomerSessionIntrospectResponse added in v0.10.1

type CustomerPortalCustomerSessionIntrospectResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerCustomerSession *components.CustomerCustomerSession
}

func (*CustomerPortalCustomerSessionIntrospectResponse) GetCustomerCustomerSession added in v0.10.1

func (*CustomerPortalCustomerSessionIntrospectResponse) GetHTTPMeta added in v0.10.1

type CustomerPortalCustomerSessionIntrospectSecurity added in v0.10.1

type CustomerPortalCustomerSessionIntrospectSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomerSessionIntrospectSecurity) GetCustomerSession added in v0.10.1

func (*CustomerPortalCustomerSessionIntrospectSecurity) GetMemberSession added in v0.13.0

type CustomerPortalCustomersAddPaymentMethodResponse added in v0.4.0

type CustomerPortalCustomersAddPaymentMethodResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Payment method created or setup initiated.
	CustomerPaymentMethodCreateResponse *components.CustomerPaymentMethodCreateResponse
}

func (*CustomerPortalCustomersAddPaymentMethodResponse) GetCustomerPaymentMethodCreateResponse added in v0.9.2

func (*CustomerPortalCustomersAddPaymentMethodResponse) GetCustomerPaymentMethodCreateResponseRequiresAction added in v0.9.2

func (*CustomerPortalCustomersAddPaymentMethodResponse) GetCustomerPaymentMethodCreateResponseSucceeded added in v0.9.2

func (*CustomerPortalCustomersAddPaymentMethodResponse) GetHTTPMeta added in v0.4.0

type CustomerPortalCustomersAddPaymentMethodSecurity added in v0.4.0

type CustomerPortalCustomersAddPaymentMethodSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomersAddPaymentMethodSecurity) GetCustomerSession added in v0.4.0

func (*CustomerPortalCustomersAddPaymentMethodSecurity) GetMemberSession added in v0.13.0

type CustomerPortalCustomersConfirmPaymentMethodResponse added in v0.9.2

type CustomerPortalCustomersConfirmPaymentMethodResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Payment method created or setup initiated.
	CustomerPaymentMethodCreateResponse *components.CustomerPaymentMethodCreateResponse
}

func (*CustomerPortalCustomersConfirmPaymentMethodResponse) GetCustomerPaymentMethodCreateResponse added in v0.9.2

func (*CustomerPortalCustomersConfirmPaymentMethodResponse) GetCustomerPaymentMethodCreateResponseRequiresAction added in v0.9.2

func (*CustomerPortalCustomersConfirmPaymentMethodResponse) GetCustomerPaymentMethodCreateResponseSucceeded added in v0.9.2

func (*CustomerPortalCustomersConfirmPaymentMethodResponse) GetHTTPMeta added in v0.9.2

type CustomerPortalCustomersConfirmPaymentMethodSecurity added in v0.9.2

type CustomerPortalCustomersConfirmPaymentMethodSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomersConfirmPaymentMethodSecurity) GetCustomerSession added in v0.9.2

func (*CustomerPortalCustomersConfirmPaymentMethodSecurity) GetMemberSession added in v0.13.0

type CustomerPortalCustomersDeletePaymentMethodRequest added in v0.4.0

type CustomerPortalCustomersDeletePaymentMethodRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalCustomersDeletePaymentMethodRequest) GetID added in v0.4.0

type CustomerPortalCustomersDeletePaymentMethodResponse added in v0.4.0

type CustomerPortalCustomersDeletePaymentMethodResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*CustomerPortalCustomersDeletePaymentMethodResponse) GetHTTPMeta added in v0.4.0

type CustomerPortalCustomersDeletePaymentMethodSecurity added in v0.4.0

type CustomerPortalCustomersDeletePaymentMethodSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomersDeletePaymentMethodSecurity) GetCustomerSession added in v0.4.0

func (*CustomerPortalCustomersDeletePaymentMethodSecurity) GetMemberSession added in v0.13.0

type CustomerPortalCustomersGetResponse

type CustomerPortalCustomersGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerPortalCustomer *components.CustomerPortalCustomer
}

func (*CustomerPortalCustomersGetResponse) GetCustomerPortalCustomer

func (*CustomerPortalCustomersGetResponse) GetHTTPMeta

type CustomerPortalCustomersGetSecurity added in v0.4.0

type CustomerPortalCustomersGetSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomersGetSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalCustomersGetSecurity) GetCustomerSession() *string

func (*CustomerPortalCustomersGetSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalCustomersGetSecurity) GetMemberSession() *string

type CustomerPortalCustomersListPaymentMethodsRequest added in v0.7.2

type CustomerPortalCustomersListPaymentMethodsRequest struct {
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*CustomerPortalCustomersListPaymentMethodsRequest) GetLimit added in v0.7.2

func (*CustomerPortalCustomersListPaymentMethodsRequest) GetPage added in v0.7.2

func (CustomerPortalCustomersListPaymentMethodsRequest) MarshalJSON added in v0.7.2

func (*CustomerPortalCustomersListPaymentMethodsRequest) UnmarshalJSON added in v0.7.2

type CustomerPortalCustomersListPaymentMethodsResponse added in v0.7.2

type CustomerPortalCustomersListPaymentMethodsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerPaymentMethod *components.ListResourceCustomerPaymentMethod

	Next func() (*CustomerPortalCustomersListPaymentMethodsResponse, error)
}

func (*CustomerPortalCustomersListPaymentMethodsResponse) GetHTTPMeta added in v0.7.2

func (*CustomerPortalCustomersListPaymentMethodsResponse) GetListResourceCustomerPaymentMethod added in v0.7.3

type CustomerPortalCustomersListPaymentMethodsSecurity added in v0.7.2

type CustomerPortalCustomersListPaymentMethodsSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomersListPaymentMethodsSecurity) GetCustomerSession added in v0.7.2

func (*CustomerPortalCustomersListPaymentMethodsSecurity) GetMemberSession added in v0.13.0

type CustomerPortalCustomersUpdateResponse added in v0.4.0

type CustomerPortalCustomersUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Customer updated.
	CustomerPortalCustomer *components.CustomerPortalCustomer
}

func (*CustomerPortalCustomersUpdateResponse) GetCustomerPortalCustomer added in v0.4.0

func (*CustomerPortalCustomersUpdateResponse) GetHTTPMeta added in v0.4.0

type CustomerPortalCustomersUpdateSecurity added in v0.4.0

type CustomerPortalCustomersUpdateSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalCustomersUpdateSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalCustomersUpdateSecurity) GetCustomerSession() *string

func (*CustomerPortalCustomersUpdateSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalCustomersUpdateSecurity) GetMemberSession() *string

type CustomerPortalDownloadablesListQueryParamBenefitIDFilter

type CustomerPortalDownloadablesListQueryParamBenefitIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerPortalDownloadablesListQueryParamBenefitIDFilterType
}

CustomerPortalDownloadablesListQueryParamBenefitIDFilter - Filter by benefit ID.

func CreateCustomerPortalDownloadablesListQueryParamBenefitIDFilterArrayOfStr

func CreateCustomerPortalDownloadablesListQueryParamBenefitIDFilterArrayOfStr(arrayOfStr []string) CustomerPortalDownloadablesListQueryParamBenefitIDFilter

func CreateCustomerPortalDownloadablesListQueryParamBenefitIDFilterStr

func CreateCustomerPortalDownloadablesListQueryParamBenefitIDFilterStr(str string) CustomerPortalDownloadablesListQueryParamBenefitIDFilter

func (CustomerPortalDownloadablesListQueryParamBenefitIDFilter) MarshalJSON

func (*CustomerPortalDownloadablesListQueryParamBenefitIDFilter) UnmarshalJSON

type CustomerPortalDownloadablesListQueryParamBenefitIDFilterType

type CustomerPortalDownloadablesListQueryParamBenefitIDFilterType string
const (
	CustomerPortalDownloadablesListQueryParamBenefitIDFilterTypeStr        CustomerPortalDownloadablesListQueryParamBenefitIDFilterType = "str"
	CustomerPortalDownloadablesListQueryParamBenefitIDFilterTypeArrayOfStr CustomerPortalDownloadablesListQueryParamBenefitIDFilterType = "arrayOfStr"
)

type CustomerPortalDownloadablesListRequest

type CustomerPortalDownloadablesListRequest struct {
	// Filter by benefit ID.
	BenefitID *CustomerPortalDownloadablesListQueryParamBenefitIDFilter `queryParam:"style=form,explode=true,name=benefit_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*CustomerPortalDownloadablesListRequest) GetBenefitID

func (*CustomerPortalDownloadablesListRequest) GetLimit

func (*CustomerPortalDownloadablesListRequest) GetPage

func (CustomerPortalDownloadablesListRequest) MarshalJSON

func (c CustomerPortalDownloadablesListRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalDownloadablesListRequest) UnmarshalJSON

func (c *CustomerPortalDownloadablesListRequest) UnmarshalJSON(data []byte) error

type CustomerPortalDownloadablesListResponse

type CustomerPortalDownloadablesListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceDownloadableRead *components.ListResourceDownloadableRead

	Next func() (*CustomerPortalDownloadablesListResponse, error)
}

func (*CustomerPortalDownloadablesListResponse) GetHTTPMeta

func (*CustomerPortalDownloadablesListResponse) GetListResourceDownloadableRead

type CustomerPortalDownloadablesListSecurity added in v0.4.0

type CustomerPortalDownloadablesListSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalDownloadablesListSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalDownloadablesListSecurity) GetCustomerSession() *string

func (*CustomerPortalDownloadablesListSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalDownloadablesListSecurity) GetMemberSession() *string

type CustomerPortalLicenseKeysActivateResponse

type CustomerPortalLicenseKeysActivateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	LicenseKeyActivationRead *components.LicenseKeyActivationRead
}

func (*CustomerPortalLicenseKeysActivateResponse) GetHTTPMeta

func (*CustomerPortalLicenseKeysActivateResponse) GetLicenseKeyActivationRead

type CustomerPortalLicenseKeysDeactivateResponse

type CustomerPortalLicenseKeysDeactivateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*CustomerPortalLicenseKeysDeactivateResponse) GetHTTPMeta

type CustomerPortalLicenseKeysGetRequest

type CustomerPortalLicenseKeysGetRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalLicenseKeysGetRequest) GetID

type CustomerPortalLicenseKeysGetResponse

type CustomerPortalLicenseKeysGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	LicenseKeyWithActivations *components.LicenseKeyWithActivations
}

func (*CustomerPortalLicenseKeysGetResponse) GetHTTPMeta

func (*CustomerPortalLicenseKeysGetResponse) GetLicenseKeyWithActivations

type CustomerPortalLicenseKeysGetSecurity added in v0.4.0

type CustomerPortalLicenseKeysGetSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalLicenseKeysGetSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalLicenseKeysGetSecurity) GetCustomerSession() *string

func (*CustomerPortalLicenseKeysGetSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalLicenseKeysGetSecurity) GetMemberSession() *string

type CustomerPortalLicenseKeysListRequest

type CustomerPortalLicenseKeysListRequest struct {
	// Filter by a specific benefit
	BenefitID *string `queryParam:"style=form,explode=true,name=benefit_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*CustomerPortalLicenseKeysListRequest) GetBenefitID

func (c *CustomerPortalLicenseKeysListRequest) GetBenefitID() *string

func (*CustomerPortalLicenseKeysListRequest) GetLimit

func (*CustomerPortalLicenseKeysListRequest) GetPage

func (CustomerPortalLicenseKeysListRequest) MarshalJSON

func (c CustomerPortalLicenseKeysListRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalLicenseKeysListRequest) UnmarshalJSON

func (c *CustomerPortalLicenseKeysListRequest) UnmarshalJSON(data []byte) error

type CustomerPortalLicenseKeysListResponse

type CustomerPortalLicenseKeysListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceLicenseKeyRead *components.ListResourceLicenseKeyRead

	Next func() (*CustomerPortalLicenseKeysListResponse, error)
}

func (*CustomerPortalLicenseKeysListResponse) GetHTTPMeta

func (*CustomerPortalLicenseKeysListResponse) GetListResourceLicenseKeyRead

type CustomerPortalLicenseKeysListSecurity added in v0.4.0

type CustomerPortalLicenseKeysListSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalLicenseKeysListSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalLicenseKeysListSecurity) GetCustomerSession() *string

func (*CustomerPortalLicenseKeysListSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalLicenseKeysListSecurity) GetMemberSession() *string

type CustomerPortalLicenseKeysValidateResponse

type CustomerPortalLicenseKeysValidateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ValidatedLicenseKey *components.ValidatedLicenseKey
}

func (*CustomerPortalLicenseKeysValidateResponse) GetHTTPMeta

func (*CustomerPortalLicenseKeysValidateResponse) GetValidatedLicenseKey

type CustomerPortalMembersAddMemberResponse added in v0.13.0

type CustomerPortalMembersAddMemberResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Member added.
	CustomerPortalMember *components.CustomerPortalMember
}

func (*CustomerPortalMembersAddMemberResponse) GetCustomerPortalMember added in v0.13.0

func (*CustomerPortalMembersAddMemberResponse) GetHTTPMeta added in v0.13.0

type CustomerPortalMembersListMembersRequest added in v0.13.0

type CustomerPortalMembersListMembersRequest struct {
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*CustomerPortalMembersListMembersRequest) GetLimit added in v0.13.0

func (*CustomerPortalMembersListMembersRequest) GetPage added in v0.13.0

func (CustomerPortalMembersListMembersRequest) MarshalJSON added in v0.13.0

func (c CustomerPortalMembersListMembersRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalMembersListMembersRequest) UnmarshalJSON added in v0.13.0

func (c *CustomerPortalMembersListMembersRequest) UnmarshalJSON(data []byte) error

type CustomerPortalMembersListMembersResponse added in v0.13.0

type CustomerPortalMembersListMembersResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerPortalMember *components.ListResourceCustomerPortalMember

	Next func() (*CustomerPortalMembersListMembersResponse, error)
}

func (*CustomerPortalMembersListMembersResponse) GetHTTPMeta added in v0.13.0

func (*CustomerPortalMembersListMembersResponse) GetListResourceCustomerPortalMember added in v0.13.0

type CustomerPortalMembersRemoveMemberRequest added in v0.13.0

type CustomerPortalMembersRemoveMemberRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalMembersRemoveMemberRequest) GetID added in v0.13.0

type CustomerPortalMembersRemoveMemberResponse added in v0.13.0

type CustomerPortalMembersRemoveMemberResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*CustomerPortalMembersRemoveMemberResponse) GetHTTPMeta added in v0.13.0

type CustomerPortalMembersUpdateMemberRequest added in v0.13.0

type CustomerPortalMembersUpdateMemberRequest struct {
	ID                         string                                `pathParam:"style=simple,explode=false,name=id"`
	CustomerPortalMemberUpdate components.CustomerPortalMemberUpdate `request:"mediaType=application/json"`
}

func (*CustomerPortalMembersUpdateMemberRequest) GetCustomerPortalMemberUpdate added in v0.13.0

func (*CustomerPortalMembersUpdateMemberRequest) GetID added in v0.13.0

type CustomerPortalMembersUpdateMemberResponse added in v0.13.0

type CustomerPortalMembersUpdateMemberResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Member updated.
	CustomerPortalMember *components.CustomerPortalMember
}

func (*CustomerPortalMembersUpdateMemberResponse) GetCustomerPortalMember added in v0.13.0

func (*CustomerPortalMembersUpdateMemberResponse) GetHTTPMeta added in v0.13.0

type CustomerPortalOrdersConfirmRetryPaymentRequest added in v0.8.2

type CustomerPortalOrdersConfirmRetryPaymentRequest struct {
	// The order ID.
	ID                          string                                 `pathParam:"style=simple,explode=false,name=id"`
	CustomerOrderConfirmPayment components.CustomerOrderConfirmPayment `request:"mediaType=application/json"`
}

func (*CustomerPortalOrdersConfirmRetryPaymentRequest) GetCustomerOrderConfirmPayment added in v0.8.2

func (*CustomerPortalOrdersConfirmRetryPaymentRequest) GetID added in v0.8.2

type CustomerPortalOrdersConfirmRetryPaymentResponse added in v0.8.2

type CustomerPortalOrdersConfirmRetryPaymentResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerOrderPaymentConfirmation *components.CustomerOrderPaymentConfirmation
}

func (*CustomerPortalOrdersConfirmRetryPaymentResponse) GetCustomerOrderPaymentConfirmation added in v0.8.2

func (*CustomerPortalOrdersConfirmRetryPaymentResponse) GetHTTPMeta added in v0.8.2

type CustomerPortalOrdersConfirmRetryPaymentSecurity added in v0.8.2

type CustomerPortalOrdersConfirmRetryPaymentSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalOrdersConfirmRetryPaymentSecurity) GetCustomerSession added in v0.8.2

func (*CustomerPortalOrdersConfirmRetryPaymentSecurity) GetMemberSession added in v0.13.0

type CustomerPortalOrdersGenerateInvoiceRequest added in v0.5.0

type CustomerPortalOrdersGenerateInvoiceRequest struct {
	// The order ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalOrdersGenerateInvoiceRequest) GetID added in v0.5.0

type CustomerPortalOrdersGenerateInvoiceResponse added in v0.5.0

type CustomerPortalOrdersGenerateInvoiceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
}

func (*CustomerPortalOrdersGenerateInvoiceResponse) GetAny added in v0.5.0

func (*CustomerPortalOrdersGenerateInvoiceResponse) GetHTTPMeta added in v0.5.0

type CustomerPortalOrdersGenerateInvoiceSecurity added in v0.5.0

type CustomerPortalOrdersGenerateInvoiceSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalOrdersGenerateInvoiceSecurity) GetCustomerSession added in v0.5.0

func (c *CustomerPortalOrdersGenerateInvoiceSecurity) GetCustomerSession() *string

func (*CustomerPortalOrdersGenerateInvoiceSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalOrdersGenerateInvoiceSecurity) GetMemberSession() *string

type CustomerPortalOrdersGetPaymentStatusRequest added in v0.8.2

type CustomerPortalOrdersGetPaymentStatusRequest struct {
	// The order ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalOrdersGetPaymentStatusRequest) GetID added in v0.8.2

type CustomerPortalOrdersGetPaymentStatusResponse added in v0.8.2

type CustomerPortalOrdersGetPaymentStatusResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerOrderPaymentStatus *components.CustomerOrderPaymentStatus
}

func (*CustomerPortalOrdersGetPaymentStatusResponse) GetCustomerOrderPaymentStatus added in v0.8.2

func (*CustomerPortalOrdersGetPaymentStatusResponse) GetHTTPMeta added in v0.8.2

type CustomerPortalOrdersGetPaymentStatusSecurity added in v0.8.2

type CustomerPortalOrdersGetPaymentStatusSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalOrdersGetPaymentStatusSecurity) GetCustomerSession added in v0.8.2

func (c *CustomerPortalOrdersGetPaymentStatusSecurity) GetCustomerSession() *string

func (*CustomerPortalOrdersGetPaymentStatusSecurity) GetMemberSession added in v0.13.0

type CustomerPortalOrdersGetRequest

type CustomerPortalOrdersGetRequest struct {
	// The order ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalOrdersGetRequest) GetID

type CustomerPortalOrdersGetResponse

type CustomerPortalOrdersGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerOrder *components.CustomerOrder
}

func (*CustomerPortalOrdersGetResponse) GetCustomerOrder

func (*CustomerPortalOrdersGetResponse) GetHTTPMeta

type CustomerPortalOrdersGetSecurity added in v0.4.0

type CustomerPortalOrdersGetSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalOrdersGetSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalOrdersGetSecurity) GetCustomerSession() *string

func (*CustomerPortalOrdersGetSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalOrdersGetSecurity) GetMemberSession() *string

type CustomerPortalOrdersInvoiceRequest

type CustomerPortalOrdersInvoiceRequest struct {
	// The order ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalOrdersInvoiceRequest) GetID

type CustomerPortalOrdersInvoiceResponse

type CustomerPortalOrdersInvoiceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerOrderInvoice *components.CustomerOrderInvoice
}

func (*CustomerPortalOrdersInvoiceResponse) GetCustomerOrderInvoice

func (*CustomerPortalOrdersInvoiceResponse) GetHTTPMeta

type CustomerPortalOrdersInvoiceSecurity added in v0.4.0

type CustomerPortalOrdersInvoiceSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalOrdersInvoiceSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalOrdersInvoiceSecurity) GetCustomerSession() *string

func (*CustomerPortalOrdersInvoiceSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalOrdersInvoiceSecurity) GetMemberSession() *string

type CustomerPortalOrdersListQueryParamProductBillingTypeFilter added in v0.4.2

type CustomerPortalOrdersListQueryParamProductBillingTypeFilter struct {
	ProductBillingType        *components.ProductBillingType  `queryParam:"inline" union:"member"`
	ArrayOfProductBillingType []components.ProductBillingType `queryParam:"inline" union:"member"`

	Type CustomerPortalOrdersListQueryParamProductBillingTypeFilterType
}

CustomerPortalOrdersListQueryParamProductBillingTypeFilter - Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.

func CreateCustomerPortalOrdersListQueryParamProductBillingTypeFilterArrayOfProductBillingType added in v0.4.2

func CreateCustomerPortalOrdersListQueryParamProductBillingTypeFilterArrayOfProductBillingType(arrayOfProductBillingType []components.ProductBillingType) CustomerPortalOrdersListQueryParamProductBillingTypeFilter

func CreateCustomerPortalOrdersListQueryParamProductBillingTypeFilterProductBillingType added in v0.4.2

func CreateCustomerPortalOrdersListQueryParamProductBillingTypeFilterProductBillingType(productBillingType components.ProductBillingType) CustomerPortalOrdersListQueryParamProductBillingTypeFilter

func (CustomerPortalOrdersListQueryParamProductBillingTypeFilter) MarshalJSON added in v0.4.2

func (*CustomerPortalOrdersListQueryParamProductBillingTypeFilter) UnmarshalJSON added in v0.4.2

type CustomerPortalOrdersListQueryParamProductBillingTypeFilterType added in v0.4.2

type CustomerPortalOrdersListQueryParamProductBillingTypeFilterType string
const (
	CustomerPortalOrdersListQueryParamProductBillingTypeFilterTypeProductBillingType        CustomerPortalOrdersListQueryParamProductBillingTypeFilterType = "ProductBillingType"
	CustomerPortalOrdersListQueryParamProductBillingTypeFilterTypeArrayOfProductBillingType CustomerPortalOrdersListQueryParamProductBillingTypeFilterType = "arrayOfProductBillingType"
)

type CustomerPortalOrdersListQueryParamProductIDFilter

type CustomerPortalOrdersListQueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerPortalOrdersListQueryParamProductIDFilterType
}

CustomerPortalOrdersListQueryParamProductIDFilter - Filter by product ID.

func CreateCustomerPortalOrdersListQueryParamProductIDFilterArrayOfStr

func CreateCustomerPortalOrdersListQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) CustomerPortalOrdersListQueryParamProductIDFilter

func CreateCustomerPortalOrdersListQueryParamProductIDFilterStr

func CreateCustomerPortalOrdersListQueryParamProductIDFilterStr(str string) CustomerPortalOrdersListQueryParamProductIDFilter

func (CustomerPortalOrdersListQueryParamProductIDFilter) MarshalJSON

func (*CustomerPortalOrdersListQueryParamProductIDFilter) UnmarshalJSON

type CustomerPortalOrdersListQueryParamProductIDFilterType

type CustomerPortalOrdersListQueryParamProductIDFilterType string
const (
	CustomerPortalOrdersListQueryParamProductIDFilterTypeStr        CustomerPortalOrdersListQueryParamProductIDFilterType = "str"
	CustomerPortalOrdersListQueryParamProductIDFilterTypeArrayOfStr CustomerPortalOrdersListQueryParamProductIDFilterType = "arrayOfStr"
)

type CustomerPortalOrdersListQueryParamSubscriptionIDFilter added in v0.1.5

type CustomerPortalOrdersListQueryParamSubscriptionIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerPortalOrdersListQueryParamSubscriptionIDFilterType
}

CustomerPortalOrdersListQueryParamSubscriptionIDFilter - Filter by subscription ID.

func CreateCustomerPortalOrdersListQueryParamSubscriptionIDFilterArrayOfStr added in v0.1.5

func CreateCustomerPortalOrdersListQueryParamSubscriptionIDFilterArrayOfStr(arrayOfStr []string) CustomerPortalOrdersListQueryParamSubscriptionIDFilter

func CreateCustomerPortalOrdersListQueryParamSubscriptionIDFilterStr added in v0.1.5

func CreateCustomerPortalOrdersListQueryParamSubscriptionIDFilterStr(str string) CustomerPortalOrdersListQueryParamSubscriptionIDFilter

func (CustomerPortalOrdersListQueryParamSubscriptionIDFilter) MarshalJSON added in v0.1.5

func (*CustomerPortalOrdersListQueryParamSubscriptionIDFilter) UnmarshalJSON added in v0.1.5

type CustomerPortalOrdersListQueryParamSubscriptionIDFilterType added in v0.1.5

type CustomerPortalOrdersListQueryParamSubscriptionIDFilterType string
const (
	CustomerPortalOrdersListQueryParamSubscriptionIDFilterTypeStr        CustomerPortalOrdersListQueryParamSubscriptionIDFilterType = "str"
	CustomerPortalOrdersListQueryParamSubscriptionIDFilterTypeArrayOfStr CustomerPortalOrdersListQueryParamSubscriptionIDFilterType = "arrayOfStr"
)

type CustomerPortalOrdersListRequest

type CustomerPortalOrdersListRequest struct {
	// Filter by product ID.
	ProductID *CustomerPortalOrdersListQueryParamProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
	// Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
	ProductBillingType *CustomerPortalOrdersListQueryParamProductBillingTypeFilter `queryParam:"style=form,explode=true,name=product_billing_type"`
	// Filter by subscription ID.
	SubscriptionID *CustomerPortalOrdersListQueryParamSubscriptionIDFilter `queryParam:"style=form,explode=true,name=subscription_id"`
	// Search by product or organization name.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomerOrderSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CustomerPortalOrdersListRequest) GetLimit

func (c *CustomerPortalOrdersListRequest) GetLimit() *int64

func (*CustomerPortalOrdersListRequest) GetPage

func (c *CustomerPortalOrdersListRequest) GetPage() *int64

func (*CustomerPortalOrdersListRequest) GetProductBillingType added in v0.4.2

func (*CustomerPortalOrdersListRequest) GetProductID

func (*CustomerPortalOrdersListRequest) GetQuery

func (c *CustomerPortalOrdersListRequest) GetQuery() *string

func (*CustomerPortalOrdersListRequest) GetSorting

func (*CustomerPortalOrdersListRequest) GetSubscriptionID

func (CustomerPortalOrdersListRequest) MarshalJSON

func (c CustomerPortalOrdersListRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalOrdersListRequest) UnmarshalJSON

func (c *CustomerPortalOrdersListRequest) UnmarshalJSON(data []byte) error

type CustomerPortalOrdersListResponse

type CustomerPortalOrdersListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerOrder *components.ListResourceCustomerOrder

	Next func() (*CustomerPortalOrdersListResponse, error)
}

func (*CustomerPortalOrdersListResponse) GetHTTPMeta

func (*CustomerPortalOrdersListResponse) GetListResourceCustomerOrder

func (c *CustomerPortalOrdersListResponse) GetListResourceCustomerOrder() *components.ListResourceCustomerOrder

type CustomerPortalOrdersListSecurity added in v0.4.0

type CustomerPortalOrdersListSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalOrdersListSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalOrdersListSecurity) GetCustomerSession() *string

func (*CustomerPortalOrdersListSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalOrdersListSecurity) GetMemberSession() *string

type CustomerPortalOrdersUpdateRequest added in v0.5.0

type CustomerPortalOrdersUpdateRequest struct {
	// The order ID.
	ID                  string                         `pathParam:"style=simple,explode=false,name=id"`
	CustomerOrderUpdate components.CustomerOrderUpdate `request:"mediaType=application/json"`
}

func (*CustomerPortalOrdersUpdateRequest) GetCustomerOrderUpdate added in v0.5.0

func (*CustomerPortalOrdersUpdateRequest) GetID added in v0.5.0

type CustomerPortalOrdersUpdateResponse added in v0.5.0

type CustomerPortalOrdersUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerOrder *components.CustomerOrder
}

func (*CustomerPortalOrdersUpdateResponse) GetCustomerOrder added in v0.5.0

func (*CustomerPortalOrdersUpdateResponse) GetHTTPMeta added in v0.5.0

type CustomerPortalOrdersUpdateSecurity added in v0.5.0

type CustomerPortalOrdersUpdateSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalOrdersUpdateSecurity) GetCustomerSession added in v0.5.0

func (c *CustomerPortalOrdersUpdateSecurity) GetCustomerSession() *string

func (*CustomerPortalOrdersUpdateSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalOrdersUpdateSecurity) GetMemberSession() *string

type CustomerPortalOrganizationsGetRequest

type CustomerPortalOrganizationsGetRequest struct {
	// The organization slug.
	Slug string `pathParam:"style=simple,explode=false,name=slug"`
}

func (*CustomerPortalOrganizationsGetRequest) GetSlug

type CustomerPortalOrganizationsGetResponse

type CustomerPortalOrganizationsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerOrganizationData *components.CustomerOrganizationData
}

func (*CustomerPortalOrganizationsGetResponse) GetCustomerOrganizationData added in v0.13.0

func (*CustomerPortalOrganizationsGetResponse) GetHTTPMeta

type CustomerPortalSeatsAssignSeatResponse added in v0.10.1

type CustomerPortalSeatsAssignSeatResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSeat *components.CustomerSeat
}

func (*CustomerPortalSeatsAssignSeatResponse) GetCustomerSeat added in v0.10.1

func (*CustomerPortalSeatsAssignSeatResponse) GetHTTPMeta added in v0.10.1

type CustomerPortalSeatsAssignSeatSecurity added in v0.10.1

type CustomerPortalSeatsAssignSeatSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSeatsAssignSeatSecurity) GetCustomerSession added in v0.10.1

func (c *CustomerPortalSeatsAssignSeatSecurity) GetCustomerSession() *string

func (*CustomerPortalSeatsAssignSeatSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSeatsAssignSeatSecurity) GetMemberSession() *string

type CustomerPortalSeatsListClaimedSubscriptionsRequest added in v0.13.0

type CustomerPortalSeatsListClaimedSubscriptionsRequest struct {
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*CustomerPortalSeatsListClaimedSubscriptionsRequest) GetLimit added in v0.13.0

func (*CustomerPortalSeatsListClaimedSubscriptionsRequest) GetPage added in v0.13.0

func (CustomerPortalSeatsListClaimedSubscriptionsRequest) MarshalJSON added in v0.13.0

func (*CustomerPortalSeatsListClaimedSubscriptionsRequest) UnmarshalJSON added in v0.13.0

type CustomerPortalSeatsListClaimedSubscriptionsResponse added in v0.10.1

type CustomerPortalSeatsListClaimedSubscriptionsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerSubscription *components.ListResourceCustomerSubscription

	Next func() (*CustomerPortalSeatsListClaimedSubscriptionsResponse, error)
}

func (*CustomerPortalSeatsListClaimedSubscriptionsResponse) GetHTTPMeta added in v0.10.1

func (*CustomerPortalSeatsListClaimedSubscriptionsResponse) GetListResourceCustomerSubscription added in v0.13.0

type CustomerPortalSeatsListClaimedSubscriptionsSecurity added in v0.10.1

type CustomerPortalSeatsListClaimedSubscriptionsSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSeatsListClaimedSubscriptionsSecurity) GetCustomerSession added in v0.10.1

func (*CustomerPortalSeatsListClaimedSubscriptionsSecurity) GetMemberSession added in v0.13.0

type CustomerPortalSeatsListSeatsRequest added in v0.10.1

type CustomerPortalSeatsListSeatsRequest struct {
	// Subscription ID
	SubscriptionID *string `queryParam:"style=form,explode=true,name=subscription_id"`
	// Order ID
	OrderID *string `queryParam:"style=form,explode=true,name=order_id"`
}

func (*CustomerPortalSeatsListSeatsRequest) GetOrderID added in v0.12.0

func (*CustomerPortalSeatsListSeatsRequest) GetSubscriptionID added in v0.10.1

func (c *CustomerPortalSeatsListSeatsRequest) GetSubscriptionID() *string

type CustomerPortalSeatsListSeatsResponse added in v0.10.1

type CustomerPortalSeatsListSeatsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	SeatsList *components.SeatsList
}

func (*CustomerPortalSeatsListSeatsResponse) GetHTTPMeta added in v0.10.1

func (*CustomerPortalSeatsListSeatsResponse) GetSeatsList added in v0.10.1

type CustomerPortalSeatsListSeatsSecurity added in v0.10.1

type CustomerPortalSeatsListSeatsSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSeatsListSeatsSecurity) GetCustomerSession added in v0.10.1

func (c *CustomerPortalSeatsListSeatsSecurity) GetCustomerSession() *string

func (*CustomerPortalSeatsListSeatsSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSeatsListSeatsSecurity) GetMemberSession() *string

type CustomerPortalSeatsResendInvitationRequest added in v0.10.1

type CustomerPortalSeatsResendInvitationRequest struct {
	SeatID string `pathParam:"style=simple,explode=false,name=seat_id"`
}

func (*CustomerPortalSeatsResendInvitationRequest) GetSeatID added in v0.10.1

type CustomerPortalSeatsResendInvitationResponse added in v0.10.1

type CustomerPortalSeatsResendInvitationResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSeat *components.CustomerSeat
}

func (*CustomerPortalSeatsResendInvitationResponse) GetCustomerSeat added in v0.10.1

func (*CustomerPortalSeatsResendInvitationResponse) GetHTTPMeta added in v0.10.1

type CustomerPortalSeatsResendInvitationSecurity added in v0.10.1

type CustomerPortalSeatsResendInvitationSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSeatsResendInvitationSecurity) GetCustomerSession added in v0.10.1

func (c *CustomerPortalSeatsResendInvitationSecurity) GetCustomerSession() *string

func (*CustomerPortalSeatsResendInvitationSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSeatsResendInvitationSecurity) GetMemberSession() *string

type CustomerPortalSeatsRevokeSeatRequest added in v0.10.1

type CustomerPortalSeatsRevokeSeatRequest struct {
	SeatID string `pathParam:"style=simple,explode=false,name=seat_id"`
}

func (*CustomerPortalSeatsRevokeSeatRequest) GetSeatID added in v0.10.1

type CustomerPortalSeatsRevokeSeatResponse added in v0.10.1

type CustomerPortalSeatsRevokeSeatResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSeat *components.CustomerSeat
}

func (*CustomerPortalSeatsRevokeSeatResponse) GetCustomerSeat added in v0.10.1

func (*CustomerPortalSeatsRevokeSeatResponse) GetHTTPMeta added in v0.10.1

type CustomerPortalSeatsRevokeSeatSecurity added in v0.10.1

type CustomerPortalSeatsRevokeSeatSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSeatsRevokeSeatSecurity) GetCustomerSession added in v0.10.1

func (c *CustomerPortalSeatsRevokeSeatSecurity) GetCustomerSession() *string

func (*CustomerPortalSeatsRevokeSeatSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSeatsRevokeSeatSecurity) GetMemberSession() *string

type CustomerPortalSubscriptionsCancelRequest

type CustomerPortalSubscriptionsCancelRequest struct {
	// The subscription ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalSubscriptionsCancelRequest) GetID

type CustomerPortalSubscriptionsCancelResponse

type CustomerPortalSubscriptionsCancelResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Customer subscription is canceled.
	CustomerSubscription *components.CustomerSubscription
}

func (*CustomerPortalSubscriptionsCancelResponse) GetCustomerSubscription

func (*CustomerPortalSubscriptionsCancelResponse) GetHTTPMeta

type CustomerPortalSubscriptionsCancelSecurity added in v0.4.0

type CustomerPortalSubscriptionsCancelSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSubscriptionsCancelSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalSubscriptionsCancelSecurity) GetCustomerSession() *string

func (*CustomerPortalSubscriptionsCancelSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSubscriptionsCancelSecurity) GetMemberSession() *string

type CustomerPortalSubscriptionsGetRequest

type CustomerPortalSubscriptionsGetRequest struct {
	// The subscription ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalSubscriptionsGetRequest) GetID

type CustomerPortalSubscriptionsGetResponse

type CustomerPortalSubscriptionsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSubscription *components.CustomerSubscription
}

func (*CustomerPortalSubscriptionsGetResponse) GetCustomerSubscription

func (*CustomerPortalSubscriptionsGetResponse) GetHTTPMeta

type CustomerPortalSubscriptionsGetSecurity added in v0.4.0

type CustomerPortalSubscriptionsGetSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSubscriptionsGetSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalSubscriptionsGetSecurity) GetCustomerSession() *string

func (*CustomerPortalSubscriptionsGetSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSubscriptionsGetSecurity) GetMemberSession() *string

type CustomerPortalSubscriptionsListQueryParamProductIDFilter

type CustomerPortalSubscriptionsListQueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomerPortalSubscriptionsListQueryParamProductIDFilterType
}

CustomerPortalSubscriptionsListQueryParamProductIDFilter - Filter by product ID.

func CreateCustomerPortalSubscriptionsListQueryParamProductIDFilterArrayOfStr

func CreateCustomerPortalSubscriptionsListQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) CustomerPortalSubscriptionsListQueryParamProductIDFilter

func CreateCustomerPortalSubscriptionsListQueryParamProductIDFilterStr

func CreateCustomerPortalSubscriptionsListQueryParamProductIDFilterStr(str string) CustomerPortalSubscriptionsListQueryParamProductIDFilter

func (CustomerPortalSubscriptionsListQueryParamProductIDFilter) MarshalJSON

func (*CustomerPortalSubscriptionsListQueryParamProductIDFilter) UnmarshalJSON

type CustomerPortalSubscriptionsListQueryParamProductIDFilterType

type CustomerPortalSubscriptionsListQueryParamProductIDFilterType string
const (
	CustomerPortalSubscriptionsListQueryParamProductIDFilterTypeStr        CustomerPortalSubscriptionsListQueryParamProductIDFilterType = "str"
	CustomerPortalSubscriptionsListQueryParamProductIDFilterTypeArrayOfStr CustomerPortalSubscriptionsListQueryParamProductIDFilterType = "arrayOfStr"
)

type CustomerPortalSubscriptionsListRequest

type CustomerPortalSubscriptionsListRequest struct {
	// Filter by product ID.
	ProductID *CustomerPortalSubscriptionsListQueryParamProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
	// Filter by active or cancelled subscription.
	Active *bool `queryParam:"style=form,explode=true,name=active"`
	// Search by product or organization name.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomerSubscriptionSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CustomerPortalSubscriptionsListRequest) GetActive

func (*CustomerPortalSubscriptionsListRequest) GetLimit

func (*CustomerPortalSubscriptionsListRequest) GetPage

func (*CustomerPortalSubscriptionsListRequest) GetProductID

func (*CustomerPortalSubscriptionsListRequest) GetQuery

func (*CustomerPortalSubscriptionsListRequest) GetSorting

func (CustomerPortalSubscriptionsListRequest) MarshalJSON

func (c CustomerPortalSubscriptionsListRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalSubscriptionsListRequest) UnmarshalJSON

func (c *CustomerPortalSubscriptionsListRequest) UnmarshalJSON(data []byte) error

type CustomerPortalSubscriptionsListResponse

type CustomerPortalSubscriptionsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerSubscription *components.ListResourceCustomerSubscription

	Next func() (*CustomerPortalSubscriptionsListResponse, error)
}

func (*CustomerPortalSubscriptionsListResponse) GetHTTPMeta

func (*CustomerPortalSubscriptionsListResponse) GetListResourceCustomerSubscription

type CustomerPortalSubscriptionsListSecurity added in v0.4.0

type CustomerPortalSubscriptionsListSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSubscriptionsListSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalSubscriptionsListSecurity) GetCustomerSession() *string

func (*CustomerPortalSubscriptionsListSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSubscriptionsListSecurity) GetMemberSession() *string

type CustomerPortalSubscriptionsUpdateRequest

type CustomerPortalSubscriptionsUpdateRequest struct {
	// The subscription ID.
	ID                         string                                `pathParam:"style=simple,explode=false,name=id"`
	CustomerSubscriptionUpdate components.CustomerSubscriptionUpdate `request:"mediaType=application/json"`
}

func (*CustomerPortalSubscriptionsUpdateRequest) GetCustomerSubscriptionUpdate

func (*CustomerPortalSubscriptionsUpdateRequest) GetID

type CustomerPortalSubscriptionsUpdateResponse

type CustomerPortalSubscriptionsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Customer subscription updated.
	CustomerSubscription *components.CustomerSubscription
}

func (*CustomerPortalSubscriptionsUpdateResponse) GetCustomerSubscription

func (*CustomerPortalSubscriptionsUpdateResponse) GetHTTPMeta

type CustomerPortalSubscriptionsUpdateSecurity added in v0.4.0

type CustomerPortalSubscriptionsUpdateSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalSubscriptionsUpdateSecurity) GetCustomerSession added in v0.4.0

func (c *CustomerPortalSubscriptionsUpdateSecurity) GetCustomerSession() *string

func (*CustomerPortalSubscriptionsUpdateSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalSubscriptionsUpdateSecurity) GetMemberSession() *string

type CustomerPortalWalletsGetRequest added in v0.12.0

type CustomerPortalWalletsGetRequest struct {
	// The wallet ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomerPortalWalletsGetRequest) GetID added in v0.12.0

type CustomerPortalWalletsGetResponse added in v0.12.0

type CustomerPortalWalletsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerWallet *components.CustomerWallet
}

func (*CustomerPortalWalletsGetResponse) GetCustomerWallet added in v0.12.0

func (*CustomerPortalWalletsGetResponse) GetHTTPMeta added in v0.12.0

type CustomerPortalWalletsGetSecurity added in v0.12.0

type CustomerPortalWalletsGetSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalWalletsGetSecurity) GetCustomerSession added in v0.12.0

func (c *CustomerPortalWalletsGetSecurity) GetCustomerSession() *string

func (*CustomerPortalWalletsGetSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalWalletsGetSecurity) GetMemberSession() *string

type CustomerPortalWalletsListRequest added in v0.12.0

type CustomerPortalWalletsListRequest struct {
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomerWalletSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*CustomerPortalWalletsListRequest) GetLimit added in v0.12.0

func (c *CustomerPortalWalletsListRequest) GetLimit() *int64

func (*CustomerPortalWalletsListRequest) GetPage added in v0.12.0

func (*CustomerPortalWalletsListRequest) GetSorting added in v0.12.0

func (CustomerPortalWalletsListRequest) MarshalJSON added in v0.12.0

func (c CustomerPortalWalletsListRequest) MarshalJSON() ([]byte, error)

func (*CustomerPortalWalletsListRequest) UnmarshalJSON added in v0.12.0

func (c *CustomerPortalWalletsListRequest) UnmarshalJSON(data []byte) error

type CustomerPortalWalletsListResponse added in v0.12.0

type CustomerPortalWalletsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomerWallet *components.ListResourceCustomerWallet

	Next func() (*CustomerPortalWalletsListResponse, error)
}

func (*CustomerPortalWalletsListResponse) GetHTTPMeta added in v0.12.0

func (*CustomerPortalWalletsListResponse) GetListResourceCustomerWallet added in v0.12.0

func (c *CustomerPortalWalletsListResponse) GetListResourceCustomerWallet() *components.ListResourceCustomerWallet

type CustomerPortalWalletsListSecurity added in v0.12.0

type CustomerPortalWalletsListSecurity struct {
	CustomerSession *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_customer_session"`
	MemberSession   *string `security:"scheme,type=http,subtype=bearer,name=Authorization,env=polar_member_session"`
}

func (*CustomerPortalWalletsListSecurity) GetCustomerSession added in v0.12.0

func (c *CustomerPortalWalletsListSecurity) GetCustomerSession() *string

func (*CustomerPortalWalletsListSecurity) GetMemberSession added in v0.13.0

func (c *CustomerPortalWalletsListSecurity) GetMemberSession() *string

type CustomerSeatsAssignSeatResponse added in v0.12.0

type CustomerSeatsAssignSeatResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSeat *components.CustomerSeat
}

func (*CustomerSeatsAssignSeatResponse) GetCustomerSeat added in v0.12.0

func (*CustomerSeatsAssignSeatResponse) GetHTTPMeta added in v0.12.0

type CustomerSeatsClaimSeatResponse added in v0.12.0

type CustomerSeatsClaimSeatResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSeatClaimResponse *components.CustomerSeatClaimResponse
}

func (*CustomerSeatsClaimSeatResponse) GetCustomerSeatClaimResponse added in v0.12.0

func (c *CustomerSeatsClaimSeatResponse) GetCustomerSeatClaimResponse() *components.CustomerSeatClaimResponse

func (*CustomerSeatsClaimSeatResponse) GetHTTPMeta added in v0.12.0

type CustomerSeatsGetClaimInfoRequest added in v0.12.0

type CustomerSeatsGetClaimInfoRequest struct {
	InvitationToken string `pathParam:"style=simple,explode=false,name=invitation_token"`
}

func (*CustomerSeatsGetClaimInfoRequest) GetInvitationToken added in v0.12.0

func (c *CustomerSeatsGetClaimInfoRequest) GetInvitationToken() string

type CustomerSeatsGetClaimInfoResponse added in v0.12.0

type CustomerSeatsGetClaimInfoResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	SeatClaimInfo *components.SeatClaimInfo
}

func (*CustomerSeatsGetClaimInfoResponse) GetHTTPMeta added in v0.12.0

func (*CustomerSeatsGetClaimInfoResponse) GetSeatClaimInfo added in v0.12.0

type CustomerSeatsListSeatsRequest added in v0.12.0

type CustomerSeatsListSeatsRequest struct {
	SubscriptionID *string `queryParam:"style=form,explode=true,name=subscription_id"`
	OrderID        *string `queryParam:"style=form,explode=true,name=order_id"`
}

func (*CustomerSeatsListSeatsRequest) GetOrderID added in v0.12.0

func (c *CustomerSeatsListSeatsRequest) GetOrderID() *string

func (*CustomerSeatsListSeatsRequest) GetSubscriptionID added in v0.12.0

func (c *CustomerSeatsListSeatsRequest) GetSubscriptionID() *string

type CustomerSeatsListSeatsResponse added in v0.12.0

type CustomerSeatsListSeatsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	SeatsList *components.SeatsList
}

func (*CustomerSeatsListSeatsResponse) GetHTTPMeta added in v0.12.0

func (*CustomerSeatsListSeatsResponse) GetSeatsList added in v0.12.0

type CustomerSeatsResendInvitationRequest added in v0.12.0

type CustomerSeatsResendInvitationRequest struct {
	SeatID string `pathParam:"style=simple,explode=false,name=seat_id"`
}

func (*CustomerSeatsResendInvitationRequest) GetSeatID added in v0.12.0

type CustomerSeatsResendInvitationResponse added in v0.12.0

type CustomerSeatsResendInvitationResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSeat *components.CustomerSeat
}

func (*CustomerSeatsResendInvitationResponse) GetCustomerSeat added in v0.12.0

func (*CustomerSeatsResendInvitationResponse) GetHTTPMeta added in v0.12.0

type CustomerSeatsRevokeSeatRequest added in v0.12.0

type CustomerSeatsRevokeSeatRequest struct {
	SeatID string `pathParam:"style=simple,explode=false,name=seat_id"`
}

func (*CustomerSeatsRevokeSeatRequest) GetSeatID added in v0.12.0

func (c *CustomerSeatsRevokeSeatRequest) GetSeatID() string

type CustomerSeatsRevokeSeatResponse added in v0.12.0

type CustomerSeatsRevokeSeatResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerSeat *components.CustomerSeat
}

func (*CustomerSeatsRevokeSeatResponse) GetCustomerSeat added in v0.12.0

func (*CustomerSeatsRevokeSeatResponse) GetHTTPMeta added in v0.12.0

type CustomerSessionsCreateCustomerSessionCreate added in v0.4.1

type CustomerSessionsCreateCustomerSessionCreate struct {
	CustomerSessionCustomerIDCreate         *components.CustomerSessionCustomerIDCreate         `queryParam:"inline" union:"member"`
	CustomerSessionCustomerExternalIDCreate *components.CustomerSessionCustomerExternalIDCreate `queryParam:"inline" union:"member"`

	Type CustomerSessionsCreateCustomerSessionCreateType
}

func CreateCustomerSessionsCreateCustomerSessionCreateCustomerSessionCustomerExternalIDCreate added in v0.4.1

func CreateCustomerSessionsCreateCustomerSessionCreateCustomerSessionCustomerExternalIDCreate(customerSessionCustomerExternalIDCreate components.CustomerSessionCustomerExternalIDCreate) CustomerSessionsCreateCustomerSessionCreate

func CreateCustomerSessionsCreateCustomerSessionCreateCustomerSessionCustomerIDCreate added in v0.4.1

func CreateCustomerSessionsCreateCustomerSessionCreateCustomerSessionCustomerIDCreate(customerSessionCustomerIDCreate components.CustomerSessionCustomerIDCreate) CustomerSessionsCreateCustomerSessionCreate

func (CustomerSessionsCreateCustomerSessionCreate) MarshalJSON added in v0.4.1

func (*CustomerSessionsCreateCustomerSessionCreate) UnmarshalJSON added in v0.4.1

func (u *CustomerSessionsCreateCustomerSessionCreate) UnmarshalJSON(data []byte) error

type CustomerSessionsCreateCustomerSessionCreateType added in v0.4.1

type CustomerSessionsCreateCustomerSessionCreateType string
const (
	CustomerSessionsCreateCustomerSessionCreateTypeCustomerSessionCustomerIDCreate         CustomerSessionsCreateCustomerSessionCreateType = "CustomerSessionCustomerIDCreate"
	CustomerSessionsCreateCustomerSessionCreateTypeCustomerSessionCustomerExternalIDCreate CustomerSessionsCreateCustomerSessionCreateType = "CustomerSessionCustomerExternalIDCreate"
)

type CustomerSessionsCreateResponse

type CustomerSessionsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Customer session created.
	CustomerSession *components.CustomerSession
}

func (*CustomerSessionsCreateResponse) GetCustomerSession

func (*CustomerSessionsCreateResponse) GetHTTPMeta

type CustomersCreateResponse

type CustomersCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Customer created.
	Customer *components.Customer
}

func (*CustomersCreateResponse) GetCustomer

func (c *CustomersCreateResponse) GetCustomer() *components.Customer

func (*CustomersCreateResponse) GetCustomerIndividual added in v0.16.0

func (c *CustomersCreateResponse) GetCustomerIndividual() *components.CustomerIndividual

func (*CustomersCreateResponse) GetCustomerTeam added in v0.16.0

func (c *CustomersCreateResponse) GetCustomerTeam() *components.CustomerTeam

func (*CustomersCreateResponse) GetHTTPMeta

type CustomersDeleteExternalRequest added in v0.4.1

type CustomersDeleteExternalRequest struct {
	// The customer external ID.
	ExternalID string `pathParam:"style=simple,explode=false,name=external_id"`
	// If true, also anonymize the customer's personal data for GDPR compliance.
	Anonymize *bool `default:"false" queryParam:"style=form,explode=true,name=anonymize"`
}

func (*CustomersDeleteExternalRequest) GetAnonymize added in v0.13.0

func (c *CustomersDeleteExternalRequest) GetAnonymize() *bool

func (*CustomersDeleteExternalRequest) GetExternalID added in v0.4.1

func (c *CustomersDeleteExternalRequest) GetExternalID() string

func (CustomersDeleteExternalRequest) MarshalJSON added in v0.13.0

func (c CustomersDeleteExternalRequest) MarshalJSON() ([]byte, error)

func (*CustomersDeleteExternalRequest) UnmarshalJSON added in v0.13.0

func (c *CustomersDeleteExternalRequest) UnmarshalJSON(data []byte) error

type CustomersDeleteExternalResponse added in v0.4.1

type CustomersDeleteExternalResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*CustomersDeleteExternalResponse) GetHTTPMeta added in v0.4.1

type CustomersDeleteRequest

type CustomersDeleteRequest struct {
	// The customer ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// If true, also anonymize the customer's personal data for GDPR compliance. This replaces email with a hashed version, hashes name and billing name (name preserved for businesses with tax_id), clears billing address, and removes OAuth account data.
	Anonymize *bool `default:"false" queryParam:"style=form,explode=true,name=anonymize"`
}

func (*CustomersDeleteRequest) GetAnonymize added in v0.13.0

func (c *CustomersDeleteRequest) GetAnonymize() *bool

func (*CustomersDeleteRequest) GetID

func (c *CustomersDeleteRequest) GetID() string

func (CustomersDeleteRequest) MarshalJSON added in v0.13.0

func (c CustomersDeleteRequest) MarshalJSON() ([]byte, error)

func (*CustomersDeleteRequest) UnmarshalJSON added in v0.13.0

func (c *CustomersDeleteRequest) UnmarshalJSON(data []byte) error

type CustomersDeleteResponse

type CustomersDeleteResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*CustomersDeleteResponse) GetHTTPMeta

type CustomersExportQueryParamOrganizationID added in v0.9.0

type CustomersExportQueryParamOrganizationID struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomersExportQueryParamOrganizationIDType
}

CustomersExportQueryParamOrganizationID - Filter by organization ID.

func CreateCustomersExportQueryParamOrganizationIDArrayOfStr added in v0.9.0

func CreateCustomersExportQueryParamOrganizationIDArrayOfStr(arrayOfStr []string) CustomersExportQueryParamOrganizationID

func CreateCustomersExportQueryParamOrganizationIDStr added in v0.9.0

func CreateCustomersExportQueryParamOrganizationIDStr(str string) CustomersExportQueryParamOrganizationID

func (CustomersExportQueryParamOrganizationID) MarshalJSON added in v0.9.0

func (u CustomersExportQueryParamOrganizationID) MarshalJSON() ([]byte, error)

func (*CustomersExportQueryParamOrganizationID) UnmarshalJSON added in v0.9.0

func (u *CustomersExportQueryParamOrganizationID) UnmarshalJSON(data []byte) error

type CustomersExportQueryParamOrganizationIDType added in v0.9.0

type CustomersExportQueryParamOrganizationIDType string
const (
	CustomersExportQueryParamOrganizationIDTypeStr        CustomersExportQueryParamOrganizationIDType = "str"
	CustomersExportQueryParamOrganizationIDTypeArrayOfStr CustomersExportQueryParamOrganizationIDType = "arrayOfStr"
)

type CustomersExportRequest added in v0.9.0

type CustomersExportRequest struct {
	// Filter by organization ID.
	OrganizationID *CustomersExportQueryParamOrganizationID `queryParam:"style=form,explode=true,name=organization_id"`
}

func (*CustomersExportRequest) GetOrganizationID added in v0.9.0

type CustomersExportResponse added in v0.9.0

type CustomersExportResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
	// Successful Response
	Res *string
}

func (*CustomersExportResponse) GetAny added in v0.9.0

func (c *CustomersExportResponse) GetAny() any

func (*CustomersExportResponse) GetHTTPMeta added in v0.9.0

func (*CustomersExportResponse) GetRes added in v0.13.0

func (c *CustomersExportResponse) GetRes() *string

type CustomersGetExternalRequest added in v0.4.1

type CustomersGetExternalRequest struct {
	// The customer external ID.
	ExternalID string `pathParam:"style=simple,explode=false,name=external_id"`
}

func (*CustomersGetExternalRequest) GetExternalID added in v0.4.1

func (c *CustomersGetExternalRequest) GetExternalID() string

type CustomersGetExternalResponse added in v0.4.1

type CustomersGetExternalResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Customer *components.Customer
}

func (*CustomersGetExternalResponse) GetCustomer added in v0.4.1

func (*CustomersGetExternalResponse) GetCustomerIndividual added in v0.16.0

func (c *CustomersGetExternalResponse) GetCustomerIndividual() *components.CustomerIndividual

func (*CustomersGetExternalResponse) GetCustomerTeam added in v0.16.0

func (*CustomersGetExternalResponse) GetHTTPMeta added in v0.4.1

type CustomersGetRequest

type CustomersGetRequest struct {
	// The customer ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomersGetRequest) GetID

func (c *CustomersGetRequest) GetID() string

type CustomersGetResponse

type CustomersGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Customer *components.Customer
}

func (*CustomersGetResponse) GetCustomer

func (c *CustomersGetResponse) GetCustomer() *components.Customer

func (*CustomersGetResponse) GetCustomerIndividual added in v0.16.0

func (c *CustomersGetResponse) GetCustomerIndividual() *components.CustomerIndividual

func (*CustomersGetResponse) GetCustomerTeam added in v0.16.0

func (c *CustomersGetResponse) GetCustomerTeam() *components.CustomerTeam

func (*CustomersGetResponse) GetHTTPMeta

func (c *CustomersGetResponse) GetHTTPMeta() components.HTTPMetadata

type CustomersGetStateExternalRequest added in v0.4.3

type CustomersGetStateExternalRequest struct {
	// The customer external ID.
	ExternalID string `pathParam:"style=simple,explode=false,name=external_id"`
}

func (*CustomersGetStateExternalRequest) GetExternalID added in v0.4.3

func (c *CustomersGetStateExternalRequest) GetExternalID() string

type CustomersGetStateExternalResponse added in v0.4.3

type CustomersGetStateExternalResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerState *components.CustomerState
}

func (*CustomersGetStateExternalResponse) GetCustomerState added in v0.4.3

func (*CustomersGetStateExternalResponse) GetCustomerStateIndividual added in v0.16.0

func (c *CustomersGetStateExternalResponse) GetCustomerStateIndividual() *components.CustomerStateIndividual

func (*CustomersGetStateExternalResponse) GetCustomerStateTeam added in v0.16.0

func (*CustomersGetStateExternalResponse) GetHTTPMeta added in v0.4.3

type CustomersGetStateRequest added in v0.4.3

type CustomersGetStateRequest struct {
	// The customer ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*CustomersGetStateRequest) GetID added in v0.4.3

func (c *CustomersGetStateRequest) GetID() string

type CustomersGetStateResponse added in v0.4.3

type CustomersGetStateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	CustomerState *components.CustomerState
}

func (*CustomersGetStateResponse) GetCustomerState added in v0.4.3

func (c *CustomersGetStateResponse) GetCustomerState() *components.CustomerState

func (*CustomersGetStateResponse) GetCustomerStateIndividual added in v0.16.0

func (c *CustomersGetStateResponse) GetCustomerStateIndividual() *components.CustomerStateIndividual

func (*CustomersGetStateResponse) GetCustomerStateTeam added in v0.16.0

func (c *CustomersGetStateResponse) GetCustomerStateTeam() *components.CustomerStateTeam

func (*CustomersGetStateResponse) GetHTTPMeta added in v0.4.3

type CustomersListQueryParamOrganizationIDFilter

type CustomersListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type CustomersListQueryParamOrganizationIDFilterType
}

CustomersListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateCustomersListQueryParamOrganizationIDFilterArrayOfStr

func CreateCustomersListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) CustomersListQueryParamOrganizationIDFilter

func CreateCustomersListQueryParamOrganizationIDFilterStr

func CreateCustomersListQueryParamOrganizationIDFilterStr(str string) CustomersListQueryParamOrganizationIDFilter

func (CustomersListQueryParamOrganizationIDFilter) MarshalJSON

func (*CustomersListQueryParamOrganizationIDFilter) UnmarshalJSON

func (u *CustomersListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type CustomersListQueryParamOrganizationIDFilterType

type CustomersListQueryParamOrganizationIDFilterType string
const (
	CustomersListQueryParamOrganizationIDFilterTypeStr        CustomersListQueryParamOrganizationIDFilterType = "str"
	CustomersListQueryParamOrganizationIDFilterTypeArrayOfStr CustomersListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type CustomersListRequest

type CustomersListRequest struct {
	// Filter by organization ID.
	OrganizationID *CustomersListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by exact email.
	Email *string `queryParam:"style=form,explode=true,name=email"`
	// Filter by name, email, or external ID.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.CustomerSortProperty `queryParam:"style=form,explode=true,name=sorting"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*CustomersListRequest) GetEmail added in v0.1.4

func (c *CustomersListRequest) GetEmail() *string

func (*CustomersListRequest) GetLimit

func (c *CustomersListRequest) GetLimit() *int64

func (*CustomersListRequest) GetMetadata added in v0.1.4

func (c *CustomersListRequest) GetMetadata() map[string]components.MetadataQuery

func (*CustomersListRequest) GetOrganizationID

func (*CustomersListRequest) GetPage

func (c *CustomersListRequest) GetPage() *int64

func (*CustomersListRequest) GetQuery

func (c *CustomersListRequest) GetQuery() *string

func (*CustomersListRequest) GetSorting

func (CustomersListRequest) MarshalJSON

func (c CustomersListRequest) MarshalJSON() ([]byte, error)

func (*CustomersListRequest) UnmarshalJSON

func (c *CustomersListRequest) UnmarshalJSON(data []byte) error

type CustomersListResponse

type CustomersListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceCustomer *components.ListResourceCustomer

	Next func() (*CustomersListResponse, error)
}

func (*CustomersListResponse) GetHTTPMeta

func (*CustomersListResponse) GetListResourceCustomer

func (c *CustomersListResponse) GetListResourceCustomer() *components.ListResourceCustomer

type CustomersUpdateExternalRequest added in v0.4.1

type CustomersUpdateExternalRequest struct {
	// The customer external ID.
	ExternalID               string                              `pathParam:"style=simple,explode=false,name=external_id"`
	CustomerUpdateExternalID components.CustomerUpdateExternalID `request:"mediaType=application/json"`
}

func (*CustomersUpdateExternalRequest) GetCustomerUpdateExternalID added in v0.4.16

func (c *CustomersUpdateExternalRequest) GetCustomerUpdateExternalID() components.CustomerUpdateExternalID

func (*CustomersUpdateExternalRequest) GetExternalID added in v0.4.1

func (c *CustomersUpdateExternalRequest) GetExternalID() string

type CustomersUpdateExternalResponse added in v0.4.1

type CustomersUpdateExternalResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Customer updated.
	Customer *components.Customer
}

func (*CustomersUpdateExternalResponse) GetCustomer added in v0.4.1

func (*CustomersUpdateExternalResponse) GetCustomerIndividual added in v0.16.0

func (*CustomersUpdateExternalResponse) GetCustomerTeam added in v0.16.0

func (*CustomersUpdateExternalResponse) GetHTTPMeta added in v0.4.1

type CustomersUpdateRequest

type CustomersUpdateRequest struct {
	// The customer ID.
	ID             string                    `pathParam:"style=simple,explode=false,name=id"`
	CustomerUpdate components.CustomerUpdate `request:"mediaType=application/json"`
}

func (*CustomersUpdateRequest) GetCustomerUpdate

func (c *CustomersUpdateRequest) GetCustomerUpdate() components.CustomerUpdate

func (*CustomersUpdateRequest) GetID

func (c *CustomersUpdateRequest) GetID() string

type CustomersUpdateResponse

type CustomersUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Customer updated.
	Customer *components.Customer
}

func (*CustomersUpdateResponse) GetCustomer

func (c *CustomersUpdateResponse) GetCustomer() *components.Customer

func (*CustomersUpdateResponse) GetCustomerIndividual added in v0.16.0

func (c *CustomersUpdateResponse) GetCustomerIndividual() *components.CustomerIndividual

func (*CustomersUpdateResponse) GetCustomerTeam added in v0.16.0

func (c *CustomersUpdateResponse) GetCustomerTeam() *components.CustomerTeam

func (*CustomersUpdateResponse) GetHTTPMeta

type DiscountIDFilter

type DiscountIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type DiscountIDFilterType
}

DiscountIDFilter - Filter by discount ID.

func CreateDiscountIDFilterArrayOfStr

func CreateDiscountIDFilterArrayOfStr(arrayOfStr []string) DiscountIDFilter

func CreateDiscountIDFilterStr

func CreateDiscountIDFilterStr(str string) DiscountIDFilter

func (DiscountIDFilter) MarshalJSON

func (u DiscountIDFilter) MarshalJSON() ([]byte, error)

func (*DiscountIDFilter) UnmarshalJSON

func (u *DiscountIDFilter) UnmarshalJSON(data []byte) error

type DiscountIDFilterType

type DiscountIDFilterType string
const (
	DiscountIDFilterTypeStr        DiscountIDFilterType = "str"
	DiscountIDFilterTypeArrayOfStr DiscountIDFilterType = "arrayOfStr"
)

type DiscountsCreateResponse

type DiscountsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Discount created.
	Discount *components.Discount
}

func (*DiscountsCreateResponse) GetDiscount

func (d *DiscountsCreateResponse) GetDiscount() *components.Discount

func (*DiscountsCreateResponse) GetHTTPMeta

type DiscountsDeleteRequest

type DiscountsDeleteRequest struct {
	// The discount ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*DiscountsDeleteRequest) GetID

func (d *DiscountsDeleteRequest) GetID() string

type DiscountsDeleteResponse

type DiscountsDeleteResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*DiscountsDeleteResponse) GetHTTPMeta

type DiscountsGetRequest

type DiscountsGetRequest struct {
	// The discount ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*DiscountsGetRequest) GetID

func (d *DiscountsGetRequest) GetID() string

type DiscountsGetResponse

type DiscountsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Discount *components.Discount
}

func (*DiscountsGetResponse) GetDiscount

func (d *DiscountsGetResponse) GetDiscount() *components.Discount

func (*DiscountsGetResponse) GetHTTPMeta

func (d *DiscountsGetResponse) GetHTTPMeta() components.HTTPMetadata

type DiscountsListQueryParamOrganizationIDFilter

type DiscountsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type DiscountsListQueryParamOrganizationIDFilterType
}

DiscountsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateDiscountsListQueryParamOrganizationIDFilterArrayOfStr

func CreateDiscountsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) DiscountsListQueryParamOrganizationIDFilter

func CreateDiscountsListQueryParamOrganizationIDFilterStr

func CreateDiscountsListQueryParamOrganizationIDFilterStr(str string) DiscountsListQueryParamOrganizationIDFilter

func (DiscountsListQueryParamOrganizationIDFilter) MarshalJSON

func (*DiscountsListQueryParamOrganizationIDFilter) UnmarshalJSON

func (u *DiscountsListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type DiscountsListQueryParamOrganizationIDFilterType

type DiscountsListQueryParamOrganizationIDFilterType string
const (
	DiscountsListQueryParamOrganizationIDFilterTypeStr        DiscountsListQueryParamOrganizationIDFilterType = "str"
	DiscountsListQueryParamOrganizationIDFilterTypeArrayOfStr DiscountsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type DiscountsListRequest

type DiscountsListRequest struct {
	// Filter by organization ID.
	OrganizationID *DiscountsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by name.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.DiscountSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*DiscountsListRequest) GetLimit

func (d *DiscountsListRequest) GetLimit() *int64

func (*DiscountsListRequest) GetOrganizationID

func (*DiscountsListRequest) GetPage

func (d *DiscountsListRequest) GetPage() *int64

func (*DiscountsListRequest) GetQuery

func (d *DiscountsListRequest) GetQuery() *string

func (*DiscountsListRequest) GetSorting

func (DiscountsListRequest) MarshalJSON

func (d DiscountsListRequest) MarshalJSON() ([]byte, error)

func (*DiscountsListRequest) UnmarshalJSON

func (d *DiscountsListRequest) UnmarshalJSON(data []byte) error

type DiscountsListResponse

type DiscountsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceDiscount *components.ListResourceDiscount

	Next func() (*DiscountsListResponse, error)
}

func (*DiscountsListResponse) GetHTTPMeta

func (*DiscountsListResponse) GetListResourceDiscount

func (d *DiscountsListResponse) GetListResourceDiscount() *components.ListResourceDiscount

type DiscountsUpdateRequest

type DiscountsUpdateRequest struct {
	// The discount ID.
	ID             string                    `pathParam:"style=simple,explode=false,name=id"`
	DiscountUpdate components.DiscountUpdate `request:"mediaType=application/json"`
}

func (*DiscountsUpdateRequest) GetDiscountUpdate

func (d *DiscountsUpdateRequest) GetDiscountUpdate() components.DiscountUpdate

func (*DiscountsUpdateRequest) GetID

func (d *DiscountsUpdateRequest) GetID() string

type DiscountsUpdateResponse

type DiscountsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Discount updated.
	Discount *components.Discount
}

func (*DiscountsUpdateResponse) GetDiscount

func (d *DiscountsUpdateResponse) GetDiscount() *components.Discount

func (*DiscountsUpdateResponse) GetHTTPMeta

type DisputesGetRequest added in v0.13.0

type DisputesGetRequest struct {
	// The dispute ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*DisputesGetRequest) GetID added in v0.13.0

func (d *DisputesGetRequest) GetID() string

type DisputesGetResponse added in v0.13.0

type DisputesGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Dispute *components.Dispute
}

func (*DisputesGetResponse) GetDispute added in v0.13.0

func (d *DisputesGetResponse) GetDispute() *components.Dispute

func (*DisputesGetResponse) GetHTTPMeta added in v0.13.0

func (d *DisputesGetResponse) GetHTTPMeta() components.HTTPMetadata

type DisputesListQueryParamOrganizationIDFilter added in v0.13.0

type DisputesListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type DisputesListQueryParamOrganizationIDFilterType
}

DisputesListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateDisputesListQueryParamOrganizationIDFilterArrayOfStr added in v0.13.0

func CreateDisputesListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) DisputesListQueryParamOrganizationIDFilter

func CreateDisputesListQueryParamOrganizationIDFilterStr added in v0.13.0

func CreateDisputesListQueryParamOrganizationIDFilterStr(str string) DisputesListQueryParamOrganizationIDFilter

func (DisputesListQueryParamOrganizationIDFilter) MarshalJSON added in v0.13.0

func (*DisputesListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.13.0

func (u *DisputesListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type DisputesListQueryParamOrganizationIDFilterType added in v0.13.0

type DisputesListQueryParamOrganizationIDFilterType string
const (
	DisputesListQueryParamOrganizationIDFilterTypeStr        DisputesListQueryParamOrganizationIDFilterType = "str"
	DisputesListQueryParamOrganizationIDFilterTypeArrayOfStr DisputesListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type DisputesListRequest added in v0.13.0

type DisputesListRequest struct {
	// Filter by organization ID.
	OrganizationID *DisputesListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by order ID.
	OrderID *QueryParamOrderIDFilter `queryParam:"style=form,explode=true,name=order_id"`
	// Filter by dispute status.
	Status *StatusFilter `queryParam:"style=form,explode=true,name=status"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.DisputeSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*DisputesListRequest) GetLimit added in v0.13.0

func (d *DisputesListRequest) GetLimit() *int64

func (*DisputesListRequest) GetOrderID added in v0.13.0

func (*DisputesListRequest) GetOrganizationID added in v0.13.0

func (*DisputesListRequest) GetPage added in v0.13.0

func (d *DisputesListRequest) GetPage() *int64

func (*DisputesListRequest) GetSorting added in v0.13.0

func (*DisputesListRequest) GetStatus added in v0.13.0

func (d *DisputesListRequest) GetStatus() *StatusFilter

func (DisputesListRequest) MarshalJSON added in v0.13.0

func (d DisputesListRequest) MarshalJSON() ([]byte, error)

func (*DisputesListRequest) UnmarshalJSON added in v0.13.0

func (d *DisputesListRequest) UnmarshalJSON(data []byte) error

type DisputesListResponse added in v0.13.0

type DisputesListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceDispute *components.ListResourceDispute

	Next func() (*DisputesListResponse, error)
}

func (*DisputesListResponse) GetHTTPMeta added in v0.13.0

func (d *DisputesListResponse) GetHTTPMeta() components.HTTPMetadata

func (*DisputesListResponse) GetListResourceDispute added in v0.13.0

func (d *DisputesListResponse) GetListResourceDispute() *components.ListResourceDispute

type EndpointID added in v0.6.1

type EndpointID struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EndpointIDType
}

EndpointID - Filter by webhook endpoint ID.

func CreateEndpointIDArrayOfStr added in v0.6.1

func CreateEndpointIDArrayOfStr(arrayOfStr []string) EndpointID

func CreateEndpointIDStr added in v0.6.1

func CreateEndpointIDStr(str string) EndpointID

func (EndpointID) MarshalJSON added in v0.6.1

func (u EndpointID) MarshalJSON() ([]byte, error)

func (*EndpointID) UnmarshalJSON added in v0.6.1

func (u *EndpointID) UnmarshalJSON(data []byte) error

type EndpointIDType added in v0.6.1

type EndpointIDType string
const (
	EndpointIDTypeStr        EndpointIDType = "str"
	EndpointIDTypeArrayOfStr EndpointIDType = "arrayOfStr"
)

type EventType added in v0.13.0

type EventType struct {
	WebhookEventType        *components.WebhookEventType  `queryParam:"inline" union:"member"`
	ArrayOfWebhookEventType []components.WebhookEventType `queryParam:"inline" union:"member"`

	Type EventTypeType
}

EventType - Filter by webhook event type.

func CreateEventTypeArrayOfWebhookEventType added in v0.13.0

func CreateEventTypeArrayOfWebhookEventType(arrayOfWebhookEventType []components.WebhookEventType) EventType

func CreateEventTypeWebhookEventType added in v0.13.0

func CreateEventTypeWebhookEventType(webhookEventType components.WebhookEventType) EventType

func (EventType) MarshalJSON added in v0.13.0

func (u EventType) MarshalJSON() ([]byte, error)

func (*EventType) UnmarshalJSON added in v0.13.0

func (u *EventType) UnmarshalJSON(data []byte) error

type EventTypeType added in v0.13.0

type EventTypeType string
const (
	EventTypeTypeWebhookEventType        EventTypeType = "WebhookEventType"
	EventTypeTypeArrayOfWebhookEventType EventTypeType = "arrayOfWebhookEventType"
)

type EventTypesListQueryParamCustomerIDFilter added in v0.13.0

type EventTypesListQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventTypesListQueryParamCustomerIDFilterType
}

EventTypesListQueryParamCustomerIDFilter - Filter by customer ID.

func CreateEventTypesListQueryParamCustomerIDFilterArrayOfStr added in v0.13.0

func CreateEventTypesListQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) EventTypesListQueryParamCustomerIDFilter

func CreateEventTypesListQueryParamCustomerIDFilterStr added in v0.13.0

func CreateEventTypesListQueryParamCustomerIDFilterStr(str string) EventTypesListQueryParamCustomerIDFilter

func (EventTypesListQueryParamCustomerIDFilter) MarshalJSON added in v0.13.0

func (*EventTypesListQueryParamCustomerIDFilter) UnmarshalJSON added in v0.13.0

func (u *EventTypesListQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type EventTypesListQueryParamCustomerIDFilterType added in v0.13.0

type EventTypesListQueryParamCustomerIDFilterType string
const (
	EventTypesListQueryParamCustomerIDFilterTypeStr        EventTypesListQueryParamCustomerIDFilterType = "str"
	EventTypesListQueryParamCustomerIDFilterTypeArrayOfStr EventTypesListQueryParamCustomerIDFilterType = "arrayOfStr"
)

type EventTypesListQueryParamExternalCustomerIDFilter added in v0.13.0

type EventTypesListQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventTypesListQueryParamExternalCustomerIDFilterType
}

EventTypesListQueryParamExternalCustomerIDFilter - Filter by external customer ID.

func CreateEventTypesListQueryParamExternalCustomerIDFilterArrayOfStr added in v0.13.0

func CreateEventTypesListQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) EventTypesListQueryParamExternalCustomerIDFilter

func CreateEventTypesListQueryParamExternalCustomerIDFilterStr added in v0.13.0

func CreateEventTypesListQueryParamExternalCustomerIDFilterStr(str string) EventTypesListQueryParamExternalCustomerIDFilter

func (EventTypesListQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.13.0

func (*EventTypesListQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.13.0

type EventTypesListQueryParamExternalCustomerIDFilterType added in v0.13.0

type EventTypesListQueryParamExternalCustomerIDFilterType string
const (
	EventTypesListQueryParamExternalCustomerIDFilterTypeStr        EventTypesListQueryParamExternalCustomerIDFilterType = "str"
	EventTypesListQueryParamExternalCustomerIDFilterTypeArrayOfStr EventTypesListQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type EventTypesListQueryParamOrganizationIDFilter added in v0.13.0

type EventTypesListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventTypesListQueryParamOrganizationIDFilterType
}

EventTypesListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateEventTypesListQueryParamOrganizationIDFilterArrayOfStr added in v0.13.0

func CreateEventTypesListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) EventTypesListQueryParamOrganizationIDFilter

func CreateEventTypesListQueryParamOrganizationIDFilterStr added in v0.13.0

func CreateEventTypesListQueryParamOrganizationIDFilterStr(str string) EventTypesListQueryParamOrganizationIDFilter

func (EventTypesListQueryParamOrganizationIDFilter) MarshalJSON added in v0.13.0

func (*EventTypesListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.13.0

func (u *EventTypesListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type EventTypesListQueryParamOrganizationIDFilterType added in v0.13.0

type EventTypesListQueryParamOrganizationIDFilterType string
const (
	EventTypesListQueryParamOrganizationIDFilterTypeStr        EventTypesListQueryParamOrganizationIDFilterType = "str"
	EventTypesListQueryParamOrganizationIDFilterTypeArrayOfStr EventTypesListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type EventTypesListRequest added in v0.13.0

type EventTypesListRequest struct {
	// Filter by organization ID.
	OrganizationID *EventTypesListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by customer ID.
	CustomerID *EventTypesListQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by external customer ID.
	ExternalCustomerID *EventTypesListQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Query to filter event types by name or label.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// When true, only return event types with root events (parent_id IS NULL).
	RootEvents *bool `default:"false" queryParam:"style=form,explode=true,name=root_events"`
	// Filter by specific parent event ID.
	ParentID *string `queryParam:"style=form,explode=true,name=parent_id"`
	// Filter by event source (system or user).
	Source *components.EventSource `queryParam:"style=form,explode=true,name=source"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.EventTypesSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*EventTypesListRequest) GetCustomerID added in v0.13.0

func (*EventTypesListRequest) GetExternalCustomerID added in v0.13.0

func (*EventTypesListRequest) GetLimit added in v0.13.0

func (e *EventTypesListRequest) GetLimit() *int64

func (*EventTypesListRequest) GetOrganizationID added in v0.13.0

func (*EventTypesListRequest) GetPage added in v0.13.0

func (e *EventTypesListRequest) GetPage() *int64

func (*EventTypesListRequest) GetParentID added in v0.13.0

func (e *EventTypesListRequest) GetParentID() *string

func (*EventTypesListRequest) GetQuery added in v0.13.0

func (e *EventTypesListRequest) GetQuery() *string

func (*EventTypesListRequest) GetRootEvents added in v0.13.0

func (e *EventTypesListRequest) GetRootEvents() *bool

func (*EventTypesListRequest) GetSorting added in v0.13.0

func (*EventTypesListRequest) GetSource added in v0.13.0

func (EventTypesListRequest) MarshalJSON added in v0.13.0

func (e EventTypesListRequest) MarshalJSON() ([]byte, error)

func (*EventTypesListRequest) UnmarshalJSON added in v0.13.0

func (e *EventTypesListRequest) UnmarshalJSON(data []byte) error

type EventTypesListResponse added in v0.13.0

type EventTypesListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceEventTypeWithStats *components.ListResourceEventTypeWithStats

	Next func() (*EventTypesListResponse, error)
}

func (*EventTypesListResponse) GetHTTPMeta added in v0.13.0

func (*EventTypesListResponse) GetListResourceEventTypeWithStats added in v0.13.0

func (e *EventTypesListResponse) GetListResourceEventTypeWithStats() *components.ListResourceEventTypeWithStats

type EventTypesUpdateRequest added in v0.13.0

type EventTypesUpdateRequest struct {
	// The event type ID.
	ID              string                     `pathParam:"style=simple,explode=false,name=id"`
	EventTypeUpdate components.EventTypeUpdate `request:"mediaType=application/json"`
}

func (*EventTypesUpdateRequest) GetEventTypeUpdate added in v0.13.0

func (e *EventTypesUpdateRequest) GetEventTypeUpdate() components.EventTypeUpdate

func (*EventTypesUpdateRequest) GetID added in v0.13.0

func (e *EventTypesUpdateRequest) GetID() string

type EventTypesUpdateResponse added in v0.13.0

type EventTypesUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	EventType *components.EventType
}

func (*EventTypesUpdateResponse) GetEventType added in v0.13.0

func (e *EventTypesUpdateResponse) GetEventType() *components.EventType

func (*EventTypesUpdateResponse) GetHTTPMeta added in v0.13.0

type EventsGetRequest added in v0.1.8

type EventsGetRequest struct {
	// The event ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*EventsGetRequest) GetID added in v0.1.8

func (e *EventsGetRequest) GetID() string

type EventsGetResponse added in v0.1.8

type EventsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Event *components.Event
}

func (*EventsGetResponse) GetEvent added in v0.1.8

func (e *EventsGetResponse) GetEvent() *components.Event

func (*EventsGetResponse) GetHTTPMeta added in v0.1.8

func (e *EventsGetResponse) GetHTTPMeta() components.HTTPMetadata

type EventsIngestResponse added in v0.1.8

type EventsIngestResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	EventsIngestResponse *components.EventsIngestResponse
}

func (*EventsIngestResponse) GetEventsIngestResponse added in v0.1.8

func (e *EventsIngestResponse) GetEventsIngestResponse() *components.EventsIngestResponse

func (*EventsIngestResponse) GetHTTPMeta added in v0.1.8

func (e *EventsIngestResponse) GetHTTPMeta() components.HTTPMetadata

type EventsListNamesQueryParamCustomerIDFilter added in v0.4.10

type EventsListNamesQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventsListNamesQueryParamCustomerIDFilterType
}

EventsListNamesQueryParamCustomerIDFilter - Filter by customer ID.

func CreateEventsListNamesQueryParamCustomerIDFilterArrayOfStr added in v0.4.10

func CreateEventsListNamesQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) EventsListNamesQueryParamCustomerIDFilter

func CreateEventsListNamesQueryParamCustomerIDFilterStr added in v0.4.10

func CreateEventsListNamesQueryParamCustomerIDFilterStr(str string) EventsListNamesQueryParamCustomerIDFilter

func (EventsListNamesQueryParamCustomerIDFilter) MarshalJSON added in v0.4.10

func (*EventsListNamesQueryParamCustomerIDFilter) UnmarshalJSON added in v0.4.10

func (u *EventsListNamesQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type EventsListNamesQueryParamCustomerIDFilterType added in v0.4.10

type EventsListNamesQueryParamCustomerIDFilterType string
const (
	EventsListNamesQueryParamCustomerIDFilterTypeStr        EventsListNamesQueryParamCustomerIDFilterType = "str"
	EventsListNamesQueryParamCustomerIDFilterTypeArrayOfStr EventsListNamesQueryParamCustomerIDFilterType = "arrayOfStr"
)

type EventsListNamesQueryParamExternalCustomerIDFilter added in v0.7.2

type EventsListNamesQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventsListNamesQueryParamExternalCustomerIDFilterType
}

EventsListNamesQueryParamExternalCustomerIDFilter - Filter by external customer ID.

func CreateEventsListNamesQueryParamExternalCustomerIDFilterArrayOfStr added in v0.7.2

func CreateEventsListNamesQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) EventsListNamesQueryParamExternalCustomerIDFilter

func CreateEventsListNamesQueryParamExternalCustomerIDFilterStr added in v0.7.2

func CreateEventsListNamesQueryParamExternalCustomerIDFilterStr(str string) EventsListNamesQueryParamExternalCustomerIDFilter

func (EventsListNamesQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.7.2

func (*EventsListNamesQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.7.2

type EventsListNamesQueryParamExternalCustomerIDFilterType added in v0.7.2

type EventsListNamesQueryParamExternalCustomerIDFilterType string
const (
	EventsListNamesQueryParamExternalCustomerIDFilterTypeStr        EventsListNamesQueryParamExternalCustomerIDFilterType = "str"
	EventsListNamesQueryParamExternalCustomerIDFilterTypeArrayOfStr EventsListNamesQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type EventsListNamesQueryParamOrganizationIDFilter added in v0.4.10

type EventsListNamesQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventsListNamesQueryParamOrganizationIDFilterType
}

EventsListNamesQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateEventsListNamesQueryParamOrganizationIDFilterArrayOfStr added in v0.4.10

func CreateEventsListNamesQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) EventsListNamesQueryParamOrganizationIDFilter

func CreateEventsListNamesQueryParamOrganizationIDFilterStr added in v0.4.10

func CreateEventsListNamesQueryParamOrganizationIDFilterStr(str string) EventsListNamesQueryParamOrganizationIDFilter

func (EventsListNamesQueryParamOrganizationIDFilter) MarshalJSON added in v0.4.10

func (*EventsListNamesQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.4.10

func (u *EventsListNamesQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type EventsListNamesQueryParamOrganizationIDFilterType added in v0.4.10

type EventsListNamesQueryParamOrganizationIDFilterType string
const (
	EventsListNamesQueryParamOrganizationIDFilterTypeStr        EventsListNamesQueryParamOrganizationIDFilterType = "str"
	EventsListNamesQueryParamOrganizationIDFilterTypeArrayOfStr EventsListNamesQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type EventsListNamesRequest added in v0.4.10

type EventsListNamesRequest struct {
	// Filter by organization ID.
	OrganizationID *EventsListNamesQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by customer ID.
	CustomerID *EventsListNamesQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by external customer ID.
	ExternalCustomerID *EventsListNamesQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by event source.
	Source *QueryParamSourceFilter `queryParam:"style=form,explode=true,name=source"`
	// Query to filter event names.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.EventNamesSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*EventsListNamesRequest) GetCustomerID added in v0.4.10

func (*EventsListNamesRequest) GetExternalCustomerID added in v0.4.10

func (*EventsListNamesRequest) GetLimit added in v0.4.10

func (e *EventsListNamesRequest) GetLimit() *int64

func (*EventsListNamesRequest) GetOrganizationID added in v0.4.10

func (*EventsListNamesRequest) GetPage added in v0.4.10

func (e *EventsListNamesRequest) GetPage() *int64

func (*EventsListNamesRequest) GetQuery added in v0.4.10

func (e *EventsListNamesRequest) GetQuery() *string

func (*EventsListNamesRequest) GetSorting added in v0.4.10

func (*EventsListNamesRequest) GetSource added in v0.4.12

func (EventsListNamesRequest) MarshalJSON added in v0.4.10

func (e EventsListNamesRequest) MarshalJSON() ([]byte, error)

func (*EventsListNamesRequest) UnmarshalJSON added in v0.4.10

func (e *EventsListNamesRequest) UnmarshalJSON(data []byte) error

type EventsListNamesResponse added in v0.4.10

type EventsListNamesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceEventName *components.ListResourceEventName

	Next func() (*EventsListNamesResponse, error)
}

func (*EventsListNamesResponse) GetHTTPMeta added in v0.4.10

func (*EventsListNamesResponse) GetListResourceEventName added in v0.4.10

func (e *EventsListNamesResponse) GetListResourceEventName() *components.ListResourceEventName

type EventsListQueryParamCustomerIDFilter added in v0.1.8

type EventsListQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventsListQueryParamCustomerIDFilterType
}

EventsListQueryParamCustomerIDFilter - Filter by customer ID.

func CreateEventsListQueryParamCustomerIDFilterArrayOfStr added in v0.1.8

func CreateEventsListQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) EventsListQueryParamCustomerIDFilter

func CreateEventsListQueryParamCustomerIDFilterStr added in v0.1.8

func CreateEventsListQueryParamCustomerIDFilterStr(str string) EventsListQueryParamCustomerIDFilter

func (EventsListQueryParamCustomerIDFilter) MarshalJSON added in v0.1.8

func (u EventsListQueryParamCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*EventsListQueryParamCustomerIDFilter) UnmarshalJSON added in v0.1.8

func (u *EventsListQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type EventsListQueryParamCustomerIDFilterType added in v0.1.8

type EventsListQueryParamCustomerIDFilterType string
const (
	EventsListQueryParamCustomerIDFilterTypeStr        EventsListQueryParamCustomerIDFilterType = "str"
	EventsListQueryParamCustomerIDFilterTypeArrayOfStr EventsListQueryParamCustomerIDFilterType = "arrayOfStr"
)

type EventsListQueryParamExternalCustomerIDFilter added in v0.13.0

type EventsListQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventsListQueryParamExternalCustomerIDFilterType
}

EventsListQueryParamExternalCustomerIDFilter - Filter by external customer ID.

func CreateEventsListQueryParamExternalCustomerIDFilterArrayOfStr added in v0.13.0

func CreateEventsListQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) EventsListQueryParamExternalCustomerIDFilter

func CreateEventsListQueryParamExternalCustomerIDFilterStr added in v0.13.0

func CreateEventsListQueryParamExternalCustomerIDFilterStr(str string) EventsListQueryParamExternalCustomerIDFilter

func (EventsListQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.13.0

func (*EventsListQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.13.0

func (u *EventsListQueryParamExternalCustomerIDFilter) UnmarshalJSON(data []byte) error

type EventsListQueryParamExternalCustomerIDFilterType added in v0.13.0

type EventsListQueryParamExternalCustomerIDFilterType string
const (
	EventsListQueryParamExternalCustomerIDFilterTypeStr        EventsListQueryParamExternalCustomerIDFilterType = "str"
	EventsListQueryParamExternalCustomerIDFilterTypeArrayOfStr EventsListQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type EventsListQueryParamOrganizationIDFilter added in v0.1.8

type EventsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type EventsListQueryParamOrganizationIDFilterType
}

EventsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateEventsListQueryParamOrganizationIDFilterArrayOfStr added in v0.1.8

func CreateEventsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) EventsListQueryParamOrganizationIDFilter

func CreateEventsListQueryParamOrganizationIDFilterStr added in v0.1.8

func CreateEventsListQueryParamOrganizationIDFilterStr(str string) EventsListQueryParamOrganizationIDFilter

func (EventsListQueryParamOrganizationIDFilter) MarshalJSON added in v0.1.8

func (*EventsListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.1.8

func (u *EventsListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type EventsListQueryParamOrganizationIDFilterType added in v0.1.8

type EventsListQueryParamOrganizationIDFilterType string
const (
	EventsListQueryParamOrganizationIDFilterTypeStr        EventsListQueryParamOrganizationIDFilterType = "str"
	EventsListQueryParamOrganizationIDFilterTypeArrayOfStr EventsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type EventsListRequest added in v0.1.8

type EventsListRequest struct {
	// Filter events following filter clauses. JSON string following the same schema a meter filter clause.
	Filter *string `queryParam:"style=form,explode=true,name=filter"`
	// Filter events after this timestamp.
	StartTimestamp *time.Time `queryParam:"style=form,explode=true,name=start_timestamp"`
	// Filter events before this timestamp.
	EndTimestamp *time.Time `queryParam:"style=form,explode=true,name=end_timestamp"`
	// Filter by organization ID.
	OrganizationID *EventsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by customer ID.
	CustomerID *EventsListQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by external customer ID.
	ExternalCustomerID *EventsListQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by a meter filter clause.
	MeterID *string `queryParam:"style=form,explode=true,name=meter_id"`
	// Filter by event name.
	Name *NameFilter `queryParam:"style=form,explode=true,name=name"`
	// Filter by event source.
	Source *SourceFilter `queryParam:"style=form,explode=true,name=source"`
	// Query to filter events.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// When combined with depth, use this event as the anchor instead of root events.
	ParentID *string `queryParam:"style=form,explode=true,name=parent_id"`
	// Fetch descendants up to this depth. When set: 0=root events only, 1=roots+children, etc. Max 5. When not set, returns all events.
	Depth *int64 `queryParam:"style=form,explode=true,name=depth"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.EventSortProperty `queryParam:"style=form,explode=true,name=sorting"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*EventsListRequest) GetCustomerID added in v0.1.8

func (*EventsListRequest) GetDepth added in v0.13.0

func (e *EventsListRequest) GetDepth() *int64

func (*EventsListRequest) GetEndTimestamp added in v0.1.8

func (e *EventsListRequest) GetEndTimestamp() *time.Time

func (*EventsListRequest) GetExternalCustomerID added in v0.1.8

func (*EventsListRequest) GetFilter added in v0.4.11

func (e *EventsListRequest) GetFilter() *string

func (*EventsListRequest) GetLimit added in v0.1.8

func (e *EventsListRequest) GetLimit() *int64

func (*EventsListRequest) GetMetadata added in v0.1.8

func (e *EventsListRequest) GetMetadata() map[string]components.MetadataQuery

func (*EventsListRequest) GetMeterID added in v0.4.10

func (e *EventsListRequest) GetMeterID() *string

func (*EventsListRequest) GetName added in v0.4.10

func (e *EventsListRequest) GetName() *NameFilter

func (*EventsListRequest) GetOrganizationID added in v0.1.8

func (*EventsListRequest) GetPage added in v0.1.8

func (e *EventsListRequest) GetPage() *int64

func (*EventsListRequest) GetParentID added in v0.12.0

func (e *EventsListRequest) GetParentID() *string

func (*EventsListRequest) GetQuery added in v0.12.0

func (e *EventsListRequest) GetQuery() *string

func (*EventsListRequest) GetSorting added in v0.1.8

func (*EventsListRequest) GetSource added in v0.1.8

func (e *EventsListRequest) GetSource() *SourceFilter

func (*EventsListRequest) GetStartTimestamp added in v0.1.8

func (e *EventsListRequest) GetStartTimestamp() *time.Time

func (EventsListRequest) MarshalJSON added in v0.1.8

func (e EventsListRequest) MarshalJSON() ([]byte, error)

func (*EventsListRequest) UnmarshalJSON added in v0.1.8

func (e *EventsListRequest) UnmarshalJSON(data []byte) error

type EventsListResponse added in v0.1.8

type EventsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ResponseEventsList *EventsListResponseEventsList
}

func (*EventsListResponse) GetHTTPMeta added in v0.1.8

func (e *EventsListResponse) GetHTTPMeta() components.HTTPMetadata

func (*EventsListResponse) GetResponseEventsList added in v0.13.0

func (e *EventsListResponse) GetResponseEventsList() *EventsListResponseEventsList

type EventsListResponseEventsList added in v0.13.0

type EventsListResponseEventsList struct {
	ListResourceEvent                     *components.ListResourceEvent                     `queryParam:"inline" union:"member"`
	ListResourceWithCursorPaginationEvent *components.ListResourceWithCursorPaginationEvent `queryParam:"inline" union:"member"`

	Type EventsListResponseEventsListType
}

EventsListResponseEventsList - Successful Response

func CreateEventsListResponseEventsListListResourceEvent added in v0.13.0

func CreateEventsListResponseEventsListListResourceEvent(listResourceEvent components.ListResourceEvent) EventsListResponseEventsList

func CreateEventsListResponseEventsListListResourceWithCursorPaginationEvent added in v0.13.0

func CreateEventsListResponseEventsListListResourceWithCursorPaginationEvent(listResourceWithCursorPaginationEvent components.ListResourceWithCursorPaginationEvent) EventsListResponseEventsList

func (EventsListResponseEventsList) MarshalJSON added in v0.13.0

func (u EventsListResponseEventsList) MarshalJSON() ([]byte, error)

func (*EventsListResponseEventsList) UnmarshalJSON added in v0.13.0

func (u *EventsListResponseEventsList) UnmarshalJSON(data []byte) error

type EventsListResponseEventsListType added in v0.13.0

type EventsListResponseEventsListType string
const (
	EventsListResponseEventsListTypeListResourceEvent                     EventsListResponseEventsListType = "ListResource_Event_"
	EventsListResponseEventsListTypeListResourceWithCursorPaginationEvent EventsListResponseEventsListType = "ListResourceWithCursorPagination_Event_"
)

type ExcludeIDs added in v0.13.0

type ExcludeIDs struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type ExcludeIDsType
}

ExcludeIDs - Exclude benefits with these IDs.

func CreateExcludeIDsArrayOfStr added in v0.13.0

func CreateExcludeIDsArrayOfStr(arrayOfStr []string) ExcludeIDs

func CreateExcludeIDsStr added in v0.13.0

func CreateExcludeIDsStr(str string) ExcludeIDs

func (ExcludeIDs) MarshalJSON added in v0.13.0

func (u ExcludeIDs) MarshalJSON() ([]byte, error)

func (*ExcludeIDs) UnmarshalJSON added in v0.13.0

func (u *ExcludeIDs) UnmarshalJSON(data []byte) error

type ExcludeIDsType added in v0.13.0

type ExcludeIDsType string
const (
	ExcludeIDsTypeStr        ExcludeIDsType = "str"
	ExcludeIDsTypeArrayOfStr ExcludeIDsType = "arrayOfStr"
)

type ExternalCustomerIDFilter added in v0.1.8

type ExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type ExternalCustomerIDFilterType
}

ExternalCustomerIDFilter - Filter by customer external ID.

func CreateExternalCustomerIDFilterArrayOfStr added in v0.1.8

func CreateExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) ExternalCustomerIDFilter

func CreateExternalCustomerIDFilterStr added in v0.1.8

func CreateExternalCustomerIDFilterStr(str string) ExternalCustomerIDFilter

func (ExternalCustomerIDFilter) MarshalJSON added in v0.1.8

func (u ExternalCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*ExternalCustomerIDFilter) UnmarshalJSON added in v0.1.8

func (u *ExternalCustomerIDFilter) UnmarshalJSON(data []byte) error

type ExternalCustomerIDFilterType added in v0.1.8

type ExternalCustomerIDFilterType string
const (
	ExternalCustomerIDFilterTypeStr        ExternalCustomerIDFilterType = "str"
	ExternalCustomerIDFilterTypeArrayOfStr ExternalCustomerIDFilterType = "arrayOfStr"
)

type FileIDFilter added in v0.4.18

type FileIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type FileIDFilterType
}

FileIDFilter - Filter by file ID.

func CreateFileIDFilterArrayOfStr added in v0.4.18

func CreateFileIDFilterArrayOfStr(arrayOfStr []string) FileIDFilter

func CreateFileIDFilterStr added in v0.4.18

func CreateFileIDFilterStr(str string) FileIDFilter

func (FileIDFilter) MarshalJSON added in v0.4.18

func (u FileIDFilter) MarshalJSON() ([]byte, error)

func (*FileIDFilter) UnmarshalJSON added in v0.4.18

func (u *FileIDFilter) UnmarshalJSON(data []byte) error

type FileIDFilterType added in v0.4.18

type FileIDFilterType string
const (
	FileIDFilterTypeStr        FileIDFilterType = "str"
	FileIDFilterTypeArrayOfStr FileIDFilterType = "arrayOfStr"
)

type FilesCreateResponse

type FilesCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// File created.
	FileUpload *components.FileUpload
}

func (*FilesCreateResponse) GetFileUpload

func (f *FilesCreateResponse) GetFileUpload() *components.FileUpload

func (*FilesCreateResponse) GetHTTPMeta

func (f *FilesCreateResponse) GetHTTPMeta() components.HTTPMetadata

type FilesDeleteRequest

type FilesDeleteRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*FilesDeleteRequest) GetID

func (f *FilesDeleteRequest) GetID() string

type FilesDeleteResponse

type FilesDeleteResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*FilesDeleteResponse) GetHTTPMeta

func (f *FilesDeleteResponse) GetHTTPMeta() components.HTTPMetadata

type FilesListQueryParamOrganizationIDFilter added in v0.4.18

type FilesListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type FilesListQueryParamOrganizationIDFilterType
}

FilesListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateFilesListQueryParamOrganizationIDFilterArrayOfStr added in v0.4.18

func CreateFilesListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) FilesListQueryParamOrganizationIDFilter

func CreateFilesListQueryParamOrganizationIDFilterStr added in v0.4.18

func CreateFilesListQueryParamOrganizationIDFilterStr(str string) FilesListQueryParamOrganizationIDFilter

func (FilesListQueryParamOrganizationIDFilter) MarshalJSON added in v0.4.18

func (u FilesListQueryParamOrganizationIDFilter) MarshalJSON() ([]byte, error)

func (*FilesListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.4.18

func (u *FilesListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type FilesListQueryParamOrganizationIDFilterType added in v0.4.18

type FilesListQueryParamOrganizationIDFilterType string
const (
	FilesListQueryParamOrganizationIDFilterTypeStr        FilesListQueryParamOrganizationIDFilterType = "str"
	FilesListQueryParamOrganizationIDFilterTypeArrayOfStr FilesListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type FilesListRequest

type FilesListRequest struct {
	// Filter by organization ID.
	OrganizationID *FilesListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by file ID.
	Ids *FileIDFilter `queryParam:"style=form,explode=true,name=ids"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*FilesListRequest) GetIds

func (f *FilesListRequest) GetIds() *FileIDFilter

func (*FilesListRequest) GetLimit

func (f *FilesListRequest) GetLimit() *int64

func (*FilesListRequest) GetOrganizationID

func (*FilesListRequest) GetPage

func (f *FilesListRequest) GetPage() *int64

func (FilesListRequest) MarshalJSON

func (f FilesListRequest) MarshalJSON() ([]byte, error)

func (*FilesListRequest) UnmarshalJSON

func (f *FilesListRequest) UnmarshalJSON(data []byte) error

type FilesListResponse

type FilesListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceFileRead *components.ListResourceFileRead

	Next func() (*FilesListResponse, error)
}

func (*FilesListResponse) GetHTTPMeta

func (f *FilesListResponse) GetHTTPMeta() components.HTTPMetadata

func (*FilesListResponse) GetListResourceFileRead

func (f *FilesListResponse) GetListResourceFileRead() *components.ListResourceFileRead

type FilesUpdateRequest

type FilesUpdateRequest struct {
	// The file ID.
	ID        string               `pathParam:"style=simple,explode=false,name=id"`
	FilePatch components.FilePatch `request:"mediaType=application/json"`
}

func (*FilesUpdateRequest) GetFilePatch

func (f *FilesUpdateRequest) GetFilePatch() components.FilePatch

func (*FilesUpdateRequest) GetID

func (f *FilesUpdateRequest) GetID() string

type FilesUpdateResponse

type FilesUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// File updated.
	ResponseFilesUpdate *FilesUpdateResponseFilesUpdate
}

func (*FilesUpdateResponse) GetHTTPMeta

func (f *FilesUpdateResponse) GetHTTPMeta() components.HTTPMetadata

func (*FilesUpdateResponse) GetResponseFilesUpdate

func (f *FilesUpdateResponse) GetResponseFilesUpdate() *FilesUpdateResponseFilesUpdate

func (*FilesUpdateResponse) GetResponseFilesUpdateDownloadable

func (f *FilesUpdateResponse) GetResponseFilesUpdateDownloadable() *components.DownloadableFileRead

func (*FilesUpdateResponse) GetResponseFilesUpdateOrganizationAvatar

func (f *FilesUpdateResponse) GetResponseFilesUpdateOrganizationAvatar() *components.OrganizationAvatarFileRead

func (*FilesUpdateResponse) GetResponseFilesUpdateProductMedia

func (f *FilesUpdateResponse) GetResponseFilesUpdateProductMedia() *components.ProductMediaFileRead

type FilesUpdateResponseFilesUpdate

type FilesUpdateResponseFilesUpdate struct {
	DownloadableFileRead       *components.DownloadableFileRead       `queryParam:"inline" union:"member"`
	ProductMediaFileRead       *components.ProductMediaFileRead       `queryParam:"inline" union:"member"`
	OrganizationAvatarFileRead *components.OrganizationAvatarFileRead `queryParam:"inline" union:"member"`

	Type FilesUpdateResponseFilesUpdateType
}

FilesUpdateResponseFilesUpdate - File updated.

func CreateFilesUpdateResponseFilesUpdateDownloadable

func CreateFilesUpdateResponseFilesUpdateDownloadable(downloadable components.DownloadableFileRead) FilesUpdateResponseFilesUpdate

func CreateFilesUpdateResponseFilesUpdateOrganizationAvatar

func CreateFilesUpdateResponseFilesUpdateOrganizationAvatar(organizationAvatar components.OrganizationAvatarFileRead) FilesUpdateResponseFilesUpdate

func CreateFilesUpdateResponseFilesUpdateProductMedia

func CreateFilesUpdateResponseFilesUpdateProductMedia(productMedia components.ProductMediaFileRead) FilesUpdateResponseFilesUpdate

func (FilesUpdateResponseFilesUpdate) MarshalJSON

func (u FilesUpdateResponseFilesUpdate) MarshalJSON() ([]byte, error)

func (*FilesUpdateResponseFilesUpdate) UnmarshalJSON

func (u *FilesUpdateResponseFilesUpdate) UnmarshalJSON(data []byte) error

type FilesUpdateResponseFilesUpdateType

type FilesUpdateResponseFilesUpdateType string
const (
	FilesUpdateResponseFilesUpdateTypeDownloadable       FilesUpdateResponseFilesUpdateType = "downloadable"
	FilesUpdateResponseFilesUpdateTypeProductMedia       FilesUpdateResponseFilesUpdateType = "product_media"
	FilesUpdateResponseFilesUpdateTypeOrganizationAvatar FilesUpdateResponseFilesUpdateType = "organization_avatar"
)

type FilesUploadedRequest

type FilesUploadedRequest struct {
	// The file ID.
	ID                  string                         `pathParam:"style=simple,explode=false,name=id"`
	FileUploadCompleted components.FileUploadCompleted `request:"mediaType=application/json"`
}

func (*FilesUploadedRequest) GetFileUploadCompleted

func (f *FilesUploadedRequest) GetFileUploadCompleted() components.FileUploadCompleted

func (*FilesUploadedRequest) GetID

func (f *FilesUploadedRequest) GetID() string

type FilesUploadedResponse

type FilesUploadedResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// File upload completed.
	ResponseFilesUploaded *FilesUploadedResponseFilesUploaded
}

func (*FilesUploadedResponse) GetHTTPMeta

func (*FilesUploadedResponse) GetResponseFilesUploaded

func (f *FilesUploadedResponse) GetResponseFilesUploaded() *FilesUploadedResponseFilesUploaded

func (*FilesUploadedResponse) GetResponseFilesUploadedDownloadable

func (f *FilesUploadedResponse) GetResponseFilesUploadedDownloadable() *components.DownloadableFileRead

func (*FilesUploadedResponse) GetResponseFilesUploadedOrganizationAvatar

func (f *FilesUploadedResponse) GetResponseFilesUploadedOrganizationAvatar() *components.OrganizationAvatarFileRead

func (*FilesUploadedResponse) GetResponseFilesUploadedProductMedia

func (f *FilesUploadedResponse) GetResponseFilesUploadedProductMedia() *components.ProductMediaFileRead

type FilesUploadedResponseFilesUploaded

type FilesUploadedResponseFilesUploaded struct {
	DownloadableFileRead       *components.DownloadableFileRead       `queryParam:"inline" union:"member"`
	ProductMediaFileRead       *components.ProductMediaFileRead       `queryParam:"inline" union:"member"`
	OrganizationAvatarFileRead *components.OrganizationAvatarFileRead `queryParam:"inline" union:"member"`

	Type FilesUploadedResponseFilesUploadedType
}

FilesUploadedResponseFilesUploaded - File upload completed.

func CreateFilesUploadedResponseFilesUploadedDownloadable

func CreateFilesUploadedResponseFilesUploadedDownloadable(downloadable components.DownloadableFileRead) FilesUploadedResponseFilesUploaded

func CreateFilesUploadedResponseFilesUploadedOrganizationAvatar

func CreateFilesUploadedResponseFilesUploadedOrganizationAvatar(organizationAvatar components.OrganizationAvatarFileRead) FilesUploadedResponseFilesUploaded

func CreateFilesUploadedResponseFilesUploadedProductMedia

func CreateFilesUploadedResponseFilesUploadedProductMedia(productMedia components.ProductMediaFileRead) FilesUploadedResponseFilesUploaded

func (FilesUploadedResponseFilesUploaded) MarshalJSON

func (u FilesUploadedResponseFilesUploaded) MarshalJSON() ([]byte, error)

func (*FilesUploadedResponseFilesUploaded) UnmarshalJSON

func (u *FilesUploadedResponseFilesUploaded) UnmarshalJSON(data []byte) error

type FilesUploadedResponseFilesUploadedType

type FilesUploadedResponseFilesUploadedType string
const (
	FilesUploadedResponseFilesUploadedTypeDownloadable       FilesUploadedResponseFilesUploadedType = "downloadable"
	FilesUploadedResponseFilesUploadedTypeProductMedia       FilesUploadedResponseFilesUploadedType = "product_media"
	FilesUploadedResponseFilesUploadedTypeOrganizationAvatar FilesUploadedResponseFilesUploadedType = "organization_avatar"
)

type FilterIDs added in v0.13.0

type FilterIDs struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type FilterIDsType
}

FilterIDs - Filter by benefit IDs.

func CreateFilterIDsArrayOfStr added in v0.13.0

func CreateFilterIDsArrayOfStr(arrayOfStr []string) FilterIDs

func CreateFilterIDsStr added in v0.13.0

func CreateFilterIDsStr(str string) FilterIDs

func (FilterIDs) MarshalJSON added in v0.13.0

func (u FilterIDs) MarshalJSON() ([]byte, error)

func (*FilterIDs) UnmarshalJSON added in v0.13.0

func (u *FilterIDs) UnmarshalJSON(data []byte) error

type FilterIDsType added in v0.13.0

type FilterIDsType string
const (
	FilterIDsTypeStr        FilterIDsType = "str"
	FilterIDsTypeArrayOfStr FilterIDsType = "arrayOfStr"
)

type HTTPCodeClass added in v0.13.0

type HTTPCodeClass string

HTTPCodeClass - Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).

const (
	HTTPCodeClassTwoxx   HTTPCodeClass = "2xx"
	HTTPCodeClassThreexx HTTPCodeClass = "3xx"
	HTTPCodeClassFourxx  HTTPCodeClass = "4xx"
	HTTPCodeClassFivexx  HTTPCodeClass = "5xx"
)

func (HTTPCodeClass) ToPointer added in v0.13.0

func (e HTTPCodeClass) ToPointer() *HTTPCodeClass

func (*HTTPCodeClass) UnmarshalJSON added in v0.13.0

func (e *HTTPCodeClass) UnmarshalJSON(data []byte) error

type LicenseKeysActivateResponse added in v0.8.2

type LicenseKeysActivateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	LicenseKeyActivationRead *components.LicenseKeyActivationRead
}

func (*LicenseKeysActivateResponse) GetHTTPMeta added in v0.8.2

func (*LicenseKeysActivateResponse) GetLicenseKeyActivationRead added in v0.8.2

func (l *LicenseKeysActivateResponse) GetLicenseKeyActivationRead() *components.LicenseKeyActivationRead

type LicenseKeysDeactivateResponse added in v0.8.2

type LicenseKeysDeactivateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*LicenseKeysDeactivateResponse) GetHTTPMeta added in v0.8.2

type LicenseKeysGetActivationRequest

type LicenseKeysGetActivationRequest struct {
	ID           string `pathParam:"style=simple,explode=false,name=id"`
	ActivationID string `pathParam:"style=simple,explode=false,name=activation_id"`
}

func (*LicenseKeysGetActivationRequest) GetActivationID

func (l *LicenseKeysGetActivationRequest) GetActivationID() string

func (*LicenseKeysGetActivationRequest) GetID

type LicenseKeysGetActivationResponse

type LicenseKeysGetActivationResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	LicenseKeyActivationRead *components.LicenseKeyActivationRead
}

func (*LicenseKeysGetActivationResponse) GetHTTPMeta

func (*LicenseKeysGetActivationResponse) GetLicenseKeyActivationRead

func (l *LicenseKeysGetActivationResponse) GetLicenseKeyActivationRead() *components.LicenseKeyActivationRead

type LicenseKeysGetRequest

type LicenseKeysGetRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*LicenseKeysGetRequest) GetID

func (l *LicenseKeysGetRequest) GetID() string

type LicenseKeysGetResponse

type LicenseKeysGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	LicenseKeyWithActivations *components.LicenseKeyWithActivations
}

func (*LicenseKeysGetResponse) GetHTTPMeta

func (*LicenseKeysGetResponse) GetLicenseKeyWithActivations

func (l *LicenseKeysGetResponse) GetLicenseKeyWithActivations() *components.LicenseKeyWithActivations

type LicenseKeysListQueryParamOrganizationIDFilter

type LicenseKeysListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type LicenseKeysListQueryParamOrganizationIDFilterType
}

LicenseKeysListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateLicenseKeysListQueryParamOrganizationIDFilterArrayOfStr

func CreateLicenseKeysListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) LicenseKeysListQueryParamOrganizationIDFilter

func CreateLicenseKeysListQueryParamOrganizationIDFilterStr

func CreateLicenseKeysListQueryParamOrganizationIDFilterStr(str string) LicenseKeysListQueryParamOrganizationIDFilter

func (LicenseKeysListQueryParamOrganizationIDFilter) MarshalJSON

func (*LicenseKeysListQueryParamOrganizationIDFilter) UnmarshalJSON

func (u *LicenseKeysListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type LicenseKeysListQueryParamOrganizationIDFilterType

type LicenseKeysListQueryParamOrganizationIDFilterType string
const (
	LicenseKeysListQueryParamOrganizationIDFilterTypeStr        LicenseKeysListQueryParamOrganizationIDFilterType = "str"
	LicenseKeysListQueryParamOrganizationIDFilterTypeArrayOfStr LicenseKeysListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type LicenseKeysListRequest

type LicenseKeysListRequest struct {
	// Filter by organization ID.
	OrganizationID *LicenseKeysListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by benefit ID.
	BenefitID *QueryParamBenefitIDFilter `queryParam:"style=form,explode=true,name=benefit_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*LicenseKeysListRequest) GetBenefitID

func (*LicenseKeysListRequest) GetLimit

func (l *LicenseKeysListRequest) GetLimit() *int64

func (*LicenseKeysListRequest) GetOrganizationID

func (*LicenseKeysListRequest) GetPage

func (l *LicenseKeysListRequest) GetPage() *int64

func (LicenseKeysListRequest) MarshalJSON

func (l LicenseKeysListRequest) MarshalJSON() ([]byte, error)

func (*LicenseKeysListRequest) UnmarshalJSON

func (l *LicenseKeysListRequest) UnmarshalJSON(data []byte) error

type LicenseKeysListResponse

type LicenseKeysListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceLicenseKeyRead *components.ListResourceLicenseKeyRead

	Next func() (*LicenseKeysListResponse, error)
}

func (*LicenseKeysListResponse) GetHTTPMeta

func (*LicenseKeysListResponse) GetListResourceLicenseKeyRead

func (l *LicenseKeysListResponse) GetListResourceLicenseKeyRead() *components.ListResourceLicenseKeyRead

type LicenseKeysUpdateRequest

type LicenseKeysUpdateRequest struct {
	ID               string                      `pathParam:"style=simple,explode=false,name=id"`
	LicenseKeyUpdate components.LicenseKeyUpdate `request:"mediaType=application/json"`
}

func (*LicenseKeysUpdateRequest) GetID

func (l *LicenseKeysUpdateRequest) GetID() string

func (*LicenseKeysUpdateRequest) GetLicenseKeyUpdate

func (l *LicenseKeysUpdateRequest) GetLicenseKeyUpdate() components.LicenseKeyUpdate

type LicenseKeysUpdateResponse

type LicenseKeysUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	LicenseKeyRead *components.LicenseKeyRead
}

func (*LicenseKeysUpdateResponse) GetHTTPMeta

func (*LicenseKeysUpdateResponse) GetLicenseKeyRead

func (l *LicenseKeysUpdateResponse) GetLicenseKeyRead() *components.LicenseKeyRead

type LicenseKeysValidateResponse added in v0.8.2

type LicenseKeysValidateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ValidatedLicenseKey *components.ValidatedLicenseKey
}

func (*LicenseKeysValidateResponse) GetHTTPMeta added in v0.8.2

func (*LicenseKeysValidateResponse) GetValidatedLicenseKey added in v0.8.2

func (l *LicenseKeysValidateResponse) GetValidatedLicenseKey() *components.ValidatedLicenseKey

type MemberIDFilter added in v0.13.0

type MemberIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MemberIDFilterType
}

MemberIDFilter - Filter by member.

func CreateMemberIDFilterArrayOfStr added in v0.13.0

func CreateMemberIDFilterArrayOfStr(arrayOfStr []string) MemberIDFilter

func CreateMemberIDFilterStr added in v0.13.0

func CreateMemberIDFilterStr(str string) MemberIDFilter

func (MemberIDFilter) MarshalJSON added in v0.13.0

func (u MemberIDFilter) MarshalJSON() ([]byte, error)

func (*MemberIDFilter) UnmarshalJSON added in v0.13.0

func (u *MemberIDFilter) UnmarshalJSON(data []byte) error

type MemberIDFilterType added in v0.13.0

type MemberIDFilterType string
const (
	MemberIDFilterTypeStr        MemberIDFilterType = "str"
	MemberIDFilterTypeArrayOfStr MemberIDFilterType = "arrayOfStr"
)

type MembersCreateMemberResponse added in v0.13.0

type MembersCreateMemberResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Member created.
	Member *components.Member
}

func (*MembersCreateMemberResponse) GetHTTPMeta added in v0.13.0

func (*MembersCreateMemberResponse) GetMember added in v0.13.0

type MembersDeleteMemberRequest added in v0.13.0

type MembersDeleteMemberRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*MembersDeleteMemberRequest) GetID added in v0.13.0

type MembersDeleteMemberResponse added in v0.13.0

type MembersDeleteMemberResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*MembersDeleteMemberResponse) GetHTTPMeta added in v0.13.0

type MembersGetMemberRequest added in v0.13.0

type MembersGetMemberRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*MembersGetMemberRequest) GetID added in v0.13.0

func (m *MembersGetMemberRequest) GetID() string

type MembersGetMemberResponse added in v0.13.0

type MembersGetMemberResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Member retrieved.
	Member *components.Member
}

func (*MembersGetMemberResponse) GetHTTPMeta added in v0.13.0

func (*MembersGetMemberResponse) GetMember added in v0.13.0

func (m *MembersGetMemberResponse) GetMember() *components.Member

type MembersListMembersRequest added in v0.13.0

type MembersListMembersRequest struct {
	// Filter by customer ID.
	CustomerID *string `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by customer external ID.
	ExternalCustomerID *string `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by member role.
	Role *components.MemberRole `queryParam:"style=form,explode=true,name=role"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.MemberSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*MembersListMembersRequest) GetCustomerID added in v0.13.0

func (m *MembersListMembersRequest) GetCustomerID() *string

func (*MembersListMembersRequest) GetExternalCustomerID added in v0.13.0

func (m *MembersListMembersRequest) GetExternalCustomerID() *string

func (*MembersListMembersRequest) GetLimit added in v0.13.0

func (m *MembersListMembersRequest) GetLimit() *int64

func (*MembersListMembersRequest) GetPage added in v0.13.0

func (m *MembersListMembersRequest) GetPage() *int64

func (*MembersListMembersRequest) GetRole added in v0.15.1

func (*MembersListMembersRequest) GetSorting added in v0.13.0

func (MembersListMembersRequest) MarshalJSON added in v0.13.0

func (m MembersListMembersRequest) MarshalJSON() ([]byte, error)

func (*MembersListMembersRequest) UnmarshalJSON added in v0.13.0

func (m *MembersListMembersRequest) UnmarshalJSON(data []byte) error

type MembersListMembersResponse added in v0.13.0

type MembersListMembersResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceMember *components.ListResourceMember

	Next func() (*MembersListMembersResponse, error)
}

func (*MembersListMembersResponse) GetHTTPMeta added in v0.13.0

func (*MembersListMembersResponse) GetListResourceMember added in v0.13.0

func (m *MembersListMembersResponse) GetListResourceMember() *components.ListResourceMember

type MembersUpdateMemberRequest added in v0.13.0

type MembersUpdateMemberRequest struct {
	ID           string                  `pathParam:"style=simple,explode=false,name=id"`
	MemberUpdate components.MemberUpdate `request:"mediaType=application/json"`
}

func (*MembersUpdateMemberRequest) GetID added in v0.13.0

func (*MembersUpdateMemberRequest) GetMemberUpdate added in v0.13.0

func (m *MembersUpdateMemberRequest) GetMemberUpdate() components.MemberUpdate

type MembersUpdateMemberResponse added in v0.13.0

type MembersUpdateMemberResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Member updated.
	Member *components.Member
}

func (*MembersUpdateMemberResponse) GetHTTPMeta added in v0.13.0

func (*MembersUpdateMemberResponse) GetMember added in v0.13.0

type MeterIDFilter added in v0.4.10

type MeterIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MeterIDFilterType
}

MeterIDFilter - Filter by meter ID.

func CreateMeterIDFilterArrayOfStr added in v0.4.10

func CreateMeterIDFilterArrayOfStr(arrayOfStr []string) MeterIDFilter

func CreateMeterIDFilterStr added in v0.4.10

func CreateMeterIDFilterStr(str string) MeterIDFilter

func (MeterIDFilter) MarshalJSON added in v0.4.10

func (u MeterIDFilter) MarshalJSON() ([]byte, error)

func (*MeterIDFilter) UnmarshalJSON added in v0.4.10

func (u *MeterIDFilter) UnmarshalJSON(data []byte) error

type MeterIDFilterType added in v0.4.10

type MeterIDFilterType string
const (
	MeterIDFilterTypeStr        MeterIDFilterType = "str"
	MeterIDFilterTypeArrayOfStr MeterIDFilterType = "arrayOfStr"
)

type MetersCreateResponse added in v0.1.8

type MetersCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Meter created.
	Meter *components.Meter
}

func (*MetersCreateResponse) GetHTTPMeta added in v0.1.8

func (m *MetersCreateResponse) GetHTTPMeta() components.HTTPMetadata

func (*MetersCreateResponse) GetMeter added in v0.1.8

func (m *MetersCreateResponse) GetMeter() *components.Meter

type MetersGetRequest added in v0.1.8

type MetersGetRequest struct {
	// The meter ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*MetersGetRequest) GetID added in v0.1.8

func (m *MetersGetRequest) GetID() string

type MetersGetResponse added in v0.1.8

type MetersGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Meter *components.Meter
}

func (*MetersGetResponse) GetHTTPMeta added in v0.1.8

func (m *MetersGetResponse) GetHTTPMeta() components.HTTPMetadata

func (*MetersGetResponse) GetMeter added in v0.1.8

func (m *MetersGetResponse) GetMeter() *components.Meter

type MetersListQueryParamOrganizationIDFilter added in v0.1.8

type MetersListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MetersListQueryParamOrganizationIDFilterType
}

MetersListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateMetersListQueryParamOrganizationIDFilterArrayOfStr added in v0.1.8

func CreateMetersListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) MetersListQueryParamOrganizationIDFilter

func CreateMetersListQueryParamOrganizationIDFilterStr added in v0.1.8

func CreateMetersListQueryParamOrganizationIDFilterStr(str string) MetersListQueryParamOrganizationIDFilter

func (MetersListQueryParamOrganizationIDFilter) MarshalJSON added in v0.1.8

func (*MetersListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.1.8

func (u *MetersListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type MetersListQueryParamOrganizationIDFilterType added in v0.1.8

type MetersListQueryParamOrganizationIDFilterType string
const (
	MetersListQueryParamOrganizationIDFilterTypeStr        MetersListQueryParamOrganizationIDFilterType = "str"
	MetersListQueryParamOrganizationIDFilterTypeArrayOfStr MetersListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type MetersListRequest added in v0.1.8

type MetersListRequest struct {
	// Filter by organization ID.
	OrganizationID *MetersListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by name.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Filter on archived meters.
	IsArchived *bool `queryParam:"style=form,explode=true,name=is_archived"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.MeterSortProperty `queryParam:"style=form,explode=true,name=sorting"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*MetersListRequest) GetIsArchived added in v0.8.4

func (m *MetersListRequest) GetIsArchived() *bool

func (*MetersListRequest) GetLimit added in v0.1.8

func (m *MetersListRequest) GetLimit() *int64

func (*MetersListRequest) GetMetadata added in v0.1.8

func (m *MetersListRequest) GetMetadata() map[string]components.MetadataQuery

func (*MetersListRequest) GetOrganizationID added in v0.1.8

func (*MetersListRequest) GetPage added in v0.1.8

func (m *MetersListRequest) GetPage() *int64

func (*MetersListRequest) GetQuery added in v0.1.8

func (m *MetersListRequest) GetQuery() *string

func (*MetersListRequest) GetSorting added in v0.1.8

func (MetersListRequest) MarshalJSON added in v0.1.8

func (m MetersListRequest) MarshalJSON() ([]byte, error)

func (*MetersListRequest) UnmarshalJSON added in v0.1.8

func (m *MetersListRequest) UnmarshalJSON(data []byte) error

type MetersListResponse added in v0.1.8

type MetersListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceMeter *components.ListResourceMeter

	Next func() (*MetersListResponse, error)
}

func (*MetersListResponse) GetHTTPMeta added in v0.1.8

func (m *MetersListResponse) GetHTTPMeta() components.HTTPMetadata

func (*MetersListResponse) GetListResourceMeter added in v0.1.8

func (m *MetersListResponse) GetListResourceMeter() *components.ListResourceMeter

type MetersQuantitiesQueryParamCustomerIDFilter added in v0.1.8

type MetersQuantitiesQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MetersQuantitiesQueryParamCustomerIDFilterType
}

MetersQuantitiesQueryParamCustomerIDFilter - Filter by customer ID.

func CreateMetersQuantitiesQueryParamCustomerIDFilterArrayOfStr added in v0.1.8

func CreateMetersQuantitiesQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) MetersQuantitiesQueryParamCustomerIDFilter

func CreateMetersQuantitiesQueryParamCustomerIDFilterStr added in v0.1.8

func CreateMetersQuantitiesQueryParamCustomerIDFilterStr(str string) MetersQuantitiesQueryParamCustomerIDFilter

func (MetersQuantitiesQueryParamCustomerIDFilter) MarshalJSON added in v0.1.8

func (*MetersQuantitiesQueryParamCustomerIDFilter) UnmarshalJSON added in v0.1.8

func (u *MetersQuantitiesQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type MetersQuantitiesQueryParamCustomerIDFilterType added in v0.1.8

type MetersQuantitiesQueryParamCustomerIDFilterType string
const (
	MetersQuantitiesQueryParamCustomerIDFilterTypeStr        MetersQuantitiesQueryParamCustomerIDFilterType = "str"
	MetersQuantitiesQueryParamCustomerIDFilterTypeArrayOfStr MetersQuantitiesQueryParamCustomerIDFilterType = "arrayOfStr"
)

type MetersQuantitiesQueryParamExternalCustomerIDFilter added in v0.4.10

type MetersQuantitiesQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MetersQuantitiesQueryParamExternalCustomerIDFilterType
}

MetersQuantitiesQueryParamExternalCustomerIDFilter - Filter by external customer ID.

func CreateMetersQuantitiesQueryParamExternalCustomerIDFilterArrayOfStr added in v0.4.10

func CreateMetersQuantitiesQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) MetersQuantitiesQueryParamExternalCustomerIDFilter

func CreateMetersQuantitiesQueryParamExternalCustomerIDFilterStr added in v0.4.10

func CreateMetersQuantitiesQueryParamExternalCustomerIDFilterStr(str string) MetersQuantitiesQueryParamExternalCustomerIDFilter

func (MetersQuantitiesQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.4.10

func (*MetersQuantitiesQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.4.10

type MetersQuantitiesQueryParamExternalCustomerIDFilterType added in v0.4.10

type MetersQuantitiesQueryParamExternalCustomerIDFilterType string
const (
	MetersQuantitiesQueryParamExternalCustomerIDFilterTypeStr        MetersQuantitiesQueryParamExternalCustomerIDFilterType = "str"
	MetersQuantitiesQueryParamExternalCustomerIDFilterTypeArrayOfStr MetersQuantitiesQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type MetersQuantitiesRequest added in v0.1.8

type MetersQuantitiesRequest struct {
	// The meter ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
	// Start timestamp.
	StartTimestamp time.Time `queryParam:"style=form,explode=true,name=start_timestamp"`
	// End timestamp.
	EndTimestamp time.Time `queryParam:"style=form,explode=true,name=end_timestamp"`
	// Interval between two timestamps.
	Interval components.TimeInterval `queryParam:"style=form,explode=true,name=interval"`
	// Timezone to use for the timestamps. Default is UTC.
	Timezone *string `default:"UTC" queryParam:"style=form,explode=true,name=timezone"`
	// Filter by customer ID.
	CustomerID *MetersQuantitiesQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by external customer ID.
	ExternalCustomerID *MetersQuantitiesQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// If set, will first compute the quantities per customer before aggregating them using the given function. If not set, the quantities will be aggregated across all events.
	CustomerAggregationFunction *components.AggregationFunction `queryParam:"style=form,explode=true,name=customer_aggregation_function"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*MetersQuantitiesRequest) GetCustomerAggregationFunction added in v0.9.2

func (m *MetersQuantitiesRequest) GetCustomerAggregationFunction() *components.AggregationFunction

func (*MetersQuantitiesRequest) GetCustomerID added in v0.1.8

func (*MetersQuantitiesRequest) GetEndTimestamp added in v0.1.8

func (m *MetersQuantitiesRequest) GetEndTimestamp() time.Time

func (*MetersQuantitiesRequest) GetExternalCustomerID added in v0.4.1

func (*MetersQuantitiesRequest) GetID added in v0.1.8

func (m *MetersQuantitiesRequest) GetID() string

func (*MetersQuantitiesRequest) GetInterval added in v0.1.8

func (*MetersQuantitiesRequest) GetMetadata added in v0.7.1

func (*MetersQuantitiesRequest) GetStartTimestamp added in v0.1.8

func (m *MetersQuantitiesRequest) GetStartTimestamp() time.Time

func (*MetersQuantitiesRequest) GetTimezone added in v0.13.0

func (m *MetersQuantitiesRequest) GetTimezone() *string

func (MetersQuantitiesRequest) MarshalJSON added in v0.1.8

func (m MetersQuantitiesRequest) MarshalJSON() ([]byte, error)

func (*MetersQuantitiesRequest) UnmarshalJSON added in v0.1.8

func (m *MetersQuantitiesRequest) UnmarshalJSON(data []byte) error

type MetersQuantitiesResponse added in v0.1.8

type MetersQuantitiesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	MeterQuantities *components.MeterQuantities
}

func (*MetersQuantitiesResponse) GetHTTPMeta added in v0.1.8

func (*MetersQuantitiesResponse) GetMeterQuantities added in v0.1.8

func (m *MetersQuantitiesResponse) GetMeterQuantities() *components.MeterQuantities

type MetersUpdateRequest added in v0.1.8

type MetersUpdateRequest struct {
	// The meter ID.
	ID          string                 `pathParam:"style=simple,explode=false,name=id"`
	MeterUpdate components.MeterUpdate `request:"mediaType=application/json"`
}

func (*MetersUpdateRequest) GetID added in v0.1.8

func (m *MetersUpdateRequest) GetID() string

func (*MetersUpdateRequest) GetMeterUpdate added in v0.1.8

func (m *MetersUpdateRequest) GetMeterUpdate() components.MeterUpdate

type MetersUpdateResponse added in v0.1.8

type MetersUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Meter updated.
	Meter *components.Meter
}

func (*MetersUpdateResponse) GetHTTPMeta added in v0.1.8

func (m *MetersUpdateResponse) GetHTTPMeta() components.HTTPMetadata

func (*MetersUpdateResponse) GetMeter added in v0.1.8

func (m *MetersUpdateResponse) GetMeter() *components.Meter

type MethodFilter added in v0.4.17

type MethodFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MethodFilterType
}

MethodFilter - Filter by payment method.

func CreateMethodFilterArrayOfStr added in v0.4.17

func CreateMethodFilterArrayOfStr(arrayOfStr []string) MethodFilter

func CreateMethodFilterStr added in v0.4.17

func CreateMethodFilterStr(str string) MethodFilter

func (MethodFilter) MarshalJSON added in v0.4.17

func (u MethodFilter) MarshalJSON() ([]byte, error)

func (*MethodFilter) UnmarshalJSON added in v0.4.17

func (u *MethodFilter) UnmarshalJSON(data []byte) error

type MethodFilterType added in v0.4.17

type MethodFilterType string
const (
	MethodFilterTypeStr        MethodFilterType = "str"
	MethodFilterTypeArrayOfStr MethodFilterType = "arrayOfStr"
)

type MetricsCreateDashboardResponse added in v0.16.0

type MetricsCreateDashboardResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	MetricDashboardSchema *components.MetricDashboardSchema
}

func (*MetricsCreateDashboardResponse) GetHTTPMeta added in v0.16.0

func (*MetricsCreateDashboardResponse) GetMetricDashboardSchema added in v0.16.0

func (m *MetricsCreateDashboardResponse) GetMetricDashboardSchema() *components.MetricDashboardSchema

type MetricsDeleteDashboardRequest added in v0.16.0

type MetricsDeleteDashboardRequest struct {
	// The metric dashboard ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*MetricsDeleteDashboardRequest) GetID added in v0.16.0

type MetricsDeleteDashboardResponse added in v0.16.0

type MetricsDeleteDashboardResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*MetricsDeleteDashboardResponse) GetHTTPMeta added in v0.16.0

type MetricsGetDashboardRequest added in v0.16.0

type MetricsGetDashboardRequest struct {
	// The metric dashboard ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*MetricsGetDashboardRequest) GetID added in v0.16.0

type MetricsGetDashboardResponse added in v0.16.0

type MetricsGetDashboardResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	MetricDashboardSchema *components.MetricDashboardSchema
}

func (*MetricsGetDashboardResponse) GetHTTPMeta added in v0.16.0

func (*MetricsGetDashboardResponse) GetMetricDashboardSchema added in v0.16.0

func (m *MetricsGetDashboardResponse) GetMetricDashboardSchema() *components.MetricDashboardSchema

type MetricsGetQueryParamCustomerIDFilter added in v0.1.5

type MetricsGetQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MetricsGetQueryParamCustomerIDFilterType
}

MetricsGetQueryParamCustomerIDFilter - Filter by customer ID.

func CreateMetricsGetQueryParamCustomerIDFilterArrayOfStr added in v0.1.5

func CreateMetricsGetQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) MetricsGetQueryParamCustomerIDFilter

func CreateMetricsGetQueryParamCustomerIDFilterStr added in v0.1.5

func CreateMetricsGetQueryParamCustomerIDFilterStr(str string) MetricsGetQueryParamCustomerIDFilter

func (MetricsGetQueryParamCustomerIDFilter) MarshalJSON added in v0.1.5

func (u MetricsGetQueryParamCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*MetricsGetQueryParamCustomerIDFilter) UnmarshalJSON added in v0.1.5

func (u *MetricsGetQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type MetricsGetQueryParamCustomerIDFilterType added in v0.1.5

type MetricsGetQueryParamCustomerIDFilterType string
const (
	MetricsGetQueryParamCustomerIDFilterTypeStr        MetricsGetQueryParamCustomerIDFilterType = "str"
	MetricsGetQueryParamCustomerIDFilterTypeArrayOfStr MetricsGetQueryParamCustomerIDFilterType = "arrayOfStr"
)

type MetricsGetQueryParamOrganizationIDFilter

type MetricsGetQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MetricsGetQueryParamOrganizationIDFilterType
}

MetricsGetQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateMetricsGetQueryParamOrganizationIDFilterArrayOfStr

func CreateMetricsGetQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) MetricsGetQueryParamOrganizationIDFilter

func CreateMetricsGetQueryParamOrganizationIDFilterStr

func CreateMetricsGetQueryParamOrganizationIDFilterStr(str string) MetricsGetQueryParamOrganizationIDFilter

func (MetricsGetQueryParamOrganizationIDFilter) MarshalJSON

func (*MetricsGetQueryParamOrganizationIDFilter) UnmarshalJSON

func (u *MetricsGetQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type MetricsGetQueryParamOrganizationIDFilterType

type MetricsGetQueryParamOrganizationIDFilterType string
const (
	MetricsGetQueryParamOrganizationIDFilterTypeStr        MetricsGetQueryParamOrganizationIDFilterType = "str"
	MetricsGetQueryParamOrganizationIDFilterTypeArrayOfStr MetricsGetQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type MetricsGetQueryParamProductIDFilter

type MetricsGetQueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MetricsGetQueryParamProductIDFilterType
}

MetricsGetQueryParamProductIDFilter - Filter by product ID.

func CreateMetricsGetQueryParamProductIDFilterArrayOfStr

func CreateMetricsGetQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) MetricsGetQueryParamProductIDFilter

func CreateMetricsGetQueryParamProductIDFilterStr

func CreateMetricsGetQueryParamProductIDFilterStr(str string) MetricsGetQueryParamProductIDFilter

func (MetricsGetQueryParamProductIDFilter) MarshalJSON

func (u MetricsGetQueryParamProductIDFilter) MarshalJSON() ([]byte, error)

func (*MetricsGetQueryParamProductIDFilter) UnmarshalJSON

func (u *MetricsGetQueryParamProductIDFilter) UnmarshalJSON(data []byte) error

type MetricsGetQueryParamProductIDFilterType

type MetricsGetQueryParamProductIDFilterType string
const (
	MetricsGetQueryParamProductIDFilterTypeStr        MetricsGetQueryParamProductIDFilterType = "str"
	MetricsGetQueryParamProductIDFilterTypeArrayOfStr MetricsGetQueryParamProductIDFilterType = "arrayOfStr"
)

type MetricsGetRequest

type MetricsGetRequest struct {
	// Start date.
	StartDate types.Date `queryParam:"style=form,explode=true,name=start_date"`
	// End date.
	EndDate types.Date `queryParam:"style=form,explode=true,name=end_date"`
	// Timezone to use for the timestamps. Default is UTC.
	Timezone *string `default:"UTC" queryParam:"style=form,explode=true,name=timezone"`
	// Interval between two timestamps.
	Interval components.TimeInterval `queryParam:"style=form,explode=true,name=interval"`
	// Filter by organization ID.
	OrganizationID *MetricsGetQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by product ID.
	ProductID *MetricsGetQueryParamProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
	// Filter by billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
	BillingType *QueryParamProductBillingTypeFilter `queryParam:"style=form,explode=true,name=billing_type"`
	// Filter by customer ID.
	CustomerID *MetricsGetQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// List of metric slugs to focus on. When provided, only the queries needed for these metrics will be executed, improving performance. If not provided, all metrics are returned.
	Metrics []string `queryParam:"style=form,explode=true,name=metrics"`
}

func (*MetricsGetRequest) GetBillingType added in v0.3.0

func (*MetricsGetRequest) GetCustomerID added in v0.1.5

func (*MetricsGetRequest) GetEndDate

func (m *MetricsGetRequest) GetEndDate() types.Date

func (*MetricsGetRequest) GetInterval

func (m *MetricsGetRequest) GetInterval() components.TimeInterval

func (*MetricsGetRequest) GetMetrics added in v0.13.0

func (m *MetricsGetRequest) GetMetrics() []string

func (*MetricsGetRequest) GetOrganizationID

func (*MetricsGetRequest) GetProductID

func (*MetricsGetRequest) GetStartDate

func (m *MetricsGetRequest) GetStartDate() types.Date

func (*MetricsGetRequest) GetTimezone added in v0.7.2

func (m *MetricsGetRequest) GetTimezone() *string

func (MetricsGetRequest) MarshalJSON

func (m MetricsGetRequest) MarshalJSON() ([]byte, error)

func (*MetricsGetRequest) UnmarshalJSON

func (m *MetricsGetRequest) UnmarshalJSON(data []byte) error

type MetricsGetResponse

type MetricsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	MetricsResponse *components.MetricsResponse
}

func (*MetricsGetResponse) GetHTTPMeta

func (m *MetricsGetResponse) GetHTTPMeta() components.HTTPMetadata

func (*MetricsGetResponse) GetMetricsResponse

func (m *MetricsGetResponse) GetMetricsResponse() *components.MetricsResponse

type MetricsLimitsResponse

type MetricsLimitsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	MetricsLimits *components.MetricsLimits
}

func (*MetricsLimitsResponse) GetHTTPMeta

func (*MetricsLimitsResponse) GetMetricsLimits

func (m *MetricsLimitsResponse) GetMetricsLimits() *components.MetricsLimits

type MetricsListDashboardsQueryParamOrganizationIDFilter added in v0.16.0

type MetricsListDashboardsQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type MetricsListDashboardsQueryParamOrganizationIDFilterType
}

MetricsListDashboardsQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateMetricsListDashboardsQueryParamOrganizationIDFilterArrayOfStr added in v0.16.0

func CreateMetricsListDashboardsQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) MetricsListDashboardsQueryParamOrganizationIDFilter

func CreateMetricsListDashboardsQueryParamOrganizationIDFilterStr added in v0.16.0

func CreateMetricsListDashboardsQueryParamOrganizationIDFilterStr(str string) MetricsListDashboardsQueryParamOrganizationIDFilter

func (MetricsListDashboardsQueryParamOrganizationIDFilter) MarshalJSON added in v0.16.0

func (*MetricsListDashboardsQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.16.0

type MetricsListDashboardsQueryParamOrganizationIDFilterType added in v0.16.0

type MetricsListDashboardsQueryParamOrganizationIDFilterType string
const (
	MetricsListDashboardsQueryParamOrganizationIDFilterTypeStr        MetricsListDashboardsQueryParamOrganizationIDFilterType = "str"
	MetricsListDashboardsQueryParamOrganizationIDFilterTypeArrayOfStr MetricsListDashboardsQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type MetricsListDashboardsRequest added in v0.16.0

type MetricsListDashboardsRequest struct {
	// Filter by organization ID.
	OrganizationID *MetricsListDashboardsQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
}

func (*MetricsListDashboardsRequest) GetOrganizationID added in v0.16.0

type MetricsListDashboardsResponse added in v0.16.0

type MetricsListDashboardsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ResponseMetricsListDashboards []components.MetricDashboardSchema
}

func (*MetricsListDashboardsResponse) GetHTTPMeta added in v0.16.0

func (*MetricsListDashboardsResponse) GetResponseMetricsListDashboards added in v0.16.0

func (m *MetricsListDashboardsResponse) GetResponseMetricsListDashboards() []components.MetricDashboardSchema

type MetricsUpdateDashboardRequest added in v0.16.0

type MetricsUpdateDashboardRequest struct {
	// The metric dashboard ID.
	ID                    string                           `pathParam:"style=simple,explode=false,name=id"`
	MetricDashboardUpdate components.MetricDashboardUpdate `request:"mediaType=application/json"`
}

func (*MetricsUpdateDashboardRequest) GetID added in v0.16.0

func (*MetricsUpdateDashboardRequest) GetMetricDashboardUpdate added in v0.16.0

func (m *MetricsUpdateDashboardRequest) GetMetricDashboardUpdate() components.MetricDashboardUpdate

type MetricsUpdateDashboardResponse added in v0.16.0

type MetricsUpdateDashboardResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	MetricDashboardSchema *components.MetricDashboardSchema
}

func (*MetricsUpdateDashboardResponse) GetHTTPMeta added in v0.16.0

func (*MetricsUpdateDashboardResponse) GetMetricDashboardSchema added in v0.16.0

func (m *MetricsUpdateDashboardResponse) GetMetricDashboardSchema() *components.MetricDashboardSchema

type NameFilter added in v0.4.10

type NameFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type NameFilterType
}

NameFilter - Filter by event name.

func CreateNameFilterArrayOfStr added in v0.4.10

func CreateNameFilterArrayOfStr(arrayOfStr []string) NameFilter

func CreateNameFilterStr added in v0.4.10

func CreateNameFilterStr(str string) NameFilter

func (NameFilter) MarshalJSON added in v0.4.10

func (u NameFilter) MarshalJSON() ([]byte, error)

func (*NameFilter) UnmarshalJSON added in v0.4.10

func (u *NameFilter) UnmarshalJSON(data []byte) error

type NameFilterType added in v0.4.10

type NameFilterType string
const (
	NameFilterTypeStr        NameFilterType = "str"
	NameFilterTypeArrayOfStr NameFilterType = "arrayOfStr"
)

type Oauth2AuthorizeResponse

type Oauth2AuthorizeResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ResponseOauth2Authorize *Oauth2AuthorizeResponseOauth2Authorize
}

func (*Oauth2AuthorizeResponse) GetHTTPMeta

func (*Oauth2AuthorizeResponse) GetResponseOauth2Authorize

func (o *Oauth2AuthorizeResponse) GetResponseOauth2Authorize() *Oauth2AuthorizeResponseOauth2Authorize

func (*Oauth2AuthorizeResponse) GetResponseOauth2AuthorizeOrganization

func (o *Oauth2AuthorizeResponse) GetResponseOauth2AuthorizeOrganization() *components.AuthorizeResponseOrganization

func (*Oauth2AuthorizeResponse) GetResponseOauth2AuthorizeUser

func (o *Oauth2AuthorizeResponse) GetResponseOauth2AuthorizeUser() *components.AuthorizeResponseUser

type Oauth2AuthorizeResponseOauth2Authorize

type Oauth2AuthorizeResponseOauth2Authorize struct {
	AuthorizeResponseUser         *components.AuthorizeResponseUser         `queryParam:"inline" union:"member"`
	AuthorizeResponseOrganization *components.AuthorizeResponseOrganization `queryParam:"inline" union:"member"`

	Type Oauth2AuthorizeResponseOauth2AuthorizeType
}

Oauth2AuthorizeResponseOauth2Authorize - Successful Response

func (Oauth2AuthorizeResponseOauth2Authorize) MarshalJSON

func (u Oauth2AuthorizeResponseOauth2Authorize) MarshalJSON() ([]byte, error)

func (*Oauth2AuthorizeResponseOauth2Authorize) UnmarshalJSON

func (u *Oauth2AuthorizeResponseOauth2Authorize) UnmarshalJSON(data []byte) error

type Oauth2AuthorizeResponseOauth2AuthorizeType

type Oauth2AuthorizeResponseOauth2AuthorizeType string
const (
	Oauth2AuthorizeResponseOauth2AuthorizeTypeUser         Oauth2AuthorizeResponseOauth2AuthorizeType = "user"
	Oauth2AuthorizeResponseOauth2AuthorizeTypeOrganization Oauth2AuthorizeResponseOauth2AuthorizeType = "organization"
)

type Oauth2ClientsOauth2CreateClientResponse

type Oauth2ClientsOauth2CreateClientResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
}

func (*Oauth2ClientsOauth2CreateClientResponse) GetAny

func (*Oauth2ClientsOauth2CreateClientResponse) GetHTTPMeta

type Oauth2ClientsOauth2DeleteClientRequest

type Oauth2ClientsOauth2DeleteClientRequest struct {
	ClientID string `pathParam:"style=simple,explode=false,name=client_id"`
}

func (*Oauth2ClientsOauth2DeleteClientRequest) GetClientID

type Oauth2ClientsOauth2DeleteClientResponse

type Oauth2ClientsOauth2DeleteClientResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
}

func (*Oauth2ClientsOauth2DeleteClientResponse) GetAny

func (*Oauth2ClientsOauth2DeleteClientResponse) GetHTTPMeta

type Oauth2ClientsOauth2GetClientRequest

type Oauth2ClientsOauth2GetClientRequest struct {
	ClientID string `pathParam:"style=simple,explode=false,name=client_id"`
}

func (*Oauth2ClientsOauth2GetClientRequest) GetClientID

type Oauth2ClientsOauth2GetClientResponse

type Oauth2ClientsOauth2GetClientResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
}

func (*Oauth2ClientsOauth2GetClientResponse) GetAny

func (*Oauth2ClientsOauth2GetClientResponse) GetHTTPMeta

type Oauth2ClientsOauth2UpdateClientRequest

type Oauth2ClientsOauth2UpdateClientRequest struct {
	ClientID                        string                                     `pathParam:"style=simple,explode=false,name=client_id"`
	OAuth2ClientConfigurationUpdate components.OAuth2ClientConfigurationUpdate `request:"mediaType=application/json"`
}

func (*Oauth2ClientsOauth2UpdateClientRequest) GetClientID

func (*Oauth2ClientsOauth2UpdateClientRequest) GetOAuth2ClientConfigurationUpdate

type Oauth2ClientsOauth2UpdateClientResponse

type Oauth2ClientsOauth2UpdateClientResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
}

func (*Oauth2ClientsOauth2UpdateClientResponse) GetAny

func (*Oauth2ClientsOauth2UpdateClientResponse) GetHTTPMeta

type Oauth2IntrospectTokenResponse

type Oauth2IntrospectTokenResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	IntrospectTokenResponse *components.IntrospectTokenResponse
}

func (*Oauth2IntrospectTokenResponse) GetHTTPMeta

func (*Oauth2IntrospectTokenResponse) GetIntrospectTokenResponse

func (o *Oauth2IntrospectTokenResponse) GetIntrospectTokenResponse() *components.IntrospectTokenResponse

type Oauth2RequestTokenRequestBody

type Oauth2RequestTokenRequestBody struct {
	AuthorizationCodeTokenRequest *components.AuthorizationCodeTokenRequest `queryParam:"inline" union:"member"`
	RefreshTokenRequest           *components.RefreshTokenRequest           `queryParam:"inline" union:"member"`
	WebTokenRequest               *components.WebTokenRequest               `queryParam:"inline" union:"member"`

	Type Oauth2RequestTokenRequestBodyType
}

func CreateOauth2RequestTokenRequestBodyAuthorizationCodeTokenRequest added in v0.3.0

func CreateOauth2RequestTokenRequestBodyAuthorizationCodeTokenRequest(authorizationCodeTokenRequest components.AuthorizationCodeTokenRequest) Oauth2RequestTokenRequestBody

func CreateOauth2RequestTokenRequestBodyRefreshTokenRequest added in v0.3.0

func CreateOauth2RequestTokenRequestBodyRefreshTokenRequest(refreshTokenRequest components.RefreshTokenRequest) Oauth2RequestTokenRequestBody

func CreateOauth2RequestTokenRequestBodyWebTokenRequest added in v0.10.1

func CreateOauth2RequestTokenRequestBodyWebTokenRequest(webTokenRequest components.WebTokenRequest) Oauth2RequestTokenRequestBody

func (Oauth2RequestTokenRequestBody) MarshalJSON

func (u Oauth2RequestTokenRequestBody) MarshalJSON() ([]byte, error)

func (*Oauth2RequestTokenRequestBody) UnmarshalJSON

func (u *Oauth2RequestTokenRequestBody) UnmarshalJSON(data []byte) error

type Oauth2RequestTokenRequestBodyType

type Oauth2RequestTokenRequestBodyType string
const (
	Oauth2RequestTokenRequestBodyTypeAuthorizationCodeTokenRequest Oauth2RequestTokenRequestBodyType = "AuthorizationCodeTokenRequest"
	Oauth2RequestTokenRequestBodyTypeRefreshTokenRequest           Oauth2RequestTokenRequestBodyType = "RefreshTokenRequest"
	Oauth2RequestTokenRequestBodyTypeWebTokenRequest               Oauth2RequestTokenRequestBodyType = "WebTokenRequest"
)

type Oauth2RequestTokenResponse

type Oauth2RequestTokenResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	TokenResponse *components.TokenResponse
}

func (*Oauth2RequestTokenResponse) GetHTTPMeta

func (*Oauth2RequestTokenResponse) GetTokenResponse

func (o *Oauth2RequestTokenResponse) GetTokenResponse() *components.TokenResponse

type Oauth2RevokeTokenResponse

type Oauth2RevokeTokenResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	RevokeTokenResponse *components.RevokeTokenResponse
}

func (*Oauth2RevokeTokenResponse) GetHTTPMeta

func (*Oauth2RevokeTokenResponse) GetRevokeTokenResponse

func (o *Oauth2RevokeTokenResponse) GetRevokeTokenResponse() *components.RevokeTokenResponse

type Oauth2UserinfoResponse

type Oauth2UserinfoResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ResponseOauth2Userinfo *Oauth2UserinfoResponseOauth2Userinfo
}

func (*Oauth2UserinfoResponse) GetHTTPMeta

func (*Oauth2UserinfoResponse) GetResponseOauth2Userinfo

func (o *Oauth2UserinfoResponse) GetResponseOauth2Userinfo() *Oauth2UserinfoResponseOauth2Userinfo

type Oauth2UserinfoResponseOauth2Userinfo

type Oauth2UserinfoResponseOauth2Userinfo struct {
	UserInfoUser         *components.UserInfoUser         `queryParam:"inline" union:"member"`
	UserInfoOrganization *components.UserInfoOrganization `queryParam:"inline" union:"member"`

	Type Oauth2UserinfoResponseOauth2UserinfoType
}

Oauth2UserinfoResponseOauth2Userinfo - Successful Response

func CreateOauth2UserinfoResponseOauth2UserinfoUserInfoOrganization

func CreateOauth2UserinfoResponseOauth2UserinfoUserInfoOrganization(userInfoOrganization components.UserInfoOrganization) Oauth2UserinfoResponseOauth2Userinfo

func CreateOauth2UserinfoResponseOauth2UserinfoUserInfoUser

func CreateOauth2UserinfoResponseOauth2UserinfoUserInfoUser(userInfoUser components.UserInfoUser) Oauth2UserinfoResponseOauth2Userinfo

func (Oauth2UserinfoResponseOauth2Userinfo) MarshalJSON

func (u Oauth2UserinfoResponseOauth2Userinfo) MarshalJSON() ([]byte, error)

func (*Oauth2UserinfoResponseOauth2Userinfo) UnmarshalJSON

func (u *Oauth2UserinfoResponseOauth2Userinfo) UnmarshalJSON(data []byte) error

type Oauth2UserinfoResponseOauth2UserinfoType

type Oauth2UserinfoResponseOauth2UserinfoType string
const (
	Oauth2UserinfoResponseOauth2UserinfoTypeUserInfoUser         Oauth2UserinfoResponseOauth2UserinfoType = "UserInfoUser"
	Oauth2UserinfoResponseOauth2UserinfoTypeUserInfoOrganization Oauth2UserinfoResponseOauth2UserinfoType = "UserInfoOrganization"
)

type Option

type Option func(*Options, ...string) error

func WithAcceptHeaderOverride added in v0.13.0

func WithAcceptHeaderOverride(acceptHeaderOverride AcceptHeaderEnum) Option

func WithOperationTimeout

func WithOperationTimeout(timeout time.Duration) Option

WithOperationTimeout allows setting the request timeout applied for an operation.

func WithRetries

func WithRetries(config retry.Config) Option

WithRetries allows customizing the default retry configuration.

func WithServerURL

func WithServerURL(serverURL string) Option

WithServerURL allows providing an alternative server URL.

func WithSetHeaders

func WithSetHeaders(hdrs map[string]string) Option

WithSetHeaders takes a map of headers that will applied to a request. If the request contains headers that are in the map then they will be overwritten.

func WithTemplatedServerURL

func WithTemplatedServerURL(serverURL string, params map[string]string) Option

WithTemplatedServerURL allows providing an alternative server URL with templated parameters.

func WithURLOverride

func WithURLOverride(urlOverride string) Option

WithURLOverride allows overriding the URL.

type Options

type Options struct {
	ServerURL            *string
	Retries              *retry.Config
	Timeout              *time.Duration
	AcceptHeaderOverride *AcceptHeaderEnum
	URLOverride          *string
	SetHeaders           map[string]string
}

type OrderIDFilter

type OrderIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrderIDFilterType
}

OrderIDFilter - Filter by order ID.

func CreateOrderIDFilterArrayOfStr

func CreateOrderIDFilterArrayOfStr(arrayOfStr []string) OrderIDFilter

func CreateOrderIDFilterStr

func CreateOrderIDFilterStr(str string) OrderIDFilter

func (OrderIDFilter) MarshalJSON

func (u OrderIDFilter) MarshalJSON() ([]byte, error)

func (*OrderIDFilter) UnmarshalJSON

func (u *OrderIDFilter) UnmarshalJSON(data []byte) error

type OrderIDFilterType

type OrderIDFilterType string
const (
	OrderIDFilterTypeStr        OrderIDFilterType = "str"
	OrderIDFilterTypeArrayOfStr OrderIDFilterType = "arrayOfStr"
)

type OrdersExportQueryParamOrganizationIDFilter added in v0.12.0

type OrdersExportQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrdersExportQueryParamOrganizationIDFilterType
}

OrdersExportQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateOrdersExportQueryParamOrganizationIDFilterArrayOfStr added in v0.12.0

func CreateOrdersExportQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) OrdersExportQueryParamOrganizationIDFilter

func CreateOrdersExportQueryParamOrganizationIDFilterStr added in v0.12.0

func CreateOrdersExportQueryParamOrganizationIDFilterStr(str string) OrdersExportQueryParamOrganizationIDFilter

func (OrdersExportQueryParamOrganizationIDFilter) MarshalJSON added in v0.12.0

func (*OrdersExportQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.12.0

func (u *OrdersExportQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type OrdersExportQueryParamOrganizationIDFilterType added in v0.12.0

type OrdersExportQueryParamOrganizationIDFilterType string
const (
	OrdersExportQueryParamOrganizationIDFilterTypeStr        OrdersExportQueryParamOrganizationIDFilterType = "str"
	OrdersExportQueryParamOrganizationIDFilterTypeArrayOfStr OrdersExportQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type OrdersExportQueryParamProductIDFilter added in v0.12.0

type OrdersExportQueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrdersExportQueryParamProductIDFilterType
}

OrdersExportQueryParamProductIDFilter - Filter by product ID.

func CreateOrdersExportQueryParamProductIDFilterArrayOfStr added in v0.12.0

func CreateOrdersExportQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) OrdersExportQueryParamProductIDFilter

func CreateOrdersExportQueryParamProductIDFilterStr added in v0.12.0

func CreateOrdersExportQueryParamProductIDFilterStr(str string) OrdersExportQueryParamProductIDFilter

func (OrdersExportQueryParamProductIDFilter) MarshalJSON added in v0.12.0

func (u OrdersExportQueryParamProductIDFilter) MarshalJSON() ([]byte, error)

func (*OrdersExportQueryParamProductIDFilter) UnmarshalJSON added in v0.12.0

func (u *OrdersExportQueryParamProductIDFilter) UnmarshalJSON(data []byte) error

type OrdersExportQueryParamProductIDFilterType added in v0.12.0

type OrdersExportQueryParamProductIDFilterType string
const (
	OrdersExportQueryParamProductIDFilterTypeStr        OrdersExportQueryParamProductIDFilterType = "str"
	OrdersExportQueryParamProductIDFilterTypeArrayOfStr OrdersExportQueryParamProductIDFilterType = "arrayOfStr"
)

type OrdersExportRequest added in v0.12.0

type OrdersExportRequest struct {
	// Filter by organization ID.
	OrganizationID *OrdersExportQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by product ID.
	ProductID *OrdersExportQueryParamProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
}

func (*OrdersExportRequest) GetOrganizationID added in v0.12.0

func (*OrdersExportRequest) GetProductID added in v0.12.0

type OrdersExportResponse added in v0.12.0

type OrdersExportResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
	// Successful Response
	Res *string
}

func (*OrdersExportResponse) GetAny added in v0.12.0

func (o *OrdersExportResponse) GetAny() any

func (*OrdersExportResponse) GetHTTPMeta added in v0.12.0

func (o *OrdersExportResponse) GetHTTPMeta() components.HTTPMetadata

func (*OrdersExportResponse) GetRes added in v0.13.0

func (o *OrdersExportResponse) GetRes() *string

type OrdersGenerateInvoiceRequest added in v0.5.0

type OrdersGenerateInvoiceRequest struct {
	// The order ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*OrdersGenerateInvoiceRequest) GetID added in v0.5.0

type OrdersGenerateInvoiceResponse added in v0.5.0

type OrdersGenerateInvoiceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
}

func (*OrdersGenerateInvoiceResponse) GetAny added in v0.5.0

func (o *OrdersGenerateInvoiceResponse) GetAny() any

func (*OrdersGenerateInvoiceResponse) GetHTTPMeta added in v0.5.0

type OrdersGetRequest

type OrdersGetRequest struct {
	// The order ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*OrdersGetRequest) GetID

func (o *OrdersGetRequest) GetID() string

type OrdersGetResponse

type OrdersGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Order *components.Order
}

func (*OrdersGetResponse) GetHTTPMeta

func (o *OrdersGetResponse) GetHTTPMeta() components.HTTPMetadata

func (*OrdersGetResponse) GetOrder

func (o *OrdersGetResponse) GetOrder() *components.Order

type OrdersInvoiceRequest

type OrdersInvoiceRequest struct {
	// The order ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*OrdersInvoiceRequest) GetID

func (o *OrdersInvoiceRequest) GetID() string

type OrdersInvoiceResponse

type OrdersInvoiceResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	OrderInvoice *components.OrderInvoice
}

func (*OrdersInvoiceResponse) GetHTTPMeta

func (*OrdersInvoiceResponse) GetOrderInvoice

func (o *OrdersInvoiceResponse) GetOrderInvoice() *components.OrderInvoice

type OrdersListQueryParamCustomerIDFilter

type OrdersListQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrdersListQueryParamCustomerIDFilterType
}

OrdersListQueryParamCustomerIDFilter - Filter by customer ID.

func CreateOrdersListQueryParamCustomerIDFilterArrayOfStr

func CreateOrdersListQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) OrdersListQueryParamCustomerIDFilter

func CreateOrdersListQueryParamCustomerIDFilterStr

func CreateOrdersListQueryParamCustomerIDFilterStr(str string) OrdersListQueryParamCustomerIDFilter

func (OrdersListQueryParamCustomerIDFilter) MarshalJSON

func (u OrdersListQueryParamCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*OrdersListQueryParamCustomerIDFilter) UnmarshalJSON

func (u *OrdersListQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type OrdersListQueryParamCustomerIDFilterType

type OrdersListQueryParamCustomerIDFilterType string
const (
	OrdersListQueryParamCustomerIDFilterTypeStr        OrdersListQueryParamCustomerIDFilterType = "str"
	OrdersListQueryParamCustomerIDFilterTypeArrayOfStr OrdersListQueryParamCustomerIDFilterType = "arrayOfStr"
)

type OrdersListQueryParamExternalCustomerIDFilter added in v0.13.0

type OrdersListQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrdersListQueryParamExternalCustomerIDFilterType
}

OrdersListQueryParamExternalCustomerIDFilter - Filter by customer external ID.

func CreateOrdersListQueryParamExternalCustomerIDFilterArrayOfStr added in v0.13.0

func CreateOrdersListQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) OrdersListQueryParamExternalCustomerIDFilter

func CreateOrdersListQueryParamExternalCustomerIDFilterStr added in v0.13.0

func CreateOrdersListQueryParamExternalCustomerIDFilterStr(str string) OrdersListQueryParamExternalCustomerIDFilter

func (OrdersListQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.13.0

func (*OrdersListQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.13.0

func (u *OrdersListQueryParamExternalCustomerIDFilter) UnmarshalJSON(data []byte) error

type OrdersListQueryParamExternalCustomerIDFilterType added in v0.13.0

type OrdersListQueryParamExternalCustomerIDFilterType string
const (
	OrdersListQueryParamExternalCustomerIDFilterTypeStr        OrdersListQueryParamExternalCustomerIDFilterType = "str"
	OrdersListQueryParamExternalCustomerIDFilterTypeArrayOfStr OrdersListQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type OrdersListQueryParamOrganizationIDFilter

type OrdersListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrdersListQueryParamOrganizationIDFilterType
}

OrdersListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateOrdersListQueryParamOrganizationIDFilterArrayOfStr

func CreateOrdersListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) OrdersListQueryParamOrganizationIDFilter

func CreateOrdersListQueryParamOrganizationIDFilterStr

func CreateOrdersListQueryParamOrganizationIDFilterStr(str string) OrdersListQueryParamOrganizationIDFilter

func (OrdersListQueryParamOrganizationIDFilter) MarshalJSON

func (*OrdersListQueryParamOrganizationIDFilter) UnmarshalJSON

func (u *OrdersListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type OrdersListQueryParamOrganizationIDFilterType

type OrdersListQueryParamOrganizationIDFilterType string
const (
	OrdersListQueryParamOrganizationIDFilterTypeStr        OrdersListQueryParamOrganizationIDFilterType = "str"
	OrdersListQueryParamOrganizationIDFilterTypeArrayOfStr OrdersListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type OrdersListQueryParamProductIDFilter added in v0.1.2

type OrdersListQueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrdersListQueryParamProductIDFilterType
}

OrdersListQueryParamProductIDFilter - Filter by product ID.

func CreateOrdersListQueryParamProductIDFilterArrayOfStr added in v0.1.2

func CreateOrdersListQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) OrdersListQueryParamProductIDFilter

func CreateOrdersListQueryParamProductIDFilterStr added in v0.1.2

func CreateOrdersListQueryParamProductIDFilterStr(str string) OrdersListQueryParamProductIDFilter

func (OrdersListQueryParamProductIDFilter) MarshalJSON added in v0.1.2

func (u OrdersListQueryParamProductIDFilter) MarshalJSON() ([]byte, error)

func (*OrdersListQueryParamProductIDFilter) UnmarshalJSON added in v0.1.2

func (u *OrdersListQueryParamProductIDFilter) UnmarshalJSON(data []byte) error

type OrdersListQueryParamProductIDFilterType added in v0.1.2

type OrdersListQueryParamProductIDFilterType string
const (
	OrdersListQueryParamProductIDFilterTypeStr        OrdersListQueryParamProductIDFilterType = "str"
	OrdersListQueryParamProductIDFilterTypeArrayOfStr OrdersListQueryParamProductIDFilterType = "arrayOfStr"
)

type OrdersListRequest

type OrdersListRequest struct {
	// Filter by organization ID.
	OrganizationID *OrdersListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by product ID.
	ProductID *OrdersListQueryParamProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
	// Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.
	ProductBillingType *ProductBillingTypeFilter `queryParam:"style=form,explode=true,name=product_billing_type"`
	// Filter by discount ID.
	DiscountID *QueryParamDiscountIDFilter `queryParam:"style=form,explode=true,name=discount_id"`
	// Filter by customer ID.
	CustomerID *OrdersListQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by customer external ID.
	ExternalCustomerID *OrdersListQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by checkout ID.
	CheckoutID *CheckoutIDFilter `queryParam:"style=form,explode=true,name=checkout_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.OrderSortProperty `queryParam:"style=form,explode=true,name=sorting"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*OrdersListRequest) GetCheckoutID added in v0.3.0

func (o *OrdersListRequest) GetCheckoutID() *CheckoutIDFilter

func (*OrdersListRequest) GetCustomerID

func (*OrdersListRequest) GetDiscountID

func (o *OrdersListRequest) GetDiscountID() *QueryParamDiscountIDFilter

func (*OrdersListRequest) GetExternalCustomerID added in v0.13.0

func (*OrdersListRequest) GetLimit

func (o *OrdersListRequest) GetLimit() *int64

func (*OrdersListRequest) GetMetadata added in v0.4.19

func (o *OrdersListRequest) GetMetadata() map[string]components.MetadataQuery

func (*OrdersListRequest) GetOrganizationID

func (*OrdersListRequest) GetPage

func (o *OrdersListRequest) GetPage() *int64

func (*OrdersListRequest) GetProductBillingType added in v0.4.2

func (o *OrdersListRequest) GetProductBillingType() *ProductBillingTypeFilter

func (*OrdersListRequest) GetProductID

func (*OrdersListRequest) GetSorting

func (OrdersListRequest) MarshalJSON

func (o OrdersListRequest) MarshalJSON() ([]byte, error)

func (*OrdersListRequest) UnmarshalJSON

func (o *OrdersListRequest) UnmarshalJSON(data []byte) error

type OrdersListResponse

type OrdersListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceOrder *components.ListResourceOrder

	Next func() (*OrdersListResponse, error)
}

func (*OrdersListResponse) GetHTTPMeta

func (o *OrdersListResponse) GetHTTPMeta() components.HTTPMetadata

func (*OrdersListResponse) GetListResourceOrder

func (o *OrdersListResponse) GetListResourceOrder() *components.ListResourceOrder

type OrdersUpdateRequest added in v0.5.0

type OrdersUpdateRequest struct {
	// The order ID.
	ID          string                 `pathParam:"style=simple,explode=false,name=id"`
	OrderUpdate components.OrderUpdate `request:"mediaType=application/json"`
}

func (*OrdersUpdateRequest) GetID added in v0.5.0

func (o *OrdersUpdateRequest) GetID() string

func (*OrdersUpdateRequest) GetOrderUpdate added in v0.5.0

func (o *OrdersUpdateRequest) GetOrderUpdate() components.OrderUpdate

type OrdersUpdateResponse added in v0.5.0

type OrdersUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Order *components.Order
}

func (*OrdersUpdateResponse) GetHTTPMeta added in v0.5.0

func (o *OrdersUpdateResponse) GetHTTPMeta() components.HTTPMetadata

func (*OrdersUpdateResponse) GetOrder added in v0.5.0

func (o *OrdersUpdateResponse) GetOrder() *components.Order

type OrganizationAccessTokensCreateResponse added in v0.13.0

type OrganizationAccessTokensCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	OrganizationAccessTokenCreateResponse *components.OrganizationAccessTokenCreateResponse
}

func (*OrganizationAccessTokensCreateResponse) GetHTTPMeta added in v0.13.0

func (*OrganizationAccessTokensCreateResponse) GetOrganizationAccessTokenCreateResponse added in v0.13.0

func (o *OrganizationAccessTokensCreateResponse) GetOrganizationAccessTokenCreateResponse() *components.OrganizationAccessTokenCreateResponse

type OrganizationAccessTokensDeleteRequest added in v0.13.0

type OrganizationAccessTokensDeleteRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*OrganizationAccessTokensDeleteRequest) GetID added in v0.13.0

type OrganizationAccessTokensDeleteResponse added in v0.13.0

type OrganizationAccessTokensDeleteResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*OrganizationAccessTokensDeleteResponse) GetHTTPMeta added in v0.13.0

type OrganizationAccessTokensListQueryParamOrganizationIDFilter added in v0.13.0

type OrganizationAccessTokensListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrganizationAccessTokensListQueryParamOrganizationIDFilterType
}

OrganizationAccessTokensListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateOrganizationAccessTokensListQueryParamOrganizationIDFilterArrayOfStr added in v0.13.0

func CreateOrganizationAccessTokensListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) OrganizationAccessTokensListQueryParamOrganizationIDFilter

func CreateOrganizationAccessTokensListQueryParamOrganizationIDFilterStr added in v0.13.0

func CreateOrganizationAccessTokensListQueryParamOrganizationIDFilterStr(str string) OrganizationAccessTokensListQueryParamOrganizationIDFilter

func (OrganizationAccessTokensListQueryParamOrganizationIDFilter) MarshalJSON added in v0.13.0

func (*OrganizationAccessTokensListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.13.0

type OrganizationAccessTokensListQueryParamOrganizationIDFilterType added in v0.13.0

type OrganizationAccessTokensListQueryParamOrganizationIDFilterType string
const (
	OrganizationAccessTokensListQueryParamOrganizationIDFilterTypeStr        OrganizationAccessTokensListQueryParamOrganizationIDFilterType = "str"
	OrganizationAccessTokensListQueryParamOrganizationIDFilterTypeArrayOfStr OrganizationAccessTokensListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type OrganizationAccessTokensListRequest added in v0.13.0

type OrganizationAccessTokensListRequest struct {
	// Filter by organization ID.
	OrganizationID *OrganizationAccessTokensListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.OrganizationAccessTokenSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*OrganizationAccessTokensListRequest) GetLimit added in v0.13.0

func (*OrganizationAccessTokensListRequest) GetOrganizationID added in v0.13.0

func (*OrganizationAccessTokensListRequest) GetPage added in v0.13.0

func (*OrganizationAccessTokensListRequest) GetSorting added in v0.13.0

func (OrganizationAccessTokensListRequest) MarshalJSON added in v0.13.0

func (o OrganizationAccessTokensListRequest) MarshalJSON() ([]byte, error)

func (*OrganizationAccessTokensListRequest) UnmarshalJSON added in v0.13.0

func (o *OrganizationAccessTokensListRequest) UnmarshalJSON(data []byte) error

type OrganizationAccessTokensListResponse added in v0.13.0

type OrganizationAccessTokensListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceOrganizationAccessToken *components.ListResourceOrganizationAccessToken

	Next func() (*OrganizationAccessTokensListResponse, error)
}

func (*OrganizationAccessTokensListResponse) GetHTTPMeta added in v0.13.0

func (*OrganizationAccessTokensListResponse) GetListResourceOrganizationAccessToken added in v0.13.0

func (o *OrganizationAccessTokensListResponse) GetListResourceOrganizationAccessToken() *components.ListResourceOrganizationAccessToken

type OrganizationAccessTokensUpdateRequest added in v0.13.0

type OrganizationAccessTokensUpdateRequest struct {
	ID                            string                                   `pathParam:"style=simple,explode=false,name=id"`
	OrganizationAccessTokenUpdate components.OrganizationAccessTokenUpdate `request:"mediaType=application/json"`
}

func (*OrganizationAccessTokensUpdateRequest) GetID added in v0.13.0

func (*OrganizationAccessTokensUpdateRequest) GetOrganizationAccessTokenUpdate added in v0.13.0

type OrganizationAccessTokensUpdateResponse added in v0.13.0

type OrganizationAccessTokensUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	OrganizationAccessToken *components.OrganizationAccessToken
}

func (*OrganizationAccessTokensUpdateResponse) GetHTTPMeta added in v0.13.0

func (*OrganizationAccessTokensUpdateResponse) GetOrganizationAccessToken added in v0.13.0

type OrganizationID

type OrganizationID struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrganizationIDType
}

OrganizationID - Filter by organization ID.

func CreateOrganizationIDArrayOfStr

func CreateOrganizationIDArrayOfStr(arrayOfStr []string) OrganizationID

func CreateOrganizationIDStr

func CreateOrganizationIDStr(str string) OrganizationID

func (OrganizationID) MarshalJSON

func (u OrganizationID) MarshalJSON() ([]byte, error)

func (*OrganizationID) UnmarshalJSON

func (u *OrganizationID) UnmarshalJSON(data []byte) error

type OrganizationIDFilter

type OrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type OrganizationIDFilterType
}

OrganizationIDFilter - Filter by organization ID.

func CreateOrganizationIDFilterArrayOfStr

func CreateOrganizationIDFilterArrayOfStr(arrayOfStr []string) OrganizationIDFilter

func CreateOrganizationIDFilterStr

func CreateOrganizationIDFilterStr(str string) OrganizationIDFilter

func (OrganizationIDFilter) MarshalJSON

func (u OrganizationIDFilter) MarshalJSON() ([]byte, error)

func (*OrganizationIDFilter) UnmarshalJSON

func (u *OrganizationIDFilter) UnmarshalJSON(data []byte) error

type OrganizationIDFilterType

type OrganizationIDFilterType string
const (
	OrganizationIDFilterTypeStr        OrganizationIDFilterType = "str"
	OrganizationIDFilterTypeArrayOfStr OrganizationIDFilterType = "arrayOfStr"
)

type OrganizationIDType

type OrganizationIDType string
const (
	OrganizationIDTypeStr        OrganizationIDType = "str"
	OrganizationIDTypeArrayOfStr OrganizationIDType = "arrayOfStr"
)

type OrganizationsCreateResponse

type OrganizationsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Organization created.
	Organization *components.Organization
}

func (*OrganizationsCreateResponse) GetHTTPMeta

func (*OrganizationsCreateResponse) GetOrganization

func (o *OrganizationsCreateResponse) GetOrganization() *components.Organization

type OrganizationsGetRequest

type OrganizationsGetRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*OrganizationsGetRequest) GetID

func (o *OrganizationsGetRequest) GetID() string

type OrganizationsGetResponse

type OrganizationsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Organization *components.Organization
}

func (*OrganizationsGetResponse) GetHTTPMeta

func (*OrganizationsGetResponse) GetOrganization

func (o *OrganizationsGetResponse) GetOrganization() *components.Organization

type OrganizationsListRequest

type OrganizationsListRequest struct {
	// Filter by slug.
	Slug *string `queryParam:"style=form,explode=true,name=slug"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.OrganizationSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*OrganizationsListRequest) GetLimit

func (o *OrganizationsListRequest) GetLimit() *int64

func (*OrganizationsListRequest) GetPage

func (o *OrganizationsListRequest) GetPage() *int64

func (*OrganizationsListRequest) GetSlug

func (o *OrganizationsListRequest) GetSlug() *string

func (*OrganizationsListRequest) GetSorting

func (OrganizationsListRequest) MarshalJSON

func (o OrganizationsListRequest) MarshalJSON() ([]byte, error)

func (*OrganizationsListRequest) UnmarshalJSON

func (o *OrganizationsListRequest) UnmarshalJSON(data []byte) error

type OrganizationsListResponse

type OrganizationsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceOrganization *components.ListResourceOrganization

	Next func() (*OrganizationsListResponse, error)
}

func (*OrganizationsListResponse) GetHTTPMeta

func (*OrganizationsListResponse) GetListResourceOrganization

func (o *OrganizationsListResponse) GetListResourceOrganization() *components.ListResourceOrganization

type OrganizationsUpdateRequest

type OrganizationsUpdateRequest struct {
	ID                 string                        `pathParam:"style=simple,explode=false,name=id"`
	OrganizationUpdate components.OrganizationUpdate `request:"mediaType=application/json"`
}

func (*OrganizationsUpdateRequest) GetID

func (*OrganizationsUpdateRequest) GetOrganizationUpdate

func (o *OrganizationsUpdateRequest) GetOrganizationUpdate() components.OrganizationUpdate

type OrganizationsUpdateResponse

type OrganizationsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Organization updated.
	Organization *components.Organization
}

func (*OrganizationsUpdateResponse) GetHTTPMeta

func (*OrganizationsUpdateResponse) GetOrganization

func (o *OrganizationsUpdateResponse) GetOrganization() *components.Organization

type PaymentsGetRequest added in v0.4.17

type PaymentsGetRequest struct {
	// The payment ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*PaymentsGetRequest) GetID added in v0.4.17

func (p *PaymentsGetRequest) GetID() string

type PaymentsGetResponse added in v0.4.17

type PaymentsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Payment *components.Payment
}

func (*PaymentsGetResponse) GetHTTPMeta added in v0.4.17

func (p *PaymentsGetResponse) GetHTTPMeta() components.HTTPMetadata

func (*PaymentsGetResponse) GetPayment added in v0.4.17

func (p *PaymentsGetResponse) GetPayment() *components.Payment

type PaymentsListQueryParamCheckoutIDFilter added in v0.4.17

type PaymentsListQueryParamCheckoutIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type PaymentsListQueryParamCheckoutIDFilterType
}

PaymentsListQueryParamCheckoutIDFilter - Filter by checkout ID.

func CreatePaymentsListQueryParamCheckoutIDFilterArrayOfStr added in v0.4.17

func CreatePaymentsListQueryParamCheckoutIDFilterArrayOfStr(arrayOfStr []string) PaymentsListQueryParamCheckoutIDFilter

func CreatePaymentsListQueryParamCheckoutIDFilterStr added in v0.4.17

func CreatePaymentsListQueryParamCheckoutIDFilterStr(str string) PaymentsListQueryParamCheckoutIDFilter

func (PaymentsListQueryParamCheckoutIDFilter) MarshalJSON added in v0.4.17

func (u PaymentsListQueryParamCheckoutIDFilter) MarshalJSON() ([]byte, error)

func (*PaymentsListQueryParamCheckoutIDFilter) UnmarshalJSON added in v0.4.17

func (u *PaymentsListQueryParamCheckoutIDFilter) UnmarshalJSON(data []byte) error

type PaymentsListQueryParamCheckoutIDFilterType added in v0.4.17

type PaymentsListQueryParamCheckoutIDFilterType string
const (
	PaymentsListQueryParamCheckoutIDFilterTypeStr        PaymentsListQueryParamCheckoutIDFilterType = "str"
	PaymentsListQueryParamCheckoutIDFilterTypeArrayOfStr PaymentsListQueryParamCheckoutIDFilterType = "arrayOfStr"
)

type PaymentsListQueryParamOrderIDFilter added in v0.4.17

type PaymentsListQueryParamOrderIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type PaymentsListQueryParamOrderIDFilterType
}

PaymentsListQueryParamOrderIDFilter - Filter by order ID.

func CreatePaymentsListQueryParamOrderIDFilterArrayOfStr added in v0.4.17

func CreatePaymentsListQueryParamOrderIDFilterArrayOfStr(arrayOfStr []string) PaymentsListQueryParamOrderIDFilter

func CreatePaymentsListQueryParamOrderIDFilterStr added in v0.4.17

func CreatePaymentsListQueryParamOrderIDFilterStr(str string) PaymentsListQueryParamOrderIDFilter

func (PaymentsListQueryParamOrderIDFilter) MarshalJSON added in v0.4.17

func (u PaymentsListQueryParamOrderIDFilter) MarshalJSON() ([]byte, error)

func (*PaymentsListQueryParamOrderIDFilter) UnmarshalJSON added in v0.4.17

func (u *PaymentsListQueryParamOrderIDFilter) UnmarshalJSON(data []byte) error

type PaymentsListQueryParamOrderIDFilterType added in v0.4.17

type PaymentsListQueryParamOrderIDFilterType string
const (
	PaymentsListQueryParamOrderIDFilterTypeStr        PaymentsListQueryParamOrderIDFilterType = "str"
	PaymentsListQueryParamOrderIDFilterTypeArrayOfStr PaymentsListQueryParamOrderIDFilterType = "arrayOfStr"
)

type PaymentsListQueryParamOrganizationIDFilter added in v0.4.17

type PaymentsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type PaymentsListQueryParamOrganizationIDFilterType
}

PaymentsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreatePaymentsListQueryParamOrganizationIDFilterArrayOfStr added in v0.4.17

func CreatePaymentsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) PaymentsListQueryParamOrganizationIDFilter

func CreatePaymentsListQueryParamOrganizationIDFilterStr added in v0.4.17

func CreatePaymentsListQueryParamOrganizationIDFilterStr(str string) PaymentsListQueryParamOrganizationIDFilter

func (PaymentsListQueryParamOrganizationIDFilter) MarshalJSON added in v0.4.17

func (*PaymentsListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.4.17

func (u *PaymentsListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type PaymentsListQueryParamOrganizationIDFilterType added in v0.4.17

type PaymentsListQueryParamOrganizationIDFilterType string
const (
	PaymentsListQueryParamOrganizationIDFilterTypeStr        PaymentsListQueryParamOrganizationIDFilterType = "str"
	PaymentsListQueryParamOrganizationIDFilterTypeArrayOfStr PaymentsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type PaymentsListQueryParamStatusFilter added in v0.13.0

type PaymentsListQueryParamStatusFilter struct {
	PaymentStatus        *components.PaymentStatus  `queryParam:"inline" union:"member"`
	ArrayOfPaymentStatus []components.PaymentStatus `queryParam:"inline" union:"member"`

	Type PaymentsListQueryParamStatusFilterType
}

PaymentsListQueryParamStatusFilter - Filter by payment status.

func CreatePaymentsListQueryParamStatusFilterArrayOfPaymentStatus added in v0.13.0

func CreatePaymentsListQueryParamStatusFilterArrayOfPaymentStatus(arrayOfPaymentStatus []components.PaymentStatus) PaymentsListQueryParamStatusFilter

func CreatePaymentsListQueryParamStatusFilterPaymentStatus added in v0.13.0

func CreatePaymentsListQueryParamStatusFilterPaymentStatus(paymentStatus components.PaymentStatus) PaymentsListQueryParamStatusFilter

func (PaymentsListQueryParamStatusFilter) MarshalJSON added in v0.13.0

func (u PaymentsListQueryParamStatusFilter) MarshalJSON() ([]byte, error)

func (*PaymentsListQueryParamStatusFilter) UnmarshalJSON added in v0.13.0

func (u *PaymentsListQueryParamStatusFilter) UnmarshalJSON(data []byte) error

type PaymentsListQueryParamStatusFilterType added in v0.13.0

type PaymentsListQueryParamStatusFilterType string
const (
	PaymentsListQueryParamStatusFilterTypePaymentStatus        PaymentsListQueryParamStatusFilterType = "PaymentStatus"
	PaymentsListQueryParamStatusFilterTypeArrayOfPaymentStatus PaymentsListQueryParamStatusFilterType = "arrayOfPaymentStatus"
)

type PaymentsListRequest added in v0.4.17

type PaymentsListRequest struct {
	// Filter by organization ID.
	OrganizationID *PaymentsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by checkout ID.
	CheckoutID *PaymentsListQueryParamCheckoutIDFilter `queryParam:"style=form,explode=true,name=checkout_id"`
	// Filter by order ID.
	OrderID *PaymentsListQueryParamOrderIDFilter `queryParam:"style=form,explode=true,name=order_id"`
	// Filter by payment status.
	Status *PaymentsListQueryParamStatusFilter `queryParam:"style=form,explode=true,name=status"`
	// Filter by payment method.
	Method *MethodFilter `queryParam:"style=form,explode=true,name=method"`
	// Filter by customer email.
	CustomerEmail *CustomerEmailFilter `queryParam:"style=form,explode=true,name=customer_email"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.PaymentSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*PaymentsListRequest) GetCheckoutID added in v0.4.17

func (*PaymentsListRequest) GetCustomerEmail added in v0.4.17

func (p *PaymentsListRequest) GetCustomerEmail() *CustomerEmailFilter

func (*PaymentsListRequest) GetLimit added in v0.4.17

func (p *PaymentsListRequest) GetLimit() *int64

func (*PaymentsListRequest) GetMethod added in v0.4.17

func (p *PaymentsListRequest) GetMethod() *MethodFilter

func (*PaymentsListRequest) GetOrderID added in v0.4.17

func (*PaymentsListRequest) GetOrganizationID added in v0.4.17

func (*PaymentsListRequest) GetPage added in v0.4.17

func (p *PaymentsListRequest) GetPage() *int64

func (*PaymentsListRequest) GetSorting added in v0.4.17

func (*PaymentsListRequest) GetStatus added in v0.4.17

func (PaymentsListRequest) MarshalJSON added in v0.4.17

func (p PaymentsListRequest) MarshalJSON() ([]byte, error)

func (*PaymentsListRequest) UnmarshalJSON added in v0.4.17

func (p *PaymentsListRequest) UnmarshalJSON(data []byte) error

type PaymentsListResponse added in v0.4.17

type PaymentsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourcePayment *components.ListResourcePayment

	Next func() (*PaymentsListResponse, error)
}

func (*PaymentsListResponse) GetHTTPMeta added in v0.4.17

func (p *PaymentsListResponse) GetHTTPMeta() components.HTTPMetadata

func (*PaymentsListResponse) GetListResourcePayment added in v0.16.0

func (p *PaymentsListResponse) GetListResourcePayment() *components.ListResourcePayment

type ProductBillingTypeFilter added in v0.3.0

type ProductBillingTypeFilter struct {
	ProductBillingType        *components.ProductBillingType  `queryParam:"inline" union:"member"`
	ArrayOfProductBillingType []components.ProductBillingType `queryParam:"inline" union:"member"`

	Type ProductBillingTypeFilterType
}

ProductBillingTypeFilter - Filter by product billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.

func CreateProductBillingTypeFilterArrayOfProductBillingType added in v0.3.0

func CreateProductBillingTypeFilterArrayOfProductBillingType(arrayOfProductBillingType []components.ProductBillingType) ProductBillingTypeFilter

func CreateProductBillingTypeFilterProductBillingType added in v0.3.0

func CreateProductBillingTypeFilterProductBillingType(productBillingType components.ProductBillingType) ProductBillingTypeFilter

func (ProductBillingTypeFilter) MarshalJSON added in v0.3.0

func (u ProductBillingTypeFilter) MarshalJSON() ([]byte, error)

func (*ProductBillingTypeFilter) UnmarshalJSON added in v0.3.0

func (u *ProductBillingTypeFilter) UnmarshalJSON(data []byte) error

type ProductBillingTypeFilterType added in v0.3.0

type ProductBillingTypeFilterType string
const (
	ProductBillingTypeFilterTypeProductBillingType        ProductBillingTypeFilterType = "ProductBillingType"
	ProductBillingTypeFilterTypeArrayOfProductBillingType ProductBillingTypeFilterType = "arrayOfProductBillingType"
)

type ProductIDFilter

type ProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type ProductIDFilterType
}

ProductIDFilter - Filter by product ID.

func CreateProductIDFilterArrayOfStr

func CreateProductIDFilterArrayOfStr(arrayOfStr []string) ProductIDFilter

func CreateProductIDFilterStr

func CreateProductIDFilterStr(str string) ProductIDFilter

func (ProductIDFilter) MarshalJSON

func (u ProductIDFilter) MarshalJSON() ([]byte, error)

func (*ProductIDFilter) UnmarshalJSON

func (u *ProductIDFilter) UnmarshalJSON(data []byte) error

type ProductIDFilterType

type ProductIDFilterType string
const (
	ProductIDFilterTypeStr        ProductIDFilterType = "str"
	ProductIDFilterTypeArrayOfStr ProductIDFilterType = "arrayOfStr"
)

type ProductsCreateResponse

type ProductsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Product created.
	Product *components.Product
}

func (*ProductsCreateResponse) GetHTTPMeta

func (*ProductsCreateResponse) GetProduct

func (p *ProductsCreateResponse) GetProduct() *components.Product

type ProductsGetRequest

type ProductsGetRequest struct {
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*ProductsGetRequest) GetID

func (p *ProductsGetRequest) GetID() string

type ProductsGetResponse

type ProductsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Product *components.Product
}

func (*ProductsGetResponse) GetHTTPMeta

func (p *ProductsGetResponse) GetHTTPMeta() components.HTTPMetadata

func (*ProductsGetResponse) GetProduct

func (p *ProductsGetResponse) GetProduct() *components.Product

type ProductsListQueryParamOrganizationIDFilter

type ProductsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type ProductsListQueryParamOrganizationIDFilterType
}

ProductsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateProductsListQueryParamOrganizationIDFilterArrayOfStr

func CreateProductsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) ProductsListQueryParamOrganizationIDFilter

func CreateProductsListQueryParamOrganizationIDFilterStr

func CreateProductsListQueryParamOrganizationIDFilterStr(str string) ProductsListQueryParamOrganizationIDFilter

func (ProductsListQueryParamOrganizationIDFilter) MarshalJSON

func (*ProductsListQueryParamOrganizationIDFilter) UnmarshalJSON

func (u *ProductsListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type ProductsListQueryParamOrganizationIDFilterType

type ProductsListQueryParamOrganizationIDFilterType string
const (
	ProductsListQueryParamOrganizationIDFilterTypeStr        ProductsListQueryParamOrganizationIDFilterType = "str"
	ProductsListQueryParamOrganizationIDFilterTypeArrayOfStr ProductsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type ProductsListRequest

type ProductsListRequest struct {
	// Filter by product ID.
	ID *QueryParamProductIDFilter `queryParam:"style=form,explode=true,name=id"`
	// Filter by organization ID.
	OrganizationID *ProductsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by product name.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Filter on archived products.
	IsArchived *bool `queryParam:"style=form,explode=true,name=is_archived"`
	// Filter on recurring products. If `true`, only subscriptions tiers are returned. If `false`, only one-time purchase products are returned.
	IsRecurring *bool `queryParam:"style=form,explode=true,name=is_recurring"`
	// Filter products granting specific benefit.
	BenefitID *BenefitIDFilter `queryParam:"style=form,explode=true,name=benefit_id"`
	// Filter by visibility.
	Visibility []components.ProductVisibility `queryParam:"style=form,explode=true,name=visibility"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.ProductSortProperty `queryParam:"style=form,explode=true,name=sorting"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*ProductsListRequest) GetBenefitID

func (p *ProductsListRequest) GetBenefitID() *BenefitIDFilter

func (*ProductsListRequest) GetID added in v0.1.2

func (*ProductsListRequest) GetIsArchived

func (p *ProductsListRequest) GetIsArchived() *bool

func (*ProductsListRequest) GetIsRecurring

func (p *ProductsListRequest) GetIsRecurring() *bool

func (*ProductsListRequest) GetLimit

func (p *ProductsListRequest) GetLimit() *int64

func (*ProductsListRequest) GetMetadata added in v0.7.1

func (p *ProductsListRequest) GetMetadata() map[string]components.MetadataQuery

func (*ProductsListRequest) GetOrganizationID

func (*ProductsListRequest) GetPage

func (p *ProductsListRequest) GetPage() *int64

func (*ProductsListRequest) GetQuery

func (p *ProductsListRequest) GetQuery() *string

func (*ProductsListRequest) GetSorting

func (*ProductsListRequest) GetVisibility added in v0.13.0

func (p *ProductsListRequest) GetVisibility() []components.ProductVisibility

func (ProductsListRequest) MarshalJSON

func (p ProductsListRequest) MarshalJSON() ([]byte, error)

func (*ProductsListRequest) UnmarshalJSON

func (p *ProductsListRequest) UnmarshalJSON(data []byte) error

type ProductsListResponse

type ProductsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceProduct *components.ListResourceProduct

	Next func() (*ProductsListResponse, error)
}

func (*ProductsListResponse) GetHTTPMeta

func (p *ProductsListResponse) GetHTTPMeta() components.HTTPMetadata

func (*ProductsListResponse) GetListResourceProduct

func (p *ProductsListResponse) GetListResourceProduct() *components.ListResourceProduct

type ProductsUpdateBenefitsRequest

type ProductsUpdateBenefitsRequest struct {
	ID                    string                           `pathParam:"style=simple,explode=false,name=id"`
	ProductBenefitsUpdate components.ProductBenefitsUpdate `request:"mediaType=application/json"`
}

func (*ProductsUpdateBenefitsRequest) GetID

func (*ProductsUpdateBenefitsRequest) GetProductBenefitsUpdate

func (p *ProductsUpdateBenefitsRequest) GetProductBenefitsUpdate() components.ProductBenefitsUpdate

type ProductsUpdateBenefitsResponse

type ProductsUpdateBenefitsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Product benefits updated.
	Product *components.Product
}

func (*ProductsUpdateBenefitsResponse) GetHTTPMeta

func (*ProductsUpdateBenefitsResponse) GetProduct

type ProductsUpdateRequest

type ProductsUpdateRequest struct {
	ID            string                   `pathParam:"style=simple,explode=false,name=id"`
	ProductUpdate components.ProductUpdate `request:"mediaType=application/json"`
}

func (*ProductsUpdateRequest) GetID

func (p *ProductsUpdateRequest) GetID() string

func (*ProductsUpdateRequest) GetProductUpdate

func (p *ProductsUpdateRequest) GetProductUpdate() components.ProductUpdate

type ProductsUpdateResponse

type ProductsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Product updated.
	Product *components.Product
}

func (*ProductsUpdateResponse) GetHTTPMeta

func (*ProductsUpdateResponse) GetProduct

func (p *ProductsUpdateResponse) GetProduct() *components.Product

type QueryParamBenefitIDFilter

type QueryParamBenefitIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamBenefitIDFilterType
}

QueryParamBenefitIDFilter - Filter by benefit ID.

func CreateQueryParamBenefitIDFilterArrayOfStr

func CreateQueryParamBenefitIDFilterArrayOfStr(arrayOfStr []string) QueryParamBenefitIDFilter

func CreateQueryParamBenefitIDFilterStr

func CreateQueryParamBenefitIDFilterStr(str string) QueryParamBenefitIDFilter

func (QueryParamBenefitIDFilter) MarshalJSON

func (u QueryParamBenefitIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamBenefitIDFilter) UnmarshalJSON

func (u *QueryParamBenefitIDFilter) UnmarshalJSON(data []byte) error

type QueryParamBenefitIDFilterType

type QueryParamBenefitIDFilterType string
const (
	QueryParamBenefitIDFilterTypeStr        QueryParamBenefitIDFilterType = "str"
	QueryParamBenefitIDFilterTypeArrayOfStr QueryParamBenefitIDFilterType = "arrayOfStr"
)

type QueryParamBenefitTypeFilter

type QueryParamBenefitTypeFilter struct {
	BenefitType        *components.BenefitType  `queryParam:"inline" union:"member"`
	ArrayOfBenefitType []components.BenefitType `queryParam:"inline" union:"member"`

	Type QueryParamBenefitTypeFilterType
}

QueryParamBenefitTypeFilter - Filter by benefit type.

func CreateQueryParamBenefitTypeFilterArrayOfBenefitType

func CreateQueryParamBenefitTypeFilterArrayOfBenefitType(arrayOfBenefitType []components.BenefitType) QueryParamBenefitTypeFilter

func CreateQueryParamBenefitTypeFilterBenefitType

func CreateQueryParamBenefitTypeFilterBenefitType(benefitType components.BenefitType) QueryParamBenefitTypeFilter

func (QueryParamBenefitTypeFilter) MarshalJSON

func (u QueryParamBenefitTypeFilter) MarshalJSON() ([]byte, error)

func (*QueryParamBenefitTypeFilter) UnmarshalJSON

func (u *QueryParamBenefitTypeFilter) UnmarshalJSON(data []byte) error

type QueryParamBenefitTypeFilterType

type QueryParamBenefitTypeFilterType string
const (
	QueryParamBenefitTypeFilterTypeBenefitType        QueryParamBenefitTypeFilterType = "BenefitType"
	QueryParamBenefitTypeFilterTypeArrayOfBenefitType QueryParamBenefitTypeFilterType = "arrayOfBenefitType"
)

type QueryParamCheckoutIDFilter added in v0.3.0

type QueryParamCheckoutIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamCheckoutIDFilterType
}

QueryParamCheckoutIDFilter - Filter by checkout ID.

func CreateQueryParamCheckoutIDFilterArrayOfStr added in v0.3.0

func CreateQueryParamCheckoutIDFilterArrayOfStr(arrayOfStr []string) QueryParamCheckoutIDFilter

func CreateQueryParamCheckoutIDFilterStr added in v0.3.0

func CreateQueryParamCheckoutIDFilterStr(str string) QueryParamCheckoutIDFilter

func (QueryParamCheckoutIDFilter) MarshalJSON added in v0.3.0

func (u QueryParamCheckoutIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamCheckoutIDFilter) UnmarshalJSON added in v0.3.0

func (u *QueryParamCheckoutIDFilter) UnmarshalJSON(data []byte) error

type QueryParamCheckoutIDFilterType added in v0.3.0

type QueryParamCheckoutIDFilterType string
const (
	QueryParamCheckoutIDFilterTypeStr        QueryParamCheckoutIDFilterType = "str"
	QueryParamCheckoutIDFilterTypeArrayOfStr QueryParamCheckoutIDFilterType = "arrayOfStr"
)

type QueryParamCustomerIDFilter

type QueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamCustomerIDFilterType
}

QueryParamCustomerIDFilter - Filter by customer.

func CreateQueryParamCustomerIDFilterArrayOfStr

func CreateQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) QueryParamCustomerIDFilter

func CreateQueryParamCustomerIDFilterStr

func CreateQueryParamCustomerIDFilterStr(str string) QueryParamCustomerIDFilter

func (QueryParamCustomerIDFilter) MarshalJSON

func (u QueryParamCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamCustomerIDFilter) UnmarshalJSON

func (u *QueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type QueryParamCustomerIDFilterType

type QueryParamCustomerIDFilterType string
const (
	QueryParamCustomerIDFilterTypeStr        QueryParamCustomerIDFilterType = "str"
	QueryParamCustomerIDFilterTypeArrayOfStr QueryParamCustomerIDFilterType = "arrayOfStr"
)

type QueryParamDiscountIDFilter

type QueryParamDiscountIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamDiscountIDFilterType
}

QueryParamDiscountIDFilter - Filter by discount ID.

func CreateQueryParamDiscountIDFilterArrayOfStr

func CreateQueryParamDiscountIDFilterArrayOfStr(arrayOfStr []string) QueryParamDiscountIDFilter

func CreateQueryParamDiscountIDFilterStr

func CreateQueryParamDiscountIDFilterStr(str string) QueryParamDiscountIDFilter

func (QueryParamDiscountIDFilter) MarshalJSON

func (u QueryParamDiscountIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamDiscountIDFilter) UnmarshalJSON

func (u *QueryParamDiscountIDFilter) UnmarshalJSON(data []byte) error

type QueryParamDiscountIDFilterType

type QueryParamDiscountIDFilterType string
const (
	QueryParamDiscountIDFilterTypeStr        QueryParamDiscountIDFilterType = "str"
	QueryParamDiscountIDFilterTypeArrayOfStr QueryParamDiscountIDFilterType = "arrayOfStr"
)

type QueryParamExternalCustomerIDFilter added in v0.1.8

type QueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamExternalCustomerIDFilterType
}

QueryParamExternalCustomerIDFilter - Filter by customer external ID.

func CreateQueryParamExternalCustomerIDFilterArrayOfStr added in v0.1.8

func CreateQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) QueryParamExternalCustomerIDFilter

func CreateQueryParamExternalCustomerIDFilterStr added in v0.1.8

func CreateQueryParamExternalCustomerIDFilterStr(str string) QueryParamExternalCustomerIDFilter

func (QueryParamExternalCustomerIDFilter) MarshalJSON added in v0.1.8

func (u QueryParamExternalCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.1.8

func (u *QueryParamExternalCustomerIDFilter) UnmarshalJSON(data []byte) error

type QueryParamExternalCustomerIDFilterType added in v0.1.8

type QueryParamExternalCustomerIDFilterType string
const (
	QueryParamExternalCustomerIDFilterTypeStr        QueryParamExternalCustomerIDFilterType = "str"
	QueryParamExternalCustomerIDFilterTypeArrayOfStr QueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type QueryParamMemberIDFilter added in v0.13.0

type QueryParamMemberIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamMemberIDFilterType
}

QueryParamMemberIDFilter - Filter by member ID.

func CreateQueryParamMemberIDFilterArrayOfStr added in v0.13.0

func CreateQueryParamMemberIDFilterArrayOfStr(arrayOfStr []string) QueryParamMemberIDFilter

func CreateQueryParamMemberIDFilterStr added in v0.13.0

func CreateQueryParamMemberIDFilterStr(str string) QueryParamMemberIDFilter

func (QueryParamMemberIDFilter) MarshalJSON added in v0.13.0

func (u QueryParamMemberIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamMemberIDFilter) UnmarshalJSON added in v0.13.0

func (u *QueryParamMemberIDFilter) UnmarshalJSON(data []byte) error

type QueryParamMemberIDFilterType added in v0.13.0

type QueryParamMemberIDFilterType string
const (
	QueryParamMemberIDFilterTypeStr        QueryParamMemberIDFilterType = "str"
	QueryParamMemberIDFilterTypeArrayOfStr QueryParamMemberIDFilterType = "arrayOfStr"
)

type QueryParamMeterIDFilter added in v0.4.10

type QueryParamMeterIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamMeterIDFilterType
}

QueryParamMeterIDFilter - Filter by meter ID.

func CreateQueryParamMeterIDFilterArrayOfStr added in v0.4.10

func CreateQueryParamMeterIDFilterArrayOfStr(arrayOfStr []string) QueryParamMeterIDFilter

func CreateQueryParamMeterIDFilterStr added in v0.4.10

func CreateQueryParamMeterIDFilterStr(str string) QueryParamMeterIDFilter

func (QueryParamMeterIDFilter) MarshalJSON added in v0.4.10

func (u QueryParamMeterIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamMeterIDFilter) UnmarshalJSON added in v0.4.10

func (u *QueryParamMeterIDFilter) UnmarshalJSON(data []byte) error

type QueryParamMeterIDFilterType added in v0.4.10

type QueryParamMeterIDFilterType string
const (
	QueryParamMeterIDFilterTypeStr        QueryParamMeterIDFilterType = "str"
	QueryParamMeterIDFilterTypeArrayOfStr QueryParamMeterIDFilterType = "arrayOfStr"
)

type QueryParamOrderIDFilter added in v0.1.5

type QueryParamOrderIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamOrderIDFilterType
}

QueryParamOrderIDFilter - Filter by order ID.

func CreateQueryParamOrderIDFilterArrayOfStr added in v0.1.5

func CreateQueryParamOrderIDFilterArrayOfStr(arrayOfStr []string) QueryParamOrderIDFilter

func CreateQueryParamOrderIDFilterStr added in v0.1.5

func CreateQueryParamOrderIDFilterStr(str string) QueryParamOrderIDFilter

func (QueryParamOrderIDFilter) MarshalJSON added in v0.1.5

func (u QueryParamOrderIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamOrderIDFilter) UnmarshalJSON added in v0.1.5

func (u *QueryParamOrderIDFilter) UnmarshalJSON(data []byte) error

type QueryParamOrderIDFilterType added in v0.1.5

type QueryParamOrderIDFilterType string
const (
	QueryParamOrderIDFilterTypeStr        QueryParamOrderIDFilterType = "str"
	QueryParamOrderIDFilterTypeArrayOfStr QueryParamOrderIDFilterType = "arrayOfStr"
)

type QueryParamOrganizationID added in v0.6.1

type QueryParamOrganizationID struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamOrganizationIDType
}

QueryParamOrganizationID - Filter by organization ID.

func CreateQueryParamOrganizationIDArrayOfStr added in v0.6.1

func CreateQueryParamOrganizationIDArrayOfStr(arrayOfStr []string) QueryParamOrganizationID

func CreateQueryParamOrganizationIDStr added in v0.6.1

func CreateQueryParamOrganizationIDStr(str string) QueryParamOrganizationID

func (QueryParamOrganizationID) MarshalJSON added in v0.6.1

func (u QueryParamOrganizationID) MarshalJSON() ([]byte, error)

func (*QueryParamOrganizationID) UnmarshalJSON added in v0.6.1

func (u *QueryParamOrganizationID) UnmarshalJSON(data []byte) error

type QueryParamOrganizationIDFilter

type QueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamOrganizationIDFilterType
}

QueryParamOrganizationIDFilter - Filter by organization ID.

func CreateQueryParamOrganizationIDFilterArrayOfStr

func CreateQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) QueryParamOrganizationIDFilter

func CreateQueryParamOrganizationIDFilterStr

func CreateQueryParamOrganizationIDFilterStr(str string) QueryParamOrganizationIDFilter

func (QueryParamOrganizationIDFilter) MarshalJSON

func (u QueryParamOrganizationIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamOrganizationIDFilter) UnmarshalJSON

func (u *QueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type QueryParamOrganizationIDFilterType

type QueryParamOrganizationIDFilterType string
const (
	QueryParamOrganizationIDFilterTypeStr        QueryParamOrganizationIDFilterType = "str"
	QueryParamOrganizationIDFilterTypeArrayOfStr QueryParamOrganizationIDFilterType = "arrayOfStr"
)

type QueryParamOrganizationIDType added in v0.6.1

type QueryParamOrganizationIDType string
const (
	QueryParamOrganizationIDTypeStr        QueryParamOrganizationIDType = "str"
	QueryParamOrganizationIDTypeArrayOfStr QueryParamOrganizationIDType = "arrayOfStr"
)

type QueryParamProductBillingTypeFilter added in v0.4.2

type QueryParamProductBillingTypeFilter struct {
	ProductBillingType        *components.ProductBillingType  `queryParam:"inline" union:"member"`
	ArrayOfProductBillingType []components.ProductBillingType `queryParam:"inline" union:"member"`

	Type QueryParamProductBillingTypeFilterType
}

QueryParamProductBillingTypeFilter - Filter by billing type. `recurring` will filter data corresponding to subscriptions creations or renewals. `one_time` will filter data corresponding to one-time purchases.

func CreateQueryParamProductBillingTypeFilterArrayOfProductBillingType added in v0.4.2

func CreateQueryParamProductBillingTypeFilterArrayOfProductBillingType(arrayOfProductBillingType []components.ProductBillingType) QueryParamProductBillingTypeFilter

func CreateQueryParamProductBillingTypeFilterProductBillingType added in v0.4.2

func CreateQueryParamProductBillingTypeFilterProductBillingType(productBillingType components.ProductBillingType) QueryParamProductBillingTypeFilter

func (QueryParamProductBillingTypeFilter) MarshalJSON added in v0.4.2

func (u QueryParamProductBillingTypeFilter) MarshalJSON() ([]byte, error)

func (*QueryParamProductBillingTypeFilter) UnmarshalJSON added in v0.4.2

func (u *QueryParamProductBillingTypeFilter) UnmarshalJSON(data []byte) error

type QueryParamProductBillingTypeFilterType added in v0.4.2

type QueryParamProductBillingTypeFilterType string
const (
	QueryParamProductBillingTypeFilterTypeProductBillingType        QueryParamProductBillingTypeFilterType = "ProductBillingType"
	QueryParamProductBillingTypeFilterTypeArrayOfProductBillingType QueryParamProductBillingTypeFilterType = "arrayOfProductBillingType"
)

type QueryParamProductIDFilter

type QueryParamProductIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamProductIDFilterType
}

QueryParamProductIDFilter - Filter by product ID.

func CreateQueryParamProductIDFilterArrayOfStr

func CreateQueryParamProductIDFilterArrayOfStr(arrayOfStr []string) QueryParamProductIDFilter

func CreateQueryParamProductIDFilterStr

func CreateQueryParamProductIDFilterStr(str string) QueryParamProductIDFilter

func (QueryParamProductIDFilter) MarshalJSON

func (u QueryParamProductIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamProductIDFilter) UnmarshalJSON

func (u *QueryParamProductIDFilter) UnmarshalJSON(data []byte) error

type QueryParamProductIDFilterType

type QueryParamProductIDFilterType string
const (
	QueryParamProductIDFilterTypeStr        QueryParamProductIDFilterType = "str"
	QueryParamProductIDFilterTypeArrayOfStr QueryParamProductIDFilterType = "arrayOfStr"
)

type QueryParamSourceFilter added in v0.4.12

type QueryParamSourceFilter struct {
	EventSource        *components.EventSource  `queryParam:"inline" union:"member"`
	ArrayOfEventSource []components.EventSource `queryParam:"inline" union:"member"`

	Type QueryParamSourceFilterType
}

QueryParamSourceFilter - Filter by event source.

func CreateQueryParamSourceFilterArrayOfEventSource added in v0.4.12

func CreateQueryParamSourceFilterArrayOfEventSource(arrayOfEventSource []components.EventSource) QueryParamSourceFilter

func CreateQueryParamSourceFilterEventSource added in v0.4.12

func CreateQueryParamSourceFilterEventSource(eventSource components.EventSource) QueryParamSourceFilter

func (QueryParamSourceFilter) MarshalJSON added in v0.4.12

func (u QueryParamSourceFilter) MarshalJSON() ([]byte, error)

func (*QueryParamSourceFilter) UnmarshalJSON added in v0.4.12

func (u *QueryParamSourceFilter) UnmarshalJSON(data []byte) error

type QueryParamSourceFilterType added in v0.4.12

type QueryParamSourceFilterType string
const (
	QueryParamSourceFilterTypeEventSource        QueryParamSourceFilterType = "EventSource"
	QueryParamSourceFilterTypeArrayOfEventSource QueryParamSourceFilterType = "arrayOfEventSource"
)

type QueryParamStatusFilter added in v0.4.17

type QueryParamStatusFilter struct {
	CheckoutStatus        *components.CheckoutStatus  `queryParam:"inline" union:"member"`
	ArrayOfCheckoutStatus []components.CheckoutStatus `queryParam:"inline" union:"member"`

	Type QueryParamStatusFilterType
}

QueryParamStatusFilter - Filter by checkout session status.

func CreateQueryParamStatusFilterArrayOfCheckoutStatus added in v0.13.0

func CreateQueryParamStatusFilterArrayOfCheckoutStatus(arrayOfCheckoutStatus []components.CheckoutStatus) QueryParamStatusFilter

func CreateQueryParamStatusFilterCheckoutStatus added in v0.13.0

func CreateQueryParamStatusFilterCheckoutStatus(checkoutStatus components.CheckoutStatus) QueryParamStatusFilter

func (QueryParamStatusFilter) MarshalJSON added in v0.4.17

func (u QueryParamStatusFilter) MarshalJSON() ([]byte, error)

func (*QueryParamStatusFilter) UnmarshalJSON added in v0.4.17

func (u *QueryParamStatusFilter) UnmarshalJSON(data []byte) error

type QueryParamStatusFilterType added in v0.4.17

type QueryParamStatusFilterType string
const (
	QueryParamStatusFilterTypeCheckoutStatus        QueryParamStatusFilterType = "CheckoutStatus"
	QueryParamStatusFilterTypeArrayOfCheckoutStatus QueryParamStatusFilterType = "arrayOfCheckoutStatus"
)

type QueryParamSubscriptionIDFilter

type QueryParamSubscriptionIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type QueryParamSubscriptionIDFilterType
}

QueryParamSubscriptionIDFilter - Filter by subscription ID.

func CreateQueryParamSubscriptionIDFilterArrayOfStr

func CreateQueryParamSubscriptionIDFilterArrayOfStr(arrayOfStr []string) QueryParamSubscriptionIDFilter

func CreateQueryParamSubscriptionIDFilterStr

func CreateQueryParamSubscriptionIDFilterStr(str string) QueryParamSubscriptionIDFilter

func (QueryParamSubscriptionIDFilter) MarshalJSON

func (u QueryParamSubscriptionIDFilter) MarshalJSON() ([]byte, error)

func (*QueryParamSubscriptionIDFilter) UnmarshalJSON

func (u *QueryParamSubscriptionIDFilter) UnmarshalJSON(data []byte) error

type QueryParamSubscriptionIDFilterType

type QueryParamSubscriptionIDFilterType string
const (
	QueryParamSubscriptionIDFilterTypeStr        QueryParamSubscriptionIDFilterType = "str"
	QueryParamSubscriptionIDFilterTypeArrayOfStr QueryParamSubscriptionIDFilterType = "arrayOfStr"
)

type RefundIDFilter added in v0.1.5

type RefundIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type RefundIDFilterType
}

RefundIDFilter - Filter by refund ID.

func CreateRefundIDFilterArrayOfStr added in v0.1.5

func CreateRefundIDFilterArrayOfStr(arrayOfStr []string) RefundIDFilter

func CreateRefundIDFilterStr added in v0.1.5

func CreateRefundIDFilterStr(str string) RefundIDFilter

func (RefundIDFilter) MarshalJSON added in v0.1.5

func (u RefundIDFilter) MarshalJSON() ([]byte, error)

func (*RefundIDFilter) UnmarshalJSON added in v0.1.5

func (u *RefundIDFilter) UnmarshalJSON(data []byte) error

type RefundIDFilterType added in v0.1.5

type RefundIDFilterType string
const (
	RefundIDFilterTypeStr        RefundIDFilterType = "str"
	RefundIDFilterTypeArrayOfStr RefundIDFilterType = "arrayOfStr"
)

type RefundsCreateResponse added in v0.1.5

type RefundsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Refund created.
	Refund *components.Refund
}

func (*RefundsCreateResponse) GetHTTPMeta added in v0.1.5

func (*RefundsCreateResponse) GetRefund added in v0.1.5

func (r *RefundsCreateResponse) GetRefund() *components.Refund

type RefundsListQueryParamCustomerIDFilter added in v0.1.5

type RefundsListQueryParamCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type RefundsListQueryParamCustomerIDFilterType
}

RefundsListQueryParamCustomerIDFilter - Filter by customer ID.

func CreateRefundsListQueryParamCustomerIDFilterArrayOfStr added in v0.1.5

func CreateRefundsListQueryParamCustomerIDFilterArrayOfStr(arrayOfStr []string) RefundsListQueryParamCustomerIDFilter

func CreateRefundsListQueryParamCustomerIDFilterStr added in v0.1.5

func CreateRefundsListQueryParamCustomerIDFilterStr(str string) RefundsListQueryParamCustomerIDFilter

func (RefundsListQueryParamCustomerIDFilter) MarshalJSON added in v0.1.5

func (u RefundsListQueryParamCustomerIDFilter) MarshalJSON() ([]byte, error)

func (*RefundsListQueryParamCustomerIDFilter) UnmarshalJSON added in v0.1.5

func (u *RefundsListQueryParamCustomerIDFilter) UnmarshalJSON(data []byte) error

type RefundsListQueryParamCustomerIDFilterType added in v0.1.5

type RefundsListQueryParamCustomerIDFilterType string
const (
	RefundsListQueryParamCustomerIDFilterTypeStr        RefundsListQueryParamCustomerIDFilterType = "str"
	RefundsListQueryParamCustomerIDFilterTypeArrayOfStr RefundsListQueryParamCustomerIDFilterType = "arrayOfStr"
)

type RefundsListQueryParamExternalCustomerIDFilter added in v0.13.0

type RefundsListQueryParamExternalCustomerIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type RefundsListQueryParamExternalCustomerIDFilterType
}

RefundsListQueryParamExternalCustomerIDFilter - Filter by customer external ID.

func CreateRefundsListQueryParamExternalCustomerIDFilterArrayOfStr added in v0.13.0

func CreateRefundsListQueryParamExternalCustomerIDFilterArrayOfStr(arrayOfStr []string) RefundsListQueryParamExternalCustomerIDFilter

func CreateRefundsListQueryParamExternalCustomerIDFilterStr added in v0.13.0

func CreateRefundsListQueryParamExternalCustomerIDFilterStr(str string) RefundsListQueryParamExternalCustomerIDFilter

func (RefundsListQueryParamExternalCustomerIDFilter) MarshalJSON added in v0.13.0

func (*RefundsListQueryParamExternalCustomerIDFilter) UnmarshalJSON added in v0.13.0

func (u *RefundsListQueryParamExternalCustomerIDFilter) UnmarshalJSON(data []byte) error

type RefundsListQueryParamExternalCustomerIDFilterType added in v0.13.0

type RefundsListQueryParamExternalCustomerIDFilterType string
const (
	RefundsListQueryParamExternalCustomerIDFilterTypeStr        RefundsListQueryParamExternalCustomerIDFilterType = "str"
	RefundsListQueryParamExternalCustomerIDFilterTypeArrayOfStr RefundsListQueryParamExternalCustomerIDFilterType = "arrayOfStr"
)

type RefundsListQueryParamOrganizationIDFilter added in v0.1.5

type RefundsListQueryParamOrganizationIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type RefundsListQueryParamOrganizationIDFilterType
}

RefundsListQueryParamOrganizationIDFilter - Filter by organization ID.

func CreateRefundsListQueryParamOrganizationIDFilterArrayOfStr added in v0.1.5

func CreateRefundsListQueryParamOrganizationIDFilterArrayOfStr(arrayOfStr []string) RefundsListQueryParamOrganizationIDFilter

func CreateRefundsListQueryParamOrganizationIDFilterStr added in v0.1.5

func CreateRefundsListQueryParamOrganizationIDFilterStr(str string) RefundsListQueryParamOrganizationIDFilter

func (RefundsListQueryParamOrganizationIDFilter) MarshalJSON added in v0.1.5

func (*RefundsListQueryParamOrganizationIDFilter) UnmarshalJSON added in v0.1.5

func (u *RefundsListQueryParamOrganizationIDFilter) UnmarshalJSON(data []byte) error

type RefundsListQueryParamOrganizationIDFilterType added in v0.1.5

type RefundsListQueryParamOrganizationIDFilterType string
const (
	RefundsListQueryParamOrganizationIDFilterTypeStr        RefundsListQueryParamOrganizationIDFilterType = "str"
	RefundsListQueryParamOrganizationIDFilterTypeArrayOfStr RefundsListQueryParamOrganizationIDFilterType = "arrayOfStr"
)

type RefundsListRequest added in v0.1.5

type RefundsListRequest struct {
	// Filter by refund ID.
	ID *RefundIDFilter `queryParam:"style=form,explode=true,name=id"`
	// Filter by organization ID.
	OrganizationID *RefundsListQueryParamOrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by order ID.
	OrderID *OrderIDFilter `queryParam:"style=form,explode=true,name=order_id"`
	// Filter by subscription ID.
	SubscriptionID *SubscriptionIDFilter `queryParam:"style=form,explode=true,name=subscription_id"`
	// Filter by customer ID.
	CustomerID *RefundsListQueryParamCustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by customer external ID.
	ExternalCustomerID *RefundsListQueryParamExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by `succeeded`.
	Succeeded *bool `queryParam:"style=form,explode=true,name=succeeded"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.RefundSortProperty `queryParam:"style=form,explode=true,name=sorting"`
}

func (*RefundsListRequest) GetCustomerID added in v0.1.5

func (*RefundsListRequest) GetExternalCustomerID added in v0.13.0

func (*RefundsListRequest) GetID added in v0.1.5

func (r *RefundsListRequest) GetID() *RefundIDFilter

func (*RefundsListRequest) GetLimit added in v0.1.5

func (r *RefundsListRequest) GetLimit() *int64

func (*RefundsListRequest) GetOrderID added in v0.1.5

func (r *RefundsListRequest) GetOrderID() *OrderIDFilter

func (*RefundsListRequest) GetOrganizationID added in v0.1.5

func (*RefundsListRequest) GetPage added in v0.1.5

func (r *RefundsListRequest) GetPage() *int64

func (*RefundsListRequest) GetSorting added in v0.1.5

func (*RefundsListRequest) GetSubscriptionID added in v0.1.5

func (r *RefundsListRequest) GetSubscriptionID() *SubscriptionIDFilter

func (*RefundsListRequest) GetSucceeded added in v0.1.5

func (r *RefundsListRequest) GetSucceeded() *bool

func (RefundsListRequest) MarshalJSON added in v0.1.5

func (r RefundsListRequest) MarshalJSON() ([]byte, error)

func (*RefundsListRequest) UnmarshalJSON added in v0.1.5

func (r *RefundsListRequest) UnmarshalJSON(data []byte) error

type RefundsListResponse added in v0.1.5

type RefundsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceRefund *components.ListResourceRefund

	Next func() (*RefundsListResponse, error)
}

func (*RefundsListResponse) GetHTTPMeta added in v0.1.5

func (r *RefundsListResponse) GetHTTPMeta() components.HTTPMetadata

func (*RefundsListResponse) GetListResourceRefund added in v0.1.5

func (r *RefundsListResponse) GetListResourceRefund() *components.ListResourceRefund

type SourceFilter added in v0.1.8

type SourceFilter struct {
	EventSource        *components.EventSource  `queryParam:"inline" union:"member"`
	ArrayOfEventSource []components.EventSource `queryParam:"inline" union:"member"`

	Type SourceFilterType
}

SourceFilter - Filter by event source.

func CreateSourceFilterArrayOfEventSource added in v0.1.8

func CreateSourceFilterArrayOfEventSource(arrayOfEventSource []components.EventSource) SourceFilter

func CreateSourceFilterEventSource added in v0.1.8

func CreateSourceFilterEventSource(eventSource components.EventSource) SourceFilter

func (SourceFilter) MarshalJSON added in v0.1.8

func (u SourceFilter) MarshalJSON() ([]byte, error)

func (*SourceFilter) UnmarshalJSON added in v0.1.8

func (u *SourceFilter) UnmarshalJSON(data []byte) error

type SourceFilterType added in v0.1.8

type SourceFilterType string
const (
	SourceFilterTypeEventSource        SourceFilterType = "EventSource"
	SourceFilterTypeArrayOfEventSource SourceFilterType = "arrayOfEventSource"
)

type StatusFilter added in v0.4.17

type StatusFilter struct {
	DisputeStatus        *components.DisputeStatus  `queryParam:"inline" union:"member"`
	ArrayOfDisputeStatus []components.DisputeStatus `queryParam:"inline" union:"member"`

	Type StatusFilterType
}

StatusFilter - Filter by dispute status.

func CreateStatusFilterArrayOfDisputeStatus added in v0.13.0

func CreateStatusFilterArrayOfDisputeStatus(arrayOfDisputeStatus []components.DisputeStatus) StatusFilter

func CreateStatusFilterDisputeStatus added in v0.13.0

func CreateStatusFilterDisputeStatus(disputeStatus components.DisputeStatus) StatusFilter

func (StatusFilter) MarshalJSON added in v0.4.17

func (u StatusFilter) MarshalJSON() ([]byte, error)

func (*StatusFilter) UnmarshalJSON added in v0.4.17

func (u *StatusFilter) UnmarshalJSON(data []byte) error

type StatusFilterType added in v0.4.17

type StatusFilterType string
const (
	StatusFilterTypeDisputeStatus        StatusFilterType = "DisputeStatus"
	StatusFilterTypeArrayOfDisputeStatus StatusFilterType = "arrayOfDisputeStatus"
)

type SubscriptionIDFilter

type SubscriptionIDFilter struct {
	Str        *string  `queryParam:"inline" union:"member"`
	ArrayOfStr []string `queryParam:"inline" union:"member"`

	Type SubscriptionIDFilterType
}

SubscriptionIDFilter - Filter by subscription ID.

func CreateSubscriptionIDFilterArrayOfStr

func CreateSubscriptionIDFilterArrayOfStr(arrayOfStr []string) SubscriptionIDFilter

func CreateSubscriptionIDFilterStr

func CreateSubscriptionIDFilterStr(str string) SubscriptionIDFilter

func (SubscriptionIDFilter) MarshalJSON

func (u SubscriptionIDFilter) MarshalJSON() ([]byte, error)

func (*SubscriptionIDFilter) UnmarshalJSON

func (u *SubscriptionIDFilter) UnmarshalJSON(data []byte) error

type SubscriptionIDFilterType

type SubscriptionIDFilterType string
const (
	SubscriptionIDFilterTypeStr        SubscriptionIDFilterType = "str"
	SubscriptionIDFilterTypeArrayOfStr SubscriptionIDFilterType = "arrayOfStr"
)

type SubscriptionsCreateResponse added in v0.12.0

type SubscriptionsCreateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Subscription created.
	Subscription *components.Subscription
}

func (*SubscriptionsCreateResponse) GetHTTPMeta added in v0.12.0

func (*SubscriptionsCreateResponse) GetSubscription added in v0.12.0

func (s *SubscriptionsCreateResponse) GetSubscription() *components.Subscription

type SubscriptionsCreateSubscriptionCreate added in v0.12.0

type SubscriptionsCreateSubscriptionCreate struct {
	SubscriptionCreateCustomer         *components.SubscriptionCreateCustomer         `queryParam:"inline" union:"member"`
	SubscriptionCreateExternalCustomer *components.SubscriptionCreateExternalCustomer `queryParam:"inline" union:"member"`

	Type SubscriptionsCreateSubscriptionCreateType
}

func CreateSubscriptionsCreateSubscriptionCreateSubscriptionCreateCustomer added in v0.12.0

func CreateSubscriptionsCreateSubscriptionCreateSubscriptionCreateCustomer(subscriptionCreateCustomer components.SubscriptionCreateCustomer) SubscriptionsCreateSubscriptionCreate

func CreateSubscriptionsCreateSubscriptionCreateSubscriptionCreateExternalCustomer added in v0.12.0

func CreateSubscriptionsCreateSubscriptionCreateSubscriptionCreateExternalCustomer(subscriptionCreateExternalCustomer components.SubscriptionCreateExternalCustomer) SubscriptionsCreateSubscriptionCreate

func (SubscriptionsCreateSubscriptionCreate) MarshalJSON added in v0.12.0

func (u SubscriptionsCreateSubscriptionCreate) MarshalJSON() ([]byte, error)

func (*SubscriptionsCreateSubscriptionCreate) UnmarshalJSON added in v0.12.0

func (u *SubscriptionsCreateSubscriptionCreate) UnmarshalJSON(data []byte) error

type SubscriptionsCreateSubscriptionCreateType added in v0.12.0

type SubscriptionsCreateSubscriptionCreateType string
const (
	SubscriptionsCreateSubscriptionCreateTypeSubscriptionCreateCustomer         SubscriptionsCreateSubscriptionCreateType = "SubscriptionCreateCustomer"
	SubscriptionsCreateSubscriptionCreateTypeSubscriptionCreateExternalCustomer SubscriptionsCreateSubscriptionCreateType = "SubscriptionCreateExternalCustomer"
)

type SubscriptionsExportRequest

type SubscriptionsExportRequest struct {
	// Filter by organization ID.
	OrganizationID *OrganizationID `queryParam:"style=form,explode=true,name=organization_id"`
}

func (*SubscriptionsExportRequest) GetOrganizationID

func (s *SubscriptionsExportRequest) GetOrganizationID() *OrganizationID

type SubscriptionsExportResponse

type SubscriptionsExportResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Any any
	// Successful Response
	Res *string
}

func (*SubscriptionsExportResponse) GetAny

func (s *SubscriptionsExportResponse) GetAny() any

func (*SubscriptionsExportResponse) GetHTTPMeta

func (*SubscriptionsExportResponse) GetRes added in v0.13.0

func (s *SubscriptionsExportResponse) GetRes() *string

type SubscriptionsGetRequest added in v0.1.7

type SubscriptionsGetRequest struct {
	// The subscription ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*SubscriptionsGetRequest) GetID added in v0.1.7

func (s *SubscriptionsGetRequest) GetID() string

type SubscriptionsGetResponse added in v0.1.7

type SubscriptionsGetResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	Subscription *components.Subscription
}

func (*SubscriptionsGetResponse) GetHTTPMeta added in v0.1.7

func (*SubscriptionsGetResponse) GetSubscription added in v0.1.7

func (s *SubscriptionsGetResponse) GetSubscription() *components.Subscription

type SubscriptionsListRequest

type SubscriptionsListRequest struct {
	// Filter by organization ID.
	OrganizationID *OrganizationIDFilter `queryParam:"style=form,explode=true,name=organization_id"`
	// Filter by product ID.
	ProductID *ProductIDFilter `queryParam:"style=form,explode=true,name=product_id"`
	// Filter by customer ID.
	CustomerID *CustomerIDFilter `queryParam:"style=form,explode=true,name=customer_id"`
	// Filter by customer external ID.
	ExternalCustomerID *ExternalCustomerIDFilter `queryParam:"style=form,explode=true,name=external_customer_id"`
	// Filter by discount ID.
	DiscountID *DiscountIDFilter `queryParam:"style=form,explode=true,name=discount_id"`
	// Filter by active or inactive subscription.
	Active *bool `queryParam:"style=form,explode=true,name=active"`
	// Filter by subscriptions that are set to cancel at period end.
	CancelAtPeriodEnd *bool `queryParam:"style=form,explode=true,name=cancel_at_period_end"`
	// Filter by customer cancellation reason.
	CustomerCancellationReason *CustomerCancellationReasonFilter `queryParam:"style=form,explode=true,name=customer_cancellation_reason"`
	// Filter by cancellation date (after or equal to).
	CanceledAtAfter *time.Time `queryParam:"style=form,explode=true,name=canceled_at_after"`
	// Filter by cancellation date (before or equal to).
	CanceledAtBefore *time.Time `queryParam:"style=form,explode=true,name=canceled_at_before"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
	// Sorting criterion. Several criteria can be used simultaneously and will be applied in order. Add a minus sign `-` before the criteria name to sort by descending order.
	Sorting []components.SubscriptionSortProperty `queryParam:"style=form,explode=true,name=sorting"`
	// Filter by metadata key-value pairs. It uses the `deepObject` style, e.g. `?metadata[key]=value`.
	Metadata map[string]components.MetadataQuery `queryParam:"style=deepObject,explode=true,name=metadata"`
}

func (*SubscriptionsListRequest) GetActive

func (s *SubscriptionsListRequest) GetActive() *bool

func (*SubscriptionsListRequest) GetCancelAtPeriodEnd added in v0.13.0

func (s *SubscriptionsListRequest) GetCancelAtPeriodEnd() *bool

func (*SubscriptionsListRequest) GetCanceledAtAfter added in v0.16.0

func (s *SubscriptionsListRequest) GetCanceledAtAfter() *time.Time

func (*SubscriptionsListRequest) GetCanceledAtBefore added in v0.16.0

func (s *SubscriptionsListRequest) GetCanceledAtBefore() *time.Time

func (*SubscriptionsListRequest) GetCustomerCancellationReason added in v0.16.0

func (s *SubscriptionsListRequest) GetCustomerCancellationReason() *CustomerCancellationReasonFilter

func (*SubscriptionsListRequest) GetCustomerID

func (s *SubscriptionsListRequest) GetCustomerID() *CustomerIDFilter

func (*SubscriptionsListRequest) GetDiscountID

func (s *SubscriptionsListRequest) GetDiscountID() *DiscountIDFilter

func (*SubscriptionsListRequest) GetExternalCustomerID added in v0.7.2

func (s *SubscriptionsListRequest) GetExternalCustomerID() *ExternalCustomerIDFilter

func (*SubscriptionsListRequest) GetLimit

func (s *SubscriptionsListRequest) GetLimit() *int64

func (*SubscriptionsListRequest) GetMetadata added in v0.4.19

func (*SubscriptionsListRequest) GetOrganizationID

func (s *SubscriptionsListRequest) GetOrganizationID() *OrganizationIDFilter

func (*SubscriptionsListRequest) GetPage

func (s *SubscriptionsListRequest) GetPage() *int64

func (*SubscriptionsListRequest) GetProductID

func (s *SubscriptionsListRequest) GetProductID() *ProductIDFilter

func (*SubscriptionsListRequest) GetSorting

func (SubscriptionsListRequest) MarshalJSON

func (s SubscriptionsListRequest) MarshalJSON() ([]byte, error)

func (*SubscriptionsListRequest) UnmarshalJSON

func (s *SubscriptionsListRequest) UnmarshalJSON(data []byte) error

type SubscriptionsListResponse

type SubscriptionsListResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceSubscription *components.ListResourceSubscription

	Next func() (*SubscriptionsListResponse, error)
}

func (*SubscriptionsListResponse) GetHTTPMeta

func (*SubscriptionsListResponse) GetListResourceSubscription

func (s *SubscriptionsListResponse) GetListResourceSubscription() *components.ListResourceSubscription

type SubscriptionsRevokeRequest added in v0.1.1

type SubscriptionsRevokeRequest struct {
	// The subscription ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*SubscriptionsRevokeRequest) GetID added in v0.1.1

type SubscriptionsRevokeResponse added in v0.1.1

type SubscriptionsRevokeResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Subscription revoked.
	Subscription *components.Subscription
}

func (*SubscriptionsRevokeResponse) GetHTTPMeta added in v0.1.1

func (*SubscriptionsRevokeResponse) GetSubscription added in v0.1.1

func (s *SubscriptionsRevokeResponse) GetSubscription() *components.Subscription

type SubscriptionsUpdateRequest added in v0.1.1

type SubscriptionsUpdateRequest struct {
	// The subscription ID.
	ID                 string                        `pathParam:"style=simple,explode=false,name=id"`
	SubscriptionUpdate components.SubscriptionUpdate `request:"mediaType=application/json"`
}

func (*SubscriptionsUpdateRequest) GetID added in v0.1.1

func (*SubscriptionsUpdateRequest) GetSubscriptionUpdate added in v0.1.1

func (s *SubscriptionsUpdateRequest) GetSubscriptionUpdate() components.SubscriptionUpdate

type SubscriptionsUpdateResponse added in v0.1.1

type SubscriptionsUpdateResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Subscription updated.
	Subscription *components.Subscription
}

func (*SubscriptionsUpdateResponse) GetHTTPMeta added in v0.1.1

func (*SubscriptionsUpdateResponse) GetSubscription added in v0.1.1

func (s *SubscriptionsUpdateResponse) GetSubscription() *components.Subscription

type WebhooksCreateWebhookEndpointResponse added in v0.6.1

type WebhooksCreateWebhookEndpointResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Webhook endpoint created.
	WebhookEndpoint *components.WebhookEndpoint
}

func (*WebhooksCreateWebhookEndpointResponse) GetHTTPMeta added in v0.6.1

func (*WebhooksCreateWebhookEndpointResponse) GetWebhookEndpoint added in v0.6.1

type WebhooksDeleteWebhookEndpointRequest added in v0.6.1

type WebhooksDeleteWebhookEndpointRequest struct {
	// The webhook endpoint ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*WebhooksDeleteWebhookEndpointRequest) GetID added in v0.6.1

type WebhooksDeleteWebhookEndpointResponse added in v0.6.1

type WebhooksDeleteWebhookEndpointResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
}

func (*WebhooksDeleteWebhookEndpointResponse) GetHTTPMeta added in v0.6.1

type WebhooksGetWebhookEndpointRequest added in v0.6.1

type WebhooksGetWebhookEndpointRequest struct {
	// The webhook endpoint ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*WebhooksGetWebhookEndpointRequest) GetID added in v0.6.1

type WebhooksGetWebhookEndpointResponse added in v0.6.1

type WebhooksGetWebhookEndpointResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	WebhookEndpoint *components.WebhookEndpoint
}

func (*WebhooksGetWebhookEndpointResponse) GetHTTPMeta added in v0.6.1

func (*WebhooksGetWebhookEndpointResponse) GetWebhookEndpoint added in v0.6.1

type WebhooksListWebhookDeliveriesRequest added in v0.6.1

type WebhooksListWebhookDeliveriesRequest struct {
	// Filter by webhook endpoint ID.
	EndpointID *EndpointID `queryParam:"style=form,explode=true,name=endpoint_id"`
	// Filter deliveries after this timestamp.
	StartTimestamp *time.Time `queryParam:"style=form,explode=true,name=start_timestamp"`
	// Filter deliveries before this timestamp.
	EndTimestamp *time.Time `queryParam:"style=form,explode=true,name=end_timestamp"`
	// Filter by delivery success status.
	Succeeded *bool `queryParam:"style=form,explode=true,name=succeeded"`
	// Query to filter webhook deliveries.
	Query *string `queryParam:"style=form,explode=true,name=query"`
	// Filter by HTTP response code class (2xx, 3xx, 4xx, 5xx).
	HTTPCodeClass *HTTPCodeClass `queryParam:"style=form,explode=true,name=http_code_class"`
	// Filter by webhook event type.
	EventType *EventType `queryParam:"style=form,explode=true,name=event_type"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*WebhooksListWebhookDeliveriesRequest) GetEndTimestamp added in v0.9.0

func (w *WebhooksListWebhookDeliveriesRequest) GetEndTimestamp() *time.Time

func (*WebhooksListWebhookDeliveriesRequest) GetEndpointID added in v0.6.1

func (*WebhooksListWebhookDeliveriesRequest) GetEventType added in v0.13.0

func (*WebhooksListWebhookDeliveriesRequest) GetHTTPCodeClass added in v0.13.0

func (w *WebhooksListWebhookDeliveriesRequest) GetHTTPCodeClass() *HTTPCodeClass

func (*WebhooksListWebhookDeliveriesRequest) GetLimit added in v0.6.1

func (*WebhooksListWebhookDeliveriesRequest) GetPage added in v0.6.1

func (*WebhooksListWebhookDeliveriesRequest) GetQuery added in v0.13.0

func (*WebhooksListWebhookDeliveriesRequest) GetStartTimestamp added in v0.9.0

func (w *WebhooksListWebhookDeliveriesRequest) GetStartTimestamp() *time.Time

func (*WebhooksListWebhookDeliveriesRequest) GetSucceeded added in v0.13.0

func (w *WebhooksListWebhookDeliveriesRequest) GetSucceeded() *bool

func (WebhooksListWebhookDeliveriesRequest) MarshalJSON added in v0.6.1

func (w WebhooksListWebhookDeliveriesRequest) MarshalJSON() ([]byte, error)

func (*WebhooksListWebhookDeliveriesRequest) UnmarshalJSON added in v0.6.1

func (w *WebhooksListWebhookDeliveriesRequest) UnmarshalJSON(data []byte) error

type WebhooksListWebhookDeliveriesResponse added in v0.6.1

type WebhooksListWebhookDeliveriesResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceWebhookDelivery *components.ListResourceWebhookDelivery

	Next func() (*WebhooksListWebhookDeliveriesResponse, error)
}

func (*WebhooksListWebhookDeliveriesResponse) GetHTTPMeta added in v0.6.1

func (*WebhooksListWebhookDeliveriesResponse) GetListResourceWebhookDelivery added in v0.6.1

type WebhooksListWebhookEndpointsRequest added in v0.6.1

type WebhooksListWebhookEndpointsRequest struct {
	// Filter by organization ID.
	OrganizationID *QueryParamOrganizationID `queryParam:"style=form,explode=true,name=organization_id"`
	// Page number, defaults to 1.
	Page *int64 `default:"1" queryParam:"style=form,explode=true,name=page"`
	// Size of a page, defaults to 10. Maximum is 100.
	Limit *int64 `default:"10" queryParam:"style=form,explode=true,name=limit"`
}

func (*WebhooksListWebhookEndpointsRequest) GetLimit added in v0.6.1

func (*WebhooksListWebhookEndpointsRequest) GetOrganizationID added in v0.6.1

func (*WebhooksListWebhookEndpointsRequest) GetPage added in v0.6.1

func (WebhooksListWebhookEndpointsRequest) MarshalJSON added in v0.6.1

func (w WebhooksListWebhookEndpointsRequest) MarshalJSON() ([]byte, error)

func (*WebhooksListWebhookEndpointsRequest) UnmarshalJSON added in v0.6.1

func (w *WebhooksListWebhookEndpointsRequest) UnmarshalJSON(data []byte) error

type WebhooksListWebhookEndpointsResponse added in v0.6.1

type WebhooksListWebhookEndpointsResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Successful Response
	ListResourceWebhookEndpoint *components.ListResourceWebhookEndpoint

	Next func() (*WebhooksListWebhookEndpointsResponse, error)
}

func (*WebhooksListWebhookEndpointsResponse) GetHTTPMeta added in v0.6.1

func (*WebhooksListWebhookEndpointsResponse) GetListResourceWebhookEndpoint added in v0.6.1

type WebhooksRedeliverWebhookEventRequest added in v0.6.1

type WebhooksRedeliverWebhookEventRequest struct {
	// The webhook event ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*WebhooksRedeliverWebhookEventRequest) GetID added in v0.6.1

type WebhooksRedeliverWebhookEventResponse added in v0.6.1

type WebhooksRedeliverWebhookEventResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Webhook event re-delivery scheduled.
	Any any
}

func (*WebhooksRedeliverWebhookEventResponse) GetAny added in v0.6.1

func (*WebhooksRedeliverWebhookEventResponse) GetHTTPMeta added in v0.6.1

type WebhooksResetWebhookEndpointSecretRequest added in v0.7.3

type WebhooksResetWebhookEndpointSecretRequest struct {
	// The webhook endpoint ID.
	ID string `pathParam:"style=simple,explode=false,name=id"`
}

func (*WebhooksResetWebhookEndpointSecretRequest) GetID added in v0.7.3

type WebhooksResetWebhookEndpointSecretResponse added in v0.7.3

type WebhooksResetWebhookEndpointSecretResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Webhook endpoint secret reset.
	WebhookEndpoint *components.WebhookEndpoint
}

func (*WebhooksResetWebhookEndpointSecretResponse) GetHTTPMeta added in v0.7.3

func (*WebhooksResetWebhookEndpointSecretResponse) GetWebhookEndpoint added in v0.7.3

type WebhooksUpdateWebhookEndpointRequest added in v0.6.1

type WebhooksUpdateWebhookEndpointRequest struct {
	// The webhook endpoint ID.
	ID                    string                           `pathParam:"style=simple,explode=false,name=id"`
	WebhookEndpointUpdate components.WebhookEndpointUpdate `request:"mediaType=application/json"`
}

func (*WebhooksUpdateWebhookEndpointRequest) GetID added in v0.6.1

func (*WebhooksUpdateWebhookEndpointRequest) GetWebhookEndpointUpdate added in v0.6.1

type WebhooksUpdateWebhookEndpointResponse added in v0.6.1

type WebhooksUpdateWebhookEndpointResponse struct {
	HTTPMeta components.HTTPMetadata `json:"-"`
	// Webhook endpoint updated.
	WebhookEndpoint *components.WebhookEndpoint
}

func (*WebhooksUpdateWebhookEndpointResponse) GetHTTPMeta added in v0.6.1

func (*WebhooksUpdateWebhookEndpointResponse) GetWebhookEndpoint added in v0.6.1

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL