rubago

package module
v0.16.2 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2026 License: MIT Imports: 14 Imported by: 0

README

Ruba for Go

Use typed clients to connect Go services to Ruba payments, billing, customers, subscriptions, orders, and webhooks.

Add it to your project

go get github.com/Rubadot/ruba-go

Make a request

package main

import (
	"context"
	"log"
	"os"

	rubago "github.com/Rubadot/ruba-go"
)

func main() {
	client := rubago.New(
		rubago.WithSecurity(os.Getenv("RUBA_ACCESS_TOKEN")),
	)

	result, err := client.Organizations.List(
		context.Background(),
		nil,
		rubago.Pointer[int64](1),
		rubago.Pointer[int64](10),
		nil,
	)
	if err != nil {
		log.Fatal(err)
	}

	log.Println(result.ListResourceOrganization)
}

Set a custom server when you need the sandbox. Authentication uses a Ruba access token sent as an HTTP bearer token.

Learn more

Start with the Ruba documentation, then use the API reference for endpoint details. Go SDK problems belong in this repository's issue tracker.

License

MIT

Documentation

Index

Constants

View Source 
const (
	// Production environment
	ServerProduction string = "production"
	// Sandbox environment
	ServerSandbox string = "sandbox"
)

Variables

View Source 
var ServerList = map[string]string{
	ServerProduction: "https://api.getruba.com",
	ServerSandbox:    "https://sandbox-api.getruba.com",
}

ServerList contains the list of servers available to the SDK

Functions

func Bool 

func Bool(b bool) *bool

Bool provides a helper function to return a pointer to a bool

func Float32 

func Float32(f float32) *float32

Float32 provides a helper function to return a pointer to a float32

func Float64 

func Float64(f float64) *float64

Float64 provides a helper function to return a pointer to a float64

func Int 

func Int(i int) *int

Int provides a helper function to return a pointer to an int

func Int64 

func Int64(i int64) *int64

Int64 provides a helper function to return a pointer to an int64

func Pointer 

func Pointer[T any](v T) *T

Pointer provides a helper function to return a pointer to a type

func String 

func String(s string) *string

String provides a helper function to return a pointer to a string

Types

type BenefitGrants 

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

func (*BenefitGrants) List 

func (s *BenefitGrants) List(ctx context.Context, request operations.BenefitGrantsListRequest, opts ...operations.Option) (*operations.BenefitGrantsListResponse, error)

List Benefit Grants List benefit grants across all benefits for the authenticated organization.

**Scopes**: `benefits:read` `benefits:write`

type Benefits 

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

func (*Benefits) Create 

func (s *Benefits) Create(ctx context.Context, request components.BenefitCreate, opts ...operations.Option) (*operations.BenefitsCreateResponse, error)

Create Benefit Create a benefit.

**Scopes**: `benefits:write`

func (*Benefits) Delete 

func (s *Benefits) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.BenefitsDeleteResponse, error)

Delete Benefit Delete a benefit.

> [!WARNING] > Every grants associated with the benefit will be revoked. > Users will lose access to the benefit.

**Scopes**: `benefits:write`

func (*Benefits) Get 

func (s *Benefits) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.BenefitsGetResponse, error)

Get Benefit Get a benefit by ID.

**Scopes**: `benefits:read` `benefits:write`

func (*Benefits) Grants 

func (s *Benefits) Grants(ctx context.Context, request operations.BenefitsGrantsRequest, opts ...operations.Option) (*operations.BenefitsGrantsResponse, error)

Grants - List Benefit Grants List the individual grants for a benefit.

It's especially useful to check if a user has been granted a benefit.

**Scopes**: `benefits:read` `benefits:write`

func (*Benefits) List 

func (s *Benefits) List(ctx context.Context, request operations.BenefitsListRequest, opts ...operations.Option) (*operations.BenefitsListResponse, error)

List Benefits List benefits.

**Scopes**: `benefits:read` `benefits:write`

func (*Benefits) Update 

func (s *Benefits) Update(ctx context.Context, id string, requestBody operations.BenefitsUpdateBenefitUpdate, opts ...operations.Option) (*operations.BenefitsUpdateResponse, error)

Update Benefit Update a benefit.

**Scopes**: `benefits:write` 

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

func (*CheckoutLinks) Create 

func (s *CheckoutLinks) Create(ctx context.Context, request components.CheckoutLinkCreate, opts ...operations.Option) (*operations.CheckoutLinksCreateResponse, error)

Create Checkout Link Create a checkout link.

**Scopes**: `checkout_links:write`

func (*CheckoutLinks) Delete 

func (s *CheckoutLinks) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.CheckoutLinksDeleteResponse, error)

Delete Checkout Link Delete a checkout link.

**Scopes**: `checkout_links:write`

func (*CheckoutLinks) Get 

func (s *CheckoutLinks) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.CheckoutLinksGetResponse, error)

Get Checkout Link Get a checkout link by ID.

**Scopes**: `checkout_links:read` `checkout_links:write`

func (*CheckoutLinks) List 

func (s *CheckoutLinks) List(ctx context.Context, request operations.CheckoutLinksListRequest, opts ...operations.Option) (*operations.CheckoutLinksListResponse, error)

List Checkout Links List checkout links.

**Scopes**: `checkout_links:read` `checkout_links:write`

func (*CheckoutLinks) Update 

func (s *CheckoutLinks) Update(ctx context.Context, id string, checkoutLinkUpdate components.CheckoutLinkUpdate, opts ...operations.Option) (*operations.CheckoutLinksUpdateResponse, error)

Update Checkout Link Update a checkout link.

**Scopes**: `checkout_links:write`

type Checkouts 

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

func (*Checkouts) ClientConfirm 

func (s *Checkouts) ClientConfirm(ctx context.Context, clientSecret string, checkoutConfirmStripe components.CheckoutConfirmStripe, opts ...operations.Option) (*operations.CheckoutsClientConfirmResponse, error)

ClientConfirm - Confirm Checkout Session from Client Confirm a checkout session by client secret.

Orders and subscriptions will be processed.

func (*Checkouts) ClientGet 

func (s *Checkouts) ClientGet(ctx context.Context, clientSecret string, opts ...operations.Option) (*operations.CheckoutsClientGetResponse, error)

ClientGet - Get Checkout Session from Client Get a checkout session by client secret.

func (*Checkouts) ClientUpdate 

func (s *Checkouts) ClientUpdate(ctx context.Context, clientSecret string, checkoutUpdatePublic components.CheckoutUpdatePublic, opts ...operations.Option) (*operations.CheckoutsClientUpdateResponse, error)

ClientUpdate - Update Checkout Session from Client Update a checkout session by client secret.

func (*Checkouts) Create 

func (s *Checkouts) Create(ctx context.Context, request components.CheckoutCreate, opts ...operations.Option) (*operations.CheckoutsCreateResponse, error)

Create Checkout Session Create a checkout session.

**Scopes**: `checkouts:write`

func (*Checkouts) Get 

func (s *Checkouts) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.CheckoutsGetResponse, error)

Get Checkout Session Get a checkout session by ID.

**Scopes**: `checkouts:read` `checkouts:write`

func (*Checkouts) List 

func (s *Checkouts) List(ctx context.Context, request operations.CheckoutsListRequest, opts ...operations.Option) (*operations.CheckoutsListResponse, error)

List Checkout Sessions List checkout sessions.

**Scopes**: `checkouts:read` `checkouts:write`

func (*Checkouts) Update 

