mirror of
https://github.com/plutov/paypal.git
synced 2025-01-23 02:11:02 +01:00
Re-adding billing agreements endpoint (#212)
* adding billing_agreements.go file * added new types * added tests * added notice of deprecation
This commit is contained in:
parent
f195993596
commit
2d088532de
|
@ -29,7 +29,7 @@ type (
|
|||
CreateAgreementResponse struct {
|
||||
Name string `json:"name,omitempty"`
|
||||
Description string `json:"description,omitempty"`
|
||||
Plan BillingPlan `json:"plan,omitempty"`
|
||||
Plan BillingPlan `json:"plan,omitempty"`
|
||||
Links []Link `json:"links,omitempty"`
|
||||
StartTime time.Time `json:"start_time,omitempty"`
|
||||
}
|
||||
|
@ -37,7 +37,7 @@ type (
|
|||
// CreateAgreementResp.
|
||||
//
|
||||
// Deprecated: use CreateAgreementResponse instead.
|
||||
CreateAgreementResp = CreateAgreementResponse
|
||||
CreateAgreementResp = CreateAgreementResponse
|
||||
|
||||
// BillingPlanListParams
|
||||
BillingPlanListParams struct {
|
||||
|
@ -100,6 +100,7 @@ func (c *Client) ActivatePlan(ctx context.Context, planID string) error {
|
|||
|
||||
// CreateBillingAgreement creates an agreement for specified plan
|
||||
// Endpoint: POST /v1/payments/billing-agreements
|
||||
// Deprecated: Use POST /v1/billing-agreements/agreements
|
||||
func (c *Client) CreateBillingAgreement(ctx context.Context, a BillingAgreement) (*CreateAgreementResponse, error) {
|
||||
// PayPal needs only ID, so we will remove all fields except Plan ID
|
||||
a.Plan = BillingPlan{
|
||||
|
|
68
billing_agreements.go
Normal file
68
billing_agreements.go
Normal file
|
@ -0,0 +1,68 @@
|
|||
package paypal
|
||||
|
||||
import (
|
||||
"context"
|
||||
"fmt"
|
||||
)
|
||||
|
||||
// CreatePaypalBillingAgreementToken - Use this call to create a billing agreement token
|
||||
// Endpoint: POST /v1/billing-agreements/agreement-tokens
|
||||
func (c *Client) CreatePaypalBillingAgreementToken(
|
||||
ctx context.Context,
|
||||
description *string,
|
||||
shippingAddress *ShippingAddress,
|
||||
payer *Payer,
|
||||
plan *BillingPlan,
|
||||
) (*BillingAgreementToken, error) {
|
||||
type createBARequest struct {
|
||||
Description *string `json:"description,omitempty"`
|
||||
ShippingAddress *ShippingAddress `json:"shipping_address,omitempty"`
|
||||
Payer *Payer `json:"payer"`
|
||||
Plan *BillingPlan `json:"plan"`
|
||||
}
|
||||
|
||||
billingAgreementToken := &BillingAgreementToken{}
|
||||
|
||||
req, err := c.NewRequest(
|
||||
ctx,
|
||||
"POST",
|
||||
fmt.Sprintf("%s%s", c.APIBase, "/v1/billing-agreements/agreement-tokens"),
|
||||
createBARequest{Description: description, ShippingAddress: shippingAddress, Payer: payer, Plan: plan})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err = c.SendWithAuth(req, billingAgreementToken); err != nil {
|
||||
return billingAgreementToken, err
|
||||
}
|
||||
|
||||
return billingAgreementToken, nil
|
||||
}
|
||||
|
||||
// CreatePaypalBillingAgreementFromToken - Use this call to create a billing agreement
|
||||
// Endpoint: POST /v1/billing-agreements/agreements
|
||||
func (c *Client) CreatePaypalBillingAgreementFromToken(
|
||||
ctx context.Context,
|
||||
tokenID string,
|
||||
) (*BillingAgreementFromToken, error) {
|
||||
type createBARequest struct {
|
||||
TokenID string `json:"token_id"`
|
||||
}
|
||||
|
||||
billingAgreement := &BillingAgreementFromToken{}
|
||||
|
||||
req, err := c.NewRequest(
|
||||
ctx,
|
||||
"POST",
|
||||
fmt.Sprintf("%s%s", c.APIBase, "/v1/billing-agreements/agreements"),
|
||||
createBARequest{TokenID: tokenID})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
if err = c.SendWithAuth(req, billingAgreement); err != nil {
|
||||
return billingAgreement, err
|
||||
}
|
||||
|
||||
return billingAgreement, nil
|
||||
}
|
25
types.go
25
types.go
|
@ -328,6 +328,31 @@ type (
|
|||
OverrideMerchantPreferences *MerchantPreferences `json:"override_merchant_preferences,omitempty"`
|
||||
}
|
||||
|
||||
// BillingAgreementFromToken struct
|
||||
BillingAgreementFromToken struct {
|
||||
ID string `json:"id,omitempty"`
|
||||
Description string `json:"description,omitempty"`
|
||||
Payer *Payer `json:"payer,omitempty"`
|
||||
Plan BillingPlan `json:"plan,omitempty"`
|
||||
Links []Link `json:"links,omitempty"`
|
||||
}
|
||||
|
||||
// BillingAgreementToken response struct
|
||||
BillingAgreementToken struct {
|
||||
Links []Link `json:"links,omitempty"`
|
||||
TokenID string `json:"token_id,omitempty"`
|
||||
}
|
||||
|
||||
// Plan struct
|
||||
Plan struct {
|
||||
ID string `json:"id"`
|
||||
Name string `json:"name"`
|
||||
Description string `json:"description"`
|
||||
CreateTime string `json:"create_time,omitempty"`
|
||||
UpdateTime string `json:"update_time,omitempty"`
|
||||
PaymentDefinitions []PaymentDefinition `json:"payment_definitions,omitempty"`
|
||||
}
|
||||
|
||||
// BillingInfo struct
|
||||
BillingInfo struct {
|
||||
OutstandingBalance AmountPayout `json:"outstanding_balance,omitempty"`
|
||||
|
|
45
unit_test.go
45
unit_test.go
|
@ -392,6 +392,16 @@ func (ts *webprofileTestServer) ServeHTTP(w http.ResponseWriter, r *http.Request
|
|||
ts.deleteinvalid(w, r)
|
||||
}
|
||||
}
|
||||
if r.RequestURI == "/v1/billing-agreements/agreement-tokens" {
|
||||
if r.Method == "POST" {
|
||||
ts.createWithoutName(w, r)
|
||||
}
|
||||
}
|
||||
if r.RequestURI == "/v1/billing-agreements/agreements" {
|
||||
if r.Method == "POST" {
|
||||
ts.createWithoutName(w, r)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
func (ts *webprofileTestServer) create(w http.ResponseWriter, r *http.Request) {
|
||||
|
@ -772,3 +782,38 @@ func TestDeleteWebProfile_invalid(t *testing.T) {
|
|||
}
|
||||
|
||||
}
|
||||
|
||||
func TestCreatePaypalBillingAgreementToken(t *testing.T) {
|
||||
|
||||
ts := httptest.NewServer(&webprofileTestServer{t: t})
|
||||
defer ts.Close()
|
||||
|
||||
c, _ := NewClient("foo", "bar", ts.URL)
|
||||
description := "name A"
|
||||
|
||||
_, err := c.CreatePaypalBillingAgreementToken(
|
||||
context.Background(),
|
||||
&description,
|
||||
&ShippingAddress{RecipientName: "Name", Type: "Type", Line1: "Line1", Line2: "Line2"},
|
||||
&Payer{PaymentMethod: "paypal"},
|
||||
&BillingPlan{ID: "id B", Name: "name B", Description: "description B", Type: "type B"})
|
||||
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
func TestCreatePaypalBillingAgreementFromToken(t *testing.T) {
|
||||
|
||||
ts := httptest.NewServer(&webprofileTestServer{t: t})
|
||||
defer ts.Close()
|
||||
|
||||
c, _ := NewClient("foo", "bar", ts.URL)
|
||||
|
||||
_, err := c.CreatePaypalBillingAgreementFromToken(context.Background(), "BillingAgreementToken")
|
||||
|
||||
if err != nil {
|
||||
t.Fatal(err)
|
||||
}
|
||||
}
|
||||
|
|
Loading…
Reference in New Issue
Block a user