offers_controller.go

/*
Package advancedbilling

This file was automatically generated for Maxio by APIMATIC v3.0 ( https://www.apimatic.io ).
*/
package advancedbilling

import (
    "context"
    "fmt"
    "github.com/apimatic/go-core-runtime/https"
    "github.com/apimatic/go-core-runtime/utilities"
    "github.com/maxio-com/ab-golang-sdk/errors"
    "github.com/maxio-com/ab-golang-sdk/models"
    "net/http"
)

// OffersController represents a controller struct.
type OffersController struct {
    baseController
}

// NewOffersController creates a new instance of OffersController.
// It takes a baseController as a parameter and returns a pointer to the OffersController.
func NewOffersController(baseController baseController) *OffersController {
    offersController := OffersController{baseController: baseController}
    return &offersController
}

// CreateOffer takes context, body as parameters and
// returns an models.ApiResponse with models.OfferResponse data and
// an error if there was an issue with the request or response.
// Create an offer within your Advanced Billing site by sending a POST request.
// ## Documentation
// Offers allow you to package complicated combinations of products, components and coupons into a convenient package which can then be subscribed to just like products.
// Once an offer is defined it can be used as an alternative to the product when creating subscriptions.
// Full documentation on how to use offers in the Advanced Billing UI can be located [here](https://maxio.zendesk.com/hc/en-us/articles/24261295098637-Offers-Overview).
// ## Using a Product Price Point
// You can optionally pass in a `product_price_point_id` that corresponds with the `product_id` and the offer will use that price point. If a `product_price_point_id` is not passed in, the product's default price point will be used.
func (o *OffersController) CreateOffer(
    ctx context.Context,
    body *models.CreateOfferRequest) (
    models.ApiResponse[models.OfferResponse],
    error) {
    req := o.prepareRequest(ctx, "POST", "/offers.json")
    req.Authenticate(NewAuth("BasicAuth"))
    req.AppendErrors(map[string]https.ErrorBuilder[error]{
        "422": {TemplatedMessage: "HTTP Response Not OK. Status code: {$statusCode}. Response: '{$response.body}'.", Unmarshaller: errors.NewErrorArrayMapResponse},
    })
    req.Header("Content-Type", "application/json")
    if body != nil {
        req.Json(body)
    }
    var result models.OfferResponse
    decoder, resp, err := req.CallAsJson()
    if err != nil {
        return models.NewApiResponse(result, resp), err
    }
    
    result, err = utilities.DecodeResults[models.OfferResponse](decoder)
    return models.NewApiResponse(result, resp), err
}

// ListOffersInput represents the input of the ListOffers endpoint.
type ListOffersInput struct {
    // Result records are organized in pages. By default, the first page of results is displayed. The page parameter specifies a page number of results to fetch. You can start navigating through the pages to consume the results. You do this by passing in a page parameter. Retrieve the next page by adding ?page=2 to the query string. If there are no results to return, then an empty result set will be returned.
    // Use in query `page=1`.
    Page            *int  
    // This parameter indicates how many records to fetch in each request. Default value is 20. The maximum allowed values is 200; any per_page value over 200 will be changed to 200.
    // Use in query `per_page=200`.
    PerPage         *int  
    // Include archived products. Use in query: `include_archived=true`.
    IncludeArchived *bool 
}

// ListOffers takes context, page, perPage, includeArchived as parameters and
// returns an models.ApiResponse with models.ListOffersResponse data and
// an error if there was an issue with the request or response.
// This endpoint will list offers for a site.
func (o *OffersController) ListOffers(
    ctx context.Context,
    input ListOffersInput) (
    models.ApiResponse[models.ListOffersResponse],
    error) {
    req := o.prepareRequest(ctx, "GET", "/offers.json")
    req.Authenticate(NewAuth("BasicAuth"))
    req.AppendErrors(map[string]https.ErrorBuilder[error]{
        "422": {TemplatedMessage: "HTTP Response Not OK. Status code: {$statusCode}. Response: '{$response.body}'.", Unmarshaller: errors.NewErrorListResponse},
    })
    if input.Page != nil {
        req.QueryParam("page", *input.Page)
    }
    if input.PerPage != nil {
        req.QueryParam("per_page", *input.PerPage)
    }
    if input.IncludeArchived != nil {
        req.QueryParam("include_archived", *input.IncludeArchived)
    }
    var result models.ListOffersResponse
    decoder, resp, err := req.CallAsJson()
    if err != nil {
        return models.NewApiResponse(result, resp), err
    }
    
    result, err = utilities.DecodeResults[models.ListOffersResponse](decoder)
    return models.NewApiResponse(result, resp), err
}

// ReadOffer takes context, offerId as parameters and
// returns an models.ApiResponse with models.OfferResponse data and
// an error if there was an issue with the request or response.
// This method allows you to list a specific offer's attributes. This is different than list all offers for a site, as it requires an `offer_id`.
func (o *OffersController) ReadOffer(
    ctx context.Context,
    offerId int) (
    models.ApiResponse[models.OfferResponse],
    error) {
    req := o.prepareRequest(ctx, "GET", fmt.Sprintf("/offers/%v.json", offerId))
    req.Authenticate(NewAuth("BasicAuth"))
    
    var result models.OfferResponse
    decoder, resp, err := req.CallAsJson()
    if err != nil {
        return models.NewApiResponse(result, resp), err
    }
    
    result, err = utilities.DecodeResults[models.OfferResponse](decoder)
    return models.NewApiResponse(result, resp), err
}

// ArchiveOffer takes context, offerId as parameters and
// returns an *Response and
// an error if there was an issue with the request or response.
// Archive an existing offer. Please provide an `offer_id` in order to archive the correct item.
func (o *OffersController) ArchiveOffer(
    ctx context.Context,
    offerId int) (
    *http.Response,
    error) {
    req := o.prepareRequest(
      ctx,
      "PUT",
      fmt.Sprintf("/offers/%v/archive.json", offerId),
    )
    req.Authenticate(NewAuth("BasicAuth"))
    
    httpCtx, err := req.Call()
    if err != nil {
        return httpCtx.Response, err
    }
    return httpCtx.Response, err
}

// UnarchiveOffer takes context, offerId as parameters and
// returns an *Response and
// an error if there was an issue with the request or response.
// Unarchive a previously archived offer. Please provide an `offer_id` in order to un-archive the correct item.
func (o *OffersController) UnarchiveOffer(
    ctx context.Context,
    offerId int) (
    *http.Response,
    error) {
    req := o.prepareRequest(
      ctx,
      "PUT",
      fmt.Sprintf("/offers/%v/unarchive.json", offerId),
    )
    req.Authenticate(NewAuth("BasicAuth"))
    
    httpCtx, err := req.Call()
    if err != nil {
        return httpCtx.Response, err
    }
    return httpCtx.Response, err
}