func (s *Checkouts) Update(ctx context.Context, id string, checkoutUpdate components.CheckoutUpdate, opts ...operations.Option) (*operations.CheckoutsUpdateResponse, error)

Update Checkout Session Update a checkout session.

**Scopes**: `checkouts:write`

type Clients 

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

func (*Clients) Create 

func (s *Clients) Create(ctx context.Context, request components.OAuth2ClientConfiguration, opts ...operations.Option) (*operations.Oauth2ClientsOauth2CreateClientResponse, error)

Create Client Create an OAuth2 client.

func (*Clients) Delete 

func (s *Clients) Delete(ctx context.Context, clientID string, opts ...operations.Option) (*operations.Oauth2ClientsOauth2DeleteClientResponse, error)

Delete Client Delete an OAuth2 client.

func (*Clients) Get 

func (s *Clients) Get(ctx context.Context, clientID string, opts ...operations.Option) (*operations.Oauth2ClientsOauth2GetClientResponse, error)

Get Client Get an OAuth2 client by Client ID.

func (*Clients) Update 

func (s *Clients) Update(ctx context.Context, clientID string, oAuth2ClientConfigurationUpdate components.OAuth2ClientConfigurationUpdate, opts ...operations.Option) (*operations.Oauth2ClientsOauth2UpdateClientResponse, error)

Update Client Update an OAuth2 client.

type CustomFields 

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

func (*CustomFields) Create 

func (s *CustomFields) Create(ctx context.Context, request components.CustomFieldCreate, opts ...operations.Option) (*operations.CustomFieldsCreateResponse, error)

Create Custom Field Create a custom field.

**Scopes**: `custom_fields:write`

func (*CustomFields) Delete 

func (s *CustomFields) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.CustomFieldsDeleteResponse, error)

Delete Custom Field Delete a custom field.

**Scopes**: `custom_fields:write`

func (*CustomFields) Get 

func (s *CustomFields) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.CustomFieldsGetResponse, error)

Get Custom Field Get a custom field by ID.

**Scopes**: `custom_fields:read` `custom_fields:write`

func (*CustomFields) List 

func (s *CustomFields) List(ctx context.Context, request operations.CustomFieldsListRequest, opts ...operations.Option) (*operations.CustomFieldsListResponse, error)

List Custom Fields List custom fields.

**Scopes**: `custom_fields:read` `custom_fields:write`

func (*CustomFields) Update 

func (s *CustomFields) Update(ctx context.Context, id string, customFieldUpdate components.CustomFieldUpdate, opts ...operations.Option) (*operations.CustomFieldsUpdateResponse, error)

Update Custom Field Update a custom field.

**Scopes**: `custom_fields:write`

type CustomerMeters 

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

func (*CustomerMeters) Get 

func (s *CustomerMeters) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.CustomerMetersGetResponse, error)

Get Customer Meter Get a customer meter by ID.

**Scopes**: `customer_meters:read`

func (*CustomerMeters) List 

func (s *CustomerMeters) List(ctx context.Context, request operations.CustomerMetersListRequest, opts ...operations.Option) (*operations.CustomerMetersListResponse, error)

List Customer Meters List customer meters.

**Scopes**: `customer_meters:read`

type CustomerPortal 

type CustomerPortal struct {
	BenefitGrants   *RubaBenefitGrants
	Customers       *RubaCustomers
	CustomerMeters  *RubaCustomerMeters
	Seats           *Seats
	CustomerSession *CustomerSession
	Downloadables   *Downloadables
	LicenseKeys     *RubaLicenseKeys
	Members         *RubaMembers
	Orders          *RubaOrders
	Organizations   *RubaOrganizations
	Subscriptions   *RubaSubscriptions
	Wallets         *Wallets
	// contains filtered or unexported fields
}

type CustomerSeats 

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

func (*CustomerSeats) AssignSeat 

func (s *CustomerSeats) AssignSeat(ctx context.Context, request components.SeatAssign, opts ...operations.Option) (*operations.CustomerSeatsAssignSeatResponse, error)

AssignSeat - Assign Seat **Scopes**: `customer_seats:write`

func (*CustomerSeats) ClaimSeat 

func (s *CustomerSeats) ClaimSeat(ctx context.Context, request components.SeatClaim, opts ...operations.Option) (*operations.CustomerSeatsClaimSeatResponse, error)

ClaimSeat - Claim Seat

func (*CustomerSeats) GetClaimInfo 

func (s *CustomerSeats) GetClaimInfo(ctx context.Context, invitationToken string, opts ...operations.Option) (*operations.CustomerSeatsGetClaimInfoResponse, error)

GetClaimInfo - Get Claim Info

func (*CustomerSeats) ListSeats 

func (s *CustomerSeats) ListSeats(ctx context.Context, subscriptionID *string, orderID *string, opts ...operations.Option) (*operations.CustomerSeatsListSeatsResponse, error)

ListSeats - List Seats **Scopes**: `customer_seats:write`

func (*CustomerSeats) ResendInvitation 

func (s *CustomerSeats) ResendInvitation(ctx context.Context, seatID string, opts ...operations.Option) (*operations.CustomerSeatsResendInvitationResponse, error)

ResendInvitation - Resend Invitation **Scopes**: `customer_seats:write`

func (*CustomerSeats) RevokeSeat 

func (s *CustomerSeats) RevokeSeat(ctx context.Context, seatID string, opts ...operations.Option) (*operations.CustomerSeatsRevokeSeatResponse, error)

RevokeSeat - Revoke Seat **Scopes**: `customer_seats:write`

type CustomerSession 

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

func (*CustomerSession) GetAuthenticatedUser 

func (s *CustomerSession) GetAuthenticatedUser(ctx context.Context, security operations.CustomerPortalCustomerSessionGetAuthenticatedUserSecurity, opts ...operations.Option) (*operations.CustomerPortalCustomerSessionGetAuthenticatedUserResponse, error)

GetAuthenticatedUser - Get Authenticated Portal User Get information about the currently authenticated portal user.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*CustomerSession) Introspect 

func (s *CustomerSession) Introspect(ctx context.Context, security operations.CustomerPortalCustomerSessionIntrospectSecurity, opts ...operations.Option) (*operations.CustomerPortalCustomerSessionIntrospectResponse, error)

Introspect Customer Session Introspect the current session and return its information.

**Scopes**: `customer_portal:read` `customer_portal:write`

type CustomerSessions 

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

func (*CustomerSessions) Create 

func (s *CustomerSessions) Create(ctx context.Context, request operations.CustomerSessionsCreateCustomerSessionCreate, opts ...operations.Option) (*operations.CustomerSessionsCreateResponse, error)

Create Customer Session Create a customer session.

For organizations with `member_model_enabled`, this will automatically create a member session for the owner member of the customer.

**Scopes**: `customer_sessions:write`

type Customers 

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

func (*Customers) Create 

func (s *Customers) Create(ctx context.Context, request components.CustomerCreate, opts ...operations.Option) (*operations.CustomersCreateResponse, error)

Create Customer Create a customer.

**Scopes**: `customers:write`

func (*Customers) Delete 

func (s *Customers) Delete(ctx context.Context, id string, anonymize *bool, opts ...operations.Option) (*operations.CustomersDeleteResponse, error)

Delete Customer Delete a customer.

This action cannot be undone and will immediately: - Cancel any active subscriptions for the customer - Revoke all their benefits - Clear any `external_id`

Use it only in the context of deleting a user within your own service. Otherwise, use more granular API endpoints to cancel a specific subscription or revoke certain benefits.

Note: The customers information will nonetheless be retained for historic orders and subscriptions.

Set `anonymize=true` to also anonymize PII for GDPR compliance.

**Scopes**: `customers:write`

func (*Customers) DeleteExternal 

func (s *Customers) DeleteExternal(ctx context.Context, externalID string, anonymize *bool, opts ...operations.Option) (*operations.CustomersDeleteExternalResponse, error)

DeleteExternal - Delete Customer by External ID Delete a customer by external ID.

Immediately cancels any active subscriptions and revokes any active benefits.

Set `anonymize=true` to also anonymize PII for GDPR compliance.

**Scopes**: `customers:write`

func (*Customers) Export 

func (s *Customers) Export(ctx context.Context, organizationID *operations.CustomersExportQueryParamOrganizationID, opts ...operations.Option) (*operations.CustomersExportResponse, error)

Export Customers Export customers as a CSV file.

**Scopes**: `customers:read` `customers:write`

func (*Customers) Get 

func (s *Customers) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.CustomersGetResponse, error)

Get Customer Get a customer by ID.

**Scopes**: `customers:read` `customers:write`

func (*Customers) GetExternal 

func (s *Customers) GetExternal(ctx context.Context, externalID string, opts ...operations.Option) (*operations.CustomersGetExternalResponse, error)

GetExternal - Get Customer by External ID Get a customer by external ID.

**Scopes**: `customers:read` `customers:write`

func (*Customers) GetState 

func (s *Customers) GetState(ctx context.Context, id string, opts ...operations.Option) (*operations.CustomersGetStateResponse, error)

GetState - Get Customer State Get a customer state by ID.

The customer state includes information about the customer's active subscriptions and benefits.

It's the ideal endpoint to use when you need to get a full overview of a customer's status.

**Scopes**: `customers:read` `customers:write`

func (*Customers) GetStateExternal 

func (s *Customers) GetStateExternal(ctx context.Context, externalID string, opts ...operations.Option) (*operations.CustomersGetStateExternalResponse, error)

GetStateExternal - Get Customer State by External ID Get a customer state by external ID.

The customer state includes information about the customer's active subscriptions and benefits.

It's the ideal endpoint to use when you need to get a full overview of a customer's status.

**Scopes**: `customers:read` `customers:write`

func (*Customers) List 

func (s *Customers) List(ctx context.Context, request operations.CustomersListRequest, opts ...operations.Option) (*operations.CustomersListResponse, error)

List Customers List customers.

**Scopes**: `customers:read` `customers:write`

func (*Customers) Update 

func (s *Customers) Update(ctx context.Context, id string, customerUpdate components.CustomerUpdate, opts ...operations.Option) (*operations.CustomersUpdateResponse, error)

Update Customer Update a customer.

**Scopes**: `customers:write`

func (*Customers) UpdateExternal 

func (s *Customers) UpdateExternal(ctx context.Context, externalID string, customerUpdateExternalID components.CustomerUpdateExternalID, opts ...operations.Option) (*operations.CustomersUpdateExternalResponse, error)

UpdateExternal - Update Customer by External ID Update a customer by external ID.

**Scopes**: `customers:write`

type Discounts 

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

func (*Discounts) Create 

func (s *Discounts) Create(ctx context.Context, request components.DiscountCreate, opts ...operations.Option) (*operations.DiscountsCreateResponse, error)

Create Discount Create a discount.

**Scopes**: `discounts:write`

func (*Discounts) Delete 

func (s *Discounts) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.DiscountsDeleteResponse, error)

Delete Discount Delete a discount.

**Scopes**: `discounts:write`

func (*Discounts) Get 

func (s *Discounts) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.DiscountsGetResponse, error)

Get Discount Get a discount by ID.

**Scopes**: `discounts:read` `discounts:write`

func (*Discounts) List 

func (s *Discounts) List(ctx context.Context, request operations.DiscountsListRequest, opts ...operations.Option) (*operations.DiscountsListResponse, error)

List Discounts List discounts.

**Scopes**: `discounts:read` `discounts:write`

func (*Discounts) Update 

func (s *Discounts) Update(ctx context.Context, id string, discountUpdate components.DiscountUpdate, opts ...operations.Option) (*operations.DiscountsUpdateResponse, error)

Update Discount Update a discount.

**Scopes**: `discounts:write`

type Disputes 

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

func (*Disputes) Get 

func (s *Disputes) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.DisputesGetResponse, error)

Get Dispute Get a dispute by ID.

**Scopes**: `disputes:read`

func (*Disputes) List 

func (s *Disputes) List(ctx context.Context, request operations.DisputesListRequest, opts ...operations.Option) (*operations.DisputesListResponse, error)

List Disputes List disputes.

**Scopes**: `disputes:read`

type Downloadables 

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

func (*Downloadables) List 

func (s *Downloadables) List(ctx context.Context, security operations.CustomerPortalDownloadablesListSecurity, benefitID *operations.CustomerPortalDownloadablesListQueryParamBenefitIDFilter, page *int64, limit *int64, opts ...operations.Option) (*operations.CustomerPortalDownloadablesListResponse, error)

List Downloadables **Scopes**: `customer_portal:read` `customer_portal:write`

type EventTypes 

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

func (*EventTypes) List 

func (s *EventTypes) List(ctx context.Context, request operations.EventTypesListRequest, opts ...operations.Option) (*operations.EventTypesListResponse, error)

List Event Types List event types with aggregated statistics.

**Scopes**: `events:read` `events:write`

func (*EventTypes) Update 

func (s *EventTypes) Update(ctx context.Context, id string, eventTypeUpdate components.EventTypeUpdate, opts ...operations.Option) (*operations.EventTypesUpdateResponse, error)

Update Event Type Update an event type's label.

type Events 

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

func (*Events) Get 

func (s *Events) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.EventsGetResponse, error)

Get Event Get an event by ID.

**Scopes**: `events:read` `events:write`

func (*Events) Ingest 

func (s *Events) Ingest(ctx context.Context, request components.EventsIngest, opts ...operations.Option) (*operations.EventsIngestResponse, error)

Ingest Events Ingest batch of events.

**Scopes**: `events:write`

func (*Events) List 

func (s *Events) List(ctx context.Context, request operations.EventsListRequest, opts ...operations.Option) (*operations.EventsListResponse, error)

List Events List events.

**Scopes**: `events:read` `events:write`

func (*Events) ListNames 

func (s *Events) ListNames(ctx context.Context, request operations.EventsListNamesRequest, opts ...operations.Option) (*operations.EventsListNamesResponse, error)

ListNames - List Event Names List event names.

**Scopes**: `events:read` `events:write`

type Files 

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

func (*Files) Create 

func (s *Files) Create(ctx context.Context, request components.FileCreate, opts ...operations.Option) (*operations.FilesCreateResponse, error)

Create File Create a file.

**Scopes**: `files:write`

func (*Files) Delete 

func (s *Files) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.FilesDeleteResponse, error)

Delete File Delete a file.

**Scopes**: `files:write`

func (*Files) List 

func (s *Files) List(ctx context.Context, organizationID *operations.FilesListQueryParamOrganizationIDFilter, ids *operations.FileIDFilter, page *int64, limit *int64, opts ...operations.Option) (*operations.FilesListResponse, error)

List Files List files.

**Scopes**: `files:read` `files:write`

func (*Files) Update 

func (s *Files) Update(ctx context.Context, id string, filePatch components.FilePatch, opts ...operations.Option) (*operations.FilesUpdateResponse, error)

