plans_pkg

package

v0.0.0-...-6ed0ad3 Latest Latest Go to latest Published: Jun 19, 2023 License: MIT Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mundipagg/mundiapi-go

Links

Open Source Insights

Documentation ¶

Index ¶

type PLANS
type PLANS_IMPL
- func NewPLANS(config configuration_pkg.CONFIGURATION) *PLANS_IMPL

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type PLANS ¶

type PLANS interface {
	UpdatePlanItem(string, string, *models_pkg.PlansItemsRequest, *string) (*models_pkg.PlansItemsResponse, error)

	DeletePlanItem(string, string, *string) (*models_pkg.PlansItemsResponse, error)

	GetPlanItem(string, string) (*models_pkg.PlansItemsResponse, error)

	CreatePlanItem(string, *models_pkg.PlansItemsRequest1, *string) (*models_pkg.PlansItemsResponse, error)

	GetPlans(*int64, *int64, *string, *string, *string, *time.Time, *time.Time) (*models_pkg.PlansResponse, error)

	CreatePlan(*models_pkg.PlansRequest, *string) (*models_pkg.PlansResponse1, error)

	GetPlan(string) (*models_pkg.PlansResponse1, error)

	UpdatePlan(string, *models_pkg.PlansRequest1, *string) (*models_pkg.PlansResponse1, error)

	DeletePlan(string, *string) (*models_pkg.PlansResponse1, error)

	UpdatePlanMetadata(string, *models_pkg.PlansMetadataRequest, *string) (*models_pkg.PlansMetadataResponse, error)
}

* Interface for the PLANS_IMPL

type PLANS_IMPL ¶

type PLANS_IMPL struct {
	// contains filtered or unexported fields
}

* Client structure as interface implementation

func NewPLANS ¶

func NewPLANS(config configuration_pkg.CONFIGURATION) *PLANS_IMPL

* Factory for the PLANS interaface returning PLANS_IMPL

func (*PLANS_IMPL) CreatePlan ¶

func (me *PLANS_IMPL) CreatePlan(
	body *models_pkg.PlansRequest,
	idempotencyKey *string) (*models_pkg.PlansResponse1, error)

*

Creates a new plan
@param *models_pkg.PlansRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.PlansResponse1 response from the API call

func (*PLANS_IMPL) CreatePlanItem ¶

func (me *PLANS_IMPL) CreatePlanItem(
	planId string,
	body *models_pkg.PlansItemsRequest1,
	idempotencyKey *string) (*models_pkg.PlansItemsResponse, error)

*

Adds a new item to a plan
@param string planId parameter: Required
@param *models_pkg.PlansItemsRequest1 body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.PlansItemsResponse response from the API call

func (*PLANS_IMPL) DeletePlan ¶

func (me *PLANS_IMPL) DeletePlan(
	planId string,
	idempotencyKey *string) (*models_pkg.PlansResponse1, error)

*

Deletes a plan
@param string planId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.PlansResponse1 response from the API call

func (*PLANS_IMPL) DeletePlanItem ¶

func (me *PLANS_IMPL) DeletePlanItem(
	planId string,
	planItemId string,
	idempotencyKey *string) (*models_pkg.PlansItemsResponse, error)

*

Removes an item from a plan
@param string planId parameter: Required
@param string planItemId parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.PlansItemsResponse response from the API call

func (*PLANS_IMPL) GetPlan ¶

func (me *PLANS_IMPL) GetPlan(
	planId string) (*models_pkg.PlansResponse1, error)

*

Gets a plan
@param string planId parameter: Required
@return Returns the *models_pkg.PlansResponse1 response from the API call

func (*PLANS_IMPL) GetPlanItem ¶

func (me *PLANS_IMPL) GetPlanItem(
	planId string,
	planItemId string) (*models_pkg.PlansItemsResponse, error)

*

Gets a plan item
@param string planId parameter: Required
@param string planItemId parameter: Required
@return Returns the *models_pkg.PlansItemsResponse response from the API call

func (*PLANS_IMPL) GetPlans ¶

func (me *PLANS_IMPL) GetPlans(
	page *int64,
	size *int64,
	name *string,
	status *string,
	billingType *string,
	createdSince *time.Time,
	createdUntil *time.Time) (*models_pkg.PlansResponse, error)

*

Gets all plans
@param *int64 page parameter: Optional
@param *int64 size parameter: Optional
@param *string name parameter: Optional
@param *string status parameter: Optional
@param *string billingType parameter: Optional
@param *time.Time createdSince parameter: Optional
@param *time.Time createdUntil parameter: Optional
@return Returns the *models_pkg.PlansResponse response from the API call

func (*PLANS_IMPL) UpdatePlan ¶

func (me *PLANS_IMPL) UpdatePlan(
	planId string,
	body *models_pkg.PlansRequest1,
	idempotencyKey *string) (*models_pkg.PlansResponse1, error)

*

Updates a plan
@param string planId parameter: Required
@param *models_pkg.PlansRequest1 body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.PlansResponse1 response from the API call

func (*PLANS_IMPL) UpdatePlanItem ¶

func (me *PLANS_IMPL) UpdatePlanItem(
	planId string,
	planItemId string,
	body *models_pkg.PlansItemsRequest,
	idempotencyKey *string) (*models_pkg.PlansItemsResponse, error)

*

Updates a plan item
@param string planId parameter: Required
@param string planItemId parameter: Required
@param *models_pkg.PlansItemsRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.PlansItemsResponse response from the API call

func (*PLANS_IMPL) UpdatePlanMetadata ¶

func (me *PLANS_IMPL) UpdatePlanMetadata(
	planId string,
	body *models_pkg.PlansMetadataRequest,
	idempotencyKey *string) (*models_pkg.PlansMetadataResponse, error)

*

Updates the metadata from a plan
@param string planId parameter: Required
@param *models_pkg.PlansMetadataRequest body parameter: Required
@param *string idempotencyKey parameter: Optional
@return Returns the *models_pkg.PlansMetadataResponse response from the API call

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL