billing

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Jun 13, 2021 License: BSD-3-Clause Imports: 6 Imported by: 0

Documentation

Overview

Package billing implements the DocuSign SDK category Billing.

Use the Billing category to manage the following billing related tasks:

* Retrieve and update billing plan information. * Retrieve invoices. * Retrieve and update payment information.

Service Api documentation may be found at: https://developers.docusign.com/esign-rest-api/v2/reference/Billing Usage example: 

import (
    "github.com/ICGGroup/esign"
    "github.com/ICGGroup/esign/v2/billing"
    "github.com/ICGGroup/esign/v2/model"
)
...
billingService := billing.New(esignCredential)

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type InvoicesGetOp 

type InvoicesGetOp esign.Op

InvoicesGetOp implements DocuSign API SDK Billing::getInvoice

func (*InvoicesGetOp) Do 

func (op *InvoicesGetOp) Do(ctx context.Context) (*model.BillingInvoice, error)

Do executes the op. A nil context will return error.

func (*InvoicesGetOp) PDF 

func (op *InvoicesGetOp) PDF(ctx context.Context) (*esign.Download, error)

PDF returns a pdf version of the invoice by setting the Accept header to application/pdf

**not included in swagger definition

type InvoicesListOp 

type InvoicesListOp esign.Op

InvoicesListOp implements DocuSign API SDK Billing::listInvoices

func (*InvoicesListOp) Do 

func (op *InvoicesListOp) Do(ctx context.Context) (*model.BillingInvoicesResponse, error)

Do executes the op. A nil context will return error.

func (*InvoicesListOp) FromDate 

func (op *InvoicesListOp) FromDate(val time.Time) *InvoicesListOp

FromDate specifies the date/time of the earliest invoice in the account to retrieve.

func (*InvoicesListOp) ToDate 

func (op *InvoicesListOp) ToDate(val time.Time) *InvoicesListOp

ToDate specifies the date/time of the latest invoice in the account to retrieve.

type InvoicesListPastDueOp 

type InvoicesListPastDueOp esign.Op

InvoicesListPastDueOp implements DocuSign API SDK Billing::listInvoicesPastDue

func (*InvoicesListPastDueOp) Do 

func (op *InvoicesListPastDueOp) Do(ctx context.Context) (*model.BillingInvoicesSummary, error)

Do executes the op. A nil context will return error.

type PaymentsCreateOp 

type PaymentsCreateOp esign.Op

PaymentsCreateOp implements DocuSign API SDK Billing::makePayment

func (*PaymentsCreateOp) Do 

func (op *PaymentsCreateOp) Do(ctx context.Context) (*model.BillingPaymentResponse, error)

Do executes the op. A nil context will return error.

type PaymentsGetOp 

type PaymentsGetOp esign.Op

PaymentsGetOp implements DocuSign API SDK Billing::getPayment

func (*PaymentsGetOp) Do 

func (op *PaymentsGetOp) Do(ctx context.Context) (*model.BillingPaymentItem, error)

Do executes the op. A nil context will return error.

type PaymentsListOp 

type PaymentsListOp esign.Op

PaymentsListOp implements DocuSign API SDK Billing::listPayments

func (*PaymentsListOp) Do 

func (op *PaymentsListOp) Do(ctx context.Context) (*model.BillingPaymentsResponse, error)

Do executes the op. A nil context will return error.

func (*PaymentsListOp) FromDate 

func (op *PaymentsListOp) FromDate(val time.Time) *PaymentsListOp

FromDate specifies the date/time of the earliest payment in the account to retrieve.

func (*PaymentsListOp) ToDate 

func (op *PaymentsListOp) ToDate(val time.Time) *PaymentsListOp

ToDate specifies the date/time of the latest payment in the account to retrieve.

type PlansGetAccountPlanOp 

type PlansGetAccountPlanOp esign.Op

PlansGetAccountPlanOp implements DocuSign API SDK Billing::getPlan

func (*PlansGetAccountPlanOp) Do 

func (op *PlansGetAccountPlanOp) Do(ctx context.Context) (*model.AccountBillingPlanResponse, error)

Do executes the op. A nil context will return error.

func (*PlansGetAccountPlanOp) IncludeCreditCardInformation 

func (op *PlansGetAccountPlanOp) IncludeCreditCardInformation() *PlansGetAccountPlanOp

IncludeCreditCardInformation when set to **true**, payment information including credit card information will show in the return.

func (*PlansGetAccountPlanOp) IncludeMetadata 

func (op *PlansGetAccountPlanOp) IncludeMetadata() *PlansGetAccountPlanOp

IncludeMetadata when set to **true**, the `canUpgrade` and `renewalStatus` properities are included the response and an array of `supportedCountries` property is added to the `billingAddress` information.

func (*PlansGetAccountPlanOp) IncludeSuccessorPlans 

func (op *PlansGetAccountPlanOp) IncludeSuccessorPlans() *PlansGetAccountPlanOp

IncludeSuccessorPlans when set to **true**, excludes successor information from the response.

type PlansGetCreditCardOp 

type PlansGetCreditCardOp esign.Op

PlansGetCreditCardOp implements DocuSign API SDK Billing::getCreditCardInfo