Update File Update a file.

**Scopes**: `files:write`

func (*Files) Uploaded 

func (s *Files) Uploaded(ctx context.Context, id string, fileUploadCompleted components.FileUploadCompleted, opts ...operations.Option) (*operations.FilesUploadedResponse, error)

Uploaded - Complete File Upload Complete a file upload.

**Scopes**: `files:write`

type HTTPClient 

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient provides an interface for supplying the SDK with a custom HTTP client

type LicenseKeys 

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

func (*LicenseKeys) Activate 

func (s *LicenseKeys) Activate(ctx context.Context, request components.LicenseKeyActivate, opts ...operations.Option) (*operations.LicenseKeysActivateResponse, error)

Activate License Key Activate a license key instance.

**Scopes**: `license_keys:write`

func (*LicenseKeys) Deactivate 

func (s *LicenseKeys) Deactivate(ctx context.Context, request components.LicenseKeyDeactivate, opts ...operations.Option) (*operations.LicenseKeysDeactivateResponse, error)

Deactivate License Key Deactivate a license key instance.

**Scopes**: `license_keys:write`

func (*LicenseKeys) Get 

func (s *LicenseKeys) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.LicenseKeysGetResponse, error)

Get License Key Get a license key.

**Scopes**: `license_keys:read` `license_keys:write`

func (*LicenseKeys) GetActivation 

func (s *LicenseKeys) GetActivation(ctx context.Context, id string, activationID string, opts ...operations.Option) (*operations.LicenseKeysGetActivationResponse, error)

GetActivation - Get Activation Get a license key activation.

**Scopes**: `license_keys:read` `license_keys:write`

func (*LicenseKeys) List 

func (s *LicenseKeys) List(ctx context.Context, organizationID *operations.LicenseKeysListQueryParamOrganizationIDFilter, benefitID *operations.QueryParamBenefitIDFilter, page *int64, limit *int64, opts ...operations.Option) (*operations.LicenseKeysListResponse, error)

List License Keys Get license keys connected to the given organization & filters.

**Scopes**: `license_keys:read` `license_keys:write`

func (*LicenseKeys) Update 

func (s *LicenseKeys) Update(ctx context.Context, id string, licenseKeyUpdate components.LicenseKeyUpdate, opts ...operations.Option) (*operations.LicenseKeysUpdateResponse, error)

Update License Key Update a license key.

**Scopes**: `license_keys:write`

func (*LicenseKeys) Validate 

func (s *LicenseKeys) Validate(ctx context.Context, request components.LicenseKeyValidate, opts ...operations.Option) (*operations.LicenseKeysValidateResponse, error)

Validate License Key Validate a license key.

**Scopes**: `license_keys:write`

type Members 

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

func (*Members) CreateMember 

func (s *Members) CreateMember(ctx context.Context, request components.MemberCreate, opts ...operations.Option) (*operations.MembersCreateMemberResponse, error)

CreateMember - Create Member Create a new member for a customer.

Only B2B customers with the member management feature enabled can add members. The authenticated user or organization must have access to the customer's organization.

**Scopes**: `members:write`

func (*Members) DeleteMember 

func (s *Members) DeleteMember(ctx context.Context, id string, opts ...operations.Option) (*operations.MembersDeleteMemberResponse, error)

DeleteMember - Delete Member Delete a member.

The authenticated user or organization must have access to the member's organization.

**Scopes**: `members:write`

func (*Members) GetMember 

func (s *Members) GetMember(ctx context.Context, id string, opts ...operations.Option) (*operations.MembersGetMemberResponse, error)

GetMember - Get Member Get a member by ID.

The authenticated user or organization must have access to the member's organization.

**Scopes**: `members:read` `members:write`

func (*Members) ListMembers 

func (s *Members) ListMembers(ctx context.Context, request operations.MembersListMembersRequest, opts ...operations.Option) (*operations.MembersListMembersResponse, error)

ListMembers - List Members List members with optional customer ID filter.

**Scopes**: `members:read` `members:write`

func (*Members) UpdateMember 

func (s *Members) UpdateMember(ctx context.Context, id string, memberUpdate components.MemberUpdate, opts ...operations.Option) (*operations.MembersUpdateMemberResponse, error)

UpdateMember - Update Member Update a member.

Only name and role can be updated. The authenticated user or organization must have access to the member's organization.

**Scopes**: `members:write`

type Meters 

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

func (*Meters) Create 

func (s *Meters) Create(ctx context.Context, request components.MeterCreate, opts ...operations.Option) (*operations.MetersCreateResponse, error)

Create Meter Create a meter.

**Scopes**: `meters:write`

func (*Meters) Get 

func (s *Meters) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.MetersGetResponse, error)

Get Meter Get a meter by ID.

**Scopes**: `meters:read` `meters:write`

func (*Meters) List 

func (s *Meters) List(ctx context.Context, request operations.MetersListRequest, opts ...operations.Option) (*operations.MetersListResponse, error)

List Meters List meters.

**Scopes**: `meters:read` `meters:write`

func (*Meters) Quantities 

func (s *Meters) Quantities(ctx context.Context, request operations.MetersQuantitiesRequest, opts ...operations.Option) (*operations.MetersQuantitiesResponse, error)

Quantities - Get Meter Quantities Get quantities of a meter over a time period.

**Scopes**: `meters:read` `meters:write`

func (*Meters) Update 

func (s *Meters) Update(ctx context.Context, id string, meterUpdate components.MeterUpdate, opts ...operations.Option) (*operations.MetersUpdateResponse, error)

Update Meter Update a meter.

**Scopes**: `meters:write`

type Metrics 

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

func (*Metrics) CreateDashboard 

func (s *Metrics) CreateDashboard(ctx context.Context, request components.MetricDashboardCreate, opts ...operations.Option) (*operations.MetricsCreateDashboardResponse, error)

CreateDashboard - Create Metric Dashboard Create a user-defined metric dashboard.

**Scopes**: `metrics:write`

func (*Metrics) DeleteDashboard 

func (s *Metrics) DeleteDashboard(ctx context.Context, id string, opts ...operations.Option) (*operations.MetricsDeleteDashboardResponse, error)

DeleteDashboard - Delete Metric Dashboard Delete a user-defined metric dashboard.

**Scopes**: `metrics:write`

func (*Metrics) Get 

func (s *Metrics) Get(ctx context.Context, request operations.MetricsGetRequest, opts ...operations.Option) (*operations.MetricsGetResponse, error)

Get Metrics Get metrics about your orders and subscriptions.

Currency values are output in cents.

**Scopes**: `metrics:read`

func (*Metrics) GetDashboard 

func (s *Metrics) GetDashboard(ctx context.Context, id string, opts ...operations.Option) (*operations.MetricsGetDashboardResponse, error)

GetDashboard - Get Metric Dashboard Get a user-defined metric dashboard by ID.

**Scopes**: `metrics:read`

func (*Metrics) Limits 

func (s *Metrics) Limits(ctx context.Context, opts ...operations.Option) (*operations.MetricsLimitsResponse, error)

Limits - Get Metrics Limits Get the interval limits for the metrics endpoint.

**Scopes**: `metrics:read`

func (*Metrics) ListDashboards 

func (s *Metrics) ListDashboards(ctx context.Context, organizationID *operations.MetricsListDashboardsQueryParamOrganizationIDFilter, opts ...operations.Option) (*operations.MetricsListDashboardsResponse, error)

ListDashboards - List Metric Dashboards List user-defined metric dashboards.

