Convert depracation comments to godoc and deprecate Resource struct. (#207)

* Fix deprecation comment formatting for godoc.

* Deprecate Resource struct
This commit is contained in:
Thomas Frössman 2021-07-20 08:37:23 +02:00 committed by GitHub
parent 7f2eec9b56
commit d2210adf9c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 20 additions and 6 deletions

View File

@ -20,7 +20,9 @@ type (
Links []Link `json:"links,omitempty"`
}
// CreateBillingResp deprecated, use CreateBillingResponse instead.
// CreateBillingResp.
//
// Deprecated: use CreateBillingResponse instead.
CreateBillingResp = CreateBillingResponse
// CreateAgreementResponse struct
@ -32,22 +34,26 @@ type (
StartTime time.Time `json:"start_time,omitempty"`
}
// CreateAgreementResp is deprecated, use CreateAgreementResponse instead.
// CreateAgreementResp.
//
// Deprecated: use CreateAgreementResponse instead.
CreateAgreementResp = CreateAgreementResponse
// BillingPlanListParams struct
// BillingPlanListParams
BillingPlanListParams struct {
ListParams
Status string `json:"status,omitempty"` //Allowed values: CREATED, ACTIVE, INACTIVE, ALL.
}
//BillingPlanListResponse struct
// BillingPlanListResponse
BillingPlanListResponse struct {
SharedListResponse
Plans []BillingPlan `json:"plans,omitempty"`
}
// BillingPlanListResp is deprecated, use BillingPlanListResponse instead.
// BillingPlanListResp.
//
// Deprecated: use BillingPlanListResponse instead.
BillingPlanListResp = BillingPlanListResponse
)

View File

@ -1132,8 +1132,16 @@ type (
Value interface{} `json:"value"`
}
// Resource is a mix of fields from several webhook resource types.
//
// Deprecated: Add implementation of specific resource types in your own
// code and don't use this catch all struct, you show know which resource
// type you are expecting and handle that type only.
//
// Every resource struct type should be unique for every combination of
// "resource_type"/"resource_version" combination of the Event type /
// webhook message.
Resource struct {
// Payment Resource type
ID string `json:"id,omitempty"`
Status string `json:"status,omitempty"`
StatusDetails *CaptureStatusDetails `json:"status_details,omitempty"`