func (*PlansGetCreditCardOp) Do 

func (op *PlansGetCreditCardOp) Do(ctx context.Context) (*model.CreditCardInformation, error)

Do executes the op. A nil context will return error.

type PlansGetOp 

type PlansGetOp esign.Op

PlansGetOp implements DocuSign API SDK Billing::getBillingPlan

func (*PlansGetOp) Do 

func (op *PlansGetOp) Do(ctx context.Context) (*model.BillingPlanResponse, error)

Do executes the op. A nil context will return error.

type PlansListOp 

type PlansListOp esign.Op

PlansListOp implements DocuSign API SDK Billing::listBillingPlans

func (*PlansListOp) Do 

func (op *PlansListOp) Do(ctx context.Context) (*model.BillingPlansResponse, error)

Do executes the op. A nil context will return error.

type PlansPurchaseEnvelopesOp 

type PlansPurchaseEnvelopesOp esign.Op

PlansPurchaseEnvelopesOp implements DocuSign API SDK Billing::purchaseEnvelopes

func (*PlansPurchaseEnvelopesOp) Do 

func (op *PlansPurchaseEnvelopesOp) Do(ctx context.Context) error

Do executes the op. A nil context will return error.

type PlansUpdateOp 

type PlansUpdateOp esign.Op

PlansUpdateOp implements DocuSign API SDK Billing::updatePlan

func (*PlansUpdateOp) Do 

func (op *PlansUpdateOp) Do(ctx context.Context) (*model.BillingPlanUpdateResponse, error)

Do executes the op. A nil context will return error.

func (*PlansUpdateOp) PreviewBillingPlan 

func (op *PlansUpdateOp) PreviewBillingPlan() *PlansUpdateOp

PreviewBillingPlan when set to **true**, updates the account using a preview billing plan.

type Service 

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

Service implements DocuSign Billing Category API operations

func New 

func New(cred esign.Credential) *Service

New initializes a billing service using cred to authorize ops.

func (*Service) InvoicesGet 

func (s *Service) InvoicesGet(invoiceID string) *InvoicesGetOp

InvoicesGet retrieves a billing invoice.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/invoices/get

SDK Method Billing::getInvoice

func (*Service) InvoicesList 

func (s *Service) InvoicesList() *InvoicesListOp

InvoicesList get a List of Billing Invoices

https://developers.docusign.com/esign-rest-api/v2/reference/billing/invoices/list

SDK Method Billing::listInvoices

func (*Service) InvoicesListPastDue 

func (s *Service) InvoicesListPastDue() *InvoicesListPastDueOp

InvoicesListPastDue get a list of past due invoices.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/invoices/listpastdue

SDK Method Billing::listInvoicesPastDue

func (*Service) PaymentsCreate 

func (s *Service) PaymentsCreate(billingPaymentRequest *model.BillingPaymentRequest) *PaymentsCreateOp

PaymentsCreate posts a payment to a past due invoice.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/payments/create

SDK Method Billing::makePayment

func (*Service) PaymentsGet 

func (s *Service) PaymentsGet(paymentID string) *PaymentsGetOp

PaymentsGet gets billing payment information for a specific payment.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/payments/get

SDK Method Billing::getPayment

func (*Service) PaymentsList 

func (s *Service) PaymentsList() *PaymentsListOp

PaymentsList gets payment information for one or more payments.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/payments/list

SDK Method Billing::listPayments

func (*Service) PlansGet 

func (s *Service) PlansGet(billingPlanID string) *PlansGetOp

PlansGet get the billing plan details.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/billingplans/get

SDK Method Billing::getBillingPlan

func (*Service) PlansGetAccountPlan 

func (s *Service) PlansGetAccountPlan() *PlansGetAccountPlanOp

PlansGetAccountPlan get Account Billing Plan

https://developers.docusign.com/esign-rest-api/v2/reference/billing/billingplans/getaccountplan

SDK Method Billing::getPlan

func (*Service) PlansGetCreditCard 

func (s *Service) PlansGetCreditCard() *PlansGetCreditCardOp

PlansGetCreditCard get metadata for a given credit card.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/billingplans/getcreditcard

SDK Method Billing::getCreditCardInfo

func (*Service) PlansList 

func (s *Service) PlansList() *PlansListOp

PlansList gets the list of available billing plans.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/billingplans/list

SDK Method Billing::listBillingPlans

func (*Service) PlansPurchaseEnvelopes 

func (s *Service) PlansPurchaseEnvelopes(purchasedEnvelopesInformation *model.PurchasedEnvelopesInformation) *PlansPurchaseEnvelopesOp

PlansPurchaseEnvelopes reserverd: Purchase additional envelopes.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/billingplans/purchaseenvelopes

SDK Method Billing::purchaseEnvelopes

func (*Service) PlansUpdate 

func (s *Service) PlansUpdate(billingPlanInformation *model.BillingPlanInformation) *PlansUpdateOp

PlansUpdate updates the account billing plan.

https://developers.docusign.com/esign-rest-api/v2/reference/billing/billingplans/update

SDK Method Billing::updatePlan

Source Files

View all Source files

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.