**Scopes**: `metrics:read`

func (*Metrics) UpdateDashboard 

func (s *Metrics) UpdateDashboard(ctx context.Context, id string, metricDashboardUpdate components.MetricDashboardUpdate, opts ...operations.Option) (*operations.MetricsUpdateDashboardResponse, error)

UpdateDashboard - Update Metric Dashboard Update a user-defined metric dashboard.

**Scopes**: `metrics:write`

type Oauth2 

type Oauth2 struct {
	Clients *Clients
	// contains filtered or unexported fields
}

func (*Oauth2) Authorize 

func (s *Oauth2) Authorize(ctx context.Context, opts ...operations.Option) (*operations.Oauth2AuthorizeResponse, error)

Authorize

func (*Oauth2) Introspect 

func (s *Oauth2) Introspect(ctx context.Context, request components.IntrospectTokenRequest, opts ...operations.Option) (*operations.Oauth2IntrospectTokenResponse, error)

Introspect Token Get information about an access token.

func (*Oauth2) Revoke 

func (s *Oauth2) Revoke(ctx context.Context, request components.RevokeTokenRequest, opts ...operations.Option) (*operations.Oauth2RevokeTokenResponse, error)

Revoke Token Revoke an access token or a refresh token.

func (*Oauth2) Token 

func (s *Oauth2) Token(ctx context.Context, request operations.Oauth2RequestTokenRequestBody, opts ...operations.Option) (*operations.Oauth2RequestTokenResponse, error)

Request Token Request an access token using a valid grant.

func (*Oauth2) Userinfo 

func (s *Oauth2) Userinfo(ctx context.Context, opts ...operations.Option) (*operations.Oauth2UserinfoResponse, error)

Userinfo - Get User Info Get information about the authenticated user.

type Orders 

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

func (*Orders) Export 

func (s *Orders) Export(ctx context.Context, organizationID *operations.OrdersExportQueryParamOrganizationIDFilter, productID *operations.OrdersExportQueryParamProductIDFilter, opts ...operations.Option) (*operations.OrdersExportResponse, error)

Export Orders Export orders as a CSV file.

**Scopes**: `orders:read`

func (*Orders) GenerateInvoice 

func (s *Orders) GenerateInvoice(ctx context.Context, id string, opts ...operations.Option) (*operations.OrdersGenerateInvoiceResponse, error)

GenerateInvoice - Generate Order Invoice Trigger generation of an order's invoice.

**Scopes**: `orders:read`

func (*Orders) Get 

func (s *Orders) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.OrdersGetResponse, error)

Get Order Get an order by ID.

**Scopes**: `orders:read`

func (*Orders) Invoice 

func (s *Orders) Invoice(ctx context.Context, id string, opts ...operations.Option) (*operations.OrdersInvoiceResponse, error)

Invoice - Get Order Invoice Get an order's invoice data.

**Scopes**: `orders:read`

func (*Orders) List 

func (s *Orders) List(ctx context.Context, request operations.OrdersListRequest, opts ...operations.Option) (*operations.OrdersListResponse, error)

List Orders List orders.

**Scopes**: `orders:read`

func (*Orders) Update 

func (s *Orders) Update(ctx context.Context, id string, orderUpdate components.OrderUpdate, opts ...operations.Option) (*operations.OrdersUpdateResponse, error)

Update Order Update an order.

**Scopes**: `orders:write`

type OrganizationAccessTokens 

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

func (*OrganizationAccessTokens) Create 

func (s *OrganizationAccessTokens) Create(ctx context.Context, request components.OrganizationAccessTokenCreate, opts ...operations.Option) (*operations.OrganizationAccessTokensCreateResponse, error)

Create **Scopes**: `organization_access_tokens:write`

func (*OrganizationAccessTokens) Delete 

func (s *OrganizationAccessTokens) Delete(ctx context.Context, id string, opts ...operations.Option) (*operations.OrganizationAccessTokensDeleteResponse, error)

Delete **Scopes**: `organization_access_tokens:write`

func (*OrganizationAccessTokens) List 

func (s *OrganizationAccessTokens) List(ctx context.Context, organizationID *operations.OrganizationAccessTokensListQueryParamOrganizationIDFilter, page *int64, limit *int64, sorting []components.OrganizationAccessTokenSortProperty, opts ...operations.Option) (*operations.OrganizationAccessTokensListResponse, error)

List List organization access tokens.

**Scopes**: `organization_access_tokens:read` `organization_access_tokens:write`

func (*OrganizationAccessTokens) Update 

func (s *OrganizationAccessTokens) Update(ctx context.Context, id string, organizationAccessTokenUpdate components.OrganizationAccessTokenUpdate, opts ...operations.Option) (*operations.OrganizationAccessTokensUpdateResponse, error)

Update **Scopes**: `organization_access_tokens:write`

type Organizations 

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

func (*Organizations) Create 

func (s *Organizations) Create(ctx context.Context, request components.OrganizationCreate, opts ...operations.Option) (*operations.OrganizationsCreateResponse, error)

Create Organization Create an organization.

**Scopes**: `organizations:write`

func (*Organizations) Get 

func (s *Organizations) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.OrganizationsGetResponse, error)

Get Organization Get an organization by ID.

**Scopes**: `organizations:read` `organizations:write`

func (*Organizations) List 

func (s *Organizations) List(ctx context.Context, slug *string, page *int64, limit *int64, sorting []components.OrganizationSortProperty, opts ...operations.Option) (*operations.OrganizationsListResponse, error)

List Organizations List organizations.

**Scopes**: `organizations:read` `organizations:write`

func (*Organizations) Update 

func (s *Organizations) Update(ctx context.Context, id string, organizationUpdate components.OrganizationUpdate, opts ...operations.Option) (*operations.OrganizationsUpdateResponse, error)

Update Organization Update an organization.

**Scopes**: `organizations:write`

type Payments 

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

func (*Payments) Get 

func (s *Payments) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.PaymentsGetResponse, error)

Get Payment Get a payment by ID.

**Scopes**: `payments:read`

func (*Payments) List 

func (s *Payments) List(ctx context.Context, request operations.PaymentsListRequest, opts ...operations.Option) (*operations.PaymentsListResponse, error)

List Payments List payments.

**Scopes**: `payments:read`

type Products 

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

func (*Products) Create 

func (s *Products) Create(ctx context.Context, request components.ProductCreate, opts ...operations.Option) (*operations.ProductsCreateResponse, error)

Create Product Create a product.

**Scopes**: `products:write`

func (*Products) Get 

func (s *Products) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.ProductsGetResponse, error)

Get Product Get a product by ID.

**Scopes**: `products:read` `products:write`

func (*Products) List 

func (s *Products) List(ctx context.Context, request operations.ProductsListRequest, opts ...operations.Option) (*operations.ProductsListResponse, error)

List Products List products.

**Scopes**: `products:read` `products:write`

func (*Products) Update 

func (s *Products) Update(ctx context.Context, id string, productUpdate components.ProductUpdate, opts ...operations.Option) (*operations.ProductsUpdateResponse, error)

Update Product Update a product.

**Scopes**: `products:write`

func (*Products) UpdateBenefits 

func (s *Products) UpdateBenefits(ctx context.Context, id string, productBenefitsUpdate components.ProductBenefitsUpdate, opts ...operations.Option) (*operations.ProductsUpdateBenefitsResponse, error)

UpdateBenefits - Update Product Benefits Update benefits granted by a product.

**Scopes**: `products:write`

type Refunds 

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

func (*Refunds) Create 

