Merge pull request #1972 from stripe/mbroshi/time-dot-time-support

Support time.Time instead of int64 for date fields

Author: mbroshi-stripe

account.go

@@ -3,6 +3,7 @@ package stripe
 import (
 	"encoding/json"
 	"testing"
+	"time"
 
 	assert "github.com/stretchr/testify/require"
 	"github.com/stripe/stripe-go/v81/form"
@@ -138,7 +139,7 @@ func TestAccount_Unmarshal(t *testing.T) {
 	assert.Equal(t, "value1", account.Metadata["key1"])
 	assert.Equal(t, "value2", account.Metadata["key2"])
 
-	assert.Equal(t, int64(1234567890), account.Requirements.CurrentDeadline)
+	assert.Equal(t, time.Unix(1234567890, 0), account.Requirements.CurrentDeadline)
 	assert.Equal(t, 2, len(account.Requirements.CurrentlyDue))
 	assert.Equal(t, AccountRequirementsDisabledReasonRejectedFraud, account.Requirements.DisabledReason)
 	assert.Equal(t, 1, len(account.Requirements.Errors))
@@ -156,7 +157,7 @@ func TestAccount_Unmarshal(t *testing.T) {
 	assert.Equal(t, int64(2), account.Settings.Payouts.Schedule.DelayDays)
 	assert.Equal(t, AccountSettingsPayoutsScheduleIntervalWeekly, account.Settings.Payouts.Schedule.Interval)
 
-	assert.Equal(t, int64(1528573382), account.TOSAcceptance.Date)
+	assert.Equal(t, time.Unix(1528573382, 0), account.TOSAcceptance.Date)
 	assert.Equal(t, "127.0.0.1", account.TOSAcceptance.IP)
 	assert.Equal(t, "user agent", account.TOSAcceptance.UserAgent)
 	assert.Equal(t, AccountTOSAcceptanceServiceAgreementRecipient, account.TOSAcceptance.ServiceAgreement)

account_test.go

@@ -6,6 +6,11 @@
 
 package stripe
 
+import (
+	"encoding/json"
+	"time"
+)
+
 // Specifies the requirements that Stripe collects from connected accounts in the Connect Onboarding flow.
 type AccountLinkCollectionOptionsParams struct {
 	// Specifies whether the platform collects only currently_due requirements (`currently_due`) or both currently_due and eventually_due requirements (`eventually_due`). If you don't specify `collection_options`, the default value is `currently_due`.
@@ -63,11 +68,51 @@ func (p *AccountLinkParams) AddExpand(f string) {
 type AccountLink struct {
 	APIResource
 	// Time at which the object was created. Measured in seconds since the Unix epoch.
-	Created int64 `json:"created"`
+	Created time.Time `json:"created"`
 	// The timestamp at which this account link will expire.
-	ExpiresAt int64 `json:"expires_at"`
+	ExpiresAt time.Time `json:"expires_at"`
 	// String representing the object's type. Objects of the same type share the same value.
 	Object string `json:"object"`
 	// The URL for the account link.
 	URL string `json:"url"`
 }
+
+// UnmarshalJSON handles deserialization of an AccountLink.
+// This custom unmarshaling is needed to handle the time fields correctly.
+func (a *AccountLink) UnmarshalJSON(data []byte) error {
+	type accountLink AccountLink
+	v := struct {
+		Created   int64 `json:"created"`
+		ExpiresAt int64 `json:"expires_at"`
+		*accountLink
+	}{
+		accountLink: (*accountLink)(a),
+	}
+	if err := json.Unmarshal(data, &v); err != nil {
+		return err
+	}
+
+	a.Created = time.Unix(v.Created, 0)
+	a.ExpiresAt = time.Unix(v.ExpiresAt, 0)
+	return nil
+}
+
+// MarshalJSON handles serialization of an AccountLink.
+// This custom marshaling is needed to handle the time fields correctly.
+func (a AccountLink) MarshalJSON() ([]byte, error) {
+	type accountLink AccountLink
+	v := struct {
+		Created   int64 `json:"created"`
+		ExpiresAt int64 `json:"expires_at"`
+		accountLink
+	}{
+		accountLink: (accountLink)(a),
+		Created:     a.Created.Unix(),
+		ExpiresAt:   a.ExpiresAt.Unix(),
+	}
+	b, err := json.Marshal(v)
+	if err != nil {
+		return nil, err
+	}
+	return b, err
+}

accountlink.go

@@ -6,6 +6,11 @@
 
 package stripe
 
+import (
+	"encoding/json"
+	"time"
+)
+
 // Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
 type AccountNoticeReason string
 
@@ -50,7 +55,7 @@ type AccountNoticeParams struct {
 	// Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
 	Metadata map[string]string `form:"metadata"`
 	// Date when you sent the notice.
-	SentAt *int64 `form:"sent_at"`
+	SentAt *time.Time `form:"sent_at"`
 }
 
 // AddExpand appends a new field to expand.
@@ -103,9 +108,9 @@ type AccountNoticeLinkedObjects struct {
 type AccountNotice struct {
 	APIResource
 	// Time at which the object was created. Measured in seconds since the Unix epoch.
-	Created int64 `json:"created"`
+	Created time.Time `json:"created"`
 	// When present, the deadline for sending the notice to meet the relevant regulations.
-	Deadline int64 `json:"deadline"`
+	Deadline time.Time `json:"deadline"`
 	// Information about the email when sent.
 	Email *AccountNoticeEmail `json:"email"`
 	// Unique identifier for the object.
@@ -121,7 +126,7 @@ type AccountNotice struct {
 	// Reason the notice is being sent. The reason determines what copy the notice must contain. See the [regulated customer notices](https://stripe.com/docs/issuing/compliance-us/issuing-regulated-customer-notices) guide. All reasons might not apply to your integration, and Stripe might add new reasons in the future, so we recommend an internal warning when you receive an unknown reason.
 	Reason AccountNoticeReason `json:"reason"`
 	// Date when the notice was sent. When absent, you must send the notice, update the content of the email and date when it was sent.
-	SentAt int64 `json:"sent_at"`
+	SentAt time.Time `json:"sent_at"`
 }
 
 // AccountNoticeList is a list of AccountNotices as retrieved from a list endpoint.
@@ -130,3 +135,47 @@ type AccountNoticeList struct {
 	ListMeta
 	Data []*AccountNotice `json:"data"`
 }
+
+// UnmarshalJSON handles deserialization of an AccountNotice.
+// This custom unmarshaling is needed to handle the time fields correctly.
+func (a *AccountNotice) UnmarshalJSON(data []byte) error {
+	type accountNotice AccountNotice
+	v := struct {
+		Created  int64 `json:"created"`
+		Deadline int64 `json:"deadline"`
+		SentAt   int64 `json:"sent_at"`
+		*accountNotice
+	}{
+		accountNotice: (*accountNotice)(a),
+	}
+	if err := json.Unmarshal(data, &v); err != nil {
+		return err
+	}
+
+	a.Created = time.Unix(v.Created, 0)
+	a.Deadline = time.Unix(v.Deadline, 0)
+	a.SentAt = time.Unix(v.SentAt, 0)
+	return nil
+}
+
+// MarshalJSON handles serialization of an AccountNotice.
+// This custom marshaling is needed to handle the time fields correctly.
+func (a AccountNotice) MarshalJSON() ([]byte, error) {
+	type accountNotice AccountNotice
+	v := struct {
+		Created  int64 `json:"created"`
+		Deadline int64 `json:"deadline"`
+		SentAt   int64 `json:"sent_at"`
+		accountNotice
+	}{
+		accountNotice: (accountNotice)(a),
+		Created:       a.Created.Unix(),
+		Deadline:      a.Deadline.Unix(),
+		SentAt:        a.SentAt.Unix(),
+	}
+	b, err := json.Marshal(v)
+	if err != nil {
+		return nil, err
+	}
+	return b, err
+}

accountnotice.go

@@ -6,6 +6,11 @@
 
 package stripe
 
+import (
+	"encoding/json"
+	"time"
+)
+
 // The list of features enabled in the embedded component.
 type AccountSessionComponentsAccountManagementFeaturesParams struct {
 	// Disables Stripe user authentication for this embedded component. This value can only be true for accounts where `controller.requirement_collection` is `application`. The default value is the opposite of the `external_account_collection` value. For example, if you don't set `external_account_collection`, it defaults to true and `disable_stripe_user_authentication` defaults to false.
@@ -679,9 +684,45 @@ type AccountSession struct {
 	ClientSecret string                    `json:"client_secret"`
 	Components   *AccountSessionComponents `json:"components"`
 	// The timestamp at which this AccountSession will expire.
-	ExpiresAt int64 `json:"expires_at"`
+	ExpiresAt time.Time `json:"expires_at"`
 	// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
 	Livemode bool `json:"livemode"`
 	// String representing the object's type. Objects of the same type share the same value.
 	Object string `json:"object"`
 }
+
+// UnmarshalJSON handles deserialization of an AccountSession.
+// This custom unmarshaling is needed to handle the time fields correctly.
+func (a *AccountSession) UnmarshalJSON(data []byte) error {
+	type accountSession AccountSession
+	v := struct {
+		ExpiresAt int64 `json:"expires_at"`
+		*accountSession
+	}{
+		accountSession: (*accountSession)(a),
+	}
+	if err := json.Unmarshal(data, &v); err != nil {
+		return err
+	}
+
+	a.ExpiresAt = time.Unix(v.ExpiresAt, 0)
+	return nil
+}
+
+// MarshalJSON handles serialization of an AccountSession.
+// This custom marshaling is needed to handle the time fields correctly.
+func (a AccountSession) MarshalJSON() ([]byte, error) {
+	type accountSession AccountSession
+	v := struct {
+		ExpiresAt int64 `json:"expires_at"`
+		accountSession
+	}{
+		accountSession: (accountSession)(a),
+		ExpiresAt:      a.ExpiresAt.Unix(),
+	}
+	b, err := json.Marshal(v)
+	if err != nil {
+		return nil, err
+	}
+	return b, err
+}

accountsession.go

@@ -6,6 +6,11 @@
 
 package stripe
 
+import (
+	"encoding/json"
+	"time"
+)
+
 // Delete an apple pay domain.
 type ApplePayDomainParams struct {
 	Params     `form:"*"`
@@ -35,9 +40,9 @@ func (p *ApplePayDomainListParams) AddExpand(f string) {
 type ApplePayDomain struct {
 	APIResource
 	// Time at which the object was created. Measured in seconds since the Unix epoch.
-	Created    int64  `json:"created"`
-	Deleted    bool   `json:"deleted"`
-	DomainName string `json:"domain_name"`
+	Created    time.Time `json:"created"`
+	Deleted    bool      `json:"deleted"`
+	DomainName string    `json:"domain_name"`
 	// Unique identifier for the object.
 	ID string `json:"id"`
 	// Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
@@ -52,3 +57,39 @@ type ApplePayDomainList struct {
 	ListMeta
 	Data []*ApplePayDomain `json:"data"`
 }
+
+// UnmarshalJSON handles deserialization of an ApplePayDomain.
+// This custom unmarshaling is needed to handle the time fields correctly.
+func (a *ApplePayDomain) UnmarshalJSON(data []byte) error {
+	type applePayDomain ApplePayDomain
+	v := struct {
+		Created int64 `json:"created"`
+		*applePayDomain
+	}{
+		applePayDomain: (*applePayDomain)(a),
+	}
+	if err := json.Unmarshal(data, &v); err != nil {
+		return err
+	}
+
+	a.Created = time.Unix(v.Created, 0)
+	return nil
+}
+
+// MarshalJSON handles serialization of an ApplePayDomain.
+// This custom marshaling is needed to handle the time fields correctly.
+func (a ApplePayDomain) MarshalJSON() ([]byte, error) {
+	type applePayDomain ApplePayDomain
+	v := struct {
+		Created int64 `json:"created"`
+		applePayDomain
+	}{
+		applePayDomain: (applePayDomain)(a),
+		Created:        a.Created.Unix(),
+	}
+	b, err := json.Marshal(v)
+	if err != nil {
+		return nil, err
+	}
+	return b, err
+}

applepaydomain.go

@@ -6,7 +6,10 @@
 
 package stripe
 
-import "encoding/json"
+import (
+	"encoding/json"
+	"time"
+)
 
 // Type of object that created the application fee, either `charge` or `payout`.
 type ApplicationFeeFeeSourceType string
@@ -71,7 +74,7 @@ type ApplicationFee struct {
 	// ID of the charge that the application fee was taken from.
 	Charge *Charge `json:"charge"`
 	// Time at which the object was created. Measured in seconds since the Unix epoch.
-	Created int64 `json:"created"`
+	Created time.Time `json:"created"`
 	// Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).
 	Currency Currency `json:"currency"`
 	// Polymorphic source of the application fee. Includes the ID of the object the application fee was created from.
@@ -107,11 +110,34 @@ func (a *ApplicationFee) UnmarshalJSON(data []byte) error {
 	}
 
 	type applicationFee ApplicationFee
-	var v applicationFee
+	v := struct {
+		Created int64 `json:"created"`
+		*applicationFee
+	}{
+		applicationFee: (*applicationFee)(a),
+	}
 	if err := json.Unmarshal(data, &v); err != nil {
 		return err
 	}
 
-	*a = ApplicationFee(v)
+	a.Created = time.Unix(v.Created, 0)
 	return nil
 }
+
+// MarshalJSON handles serialization of an ApplicationFee.
+// This custom marshaling is needed to handle the time fields correctly.
+func (a ApplicationFee) MarshalJSON() ([]byte, error) {
+	type applicationFee ApplicationFee
+	v := struct {
+		Created int64 `json:"created"`
+		applicationFee
+	}{
+		applicationFee: (applicationFee)(a),
+		Created:        a.Created.Unix(),
+	}
+	b, err := json.Marshal(v)
+	if err != nil {
+		return nil, err
+	}
+	return b, err
+}