Go API client for openapi

CRUD operations on a set of resources, including organizations, products, offers, entitlements, usage record groups for meterting, etc.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 1.0
Package version: 1.0.0
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.GoClientCodegen For more information, please visit https://www.suger.io/support

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import openapi "github.com/sugerio/suger-sdk-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value openapi.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value openapi.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{
"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using openapi.ContextOperationServerIndices and openapi.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})

Documentation for API Endpoints

All URIs are relative to https://api.suger.cloud

Class	Method	HTTP request	Description
APIAPI	GetApiClient	Get /org/{orgId}/apiClient/{apiClientId}	get api client
APIAPI	GetApiClientAccessToken	Post /public/apiClient/accessToken	get api access token
APIAPI	ListApiClients	Get /org/{orgId}/apiClient	list api clients
BillingAPI	CreateAddon	Post /org/{orgId}/addon	create addon
BillingAPI	CreateRefund	Post /org/{orgId}/buyer/{buyerId}/paymentTransaction/{paymentTransactionId}/refund	create refund.
BillingAPI	DeleteAddon	Delete /org/{orgId}/addon/{addonId}	delete addon
BillingAPI	GetAddon	Get /org/{orgId}/addon/{addonId}	get addon
BillingAPI	GetInvoice	Get /org/{orgId}/entitlement/{entitlementId}/invoice/{invoiceId}	get invoice
BillingAPI	IssueInvoice	Patch /org/{orgId}/entitlement/{entitlementId}/invoice/{invoiceId}/issue	issue invoice
BillingAPI	ListAddons	Get /org/{orgId}/addon	list addons
BillingAPI	ListInvoices	Get /org/{orgId}/invoice	list invoices
BillingAPI	ListPaymentTransactions	Get /org/{orgId}/paymentTransaction	list payment transactions
BillingAPI	ListRefundOfPaymentTransaction	Get /org/{orgId}/buyer/{buyerId}/paymentTransaction/{paymentTransactionId}/refund	list refunds.
BillingAPI	PayInvoice	Patch /org/{orgId}/entitlement/{entitlementId}/invoice/{invoiceId}/pay	pay invoice
BillingAPI	UpdateAddon	Patch /org/{orgId}/addon/{addonId}	update addon
BillingAPI	VoidInvoice	Patch /org/{orgId}/entitlement/{entitlementId}/invoice/{invoiceId}/void	void invoice
BuyerAPI	CloseCreditWallet	Patch /org/{orgId}/buyer/{buyerId}/wallet/{walletId}/close	close credit wallet
BuyerAPI	CreateBuyer	Post /org/{orgId}/buyer	create buyer
BuyerAPI	CreateCreditWallet	Post /org/{orgId}/buyer/{buyerId}/wallet	create credit wallet
BuyerAPI	DeleteBuyerWallet	Delete /org/{orgId}/buyer/{buyerId}/wallet/{walletId}	delete buyer wallet
BuyerAPI	GetBuyer	Get /org/{orgId}/buyer/{buyerId}	get buyer
BuyerAPI	ListBuyerWallets	Get /org/{orgId}/buyer/{buyerId}/wallet	list buyer's wallets
BuyerAPI	ListBuyers	Get /org/{orgId}/buyer	list buyers
BuyerAPI	SetBuyerDefaultWallet	Patch /org/{orgId}/buyer/{buyerId}/wallet/{walletId}/default	set buyer default wallet
BuyerAPI	UpdateBuyer	Patch /org/{orgId}/buyer/{buyerId}	update buyer
BuyerAPI	UpdateCreditWallet	Patch /org/{orgId}/buyer/{buyerId}/wallet/{walletId}	update credit wallet
ContactAPI	AddContactToBuyer	Post /org/{orgId}/contact/{contactId}/buyer/{buyerId}	add contact to buyer
ContactAPI	AddContactToOffer	Post /org/{orgId}/contact/{contactId}/offer/{offerId}	add contact to offer
ContactAPI	BatchCreateContacts	Post /org/{orgId}/contact/batch	batch create contacts
ContactAPI	CreateContact	Post /org/{orgId}/contact	create contact
ContactAPI	GetContact	Get /org/{orgId}/contact/{contactId}	get contact
ContactAPI	ListContactsByOrganization	Get /org/{orgId}/contact	list contacts by organization
ContactAPI	RemoveContactFromBuyer	Delete /org/{orgId}/contact/{contactId}/buyer/{buyerId}	remove contact from buyer
ContactAPI	RemoveContactFromOffer	Delete /org/{orgId}/contact/{contactId}/offer/{offerId}	remove contact from offer
ContactAPI	UpdateContact	Patch /org/{orgId}/contact/{contactId}	update contact
EntitlementAPI	AddEntitlementCredit	Post /org/{orgId}/entitlement/{entitlementId}/addCredit	add entitlement credit
EntitlementAPI	ApplyAddonToEntitlement	Post /org/{orgId}/entitlement/{entitlementId}/addon	apply addon to entitlement
EntitlementAPI	ApproveEntitlement	Post /org/{orgId}/entitlement/{entitlementId}/approve	approve entitlement
EntitlementAPI	CancelEntitlement	Post /org/{orgId}/entitlement/{entitlementId}/cancel	cancel entitlement
EntitlementAPI	CreateEntitlement	Post /org/{orgId}/entitlement	create entitlement
EntitlementAPI	DeleteEntitlementTerm	Delete /org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}	delete entitlement term
EntitlementAPI	DivideEntitlementCommit	Post /org/{orgId}/entitlement/{entitlementId}/divideCommit	divide entitlement commit
EntitlementAPI	GetEntitlement	Get /org/{orgId}/entitlement/{entitlementId}	get entitlement
EntitlementAPI	GetEntitlementTerm	Get /org/{orgId}/entitlement/{entitlementId}/entitlementTerm/{entitlementTermId}	get entitlement term
EntitlementAPI	ListEntitlementTerms	Get /org/{orgId}/entitlement/{entitlementId}/entitlementTerm	list entitlement terms
EntitlementAPI	ListEntitlements	Get /org/{orgId}/entitlement	list entitlements
EntitlementAPI	ScheduleEntitlementCancellation	Post /org/{orgId}/entitlement/{entitlementId}/scheduleCancellation	schedule entitlement cancellation
EntitlementAPI	UnscheduleEntitlementCancellation	Post /org/{orgId}/entitlement/{entitlementId}/unscheduleCancellation	unschedule entitlement cancellation
EntitlementAPI	UpdateEntitlementMetaInfo	Patch /org/{orgId}/entitlement/{entitlementId}/metaInfo	update entitlement meta info
EntitlementAPI	UpdateEntitlementName	Patch /org/{orgId}/entitlement/{entitlementId}/entitlementName	update entitlement name
EntitlementAPI	UpdateEntitlementSeat	Patch /org/{orgId}/entitlement/{entitlementId}/seat	update seat for the active AZURE subscription
MeteringAPI	BatchReportUsageRecordGroups	Post /org/{orgId}/batchCreateUsageRecordGroups	batch report usageRecordGroups
MeteringAPI	BatchValidateUsageRecordGroups	Post /org/{orgId}/batchValidateUsageRecordGroups	batch validate usageRecordGroups
MeteringAPI	CreateBillableMetric	Post /org/{orgId}/billableMetric	create billable metric
MeteringAPI	DeleteUsageRecordGroup	Delete /org/{orgId}/usageRecordGroup/{usageRecordGroupId}	delete usageRecordGroup
MeteringAPI	GetBillableMetric	Get /org/{orgId}/billableMetric/{billableMetricId}	get billable metric
MeteringAPI	GetUsageMeteringConfigInfo	Get /org/{orgId}/usageMeteringConfigInfo	get usage metering config info
MeteringAPI	ListBillableMetrics	Get /org/{orgId}/billableMetric	list billable metrics
MeteringAPI	ListUsageRecordGroups	Get /org/{orgId}/usageRecordGroup	list usageRecordGroups
MeteringAPI	ListUsageRecordReports	Get /org/{orgId}/usageRecordReport	list usageRecordReports
MeteringAPI	ReportUsageRecordGroup	Post /org/{orgId}/entitlement/{entitlementId}/usageRecordGroup	report usageRecordGroup
MeteringAPI	RetryUsageRecordGroup	Post /org/{orgId}/usageRecordGroup/{usageRecordGroupId}/retry	retry usageRecordGroup
MeteringAPI	UpdateBillableMetric	Patch /org/{orgId}/billableMetric/{billableMetricId}	update billable metric
MeteringAPI	UpdateUsageMeteringConfigInfo	Patch /org/{orgId}/usageMeteringConfigInfo	update usage metering config info
NotificationAPI	GetNotificationMessage	Get /org/{orgId}/notificationMessage/{notificationMessageId}	get notification message
NotificationAPI	ListNotificationEvents	Get /org/{orgId}/notificationEvent	list notification events
NotificationAPI	ListNotificationEventsByEntity	Get /org/{orgId}/notificationEvent/{entityType}/{entityId}	list notification events by entity
NotificationAPI	ListNotificationMessages	Get /org/{orgId}/notificationMessage	list notification messages
OfferAPI	CancelOffer	Post /org/{orgId}/offer/{offerId}/cancel	cancel offer
OfferAPI	CreateOffer	Post /org/{orgId}/offer	create offer
OfferAPI	CreateOrUpdateDraftOffer	Post /org/{orgId}/draftOffer	create or update draft offer
OfferAPI	DeleteOffer	Delete /org/{orgId}/offer/{offerId}	delete offer
OfferAPI	ExtendPrivateOfferExpiryDate	Post /org/{orgId}/offer/{offerId}/extendExpiryDate	extend offer expiry date
OfferAPI	GetOffer	Get /org/{orgId}/offer/{offerId}	get offer
OfferAPI	GetOfferByExternalId	Get /org/{orgId}/offerExternalId/{offerExternalId}	get offer by external ID
OfferAPI	GetOfferEula	Get /org/{orgId}/offer/{offerId}/eula	get offer EULA
OfferAPI	GetOfferResellerEula	Get /org/{orgId}/offer/{offerId}/resellerEula	get offer reseller EULA
OfferAPI	ListOffers	Get /org/{orgId}/offer	list offers
OfferAPI	SendOfferNotifications	Post /org/{orgId}/offer/{offerId}/notifyContacts	notify offer contacts
OfferAPI	UpdateOfferMetaInfo	Patch /org/{orgId}/offer/{offerId}/metaInfo	update offer meta info
ProductAPI	CreateOrUpdateDraftProduct	Post /org/{orgId}/draftProduct	create or update draft product
ProductAPI	CreateProduct	Post /org/{orgId}/product	create product
ProductAPI	DeleteProduct	Delete /org/{orgId}/product/{productId}	delete product
ProductAPI	GetProduct	Get /org/{orgId}/product/{productId}	get product
ProductAPI	ListProductMeteringDimensions	Get /org/{orgId}/product/{productId}/dimension	list metering dimensions of product
ProductAPI	ListProductsByOrganization	Get /org/{orgId}/product	list products by organization
ProductAPI	ListProductsByPartner	Get /org/{orgId}/partner/{partner}/product	list products by partner
ProductAPI	PublishProduct	Patch /org/{orgId}/product/{productId}/publish	publish product
ProductAPI	UpdateProduct	Patch /org/{orgId}/product/{productId}	update product
ProductAPI	UpdateProductFulfillmentUrl	Patch /org/{orgId}/product/{productId}/fulfillmentUrl	update product fulfillment url
ProductAPI	UpdateProductMetaInfo	Patch /org/{orgId}/product/{productId}/metaInfo	update product meta info
ReportAPI	GetRevenueReport	Post /org/{orgId}/revenueReport	get revenue report
ReportAPI	ListDailyRevenueRecords	Get /org/{orgId}/dailyRevenueRecord	list daily revenue records
ReportAPI	ListRevenueRecordDetails	Get /org/{orgId}/partner/{partner}/revenueRecordDetail	list revenue record details
ReportAPI	ListRevenueRecords	Get /org/{orgId}/partner/{partner}/revenueRecord	list revenue records
ReportAPI	ListUsageMeteringDailyRecords	Get /org/{orgId}/partner/{partner}/usageMeteringDailyRecord	list usage metering daily records
SupportAPI	CloseSupportTicket	Patch /org/{orgId}/support/ticket/{ticketId}/close	close support ticket
SupportAPI	CreateSupportTicket	Post /org/{orgId}/support/ticket	create support ticket
SupportAPI	CreateSupportTicketAttachment	Post /org/{orgId}/support/ticket/{ticketId}/attachment	create support ticket attachment
SupportAPI	CreateSupportTicketComment	Post /org/{orgId}/support/ticket/{ticketId}/comment	create support ticket comment
SupportAPI	GetSupportTicket	Get /org/{orgId}/support/ticket/{ticketId}	get support ticket
SupportAPI	ListSupportTickets	Get /org/{orgId}/support/ticket	list support tickets
SupportAPI	ReopenSupportTicket	Patch /org/{orgId}/support/ticket/{ticketId}/reopen	reopen support ticket
SupportAPI	UpdateSupportTicket	Patch /org/{orgId}/support/ticket/{ticketId}	update support ticket

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

APIKeyAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: APIKeyAuth and passed in as the auth context for each request.

Example

auth := context.WithValue(
context.Background(),
openapi.ContextAPIKeys,
map[string]openapi.APIKey{
"APIKeyAuth": {Key: "Key " + API_KEY_STRING},
},
)
r, err := client.Service.Operation(auth, args)

		configuration := openapiclient.NewConfiguration()
		apiClient := openapiclient.NewAPIClient(configuration)
		var orgId = "***"
		var offerId = "***"
		auth := context.WithValue(
			context.Background(),
			openapiclient.ContextAPIKeys,
			map[string]openapiclient.APIKey{
				"APIKeyAuth": {Key: "Key API_KEY_STRING"},
			},
		)

		resp, httpRes, err := apiClient.OfferAPI.GetOffer(auth, orgId, offerId).Execute()

BearerTokenAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: BearerTokenAuth and passed in as the auth context for each request.