pactman

type APIError struct {
	// Status is the HTTP status code.
	Status int
	// APIMessage is the envelope's reasons joined, or its message, or the start
	// of a non-JSON body. Empty when the response carried none.
	APIMessage string
	// APICode is the envelope's code, when present.
	APICode *int
	// APIErrors is the envelope's errors, normalized to a list.
	APIErrors []APIErrorDetail
	// RequestID is the correlation identifier from the response headers.
	RequestID string
	// RetryAfter is the server's Retry-After, when it sent a usable value.
	RetryAfter *time.Duration
	// Body is the response body exactly as received. An undecodable body is
	// still evidence.
	Body []byte
	// Attempts is how many attempts were made before this error surfaced.
	Attempts int
	// contains filtered or unexported fields
}

type APIErrorDetail struct {
	// Resource is the API resource the error came from.
	Resource string `json:"resource"`
	// Reason is the human-readable explanation.
	Reason string `json:"reason"`
	// Code is the status for this specific failure, which may differ from the
	// HTTP status.
	Code *int `json:"code"`
	// EINs are the EINs this error applies to, for bulk requests. The API sends
	// them as a list or as one comma-separated string; both read as a list.
	EINs []string `json:"eins"`

	// Fields is every field the API returned for this entry, exactly as sent.
	Fields Object `json:"-"`
}

type AROESource struct {
	RevocationCode    *string
	RevocationDate    *string
	ReinstatementDate *string
}

type BMFSource struct {
	Status                    *bool
	OrganizationName          *string
	EIN                       *string
	ChurchMessage             *string
	Subsection                *string
	SubsectionDescription     *string
	FoundationCode            *string
	FoundationCodeDescription *string
	FoundationTypeCode        *string
	FoundationTypeDescription *string
	Foundation509aStatus      *string
	RulingMonth               *string
	RulingYear                *string
	GroupExemption            *string
	ExemptStatusCode          *string
	FilingReqCode             *string
	MostRecent                *string
}

type BulkCheckResult struct {
	Result
	// Organizations are the records the API matched, in the order it returned
	// them — which is not guaranteed to follow the order supplied. Index them
	// by EIN rather than pairing them positionally.
	Organizations []*Nonprofit
	// NotFoundEINs are the EINs the API reported no record for, collected from
	// Errors. A bulk request where some EINs miss is an HTTP 200, not an error.
	NotFoundEINs []string
}

type Client struct {
	// Nonprofits holds the nonprofit lookups.
	Nonprofits *NonprofitsResource
	// contains filtered or unexported fields
}

type ClientOption interface {
	// contains filtered or unexported methods
}

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

type Envelope struct {
	Code    *int    `json:"code"`
	Message *string `json:"message"`
	// Errors are the item-level failures, normalized to a list. They appear on
	// successful responses too: a bulk request where some EINs were not found
	// is an HTTP 200 with entries here.
	Errors []APIErrorDetail `json:"errors"`
	// TimeTaken is the server-side processing time, in milliseconds.
	TimeTaken *float64 `json:"timeTaken"`
	// NonprofitCheckCount is the checks the account has consumed so far in the
	// current billing cycle, including this request. See Result.CheckCount.
	NonprofitCheckCount *int64 `json:"nonprofit_check_count"`

	// Fields is every field of the response body, exactly as sent.
	Fields Object `json:"-"`
}

type Environment string

type Error interface {
	error
	Category() ErrorCategory
	Origin() ErrorOrigin
}

type ErrorCategory string

type ErrorOrigin string

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

type NetworkError struct {
	// Attempts is how many attempts were made; 0 when the context had already
	// ended before the first one.
	Attempts int
	// contains filtered or unexported fields
}

type Nonprofit struct {
	// PactmanOrgURL is the organization's public Pactman profile URL.
	PactmanOrgURL                *string `json:"pactman_org_url"`
	OrganizationInfoLastModified *string `json:"organization_info_last_modified"`

	EIN                 *string `json:"ein"`
	OrganizationName    *string `json:"organization_name"`
	OrganizationNameAKA *string `json:"organization_name_aka"`
	AddressLine1        *string `json:"address_line1"`
	AddressLine2        *string `json:"address_line2"`
	City                *string `json:"city"`
	State               *string `json:"state"`
	StateName           *string `json:"state_name"`
	ZIP                 *string `json:"zip"`
	FilingReqCode       *string `json:"filing_req_code"`

	// IRS Publication 78.
	Pub78ChurchMessage    *string `json:"pub78_church_message"`
	Pub78OrganizationName *string `json:"pub78_organization_name"`
	Pub78EIN              *string `json:"pub78_ein"`
	Pub78Verified         *bool   `json:"pub78_verified"`
	Pub78City             *string `json:"pub78_city"`
	Pub78State            *string `json:"pub78_state"`
	Pub78Indicator        *string `json:"pub78_indicator"`
	// OrganizationTypes are the deductibility entries. An entry can itself be
	// nil, so read through it rather than into it.
	OrganizationTypes []*OrganizationType `json:"organization_types"`
	MostRecentPub78   *string             `json:"most_recent_pub78"`

	// IRS Business Master File.
	BMFChurchMessage          *string `json:"bmf_church_message"`
	BMFOrganizationName       *string `json:"bmf_organization_name"`
	BMFEIN                    *string `json:"bmf_ein"`
	BMFStatus                 *bool   `json:"bmf_status"`
	BMFSubsection             *string `json:"bmf_subsection"`
	MostRecentBMF             *string `json:"most_recent_bmf"`
	SubsectionDescription     *string `json:"subsection_description"`
	FoundationCode            *string `json:"foundation_code"`
	FoundationCodeDescription *string `json:"foundation_code_description"`
	FoundationTypeCode        *string `json:"foundation_type_code"`
	FoundationTypeDescription *string `json:"foundation_type_description"`
	Foundation509aStatus      *string `json:"foundation_509a_status"`
	RulingMonth               *string `json:"ruling_month"`
	RulingYear                *string `json:"ruling_year"`
	GroupExemption            *string `json:"group_exemption"`
	ExemptStatusCode          *string `json:"exempt_status_code"`

	// OFACStatus is the OFAC Specially Designated Nationals finding. The API
	// returns a sentence, not a flag — do not pattern-match it to derive a
	// boolean. Read it, or present it to a reviewer.
	OFACStatus *string `json:"ofac_status"`

	// IRS Automatic Revocation of Exemption.
	RevocationCode    *string `json:"revocation_code"`
	RevocationDate    *string `json:"revocation_date"`
	ReinstatementDate *string `json:"reinstatement_date"`

	// IRSBMFPub78Conflict is true when the IRS BMF and Publication 78 records disagree.
	IRSBMFPub78Conflict *bool   `json:"irs_bmf_pub78_conflict"`
	ReportDate          *string `json:"report_date"`

	// Fields is every field the API returned for this record, exactly as sent,
	// including null ones and ones this SDK does not declare.
	Fields Object `json:"-"`
}

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

type OFACSource struct {
	// Status is the finding as the API phrases it. It is prose, not a flag;
	// the API does not return a boolean match indicator, and this SDK does not
	// invent one by matching on the wording.
	Status *string
}

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

type Option interface {
	ClientOption
	RequestOption
}

type OrganizationType struct {
	OrganizationType               *string `json:"organization_type"`
	DeductibilityLimitation        *string `json:"deductibility_limitation"`
	DeductibilityStatusDescription *string `json:"deductibility_status_description"`

	// Fields is every field the API returned for this entry, exactly as sent.
	Fields Object `json:"-"`
}

type Pub78Source struct {
	Verified          *bool
	OrganizationName  *string
	EIN               *string
	City              *string
	State             *string
	Indicator         *string
	ChurchMessage     *string
	OrganizationTypes []*OrganizationType
	MostRecent        *string
}

type RequestOption interface {
	// contains filtered or unexported methods
}

type Result struct {
	// CheckCount is nonprofit_check_count from the envelope: the checks
	// consumed so far in the current billing cycle, including this request,
	// resetting each cycle. It is not the size of this request; take the
	// difference between two responses for that. Nil when not reported.
	CheckCount *int64
	// TimeTaken is the server-side processing time, when reported.
	TimeTaken *time.Duration
	// Errors are item-level failures reported alongside a successful response.
	// Empty when the API reported none.
	Errors []APIErrorDetail
	// RequestID is the correlation identifier from the response headers, when
	// the server sent one.
	RequestID string
	// Status is the HTTP status of the response.
	Status int
	// Raw is the response body, unmodified, including fields not typed here.
	// json.Marshal(result.Raw) returns the body exactly as received.
	Raw Envelope
}

type RetryPolicy struct {
	// MaxRetries is the retries after the first attempt. 0 disables retrying.
	MaxRetries int
	// InitialDelay is the delay before the first retry. Later delays grow by
	// BackoffFactor and are randomized when Jitter is on.
	InitialDelay time.Duration
	// MaxDelay caps a single backoff delay. A server-supplied Retry-After is
	// honored even when it exceeds this.
	MaxDelay time.Duration
	// BackoffFactor multiplies each successive delay. It must be 1 or more.
	BackoffFactor float64
	// Jitter randomizes each delay across [0, computed] (full jitter), so that
	// clients failing together do not retry in lockstep.
	Jitter bool
	// RetryableStatuses are the HTTP statuses worth retrying. 400, 401, 403 and
	// 404 are never retried, whatever this contains.
	RetryableStatuses []int
	// RespectRetryAfter waits for the server's Retry-After before falling back
	// to backoff.
	RespectRetryAfter bool
}

type SingleCheckResult struct {
	Result
	// Nonprofit is the organization, or nil when the API returned no record.
	Nonprofit *Nonprofit
}

type TimeoutError struct {
	// Timeout is the per-attempt timeout that expired.
	Timeout time.Duration
	// Attempts is how many attempts were made.
	Attempts int
}

type ValidationError struct {

	// Issues lists every rejected item. A bulk call reports all of them at once.
	Issues []ValidationIssue
	// contains filtered or unexported fields
}

type ValidationIssue struct {
	// Message says why the value was rejected.
	Message string `json:"message"`
	// Index is the item's position in the input list, or -1 when the value was
	// not part of a list.
	Index int `json:"index"`
	// Value is the offending value, as supplied.
	Value string `json:"value"`
}