func (s *Refunds) Create(ctx context.Context, request components.RefundCreate, opts ...operations.Option) (*operations.RefundsCreateResponse, error)

Create Refund Create a refund.

**Scopes**: `refunds:write`

func (*Refunds) List 

func (s *Refunds) List(ctx context.Context, request operations.RefundsListRequest, opts ...operations.Option) (*operations.RefundsListResponse, error)

List Refunds List refunds.

**Scopes**: `refunds:read` `refunds:write`

type Ruba 

type Ruba struct {
	SDKVersion               string
	Organizations            *Organizations
	Subscriptions            *Subscriptions
	Oauth2                   *Oauth2
	Benefits                 *Benefits
	BenefitGrants            *BenefitGrants
	Webhooks                 *Webhooks
	Products                 *Products
	Orders                   *Orders
	Refunds                  *Refunds
	Disputes                 *Disputes
	Checkouts                *Checkouts
	Files                    *Files
	Metrics                  *Metrics
	LicenseKeys              *LicenseKeys
	CheckoutLinks            *CheckoutLinks
	CustomFields             *CustomFields
	Discounts                *Discounts
	Customers                *Customers
	Members                  *Members
	CustomerPortal           *CustomerPortal
	CustomerSeats            *CustomerSeats
	CustomerSessions         *CustomerSessions
	Events                   *Events
	EventTypes               *EventTypes
	Meters                   *Meters
	OrganizationAccessTokens *OrganizationAccessTokens
	CustomerMeters           *CustomerMeters
	Payments                 *Payments
	// contains filtered or unexported fields
}

Ruba API: Ruba HTTP and Webhooks API Read the docs at https://docs.getruba.com/api-reference

func New 

func New(opts ...SDKOption) *Ruba

New creates a new instance of the SDK with the provided options

type RubaBenefitGrants 

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

func (*RubaBenefitGrants) Get 

func (s *RubaBenefitGrants) Get(ctx context.Context, security operations.CustomerPortalBenefitGrantsGetSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalBenefitGrantsGetResponse, error)

Get Benefit Grant Get a benefit grant by ID for the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaBenefitGrants) List 

func (s *RubaBenefitGrants) List(ctx context.Context, request operations.CustomerPortalBenefitGrantsListRequest, security operations.CustomerPortalBenefitGrantsListSecurity, opts ...operations.Option) (*operations.CustomerPortalBenefitGrantsListResponse, error)

List Benefit Grants List benefits grants of the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaBenefitGrants) Update 

func (s *RubaBenefitGrants) Update(ctx context.Context, security operations.CustomerPortalBenefitGrantsUpdateSecurity, id string, customerBenefitGrantUpdate components.CustomerBenefitGrantUpdate, opts ...operations.Option) (*operations.CustomerPortalBenefitGrantsUpdateResponse, error)

Update Benefit Grant Update a benefit grant for the authenticated customer.

**Scopes**: `customer_portal:write`

type RubaCustomerMeters 

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

func (*RubaCustomerMeters) Get 

func (s *RubaCustomerMeters) Get(ctx context.Context, security operations.CustomerPortalCustomerMetersGetSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalCustomerMetersGetResponse, error)

Get Customer Meter Get a meter by ID for the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaCustomerMeters) List 

func (s *RubaCustomerMeters) List(ctx context.Context, request operations.CustomerPortalCustomerMetersListRequest, security operations.CustomerPortalCustomerMetersListSecurity, opts ...operations.Option) (*operations.CustomerPortalCustomerMetersListResponse, error)

List Meters List meters of the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

type RubaCustomers 

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

func (*RubaCustomers) AddPaymentMethod 

func (s *RubaCustomers) AddPaymentMethod(ctx context.Context, request components.CustomerPaymentMethodCreate, security operations.CustomerPortalCustomersAddPaymentMethodSecurity, opts ...operations.Option) (*operations.CustomerPortalCustomersAddPaymentMethodResponse, error)

AddPaymentMethod - Add Customer Payment Method Add a payment method to the authenticated customer.

func (*RubaCustomers) ConfirmPaymentMethod 

func (s *RubaCustomers) ConfirmPaymentMethod(ctx context.Context, request components.CustomerPaymentMethodConfirm, security operations.CustomerPortalCustomersConfirmPaymentMethodSecurity, opts ...operations.Option) (*operations.CustomerPortalCustomersConfirmPaymentMethodResponse, error)

ConfirmPaymentMethod - Confirm Customer Payment Method Confirm a payment method for the authenticated customer.

func (*RubaCustomers) DeletePaymentMethod 

func (s *RubaCustomers) DeletePaymentMethod(ctx context.Context, security operations.CustomerPortalCustomersDeletePaymentMethodSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalCustomersDeletePaymentMethodResponse, error)

DeletePaymentMethod - Delete Customer Payment Method Delete a payment method from the authenticated customer.

func (*RubaCustomers) Get 

func (s *RubaCustomers) Get(ctx context.Context, security operations.CustomerPortalCustomersGetSecurity, opts ...operations.Option) (*operations.CustomerPortalCustomersGetResponse, error)

Get Customer Get authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaCustomers) ListPaymentMethods 

func (s *RubaCustomers) ListPaymentMethods(ctx context.Context, security operations.CustomerPortalCustomersListPaymentMethodsSecurity, page *int64, limit *int64, opts ...operations.Option) (*operations.CustomerPortalCustomersListPaymentMethodsResponse, error)

ListPaymentMethods - List Customer Payment Methods Get saved payment methods of the authenticated customer.

func (*RubaCustomers) Update 

func (s *RubaCustomers) Update(ctx context.Context, request components.CustomerPortalCustomerUpdate, security operations.CustomerPortalCustomersUpdateSecurity, opts ...operations.Option) (*operations.CustomerPortalCustomersUpdateResponse, error)

Update Customer Update authenticated customer.

type RubaLicenseKeys 

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

func (*RubaLicenseKeys) Activate 

func (s *RubaLicenseKeys) Activate(ctx context.Context, request components.LicenseKeyActivate, opts ...operations.Option) (*operations.CustomerPortalLicenseKeysActivateResponse, error)

Activate License Key Activate a license key instance.

> This endpoint doesn't require authentication and can be safely used on a public > client, like a desktop application or a mobile app. > If you plan to validate a license key on a server, use the `/v1/license-keys/activate` > endpoint instead.

func (*RubaLicenseKeys) Deactivate 

func (s *RubaLicenseKeys) Deactivate(ctx context.Context, request components.LicenseKeyDeactivate, opts ...operations.Option) (*operations.CustomerPortalLicenseKeysDeactivateResponse, error)

Deactivate License Key Deactivate a license key instance.

> This endpoint doesn't require authentication and can be safely used on a public > client, like a desktop application or a mobile app. > If you plan to validate a license key on a server, use the `/v1/license-keys/deactivate` > endpoint instead.

func (*RubaLicenseKeys) Get 

func (s *RubaLicenseKeys) Get(ctx context.Context, security operations.CustomerPortalLicenseKeysGetSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalLicenseKeysGetResponse, error)

Get License Key Get a license key.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaLicenseKeys) List 

func (s *RubaLicenseKeys) List(ctx context.Context, security operations.CustomerPortalLicenseKeysListSecurity, benefitID *string, page *int64, limit *int64, opts ...operations.Option) (*operations.CustomerPortalLicenseKeysListResponse, error)

List License Keys **Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaLicenseKeys) Validate 

