Skip to content

Commit

Permalink
Merge pull request #2 from moov-io/create-openapi.yaml-and-client
Browse files Browse the repository at this point in the history
Create openapi.yaml and client
  • Loading branch information
bkmoovio authored Mar 18, 2019
2 parents 33acf86 + c4e7cb5 commit a8d1536
Show file tree
Hide file tree
Showing 121 changed files with 9,308 additions and 0 deletions.
24 changes: 24 additions & 0 deletions client/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# Compiled Object files, Static and Dynamic libs (Shared Objects)
*.o
*.a
*.so

# Folders
_obj
_test

# Architecture specific extensions/prefixes
*.[568vq]
[568vq].out

*.cgo1.go
*.cgo2.c
_cgo_defun.c
_cgo_gotypes.go
_cgo_export.*

_testmain.go

*.exe
*.test
*.prof
23 changes: 23 additions & 0 deletions client/.openapi-generator-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# OpenAPI Generator Ignore
# Generated by openapi-generator https://github.com/openapitools/openapi-generator

# Use this file to prevent files from being overwritten by the generator.
# The patterns follow closely to .gitignore or .dockerignore.

# As an example, the C# client generator defines ApiClient.cs.
# You can make changes and tell OpenAPI Generator to ignore just this file by uncommenting the following line:
#ApiClient.cs

# You can match any string of characters against a directory, file or extension with a single asterisk (*):
#foo/*/qux
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux

# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
#foo/**/qux
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux

# You can also negate patterns with an exclamation (!).
# For example, you can ignore all files in a docs folder with the file extension .md:
#docs/*.md
# Then explicitly reverse the ignore rule for a single file:
#!docs/README.md
1 change: 1 addition & 0 deletions client/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
4.0.0-SNAPSHOT
8 changes: 8 additions & 0 deletions client/.travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
language: go

install:
- go get -d -v .

script:
- go build -v ./

106 changes: 106 additions & 0 deletions client/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# Go API client for openapi

Moov WIRE () implements an HTTP API for creating, parsing and validating WIRE files.

## Overview
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: v1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://github.com/moov-io/wire](https://github.com/moov-io/wire)

## 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:
```golang
import "./openapi"
```

## Documentation for API Endpoints

All URIs are relative to *http://localhost:8087*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FilesApi* | [**CreateFile**](docs/FilesApi.md#createfile) | **Post** /files/create | Create a new File object
*FilesApi* | [**DeleteWIREFile**](docs/FilesApi.md#deletewirefile) | **Delete** /files/{file_id} | Permanently deletes a File and associated Batches. It cannot be undone.
*FilesApi* | [**GetFileByID**](docs/FilesApi.md#getfilebyid) | **Get** /files/{file_id} | Retrieves the details of an existing File. You need only supply the unique File identifier that was returned upon creation.
*FilesApi* | [**GetFiles**](docs/FilesApi.md#getfiles) | **Get** /files | Gets a list of Files
*FilesApi* | [**Ping**](docs/FilesApi.md#ping) | **Get** /ping | Ping the Wire service to check if running
*FilesApi* | [**UpdateFile**](docs/FilesApi.md#updatefile) | **Post** /files/{file_id} | Updates the specified FedWire Message by setting the values of the parameters passed. Any parameters not provided will be left unchanged.


## Documentation For Models

- [AccountCreditedDrawdown](docs/AccountCreditedDrawdown.md)
- [AccountDebitedDrawdown](docs/AccountDebitedDrawdown.md)
- [AdditionalFiToFi](docs/AdditionalFiToFi.md)
- [Address](docs/Address.md)
- [AddressTypeEnum](docs/AddressTypeEnum.md)
- [Adjustment](docs/Adjustment.md)
- [Advice](docs/Advice.md)
- [AdviceCodeEnum](docs/AdviceCodeEnum.md)
- [Amount](docs/Amount.md)
- [BusinessFunctionCode](docs/BusinessFunctionCode.md)
- [BusinessFunctionCodeEnum](docs/BusinessFunctionCodeEnum.md)
- [Charges](docs/Charges.md)
- [CoverPayment](docs/CoverPayment.md)
- [CreateFile](docs/CreateFile.md)
- [DateMmdd](docs/DateMmdd.md)
- [DateRemittanceDocument](docs/DateRemittanceDocument.md)
- [Error](docs/Error.md)
- [FedWireError](docs/FedWireError.md)
- [FedWireMessage](docs/FedWireMessage.md)
- [FiToFi](docs/FiToFi.md)
- [File](docs/File.md)
- [FinancialInstitution](docs/FinancialInstitution.md)
- [IdentificationTypeEnum](docs/IdentificationTypeEnum.md)
- [InputMessageAccountabilityData](docs/InputMessageAccountabilityData.md)
- [InstructedAmount](docs/InstructedAmount.md)
- [LocalInstrument](docs/LocalInstrument.md)
- [LocalInstrumentEnum](docs/LocalInstrumentEnum.md)
- [MessageDisposition](docs/MessageDisposition.md)
- [OriginatorToBeneficiary](docs/OriginatorToBeneficiary.md)
- [OutputMessageAccountabilityData](docs/OutputMessageAccountabilityData.md)
- [PaymentMethodToBeneficiary](docs/PaymentMethodToBeneficiary.md)
- [PaymentNotification](docs/PaymentNotification.md)
- [Personal](docs/Personal.md)
- [PrimaryRemittanceDocument](docs/PrimaryRemittanceDocument.md)
- [ReceiptTimeStamp](docs/ReceiptTimeStamp.md)
- [ReceiverDepositoryInstitution](docs/ReceiverDepositoryInstitution.md)
- [RelatedRemittance](docs/RelatedRemittance.md)
- [RemittanceAmount](docs/RemittanceAmount.md)
- [RemittanceBeneficiary](docs/RemittanceBeneficiary.md)
- [RemittanceData](docs/RemittanceData.md)
- [RemittanceFreeText](docs/RemittanceFreeText.md)
- [RemittanceLocationMethodEnum](docs/RemittanceLocationMethodEnum.md)
- [RemittanceOriginator](docs/RemittanceOriginator.md)
- [SecondaryRemittanceDocument](docs/SecondaryRemittanceDocument.md)
- [SenderDepositoryInstitution](docs/SenderDepositoryInstitution.md)
- [SenderSupplied](docs/SenderSupplied.md)
- [ServiceMessage](docs/ServiceMessage.md)
- [SubTypeCodeEnum](docs/SubTypeCodeEnum.md)
- [TestProductionCodeEnum](docs/TestProductionCodeEnum.md)
- [TimeHhmm](docs/TimeHhmm.md)
- [TypeCodeEnum](docs/TypeCodeEnum.md)
- [TypeSubType](docs/TypeSubType.md)
- [UnstructuredAddenda](docs/UnstructuredAddenda.md)


## Documentation For Authorization
Endpoints do not require authorization.


## Author



Loading

0 comments on commit a8d1536

Please sign in to comment.