Skip to content

Commit

Permalink
feat: Add client
Browse files Browse the repository at this point in the history
  • Loading branch information
gfyrag committed Nov 13, 2022
1 parent cbb5394 commit 375ceee
Show file tree
Hide file tree
Showing 33 changed files with 5,477 additions and 1 deletion.
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
29 changes: 29 additions & 0 deletions client/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
.gitignore
.travis.yml
README.md
api/openapi.yaml
api_default.go
api_payments.go
client.go
configuration.go
docs/ConnectorConfig.md
docs/ConnectorTask.md
docs/DefaultApi.md
docs/GetPaymentResponse.md
docs/ListPaymentsResponse.md
docs/Payment.md
docs/PaymentsApi.md
docs/StripeConfig.md
docs/StripeTask.md
git_push.sh
go.mod
go.sum
model_connector_config.go
model_connector_task.go
model_get_payment_response.go
model_list_payments_response.go
model_payment.go
model_stripe_config.go
model_stripe_task.go
response.go
utils.go
1 change: 1 addition & 0 deletions client/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
6.1.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 ./

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

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

## 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: 1.0.0
- Package version: latest
- Build package: org.openapitools.codegen.languages.GoClientCodegen

## Installation

Install the following dependencies:

```shell
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```golang
import client "github.com/numary/payments/client"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```golang
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```

## Configuration of Server URL

Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification.

### Select Server Configuration

For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`.

```golang
ctx := context.WithValue(context.Background(), client.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`.

```golang
ctx := context.WithValue(context.Background(), client.ContextServerVariables, map[string]string{
"basePath": "v2",
})
```

Note, enum values are always validated and all unused variables are silently ignored.

### URLs Configuration per Operation

Each operation can use different server URL defined using `OperationServers` map in the `Configuration`.
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps.

```golang
ctx := context.WithValue(context.Background(), client.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), client.ContextOperationServerVariables, map[string]map[string]string{
"{classname}Service.{nickname}": {
"port": "8443",
},
})
```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**GetConnectorTask**](docs/DefaultApi.md#getconnectortask) | **Get** /connectors/{connector}/tasks/{taskId} | Read a specific task of the connector
*DefaultApi* | [**InstallConnector**](docs/DefaultApi.md#installconnector) | **Post** /connectors/{connector} | Install connector
*DefaultApi* | [**ListConnectorTasks**](docs/DefaultApi.md#listconnectortasks) | **Get** /connectors/{connector}/tasks | List connector tasks
*DefaultApi* | [**ReadConnectorConfig**](docs/DefaultApi.md#readconnectorconfig) | **Get** /connectors/{connector}/config | Read connector config
*DefaultApi* | [**ResetConnector**](docs/DefaultApi.md#resetconnector) | **Post** /connectors/{connector}/reset | Reset connector
*DefaultApi* | [**UninstallConnector**](docs/DefaultApi.md#uninstallconnector) | **Delete** /connectors/{connector} | Uninstall connector
*PaymentsApi* | [**GetPayment**](docs/PaymentsApi.md#getpayment) | **Get** /payments/{paymentId} | Returns a payment.
*PaymentsApi* | [**ListPayments**](docs/PaymentsApi.md#listpayments) | **Get** /payments | Returns a list of payments.


## Documentation For Models

- [ConnectorConfig](docs/ConnectorConfig.md)
- [ConnectorTask](docs/ConnectorTask.md)
- [GetPaymentResponse](docs/GetPaymentResponse.md)
- [ListPaymentsResponse](docs/ListPaymentsResponse.md)
- [Payment](docs/Payment.md)
- [StripeConfig](docs/StripeConfig.md)
- [StripeTask](docs/StripeTask.md)


## Documentation For Authorization

Endpoints do not require authorization.


## Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains
a number of utility functions to easily obtain pointers to values of basic types.
Each of these functions takes a value of the given basic type and returns a pointer to it:

* `PtrBool`
* `PtrInt`
* `PtrInt32`
* `PtrInt64`
* `PtrFloat`
* `PtrFloat32`
* `PtrFloat64`
* `PtrString`
* `PtrTime`

## Author



Loading

0 comments on commit 375ceee

Please sign in to comment.