func (s *RubaLicenseKeys) Validate(ctx context.Context, request components.LicenseKeyValidate, opts ...operations.Option) (*operations.CustomerPortalLicenseKeysValidateResponse, error)

Validate License Key Validate a license key.

> This endpoint doesn't require authentication and can be safely used on a public > client, like a desktop application or a mobile app. > If you plan to validate a license key on a server, use the `/v1/license-keys/validate` > endpoint instead.

type RubaMembers 

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

func (*RubaMembers) AddMember 

func (s *RubaMembers) AddMember(ctx context.Context, request components.CustomerPortalMemberCreate, opts ...operations.Option) (*operations.CustomerPortalMembersAddMemberResponse, error)

AddMember - Add Member Add a new member to the customer's team.

Only available to owners and billing managers of team customers.

Rules: - Cannot add a member with the owner role (there must be exactly one owner) - If a member with this email already exists, the existing member is returned

func (*RubaMembers) ListMembers 

func (s *RubaMembers) ListMembers(ctx context.Context, page *int64, limit *int64, opts ...operations.Option) (*operations.CustomerPortalMembersListMembersResponse, error)

ListMembers - List Members List all members of the customer's team.

Only available to owners and billing managers of team customers.

func (*RubaMembers) RemoveMember 

func (s *RubaMembers) RemoveMember(ctx context.Context, id string, opts ...operations.Option) (*operations.CustomerPortalMembersRemoveMemberResponse, error)

RemoveMember - Remove Member Remove a member from the team.

Only available to owners and billing managers of team customers.

Rules: - Cannot remove yourself - Cannot remove the only owner

func (*RubaMembers) UpdateMember 

func (s *RubaMembers) UpdateMember(ctx context.Context, id string, customerPortalMemberUpdate components.CustomerPortalMemberUpdate, opts ...operations.Option) (*operations.CustomerPortalMembersUpdateMemberResponse, error)

UpdateMember - Update Member Update a member's role.

Only available to owners and billing managers of team customers.

Rules: - Cannot modify your own role (to prevent self-demotion) - Customer must have exactly one owner at all times

type RubaOrders 

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

func (*RubaOrders) ConfirmRetryPayment 

func (s *RubaOrders) ConfirmRetryPayment(ctx context.Context, security operations.CustomerPortalOrdersConfirmRetryPaymentSecurity, id string, customerOrderConfirmPayment components.CustomerOrderConfirmPayment, opts ...operations.Option) (*operations.CustomerPortalOrdersConfirmRetryPaymentResponse, error)

ConfirmRetryPayment - Confirm Retry Payment Confirm a retry payment using a Stripe confirmation token.

func (*RubaOrders) GenerateInvoice 

func (s *RubaOrders) GenerateInvoice(ctx context.Context, security operations.CustomerPortalOrdersGenerateInvoiceSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalOrdersGenerateInvoiceResponse, error)

GenerateInvoice - Generate Order Invoice Trigger generation of an order's invoice.

func (*RubaOrders) Get 

func (s *RubaOrders) Get(ctx context.Context, security operations.CustomerPortalOrdersGetSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalOrdersGetResponse, error)

Get Order Get an order by ID for the authenticated customer.

func (*RubaOrders) GetPaymentStatus 

func (s *RubaOrders) GetPaymentStatus(ctx context.Context, security operations.CustomerPortalOrdersGetPaymentStatusSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalOrdersGetPaymentStatusResponse, error)

GetPaymentStatus - Get Order Payment Status Get the current payment status for an order.

func (*RubaOrders) Invoice 

func (s *RubaOrders) Invoice(ctx context.Context, security operations.CustomerPortalOrdersInvoiceSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalOrdersInvoiceResponse, error)

Invoice - Get Order Invoice Get an order's invoice data.

func (*RubaOrders) List 

func (s *RubaOrders) List(ctx context.Context, request operations.CustomerPortalOrdersListRequest, security operations.CustomerPortalOrdersListSecurity, opts ...operations.Option) (*operations.CustomerPortalOrdersListResponse, error)

List Orders List orders of the authenticated customer.

func (*RubaOrders) Update 

func (s *RubaOrders) Update(ctx context.Context, security operations.CustomerPortalOrdersUpdateSecurity, id string, customerOrderUpdate components.CustomerOrderUpdate, opts ...operations.Option) (*operations.CustomerPortalOrdersUpdateResponse, error)

Update Order Update an order for the authenticated customer.

type RubaOrganizations 

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

func (*RubaOrganizations) Get 

func (s *RubaOrganizations) Get(ctx context.Context, slug string, opts ...operations.Option) (*operations.CustomerPortalOrganizationsGetResponse, error)

Get Organization Get a customer portal's organization by slug.

type RubaSubscriptions 

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

func (*RubaSubscriptions) Cancel 

func (s *RubaSubscriptions) Cancel(ctx context.Context, security operations.CustomerPortalSubscriptionsCancelSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalSubscriptionsCancelResponse, error)

Cancel Subscription Cancel a subscription of the authenticated customer.

func (*RubaSubscriptions) Get 

func (s *RubaSubscriptions) Get(ctx context.Context, security operations.CustomerPortalSubscriptionsGetSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalSubscriptionsGetResponse, error)

Get Subscription Get a subscription for the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaSubscriptions) List 

func (s *RubaSubscriptions) List(ctx context.Context, request operations.CustomerPortalSubscriptionsListRequest, security operations.CustomerPortalSubscriptionsListSecurity, opts ...operations.Option) (*operations.CustomerPortalSubscriptionsListResponse, error)

List Subscriptions List subscriptions of the authenticated customer.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*RubaSubscriptions) Update 

func (s *RubaSubscriptions) Update(ctx context.Context, security operations.CustomerPortalSubscriptionsUpdateSecurity, id string, customerSubscriptionUpdate components.CustomerSubscriptionUpdate, opts ...operations.Option) (*operations.CustomerPortalSubscriptionsUpdateResponse, error)

Update Subscription Update a subscription of the authenticated customer.

type SDKOption 

type SDKOption func(*Ruba)

func WithClient 

func WithClient(client HTTPClient) SDKOption

WithClient allows the overriding of the default HTTP client used by the SDK

func WithRetryConfig 

func WithRetryConfig(retryConfig retry.Config) SDKOption

func WithSecurity 

func WithSecurity(accessToken string) SDKOption

WithSecurity configures the SDK to use the provided security details

func WithSecuritySource 

func WithSecuritySource(security func(context.Context) (components.Security, error)) SDKOption

WithSecuritySource configures the SDK to invoke the Security Source function on each method call to determine authentication

func WithServer 

func WithServer(server string) SDKOption

WithServer allows the overriding of the default server by name

func WithServerURL 

func WithServerURL(serverURL string) SDKOption

WithServerURL allows providing an alternative server URL

func WithTemplatedServerURL 

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

WithTemplatedServerURL allows the overriding of the default server URL with a templated URL populated with the provided parameters

func WithTimeout 

func WithTimeout(timeout time.Duration) SDKOption

WithTimeout Optional request timeout applied to each operation

type Seats 

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

func (*Seats) AssignSeat 

func (s *Seats) AssignSeat(ctx context.Context, request components.SeatAssign, security operations.CustomerPortalSeatsAssignSeatSecurity, opts ...operations.Option) (*operations.CustomerPortalSeatsAssignSeatResponse, error)

AssignSeat - Assign Seat

func (*Seats) ListClaimedSubscriptions 

func (s *Seats) ListClaimedSubscriptions(ctx context.Context, security operations.CustomerPortalSeatsListClaimedSubscriptionsSecurity, page *int64, limit *int64, opts ...operations.Option) (*operations.CustomerPortalSeatsListClaimedSubscriptionsResponse, error)

ListClaimedSubscriptions - List Claimed Subscriptions List all subscriptions where the authenticated customer has claimed a seat.

**Scopes**: `customer_portal:read` `customer_portal:write`

func (*Seats) ListSeats 

func (s *Seats) ListSeats(ctx context.Context, security operations.CustomerPortalSeatsListSeatsSecurity, subscriptionID *string, orderID *string, opts ...operations.Option) (*operations.CustomerPortalSeatsListSeatsResponse, error)

ListSeats - List Seats **Scopes**: `customer_portal:read` `customer_portal:write`

func (*Seats) ResendInvitation 

func (s *Seats) ResendInvitation(ctx context.Context, security operations.CustomerPortalSeatsResendInvitationSecurity, seatID string, opts ...operations.Option) (*operations.CustomerPortalSeatsResendInvitationResponse, error)

ResendInvitation - Resend Invitation

func (*Seats) RevokeSeat 

func (s *Seats) RevokeSeat(ctx context.Context, security operations.CustomerPortalSeatsRevokeSeatSecurity, seatID string, opts ...operations.Option) (*operations.CustomerPortalSeatsRevokeSeatResponse, error)

RevokeSeat - Revoke Seat

type Subscriptions 

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

func (*Subscriptions) Create 

func (s *Subscriptions) Create(ctx context.Context, request operations.SubscriptionsCreateSubscriptionCreate, opts ...operations.Option) (*operations.SubscriptionsCreateResponse, error)

Create Subscription Create a subscription programmatically.

This endpoint only allows to create subscription on free products. For paid products, use the checkout flow.

No initial order will be created and no confirmation email will be sent.

**Scopes**: `subscriptions:write`

func (*Subscriptions) Export 

func (s *Subscriptions) Export(ctx context.Context, organizationID *operations.OrganizationID, opts ...operations.Option) (*operations.SubscriptionsExportResponse, error)

Export Subscriptions Export subscriptions as a CSV file.

**Scopes**: `subscriptions:read` `subscriptions:write`

func (*Subscriptions) Get 

func (s *Subscriptions) Get(ctx context.Context, id string, opts ...operations.Option) (*operations.SubscriptionsGetResponse, error)

Get Subscription Get a subscription by ID.

**Scopes**: `subscriptions:read` `subscriptions:write`

func (*Subscriptions) List 

func (s *Subscriptions) List(ctx context.Context, request operations.SubscriptionsListRequest, opts ...operations.Option) (*operations.SubscriptionsListResponse, error)

List Subscriptions List subscriptions.

**Scopes**: `subscriptions:read` `subscriptions:write`

func (*Subscriptions) Revoke 

func (s *Subscriptions) Revoke(ctx context.Context, id string, opts ...operations.Option) (*operations.SubscriptionsRevokeResponse, error)

Revoke Subscription Revoke a subscription, i.e cancel immediately.

**Scopes**: `subscriptions:write`

func (*Subscriptions) Update 

func (s *Subscriptions) Update(ctx context.Context, id string, subscriptionUpdate components.SubscriptionUpdate, opts ...operations.Option) (*operations.SubscriptionsUpdateResponse, error)

Update Subscription Update a subscription.

**Scopes**: `subscriptions:write`

type Wallets 

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

func (*Wallets) Get 

func (s *Wallets) Get(ctx context.Context, security operations.CustomerPortalWalletsGetSecurity, id string, opts ...operations.Option) (*operations.CustomerPortalWalletsGetResponse, error)

Get Wallet Get a wallet by ID for the authenticated customer.

func (*Wallets) List 

func (s *Wallets) List(ctx context.Context, security operations.CustomerPortalWalletsListSecurity, page *int64, limit *int64, sorting []components.CustomerWalletSortProperty, opts ...operations.Option) (*operations.CustomerPortalWalletsListResponse, error)

List Wallets List wallets of the authenticated customer.

type Webhooks 

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

func (*Webhooks) CreateWebhookEndpoint 

func (s *Webhooks) CreateWebhookEndpoint(ctx context.Context, request components.WebhookEndpointCreate, opts ...operations.Option) (*operations.WebhooksCreateWebhookEndpointResponse, error)

CreateWebhookEndpoint - Create Webhook Endpoint Create a webhook endpoint.

**Scopes**: `webhooks:write`

func (*Webhooks) DeleteWebhookEndpoint 

func (s *Webhooks) DeleteWebhookEndpoint(ctx context.Context, id string, opts ...operations.Option) (*operations.WebhooksDeleteWebhookEndpointResponse, error)

DeleteWebhookEndpoint - Delete Webhook Endpoint Delete a webhook endpoint.

**Scopes**: `webhooks:write`

func (*Webhooks) GetWebhookEndpoint 

func (s *Webhooks) GetWebhookEndpoint(ctx context.Context, id string, opts ...operations.Option) (*operations.WebhooksGetWebhookEndpointResponse, error)

GetWebhookEndpoint - Get Webhook Endpoint Get a webhook endpoint by ID.

**Scopes**: `webhooks:read` `webhooks:write`

func (*Webhooks) ListWebhookDeliveries 

func (s *Webhooks) ListWebhookDeliveries(ctx context.Context, request operations.WebhooksListWebhookDeliveriesRequest, opts ...operations.Option) (*operations.WebhooksListWebhookDeliveriesResponse, error)

ListWebhookDeliveries - List Webhook Deliveries List webhook deliveries.

Deliveries are all the attempts to deliver a webhook event to an endpoint.

**Scopes**: `webhooks:read` `webhooks:write`

func (*Webhooks) ListWebhookEndpoints 

func (s *Webhooks) ListWebhookEndpoints(ctx context.Context, organizationID *operations.QueryParamOrganizationID, page *int64, limit *int64, opts ...operations.Option) (*operations.WebhooksListWebhookEndpointsResponse, error)

ListWebhookEndpoints - List Webhook Endpoints List webhook endpoints.

**Scopes**: `webhooks:read` `webhooks:write`

func (*Webhooks) RedeliverWebhookEvent 

func (s *Webhooks) RedeliverWebhookEvent(ctx context.Context, id string, opts ...operations.Option) (*operations.WebhooksRedeliverWebhookEventResponse, error)

RedeliverWebhookEvent - Redeliver Webhook Event Schedule the re-delivery of a webhook event.

**Scopes**: `webhooks:write`

func (*Webhooks) ResetWebhookEndpointSecret 

func (s *Webhooks) ResetWebhookEndpointSecret(ctx context.Context, id string, opts ...operations.Option) (*operations.WebhooksResetWebhookEndpointSecretResponse, error)

ResetWebhookEndpointSecret - Reset Webhook Endpoint Secret Regenerate a webhook endpoint secret.

**Scopes**: `webhooks:write`

func (*Webhooks) UpdateWebhookEndpoint 

func (s *Webhooks) UpdateWebhookEndpoint(ctx context.Context, id string, webhookEndpointUpdate components.WebhookEndpointUpdate, opts ...operations.Option) (*operations.WebhooksUpdateWebhookEndpointResponse, error)

UpdateWebhookEndpoint - Update Webhook Endpoint Update a webhook endpoint.

**Scopes**: `webhooks:write`

Source Files

View all Source files

Directories

Path Synopsis
internal
config
hooks
utils
models
apierrors
components
operations
webhooks

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.