|
1 |
| -# loops-api-go |
2 |
| -API Client for loops.so generated from OpenAPI Spec |
| 1 | +# Go API client for openapi |
| 2 | + |
| 3 | +This is the OpenAPI Spec for the [Loops API](https://loops.so/docs/api). |
| 4 | + |
| 5 | +## Overview |
| 6 | +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. |
| 7 | + |
| 8 | +- API version: 1.0.1 |
| 9 | +- Package version: 1.0.0 |
| 10 | +- Build package: org.openapitools.codegen.languages.GoClientCodegen |
| 11 | + |
| 12 | +## Installation |
| 13 | + |
| 14 | +Install the following dependencies: |
| 15 | + |
| 16 | +```sh |
| 17 | +go get github.com/stretchr/testify/assert |
| 18 | +go get golang.org/x/net/context |
| 19 | +``` |
| 20 | + |
| 21 | +Put the package under your project folder and add the following in import: |
| 22 | + |
| 23 | +```go |
| 24 | +import openapi "github.com/GIT_USER_ID/GIT_REPO_ID" |
| 25 | +``` |
| 26 | + |
| 27 | +To use a proxy, set the environment variable `HTTP_PROXY`: |
| 28 | + |
| 29 | +```go |
| 30 | +os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port") |
| 31 | +``` |
| 32 | + |
| 33 | +## Configuration of Server URL |
| 34 | + |
| 35 | +Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification. |
| 36 | + |
| 37 | +### Select Server Configuration |
| 38 | + |
| 39 | +For using other server than the one defined on index 0 set context value `openapi.ContextServerIndex` of type `int`. |
| 40 | + |
| 41 | +```go |
| 42 | +ctx := context.WithValue(context.Background(), openapi.ContextServerIndex, 1) |
| 43 | +``` |
| 44 | + |
| 45 | +### Templated Server URL |
| 46 | + |
| 47 | +Templated server URL is formatted using default variables from configuration or from context value `openapi.ContextServerVariables` of type `map[string]string`. |
| 48 | + |
| 49 | +```go |
| 50 | +ctx := context.WithValue(context.Background(), openapi.ContextServerVariables, map[string]string{ |
| 51 | + "basePath": "v2", |
| 52 | +}) |
| 53 | +``` |
| 54 | + |
| 55 | +Note, enum values are always validated and all unused variables are silently ignored. |
| 56 | + |
| 57 | +### URLs Configuration per Operation |
| 58 | + |
| 59 | +Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. |
| 60 | +An operation is uniquely identified by `"{classname}Service.{nickname}"` string. |
| 61 | +Similar rules for overriding default operation server index and variables applies by using `openapi.ContextOperationServerIndices` and `openapi.ContextOperationServerVariables` context maps. |
| 62 | + |
| 63 | +```go |
| 64 | +ctx := context.WithValue(context.Background(), openapi.ContextOperationServerIndices, map[string]int{ |
| 65 | + "{classname}Service.{nickname}": 2, |
| 66 | +}) |
| 67 | +ctx = context.WithValue(context.Background(), openapi.ContextOperationServerVariables, map[string]map[string]string{ |
| 68 | + "{classname}Service.{nickname}": { |
| 69 | + "port": "8443", |
| 70 | + }, |
| 71 | +}) |
| 72 | +``` |
| 73 | + |
| 74 | +## Documentation for API Endpoints |
| 75 | + |
| 76 | +All URIs are relative to *https://app.loops.so/api/v1* |
| 77 | + |
| 78 | +Class | Method | HTTP request | Description |
| 79 | +------------ | ------------- | ------------- | ------------- |
| 80 | +*ContactsAPI* | [**ContactsCreatePost**](docs/ContactsAPI.md#contactscreatepost) | **Post** /contacts/create | Create a contact |
| 81 | +*ContactsAPI* | [**ContactsDeletePost**](docs/ContactsAPI.md#contactsdeletepost) | **Post** /contacts/delete | Delete a contact |
| 82 | +*ContactsAPI* | [**ContactsFindGet**](docs/ContactsAPI.md#contactsfindget) | **Get** /contacts/find | Find a contact |
| 83 | +*ContactsAPI* | [**ContactsUpdatePut**](docs/ContactsAPI.md#contactsupdateput) | **Put** /contacts/update | Update a contact |
| 84 | +*CustomFieldsAPI* | [**ContactsCustomFieldsGet**](docs/CustomFieldsAPI.md#contactscustomfieldsget) | **Get** /contacts/customFields | Get a list of custom contact properties |
| 85 | +*EventsAPI* | [**EventsSendPost**](docs/EventsAPI.md#eventssendpost) | **Post** /events/send | Send an event |
| 86 | +*TransactionalEmailsAPI* | [**TransactionalPost**](docs/TransactionalEmailsAPI.md#transactionalpost) | **Post** /transactional | Send a transactional email |
| 87 | + |
| 88 | + |
| 89 | +## Documentation For Models |
| 90 | + |
| 91 | + - [Contact](docs/Contact.md) |
| 92 | + - [ContactDeleteRequest](docs/ContactDeleteRequest.md) |
| 93 | + - [ContactDeleteResponse](docs/ContactDeleteResponse.md) |
| 94 | + - [ContactFailureResponse](docs/ContactFailureResponse.md) |
| 95 | + - [ContactRequest](docs/ContactRequest.md) |
| 96 | + - [ContactSuccessResponse](docs/ContactSuccessResponse.md) |
| 97 | + - [ContactsDeletePost500Response](docs/ContactsDeletePost500Response.md) |
| 98 | + - [CustomField](docs/CustomField.md) |
| 99 | + - [EventFailureResponse](docs/EventFailureResponse.md) |
| 100 | + - [EventRequest](docs/EventRequest.md) |
| 101 | + - [EventSuccessResponse](docs/EventSuccessResponse.md) |
| 102 | + - [TransactionalFailure2Response](docs/TransactionalFailure2Response.md) |
| 103 | + - [TransactionalFailure2ResponseError](docs/TransactionalFailure2ResponseError.md) |
| 104 | + - [TransactionalFailure3Response](docs/TransactionalFailure3Response.md) |
| 105 | + - [TransactionalFailureResponse](docs/TransactionalFailureResponse.md) |
| 106 | + - [TransactionalPost400Response](docs/TransactionalPost400Response.md) |
| 107 | + - [TransactionalRequest](docs/TransactionalRequest.md) |
| 108 | + - [TransactionalSuccessResponse](docs/TransactionalSuccessResponse.md) |
| 109 | + |
| 110 | + |
| 111 | +## Documentation For Authorization |
| 112 | + |
| 113 | + |
| 114 | +Authentication schemes defined for the API: |
| 115 | +### apiKey |
| 116 | + |
| 117 | +- **Type**: HTTP Bearer token authentication |
| 118 | + |
| 119 | +Example |
| 120 | + |
| 121 | +```go |
| 122 | +auth := context.WithValue(context.Background(), openapi.ContextAccessToken, "BEARER_TOKEN_STRING") |
| 123 | +r, err := client.Service.Operation(auth, args) |
| 124 | +``` |
| 125 | + |
| 126 | + |
| 127 | +## Documentation for Utility Methods |
| 128 | + |
| 129 | +Due to the fact that model structure members are all pointers, this package contains |
| 130 | +a number of utility functions to easily obtain pointers to values of basic types. |
| 131 | +Each of these functions takes a value of the given basic type and returns a pointer to it: |
| 132 | + |
| 133 | +* `PtrBool` |
| 134 | +* `PtrInt` |
| 135 | +* `PtrInt32` |
| 136 | +* `PtrInt64` |
| 137 | +* `PtrFloat` |
| 138 | +* `PtrFloat32` |
| 139 | +* `PtrFloat64` |
| 140 | +* `PtrString` |
| 141 | +* `PtrTime` |
| 142 | + |
| 143 | +## Author |
| 144 | + |
| 145 | + |
3 | 146 |
|
4 |
| -[](https://pkg.go.dev/github.com/behnh/loops-api-go) |
|
0 commit comments