Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
README.md
api/openapi.yaml
api_api_key.go
api_contact_properties.go
api_contacts.go
api_custom_fields.go
api_events.go
api_mailing_lists.go
api_transactional_emails.go
Expand All @@ -17,17 +17,21 @@ docs/Contact.md
docs/ContactDeleteRequest.md
docs/ContactDeleteResponse.md
docs/ContactFailureResponse.md
docs/ContactPropertiesAPI.md
docs/ContactProperty.md
docs/ContactPropertyCreateRequest.md
docs/ContactPropertyFailureResponse.md
docs/ContactPropertySuccessResponse.md
docs/ContactRequest.md
docs/ContactSuccessResponse.md
docs/ContactsAPI.md
docs/CustomField.md
docs/CustomFieldsAPI.md
docs/EventFailureResponse.md
docs/EventRequest.md
docs/EventSuccessResponse.md
docs/EventsAPI.md
docs/MailingList.md
docs/MailingListsAPI.md
docs/TransactionalEmail.md
docs/TransactionalEmailsAPI.md
docs/TransactionalFailure2Response.md
docs/TransactionalFailure2ResponseError.md
Expand All @@ -47,13 +51,17 @@ model_contact.go
model_contact_delete_request.go
model_contact_delete_response.go
model_contact_failure_response.go
model_contact_property.go
model_contact_property_create_request.go
model_contact_property_failure_response.go
model_contact_property_success_response.go
model_contact_request.go
model_contact_success_response.go
model_custom_field.go
model_event_failure_response.go
model_event_request.go
model_event_success_response.go
model_mailing_list.go
model_transactional_email.go
model_transactional_failure2_response.go
model_transactional_failure2_response_error.go
model_transactional_failure3_response.go
Expand All @@ -62,4 +70,5 @@ model_transactional_request.go
model_transactional_request_attachments_inner.go
model_transactional_success_response.go
response.go
test/api_contact_properties_test.go
utils.go
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ This is the OpenAPI Spec for the [Loops API](https://loops.so/docs/api).
## 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.3.4
- API version: 1.4.1
- Package version: 1.0.2
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
Expand Down Expand Up @@ -79,13 +79,15 @@ All URIs are relative to *https://app.loops.so/api/v1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIKeyAPI* | [**ApiKeyGet**](docs/APIKeyAPI.md#apikeyget) | **Get** /api-key | Test your API key
*ContactPropertiesAPI* | [**ContactsPropertiesGet**](docs/ContactPropertiesAPI.md#contactspropertiesget) | **Get** /contacts/properties | Get a list of contact properties
*ContactPropertiesAPI* | [**ContactsPropertiesPost**](docs/ContactPropertiesAPI.md#contactspropertiespost) | **Post** /contacts/properties | Create a contact property
*ContactsAPI* | [**ContactsCreatePost**](docs/ContactsAPI.md#contactscreatepost) | **Post** /contacts/create | Create a contact
*ContactsAPI* | [**ContactsDeletePost**](docs/ContactsAPI.md#contactsdeletepost) | **Post** /contacts/delete | Delete a contact
*ContactsAPI* | [**ContactsFindGet**](docs/ContactsAPI.md#contactsfindget) | **Get** /contacts/find | Find a contact
*ContactsAPI* | [**ContactsUpdatePut**](docs/ContactsAPI.md#contactsupdateput) | **Put** /contacts/update | Update a contact
*CustomFieldsAPI* | [**ContactsCustomFieldsGet**](docs/CustomFieldsAPI.md#contactscustomfieldsget) | **Get** /contacts/customFields | Get a list of custom contact properties
*EventsAPI* | [**EventsSendPost**](docs/EventsAPI.md#eventssendpost) | **Post** /events/send | Send an event
*MailingListsAPI* | [**ListsGet**](docs/MailingListsAPI.md#listsget) | **Get** /lists | Get a list of mailing lists
*TransactionalEmailsAPI* | [**TransactionalGet**](docs/TransactionalEmailsAPI.md#transactionalget) | **Get** /transactional | List transactional emails
*TransactionalEmailsAPI* | [**TransactionalPost**](docs/TransactionalEmailsAPI.md#transactionalpost) | **Post** /transactional | Send a transactional email


Expand All @@ -97,13 +99,17 @@ Class | Method | HTTP request | Description
- [ContactDeleteRequest](docs/ContactDeleteRequest.md)
- [ContactDeleteResponse](docs/ContactDeleteResponse.md)
- [ContactFailureResponse](docs/ContactFailureResponse.md)
- [ContactProperty](docs/ContactProperty.md)
- [ContactPropertyCreateRequest](docs/ContactPropertyCreateRequest.md)
- [ContactPropertyFailureResponse](docs/ContactPropertyFailureResponse.md)
- [ContactPropertySuccessResponse](docs/ContactPropertySuccessResponse.md)
- [ContactRequest](docs/ContactRequest.md)
- [ContactSuccessResponse](docs/ContactSuccessResponse.md)
- [CustomField](docs/CustomField.md)
- [EventFailureResponse](docs/EventFailureResponse.md)
- [EventRequest](docs/EventRequest.md)
- [EventSuccessResponse](docs/EventSuccessResponse.md)
- [MailingList](docs/MailingList.md)
- [TransactionalEmail](docs/TransactionalEmail.md)
- [TransactionalFailure2Response](docs/TransactionalFailure2Response.md)
- [TransactionalFailure2ResponseError](docs/TransactionalFailure2ResponseError.md)
- [TransactionalFailure3Response](docs/TransactionalFailure3Response.md)
Expand Down
189 changes: 157 additions & 32 deletions api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,21 @@ openapi: 3.1.0
info:
description: "This is the OpenAPI Spec for the [Loops API](https://loops.so/docs/api)."
title: Loops OpenAPI Spec
version: 1.3.4
version: 1.4.1
servers:
- url: https://app.loops.so/api/v1
tags:
- name: API key
- description: Manage contacts in your audience
name: Contacts
- description: Manage contact properties
name: Contact properties
- description: View mailing lists
name: Mailing lists
- description: Trigger email sending with events
name: Events
- description: Send transactional emails
- description: Send and view transactional emails
name: Transactional emails
- description: View custom contact properties
name: Custom fields
paths:
/api-key:
get:
Expand Down Expand Up @@ -65,10 +65,6 @@ paths:
$ref: '#/components/schemas/ContactFailureResponse'
description: Bad request (e.g. invalid email address).
"405":
content:
application/json:
schema:
$ref: '#/components/schemas/ContactFailureResponse'
description: Wrong HTTP request method.
"409":
content:
Expand Down Expand Up @@ -111,10 +107,6 @@ paths:
$ref: '#/components/schemas/ContactFailureResponse'
description: Bad request (e.g. `email` or `userId` are missing).
"405":
content:
application/json:
schema:
$ref: '#/components/schemas/ContactFailureResponse'
description: Wrong HTTP request method.
security:
- apiKey: []
Expand Down Expand Up @@ -200,6 +192,64 @@ paths:
summary: Delete a contact
tags:
- Contacts
/contacts/properties:
get:
description: Retrieve a list of your account's contact properties.<br>Use the
`list` parameter to query "all" or "custom" properties.
parameters:
- description: \"all\" (default) or \"custom\"
explode: true
in: query
name: list
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/ContactProperty'
type: array
description: Successful.
"405":
description: Wrong HTTP request method.
security:
- apiKey: []
summary: Get a list of contact properties
tags:
- Contact properties
post:
description: Add a contact property to your team.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPropertyCreateRequest'
description: "The name value must be in camelCase, like `planName`."
required: true
responses:
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPropertySuccessResponse'
description: Successful create.
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/ContactPropertyFailureResponse'
description: Bad request (e.g. invalid type).
"405":
description: Wrong HTTP request method.
security:
- apiKey: []
summary: Create a contact property
tags:
- Contact properties
/lists:
get:
description: Retrieve a list of your account's mailing lists.
Expand Down Expand Up @@ -257,6 +307,43 @@ paths:
tags:
- Events
/transactional:
get:
description: Get a list of published transactional emails.
parameters:
- description: How many results to return in each request. Must be between 10
and 50. Default is 20.
explode: true
in: query
name: perPage
required: false
schema:
type: string
style: form
- description: "A cursor, to return a specific page of results. Cursors can\
\ be found from the `pagination.nextCursor` value in each response."
explode: true
in: query
name: cursor
required: false
schema:
type: string
style: form
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/TransactionalEmail'
type: array
description: Successful.
"405":
description: Wrong HTTP request method.
security:
- apiKey: []
summary: List transactional emails
tags:
- Transactional emails
post:
description: "Send a transactional email to a contact.<br>Please [email us](mailto:help@loops.so)\
\ to enable attachments on your account before using them with the API."
Expand Down Expand Up @@ -292,25 +379,6 @@ paths:
summary: Send a transactional email
tags:
- Transactional emails
/contacts/customFields:
get:
description: Retrieve a list of your account's custom contact properties.
responses:
"200":
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CustomField'
type: array
description: Successful.
"405":
description: Wrong HTTP request method.
security:
- apiKey: []
summary: Get a list of custom contact properties
tags:
- Custom fields
components:
schemas:
Contact:
Expand Down Expand Up @@ -419,6 +487,38 @@ components:
required:
- message
- success
ContactPropertyCreateRequest:
example:
name: name
type: type
properties:
name:
type: string
type:
type: string
required:
- name
- type
ContactPropertySuccessResponse:
example:
success: true
properties:
success:
type: boolean
required:
- success
ContactPropertyFailureResponse:
example:
success: true
message: message
properties:
success:
type: boolean
message:
type: string
required:
- message
- success
EventRequest:
example:
eventName: eventName
Expand Down Expand Up @@ -548,7 +648,32 @@ components:
required:
- message
- success
CustomField:
TransactionalEmail:
example:
lastUpdated: lastUpdated
dataVariables:
- dataVariables
- dataVariables
name: name
id: id
properties:
id:
type: string
name:
type: string
lastUpdated:
type: string
dataVariables:
items:
description: TODO default missing array inner type to string
type: string
type: array
required:
- dataVariables
- id
- lastUpdated
- name
ContactProperty:
example:
label: label
type: type
Expand Down
2 changes: 1 addition & 1 deletion api_api_key.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading