# README
Go API client for client
Package github.com/moov-io/irs implements a file reader and writer written in Go along with a HTTP API and CLI for creating, parsing, validating, and transforming IRS electronic Filing Information Returns Electronically (FIRE). FIRE operates on a byte(ASCII) level making it difficult to interface with JSON and CSV/TEXT file formats.
| Input | Output |
|---|---|
| JSON | JSON |
| ASCII FIRE | ASCII FIRE |
| PDF Form | |
| SQL |
Overview
This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.
- API version: 0.0.1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Installation
Install the following dependencies:
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
go get github.com/antihax/optional
Put the package under your project folder and add the following in import:
import "./client"
Documentation for API Endpoints
All URIs are relative to https://local.moov.io:8208
| Class | Method | HTTP request | Description |
|---|---|---|---|
| IrsFilesApi | Convert | Post /convert | Convert irs file |
| IrsFilesApi | Health | Get /health | health irs service |
| IrsFilesApi | Post /print | Print irs file with specific format | |
| IrsFilesApi | Validator | Post /validator | Validate irs file |
Documentation For Models
- ARecord
- BRecordWith1097Btc
- BRecordWith1098
- BRecordWith1098C
- BRecordWith1098E
- BRecordWith1098F
- BRecordWith1098Q
- BRecordWith1098T
- BRecordWith1099A
- BRecordWith1099B
- BRecordWith1099C
- BRecordWith1099Cap
- BRecordWith1099Div
- BRecordWith1099G
- BRecordWith1099H
- BRecordWith1099Int
- BRecordWith1099K
- BRecordWith1099Ls
- BRecordWith1099Ltc
- BRecordWith1099Misc
- BRecordWith1099Nec
- BRecordWith1099Oid
- BRecordWith1099Patr
- BRecordWith1099Q
- BRecordWith1099R
- BRecordWith1099S
- BRecordWith1099Sa
- BRecordWith1099Sb
- BRecordWith3921
- BRecordWith3922
- BRecordWith5498
- BRecordWith5498Esa
- BRecordWith5498Sa
- BRecordWithW2G
- CRecord
- FRecord
- File
- KRecord
- PaymentPerson
- TRecord
Documentation For Authorization
GatewayAuth
- Type: HTTP basic authentication
Example
auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
UserName: "username",
Password: "password",
})
r, err := client.Service.Operation(auth, args)
Author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResonse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKey takes an APIKey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
# Structs
APIClient manages communication with the IRS API API v0.0.1 In most cases there should be only one, shared, APIClient.
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
APIResponse stores the API response returned by the server.
ARecord struct for ARecord.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
BRecordWith1097Btc struct for BRecordWith1097Btc.
BRecordWith1098 struct for BRecordWith1098.
BRecordWith1098C struct for BRecordWith1098C.
BRecordWith1098E struct for BRecordWith1098E.
BRecordWith1098F struct for BRecordWith1098F.
BRecordWith1098Q struct for BRecordWith1098Q.
BRecordWith1098T struct for BRecordWith1098T.
BRecordWith1099A struct for BRecordWith1099A.
BRecordWith1099B struct for BRecordWith1099B.
BRecordWith1099C struct for BRecordWith1099C.
BRecordWith1099Cap struct for BRecordWith1099Cap.
BRecordWith1099Div struct for BRecordWith1099Div.
BRecordWith1099G struct for BRecordWith1099G.
BRecordWith1099H struct for BRecordWith1099H.
BRecordWith1099Int struct for BRecordWith1099Int.
BRecordWith1099K struct for BRecordWith1099K.
BRecordWith1099Ls struct for BRecordWith1099Ls.
BRecordWith1099Ltc struct for BRecordWith1099Ltc.
BRecordWith1099Misc struct for BRecordWith1099Misc.
BRecordWith1099Nec struct for BRecordWith1099Nec.
BRecordWith1099Oid struct for BRecordWith1099Oid.
BRecordWith1099Patr struct for BRecordWith1099Patr.
BRecordWith1099Q struct for BRecordWith1099Q.
BRecordWith1099R struct for BRecordWith1099R.
BRecordWith1099S struct for BRecordWith1099S.
BRecordWith1099Sa struct for BRecordWith1099Sa.
BRecordWith1099Sb struct for BRecordWith1099Sb.
BRecordWith3921 struct for BRecordWith3921.
BRecordWith3922 struct for BRecordWith3922.
BRecordWith5498 struct for BRecordWith5498.
BRecordWith5498Esa struct for BRecordWith5498Esa.
BRecordWith5498Sa struct for BRecordWith5498Sa.
BRecordWithW2G struct for BRecordWithW2G.
Configuration stores the configuration of the API client.
ConvertOpts Optional parameters for the method 'Convert'.
CRecord struct for CRecord.
File struct for File.
FRecord struct for FRecord.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
KRecord struct for KRecord.
PaymentPerson struct for PaymentPerson.
PrintOpts Optional parameters for the method 'Print'.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
TRecord struct for TRecord.
ValidatorOpts Optional parameters for the method 'Validator'.
# Type aliases
IrsFilesApiService IrsFilesApi service.