From 2471c0520fb848f4c5a65bcd5eed5e44db29d243 Mon Sep 17 00:00:00 2001 From: Vernon Keenan Date: Tue, 12 Sep 2023 03:49:57 +0000 Subject: [PATCH] first --- api/auth/auth_client/auth_client.go | 2 +- api/auth/auth_models/user_response.go | 2 +- .../workflow_client/app_log/app_log_client.go | 86 + .../app_log/post_app_logs_parameters.go | 157 + .../app_log/post_app_logs_responses.go | 531 ++ .../cors/app_log_options_parameters.go | 132 + .../cors/app_log_options_responses.go | 148 + .../workflow_client/cors/cors_client.go | 163 + .../cors/email_message_options_parameters.go | 132 + .../cors/email_message_options_responses.go | 148 + ...tgoing_email_message_options_parameters.go | 132 + ...utgoing_email_message_options_responses.go | 148 + .../email_message/email_message_client.go | 86 + .../get_email_messages_parameters.go | 167 + .../get_email_messages_responses.go | 531 ++ .../outgoing_email_message_client.go | 86 + ...post_outgoing_email_messages_parameters.go | 157 + .../post_outgoing_email_messages_responses.go | 531 ++ .../workflow_client/workflow_client.go | 131 + api/workflow/workflow_models/app_log.go | 84 + .../workflow_models/app_log_request.go | 166 + .../workflow_models/app_log_response.go | 166 + api/workflow/workflow_models/document.go | 233 + api/workflow/workflow_models/email_message.go | 203 + .../workflow_models/email_message_request.go | 166 + .../email_messages_response.go | 166 + api/workflow/workflow_models/error.go | 60 + api/workflow/workflow_models/headers.go | 57 + .../workflow_models/outgoing_email_message.go | 153 + .../outgoing_email_message_request.go | 166 + api/workflow/workflow_models/request_meta.go | 75 + api/workflow/workflow_models/response_meta.go | 84 + ...{auth-vernonkeenan.yaml => auth-work.yaml} | 8 +- ...{auth-vernonkeenan.yaml => auth-work.yaml} | 8 +- swagger/external/crm-vernonkeenan.yaml | 822 --- swagger/external/devops-vernonkeenan.yaml | 1820 ------ swagger/external/members-vernonkeenan.yaml | 3826 ------------ swagger/external/plex-vernonkeenan.yaml | 596 -- swagger/external/research-vernonkeenan.yaml | 2019 ------ swagger/external/sf-gate-vernonkeenan.yaml | 5552 ----------------- swagger/external/stash-vernonkeenan.yaml | 215 - swagger/external/workflow-work.yaml | 585 ++ swagger/workflow-work.yaml | 585 ++ 43 files changed, 6425 insertions(+), 14860 deletions(-) create mode 100644 api/workflow/workflow_client/app_log/app_log_client.go create mode 100644 api/workflow/workflow_client/app_log/post_app_logs_parameters.go create mode 100644 api/workflow/workflow_client/app_log/post_app_logs_responses.go create mode 100644 api/workflow/workflow_client/cors/app_log_options_parameters.go create mode 100644 api/workflow/workflow_client/cors/app_log_options_responses.go create mode 100644 api/workflow/workflow_client/cors/cors_client.go create mode 100644 api/workflow/workflow_client/cors/email_message_options_parameters.go create mode 100644 api/workflow/workflow_client/cors/email_message_options_responses.go create mode 100644 api/workflow/workflow_client/cors/outgoing_email_message_options_parameters.go create mode 100644 api/workflow/workflow_client/cors/outgoing_email_message_options_responses.go create mode 100644 api/workflow/workflow_client/email_message/email_message_client.go create mode 100644 api/workflow/workflow_client/email_message/get_email_messages_parameters.go create mode 100644 api/workflow/workflow_client/email_message/get_email_messages_responses.go create mode 100644 api/workflow/workflow_client/outgoing_email_message/outgoing_email_message_client.go create mode 100644 api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_parameters.go create mode 100644 api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_responses.go create mode 100644 api/workflow/workflow_client/workflow_client.go create mode 100644 api/workflow/workflow_models/app_log.go create mode 100644 api/workflow/workflow_models/app_log_request.go create mode 100644 api/workflow/workflow_models/app_log_response.go create mode 100644 api/workflow/workflow_models/document.go create mode 100644 api/workflow/workflow_models/email_message.go create mode 100644 api/workflow/workflow_models/email_message_request.go create mode 100644 api/workflow/workflow_models/email_messages_response.go create mode 100644 api/workflow/workflow_models/error.go create mode 100644 api/workflow/workflow_models/headers.go create mode 100644 api/workflow/workflow_models/outgoing_email_message.go create mode 100644 api/workflow/workflow_models/outgoing_email_message_request.go create mode 100644 api/workflow/workflow_models/request_meta.go create mode 100644 api/workflow/workflow_models/response_meta.go rename swagger/{auth-vernonkeenan.yaml => auth-work.yaml} (98%) rename swagger/external/{auth-vernonkeenan.yaml => auth-work.yaml} (98%) delete mode 100644 swagger/external/crm-vernonkeenan.yaml delete mode 100644 swagger/external/devops-vernonkeenan.yaml delete mode 100644 swagger/external/members-vernonkeenan.yaml delete mode 100644 swagger/external/plex-vernonkeenan.yaml delete mode 100644 swagger/external/research-vernonkeenan.yaml delete mode 100644 swagger/external/sf-gate-vernonkeenan.yaml delete mode 100644 swagger/external/stash-vernonkeenan.yaml create mode 100644 swagger/external/workflow-work.yaml create mode 100644 swagger/workflow-work.yaml diff --git a/api/auth/auth_client/auth_client.go b/api/auth/auth_client/auth_client.go index c0577d1..d56d628 100644 --- a/api/auth/auth_client/auth_client.go +++ b/api/auth/auth_client/auth_client.go @@ -23,7 +23,7 @@ var Default = NewHTTPClient(nil) const ( // DefaultHost is the default Host // found in Meta (info) section of spec file - DefaultHost string = "auth.vernonkeenan.com:8080" + DefaultHost string = "auth.work.tnxs.net:8080" // DefaultBasePath is the default BasePath // found in Meta (info) section of spec file DefaultBasePath string = "/v1" diff --git a/api/auth/auth_models/user_response.go b/api/auth/auth_models/user_response.go index b762478..a3bfa40 100644 --- a/api/auth/auth_models/user_response.go +++ b/api/auth/auth_models/user_response.go @@ -18,7 +18,7 @@ import ( "github.com/go-openapi/swag" ) -// UserResponse An array Taxnexus user objects +// UserResponse An array user objects // // swagger:model UserResponse type UserResponse struct { diff --git a/api/workflow/workflow_client/app_log/app_log_client.go b/api/workflow/workflow_client/app_log/app_log_client.go new file mode 100644 index 0000000..2713999 --- /dev/null +++ b/api/workflow/workflow_client/app_log/app_log_client.go @@ -0,0 +1,86 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package app_log + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" +) + +// New creates a new app log API client. +func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService { + return &Client{transport: transport, formats: formats} +} + +/* +Client for app log API +*/ +type Client struct { + transport runtime.ClientTransport + formats strfmt.Registry +} + +// ClientOption is the option for Client methods +type ClientOption func(*runtime.ClientOperation) + +// ClientService is the interface for Client methods +type ClientService interface { + PostAppLogs(params *PostAppLogsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostAppLogsOK, error) + + SetTransport(transport runtime.ClientTransport) +} + +/* +PostAppLogs posts app log messages + +Insert app log messages into workflow storage +*/ +func (a *Client) PostAppLogs(params *PostAppLogsParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostAppLogsOK, error) { + // TODO: Validate the params before sending + if params == nil { + params = NewPostAppLogsParams() + } + op := &runtime.ClientOperation{ + ID: "postAppLogs", + Method: "POST", + PathPattern: "/applogs", + ProducesMediaTypes: []string{"application/json"}, + ConsumesMediaTypes: []string{"application/json"}, + Schemes: []string{"http"}, + Params: params, + Reader: &PostAppLogsReader{formats: a.formats}, + AuthInfo: authInfo, + Context: params.Context, + Client: params.HTTPClient, + } + for _, opt := range opts { + opt(op) + } + + result, err := a.transport.Submit(op) + if err != nil { + return nil, err + } + success, ok := result.(*PostAppLogsOK) + if ok { + return success, nil + } + // unexpected success response + // safeguard: normally, absent a default response, unknown success responses return an error above: so this is a codegen issue + msg := fmt.Sprintf("unexpected success response for postAppLogs: API contract not enforced by server. Client expected to get an error, but got: %T", result) + panic(msg) +} + +// SetTransport changes the transport on the client +func (a *Client) SetTransport(transport runtime.ClientTransport) { + a.transport = transport +} diff --git a/api/workflow/workflow_client/app_log/post_app_logs_parameters.go b/api/workflow/workflow_client/app_log/post_app_logs_parameters.go new file mode 100644 index 0000000..94d86c9 --- /dev/null +++ b/api/workflow/workflow_client/app_log/post_app_logs_parameters.go @@ -0,0 +1,157 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package app_log + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "net/http" + "time" + + "github.com/go-openapi/errors" + "github.com/go-openapi/runtime" + cr "github.com/go-openapi/runtime/client" + "github.com/go-openapi/strfmt" + + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_models" +) + +// NewPostAppLogsParams creates a new PostAppLogsParams object, +// with the default timeout for this client. +// +// Default values are not hydrated, since defaults are normally applied by the API server side. +// +// To enforce default values in parameter, use SetDefaults or WithDefaults. +func NewPostAppLogsParams() *PostAppLogsParams { + return &PostAppLogsParams{ + timeout: cr.DefaultTimeout, + } +} + +// NewPostAppLogsParamsWithTimeout creates a new PostAppLogsParams object +// with the ability to set a timeout on a request. +func NewPostAppLogsParamsWithTimeout(timeout time.Duration) *PostAppLogsParams { + return &PostAppLogsParams{ + timeout: timeout, + } +} + +// NewPostAppLogsParamsWithContext creates a new PostAppLogsParams object +// with the ability to set a context for a request. +func NewPostAppLogsParamsWithContext(ctx context.Context) *PostAppLogsParams { + return &PostAppLogsParams{ + Context: ctx, + } +} + +// NewPostAppLogsParamsWithHTTPClient creates a new PostAppLogsParams object +// with the ability to set a custom HTTPClient for a request. +func NewPostAppLogsParamsWithHTTPClient(client *http.Client) *PostAppLogsParams { + return &PostAppLogsParams{ + HTTPClient: client, + } +} + +/* +PostAppLogsParams contains all the parameters to send to the API endpoint + + for the post app logs operation. + + Typically these are written to a http.Request. +*/ +type PostAppLogsParams struct { + + /* AppLogRequest. + + An array of new AppLog records + */ + AppLogRequest *workflow_models.AppLogRequest + + timeout time.Duration + Context context.Context + HTTPClient *http.Client +} + +// WithDefaults hydrates default values in the post app logs params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *PostAppLogsParams) WithDefaults() *PostAppLogsParams { + o.SetDefaults() + return o +} + +// SetDefaults hydrates default values in the post app logs params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *PostAppLogsParams) SetDefaults() { + // no default values defined for this parameter +} + +// WithTimeout adds the timeout to the post app logs params +func (o *PostAppLogsParams) WithTimeout(timeout time.Duration) *PostAppLogsParams { + o.SetTimeout(timeout) + return o +} + +// SetTimeout adds the timeout to the post app logs params +func (o *PostAppLogsParams) SetTimeout(timeout time.Duration) { + o.timeout = timeout +} + +// WithContext adds the context to the post app logs params +func (o *PostAppLogsParams) WithContext(ctx context.Context) *PostAppLogsParams { + o.SetContext(ctx) + return o +} + +// SetContext adds the context to the post app logs params +func (o *PostAppLogsParams) SetContext(ctx context.Context) { + o.Context = ctx +} + +// WithHTTPClient adds the HTTPClient to the post app logs params +func (o *PostAppLogsParams) WithHTTPClient(client *http.Client) *PostAppLogsParams { + o.SetHTTPClient(client) + return o +} + +// SetHTTPClient adds the HTTPClient to the post app logs params +func (o *PostAppLogsParams) SetHTTPClient(client *http.Client) { + o.HTTPClient = client +} + +// WithAppLogRequest adds the appLogRequest to the post app logs params +func (o *PostAppLogsParams) WithAppLogRequest(appLogRequest *workflow_models.AppLogRequest) *PostAppLogsParams { + o.SetAppLogRequest(appLogRequest) + return o +} + +// SetAppLogRequest adds the appLogRequest to the post app logs params +func (o *PostAppLogsParams) SetAppLogRequest(appLogRequest *workflow_models.AppLogRequest) { + o.AppLogRequest = appLogRequest +} + +// WriteToRequest writes these params to a swagger request +func (o *PostAppLogsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { + + if err := r.SetTimeout(o.timeout); err != nil { + return err + } + var res []error + if o.AppLogRequest != nil { + if err := r.SetBodyParam(o.AppLogRequest); err != nil { + return err + } + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} diff --git a/api/workflow/workflow_client/app_log/post_app_logs_responses.go b/api/workflow/workflow_client/app_log/post_app_logs_responses.go new file mode 100644 index 0000000..3f91df3 --- /dev/null +++ b/api/workflow/workflow_client/app_log/post_app_logs_responses.go @@ -0,0 +1,531 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package app_log + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + "io" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" + + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_models" +) + +// PostAppLogsReader is a Reader for the PostAppLogs structure. +type PostAppLogsReader struct { + formats strfmt.Registry +} + +// ReadResponse reads a server response into the received o. +func (o *PostAppLogsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error) { + switch response.Code() { + case 200: + result := NewPostAppLogsOK() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return result, nil + case 401: + result := NewPostAppLogsUnauthorized() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 403: + result := NewPostAppLogsForbidden() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 404: + result := NewPostAppLogsNotFound() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 422: + result := NewPostAppLogsUnprocessableEntity() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 500: + result := NewPostAppLogsInternalServerError() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + default: + return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + } +} + +// NewPostAppLogsOK creates a PostAppLogsOK with default headers values +func NewPostAppLogsOK() *PostAppLogsOK { + return &PostAppLogsOK{} +} + +/* +PostAppLogsOK describes a response with status code 200, with default header values. + +Array of AppLogs +*/ +type PostAppLogsOK struct { + AccessControlAllowOrigin string + + Payload *workflow_models.AppLogResponse +} + +// IsSuccess returns true when this post app logs o k response has a 2xx status code +func (o *PostAppLogsOK) IsSuccess() bool { + return true +} + +// IsRedirect returns true when this post app logs o k response has a 3xx status code +func (o *PostAppLogsOK) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post app logs o k response has a 4xx status code +func (o *PostAppLogsOK) IsClientError() bool { + return false +} + +// IsServerError returns true when this post app logs o k response has a 5xx status code +func (o *PostAppLogsOK) IsServerError() bool { + return false +} + +// IsCode returns true when this post app logs o k response a status code equal to that given +func (o *PostAppLogsOK) IsCode(code int) bool { + return code == 200 +} + +// Code gets the status code for the post app logs o k response +func (o *PostAppLogsOK) Code() int { + return 200 +} + +func (o *PostAppLogsOK) Error() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsOK %+v", 200, o.Payload) +} + +func (o *PostAppLogsOK) String() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsOK %+v", 200, o.Payload) +} + +func (o *PostAppLogsOK) GetPayload() *workflow_models.AppLogResponse { + return o.Payload +} + +func (o *PostAppLogsOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.AppLogResponse) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostAppLogsUnauthorized creates a PostAppLogsUnauthorized with default headers values +func NewPostAppLogsUnauthorized() *PostAppLogsUnauthorized { + return &PostAppLogsUnauthorized{} +} + +/* +PostAppLogsUnauthorized describes a response with status code 401, with default header values. + +Access Unauthorized, invalid API-KEY was used +*/ +type PostAppLogsUnauthorized struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post app logs unauthorized response has a 2xx status code +func (o *PostAppLogsUnauthorized) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post app logs unauthorized response has a 3xx status code +func (o *PostAppLogsUnauthorized) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post app logs unauthorized response has a 4xx status code +func (o *PostAppLogsUnauthorized) IsClientError() bool { + return true +} + +// IsServerError returns true when this post app logs unauthorized response has a 5xx status code +func (o *PostAppLogsUnauthorized) IsServerError() bool { + return false +} + +// IsCode returns true when this post app logs unauthorized response a status code equal to that given +func (o *PostAppLogsUnauthorized) IsCode(code int) bool { + return code == 401 +} + +// Code gets the status code for the post app logs unauthorized response +func (o *PostAppLogsUnauthorized) Code() int { + return 401 +} + +func (o *PostAppLogsUnauthorized) Error() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsUnauthorized %+v", 401, o.Payload) +} + +func (o *PostAppLogsUnauthorized) String() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsUnauthorized %+v", 401, o.Payload) +} + +func (o *PostAppLogsUnauthorized) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostAppLogsUnauthorized) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostAppLogsForbidden creates a PostAppLogsForbidden with default headers values +func NewPostAppLogsForbidden() *PostAppLogsForbidden { + return &PostAppLogsForbidden{} +} + +/* +PostAppLogsForbidden describes a response with status code 403, with default header values. + +Access forbidden, account lacks access +*/ +type PostAppLogsForbidden struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post app logs forbidden response has a 2xx status code +func (o *PostAppLogsForbidden) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post app logs forbidden response has a 3xx status code +func (o *PostAppLogsForbidden) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post app logs forbidden response has a 4xx status code +func (o *PostAppLogsForbidden) IsClientError() bool { + return true +} + +// IsServerError returns true when this post app logs forbidden response has a 5xx status code +func (o *PostAppLogsForbidden) IsServerError() bool { + return false +} + +// IsCode returns true when this post app logs forbidden response a status code equal to that given +func (o *PostAppLogsForbidden) IsCode(code int) bool { + return code == 403 +} + +// Code gets the status code for the post app logs forbidden response +func (o *PostAppLogsForbidden) Code() int { + return 403 +} + +func (o *PostAppLogsForbidden) Error() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsForbidden %+v", 403, o.Payload) +} + +func (o *PostAppLogsForbidden) String() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsForbidden %+v", 403, o.Payload) +} + +func (o *PostAppLogsForbidden) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostAppLogsForbidden) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostAppLogsNotFound creates a PostAppLogsNotFound with default headers values +func NewPostAppLogsNotFound() *PostAppLogsNotFound { + return &PostAppLogsNotFound{} +} + +/* +PostAppLogsNotFound describes a response with status code 404, with default header values. + +Resource was not found +*/ +type PostAppLogsNotFound struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post app logs not found response has a 2xx status code +func (o *PostAppLogsNotFound) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post app logs not found response has a 3xx status code +func (o *PostAppLogsNotFound) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post app logs not found response has a 4xx status code +func (o *PostAppLogsNotFound) IsClientError() bool { + return true +} + +// IsServerError returns true when this post app logs not found response has a 5xx status code +func (o *PostAppLogsNotFound) IsServerError() bool { + return false +} + +// IsCode returns true when this post app logs not found response a status code equal to that given +func (o *PostAppLogsNotFound) IsCode(code int) bool { + return code == 404 +} + +// Code gets the status code for the post app logs not found response +func (o *PostAppLogsNotFound) Code() int { + return 404 +} + +func (o *PostAppLogsNotFound) Error() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsNotFound %+v", 404, o.Payload) +} + +func (o *PostAppLogsNotFound) String() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsNotFound %+v", 404, o.Payload) +} + +func (o *PostAppLogsNotFound) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostAppLogsNotFound) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostAppLogsUnprocessableEntity creates a PostAppLogsUnprocessableEntity with default headers values +func NewPostAppLogsUnprocessableEntity() *PostAppLogsUnprocessableEntity { + return &PostAppLogsUnprocessableEntity{} +} + +/* +PostAppLogsUnprocessableEntity describes a response with status code 422, with default header values. + +Unprocessable Entity, likely a bad parameter +*/ +type PostAppLogsUnprocessableEntity struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post app logs unprocessable entity response has a 2xx status code +func (o *PostAppLogsUnprocessableEntity) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post app logs unprocessable entity response has a 3xx status code +func (o *PostAppLogsUnprocessableEntity) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post app logs unprocessable entity response has a 4xx status code +func (o *PostAppLogsUnprocessableEntity) IsClientError() bool { + return true +} + +// IsServerError returns true when this post app logs unprocessable entity response has a 5xx status code +func (o *PostAppLogsUnprocessableEntity) IsServerError() bool { + return false +} + +// IsCode returns true when this post app logs unprocessable entity response a status code equal to that given +func (o *PostAppLogsUnprocessableEntity) IsCode(code int) bool { + return code == 422 +} + +// Code gets the status code for the post app logs unprocessable entity response +func (o *PostAppLogsUnprocessableEntity) Code() int { + return 422 +} + +func (o *PostAppLogsUnprocessableEntity) Error() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsUnprocessableEntity %+v", 422, o.Payload) +} + +func (o *PostAppLogsUnprocessableEntity) String() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsUnprocessableEntity %+v", 422, o.Payload) +} + +func (o *PostAppLogsUnprocessableEntity) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostAppLogsUnprocessableEntity) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostAppLogsInternalServerError creates a PostAppLogsInternalServerError with default headers values +func NewPostAppLogsInternalServerError() *PostAppLogsInternalServerError { + return &PostAppLogsInternalServerError{} +} + +/* +PostAppLogsInternalServerError describes a response with status code 500, with default header values. + +Server Internal Error +*/ +type PostAppLogsInternalServerError struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post app logs internal server error response has a 2xx status code +func (o *PostAppLogsInternalServerError) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post app logs internal server error response has a 3xx status code +func (o *PostAppLogsInternalServerError) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post app logs internal server error response has a 4xx status code +func (o *PostAppLogsInternalServerError) IsClientError() bool { + return false +} + +// IsServerError returns true when this post app logs internal server error response has a 5xx status code +func (o *PostAppLogsInternalServerError) IsServerError() bool { + return true +} + +// IsCode returns true when this post app logs internal server error response a status code equal to that given +func (o *PostAppLogsInternalServerError) IsCode(code int) bool { + return code == 500 +} + +// Code gets the status code for the post app logs internal server error response +func (o *PostAppLogsInternalServerError) Code() int { + return 500 +} + +func (o *PostAppLogsInternalServerError) Error() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsInternalServerError %+v", 500, o.Payload) +} + +func (o *PostAppLogsInternalServerError) String() string { + return fmt.Sprintf("[POST /applogs][%d] postAppLogsInternalServerError %+v", 500, o.Payload) +} + +func (o *PostAppLogsInternalServerError) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostAppLogsInternalServerError) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} diff --git a/api/workflow/workflow_client/cors/app_log_options_parameters.go b/api/workflow/workflow_client/cors/app_log_options_parameters.go new file mode 100644 index 0000000..ea7c46b --- /dev/null +++ b/api/workflow/workflow_client/cors/app_log_options_parameters.go @@ -0,0 +1,132 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package cors + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "net/http" + "time" + + "github.com/go-openapi/errors" + "github.com/go-openapi/runtime" + cr "github.com/go-openapi/runtime/client" + "github.com/go-openapi/strfmt" +) + +// NewAppLogOptionsParams creates a new AppLogOptionsParams object, +// with the default timeout for this client. +// +// Default values are not hydrated, since defaults are normally applied by the API server side. +// +// To enforce default values in parameter, use SetDefaults or WithDefaults. +func NewAppLogOptionsParams() *AppLogOptionsParams { + return &AppLogOptionsParams{ + timeout: cr.DefaultTimeout, + } +} + +// NewAppLogOptionsParamsWithTimeout creates a new AppLogOptionsParams object +// with the ability to set a timeout on a request. +func NewAppLogOptionsParamsWithTimeout(timeout time.Duration) *AppLogOptionsParams { + return &AppLogOptionsParams{ + timeout: timeout, + } +} + +// NewAppLogOptionsParamsWithContext creates a new AppLogOptionsParams object +// with the ability to set a context for a request. +func NewAppLogOptionsParamsWithContext(ctx context.Context) *AppLogOptionsParams { + return &AppLogOptionsParams{ + Context: ctx, + } +} + +// NewAppLogOptionsParamsWithHTTPClient creates a new AppLogOptionsParams object +// with the ability to set a custom HTTPClient for a request. +func NewAppLogOptionsParamsWithHTTPClient(client *http.Client) *AppLogOptionsParams { + return &AppLogOptionsParams{ + HTTPClient: client, + } +} + +/* +AppLogOptionsParams contains all the parameters to send to the API endpoint + + for the app log options operation. + + Typically these are written to a http.Request. +*/ +type AppLogOptionsParams struct { + timeout time.Duration + Context context.Context + HTTPClient *http.Client +} + +// WithDefaults hydrates default values in the app log options params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *AppLogOptionsParams) WithDefaults() *AppLogOptionsParams { + o.SetDefaults() + return o +} + +// SetDefaults hydrates default values in the app log options params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *AppLogOptionsParams) SetDefaults() { + // no default values defined for this parameter +} + +// WithTimeout adds the timeout to the app log options params +func (o *AppLogOptionsParams) WithTimeout(timeout time.Duration) *AppLogOptionsParams { + o.SetTimeout(timeout) + return o +} + +// SetTimeout adds the timeout to the app log options params +func (o *AppLogOptionsParams) SetTimeout(timeout time.Duration) { + o.timeout = timeout +} + +// WithContext adds the context to the app log options params +func (o *AppLogOptionsParams) WithContext(ctx context.Context) *AppLogOptionsParams { + o.SetContext(ctx) + return o +} + +// SetContext adds the context to the app log options params +func (o *AppLogOptionsParams) SetContext(ctx context.Context) { + o.Context = ctx +} + +// WithHTTPClient adds the HTTPClient to the app log options params +func (o *AppLogOptionsParams) WithHTTPClient(client *http.Client) *AppLogOptionsParams { + o.SetHTTPClient(client) + return o +} + +// SetHTTPClient adds the HTTPClient to the app log options params +func (o *AppLogOptionsParams) SetHTTPClient(client *http.Client) { + o.HTTPClient = client +} + +// WriteToRequest writes these params to a swagger request +func (o *AppLogOptionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { + + if err := r.SetTimeout(o.timeout); err != nil { + return err + } + var res []error + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} diff --git a/api/workflow/workflow_client/cors/app_log_options_responses.go b/api/workflow/workflow_client/cors/app_log_options_responses.go new file mode 100644 index 0000000..192e5e7 --- /dev/null +++ b/api/workflow/workflow_client/cors/app_log_options_responses.go @@ -0,0 +1,148 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package cors + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" +) + +// AppLogOptionsReader is a Reader for the AppLogOptions structure. +type AppLogOptionsReader struct { + formats strfmt.Registry +} + +// ReadResponse reads a server response into the received o. +func (o *AppLogOptionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error) { + switch response.Code() { + case 200: + result := NewAppLogOptionsOK() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return result, nil + default: + return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + } +} + +// NewAppLogOptionsOK creates a AppLogOptionsOK with default headers values +func NewAppLogOptionsOK() *AppLogOptionsOK { + return &AppLogOptionsOK{} +} + +/* +AppLogOptionsOK describes a response with status code 200, with default header values. + +CORS OPTIONS response +*/ +type AppLogOptionsOK struct { + AccessControlAllowCredentials string + AccessControlAllowHeaders string + AccessControlAllowMethods string + AccessControlAllowOrigin string + AccessControlExposeHeaders string + AccessControlMaxAge string + CacheControl string +} + +// IsSuccess returns true when this app log options o k response has a 2xx status code +func (o *AppLogOptionsOK) IsSuccess() bool { + return true +} + +// IsRedirect returns true when this app log options o k response has a 3xx status code +func (o *AppLogOptionsOK) IsRedirect() bool { + return false +} + +// IsClientError returns true when this app log options o k response has a 4xx status code +func (o *AppLogOptionsOK) IsClientError() bool { + return false +} + +// IsServerError returns true when this app log options o k response has a 5xx status code +func (o *AppLogOptionsOK) IsServerError() bool { + return false +} + +// IsCode returns true when this app log options o k response a status code equal to that given +func (o *AppLogOptionsOK) IsCode(code int) bool { + return code == 200 +} + +// Code gets the status code for the app log options o k response +func (o *AppLogOptionsOK) Code() int { + return 200 +} + +func (o *AppLogOptionsOK) Error() string { + return fmt.Sprintf("[OPTIONS /applogs][%d] appLogOptionsOK ", 200) +} + +func (o *AppLogOptionsOK) String() string { + return fmt.Sprintf("[OPTIONS /applogs][%d] appLogOptionsOK ", 200) +} + +func (o *AppLogOptionsOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Credentials + hdrAccessControlAllowCredentials := response.GetHeader("Access-Control-Allow-Credentials") + + if hdrAccessControlAllowCredentials != "" { + o.AccessControlAllowCredentials = hdrAccessControlAllowCredentials + } + + // hydrates response header Access-Control-Allow-Headers + hdrAccessControlAllowHeaders := response.GetHeader("Access-Control-Allow-Headers") + + if hdrAccessControlAllowHeaders != "" { + o.AccessControlAllowHeaders = hdrAccessControlAllowHeaders + } + + // hydrates response header Access-Control-Allow-Methods + hdrAccessControlAllowMethods := response.GetHeader("Access-Control-Allow-Methods") + + if hdrAccessControlAllowMethods != "" { + o.AccessControlAllowMethods = hdrAccessControlAllowMethods + } + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + // hydrates response header Access-Control-Expose-Headers + hdrAccessControlExposeHeaders := response.GetHeader("Access-Control-Expose-Headers") + + if hdrAccessControlExposeHeaders != "" { + o.AccessControlExposeHeaders = hdrAccessControlExposeHeaders + } + + // hydrates response header Access-Control-Max-Age + hdrAccessControlMaxAge := response.GetHeader("Access-Control-Max-Age") + + if hdrAccessControlMaxAge != "" { + o.AccessControlMaxAge = hdrAccessControlMaxAge + } + + // hydrates response header Cache-Control + hdrCacheControl := response.GetHeader("Cache-Control") + + if hdrCacheControl != "" { + o.CacheControl = hdrCacheControl + } + + return nil +} diff --git a/api/workflow/workflow_client/cors/cors_client.go b/api/workflow/workflow_client/cors/cors_client.go new file mode 100644 index 0000000..b5f554d --- /dev/null +++ b/api/workflow/workflow_client/cors/cors_client.go @@ -0,0 +1,163 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package cors + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" +) + +// New creates a new cors API client. +func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService { + return &Client{transport: transport, formats: formats} +} + +/* +Client for cors API +*/ +type Client struct { + transport runtime.ClientTransport + formats strfmt.Registry +} + +// ClientOption is the option for Client methods +type ClientOption func(*runtime.ClientOperation) + +// ClientService is the interface for Client methods +type ClientService interface { + AppLogOptions(params *AppLogOptionsParams, opts ...ClientOption) (*AppLogOptionsOK, error) + + EmailMessageOptions(params *EmailMessageOptionsParams, opts ...ClientOption) (*EmailMessageOptionsOK, error) + + OutgoingEmailMessageOptions(params *OutgoingEmailMessageOptionsParams, opts ...ClientOption) (*OutgoingEmailMessageOptionsOK, error) + + SetTransport(transport runtime.ClientTransport) +} + +/* +AppLogOptions CORS support +*/ +func (a *Client) AppLogOptions(params *AppLogOptionsParams, opts ...ClientOption) (*AppLogOptionsOK, error) { + // TODO: Validate the params before sending + if params == nil { + params = NewAppLogOptionsParams() + } + op := &runtime.ClientOperation{ + ID: "appLogOptions", + Method: "OPTIONS", + PathPattern: "/applogs", + ProducesMediaTypes: []string{"application/json"}, + ConsumesMediaTypes: []string{"application/json"}, + Schemes: []string{"http"}, + Params: params, + Reader: &AppLogOptionsReader{formats: a.formats}, + Context: params.Context, + Client: params.HTTPClient, + } + for _, opt := range opts { + opt(op) + } + + result, err := a.transport.Submit(op) + if err != nil { + return nil, err + } + success, ok := result.(*AppLogOptionsOK) + if ok { + return success, nil + } + // unexpected success response + // safeguard: normally, absent a default response, unknown success responses return an error above: so this is a codegen issue + msg := fmt.Sprintf("unexpected success response for appLogOptions: API contract not enforced by server. Client expected to get an error, but got: %T", result) + panic(msg) +} + +/* +EmailMessageOptions CORS support +*/ +func (a *Client) EmailMessageOptions(params *EmailMessageOptionsParams, opts ...ClientOption) (*EmailMessageOptionsOK, error) { + // TODO: Validate the params before sending + if params == nil { + params = NewEmailMessageOptionsParams() + } + op := &runtime.ClientOperation{ + ID: "emailMessageOptions", + Method: "OPTIONS", + PathPattern: "/emailmessages", + ProducesMediaTypes: []string{"application/json"}, + ConsumesMediaTypes: []string{"application/json"}, + Schemes: []string{"http"}, + Params: params, + Reader: &EmailMessageOptionsReader{formats: a.formats}, + Context: params.Context, + Client: params.HTTPClient, + } + for _, opt := range opts { + opt(op) + } + + result, err := a.transport.Submit(op) + if err != nil { + return nil, err + } + success, ok := result.(*EmailMessageOptionsOK) + if ok { + return success, nil + } + // unexpected success response + // safeguard: normally, absent a default response, unknown success responses return an error above: so this is a codegen issue + msg := fmt.Sprintf("unexpected success response for emailMessageOptions: API contract not enforced by server. Client expected to get an error, but got: %T", result) + panic(msg) +} + +/* +OutgoingEmailMessageOptions CORS support +*/ +func (a *Client) OutgoingEmailMessageOptions(params *OutgoingEmailMessageOptionsParams, opts ...ClientOption) (*OutgoingEmailMessageOptionsOK, error) { + // TODO: Validate the params before sending + if params == nil { + params = NewOutgoingEmailMessageOptionsParams() + } + op := &runtime.ClientOperation{ + ID: "outgoingEmailMessageOptions", + Method: "OPTIONS", + PathPattern: "/outgoingemailmessages", + ProducesMediaTypes: []string{"application/json"}, + ConsumesMediaTypes: []string{"application/json"}, + Schemes: []string{"http"}, + Params: params, + Reader: &OutgoingEmailMessageOptionsReader{formats: a.formats}, + Context: params.Context, + Client: params.HTTPClient, + } + for _, opt := range opts { + opt(op) + } + + result, err := a.transport.Submit(op) + if err != nil { + return nil, err + } + success, ok := result.(*OutgoingEmailMessageOptionsOK) + if ok { + return success, nil + } + // unexpected success response + // safeguard: normally, absent a default response, unknown success responses return an error above: so this is a codegen issue + msg := fmt.Sprintf("unexpected success response for outgoingEmailMessageOptions: API contract not enforced by server. Client expected to get an error, but got: %T", result) + panic(msg) +} + +// SetTransport changes the transport on the client +func (a *Client) SetTransport(transport runtime.ClientTransport) { + a.transport = transport +} diff --git a/api/workflow/workflow_client/cors/email_message_options_parameters.go b/api/workflow/workflow_client/cors/email_message_options_parameters.go new file mode 100644 index 0000000..e503613 --- /dev/null +++ b/api/workflow/workflow_client/cors/email_message_options_parameters.go @@ -0,0 +1,132 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package cors + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "net/http" + "time" + + "github.com/go-openapi/errors" + "github.com/go-openapi/runtime" + cr "github.com/go-openapi/runtime/client" + "github.com/go-openapi/strfmt" +) + +// NewEmailMessageOptionsParams creates a new EmailMessageOptionsParams object, +// with the default timeout for this client. +// +// Default values are not hydrated, since defaults are normally applied by the API server side. +// +// To enforce default values in parameter, use SetDefaults or WithDefaults. +func NewEmailMessageOptionsParams() *EmailMessageOptionsParams { + return &EmailMessageOptionsParams{ + timeout: cr.DefaultTimeout, + } +} + +// NewEmailMessageOptionsParamsWithTimeout creates a new EmailMessageOptionsParams object +// with the ability to set a timeout on a request. +func NewEmailMessageOptionsParamsWithTimeout(timeout time.Duration) *EmailMessageOptionsParams { + return &EmailMessageOptionsParams{ + timeout: timeout, + } +} + +// NewEmailMessageOptionsParamsWithContext creates a new EmailMessageOptionsParams object +// with the ability to set a context for a request. +func NewEmailMessageOptionsParamsWithContext(ctx context.Context) *EmailMessageOptionsParams { + return &EmailMessageOptionsParams{ + Context: ctx, + } +} + +// NewEmailMessageOptionsParamsWithHTTPClient creates a new EmailMessageOptionsParams object +// with the ability to set a custom HTTPClient for a request. +func NewEmailMessageOptionsParamsWithHTTPClient(client *http.Client) *EmailMessageOptionsParams { + return &EmailMessageOptionsParams{ + HTTPClient: client, + } +} + +/* +EmailMessageOptionsParams contains all the parameters to send to the API endpoint + + for the email message options operation. + + Typically these are written to a http.Request. +*/ +type EmailMessageOptionsParams struct { + timeout time.Duration + Context context.Context + HTTPClient *http.Client +} + +// WithDefaults hydrates default values in the email message options params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *EmailMessageOptionsParams) WithDefaults() *EmailMessageOptionsParams { + o.SetDefaults() + return o +} + +// SetDefaults hydrates default values in the email message options params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *EmailMessageOptionsParams) SetDefaults() { + // no default values defined for this parameter +} + +// WithTimeout adds the timeout to the email message options params +func (o *EmailMessageOptionsParams) WithTimeout(timeout time.Duration) *EmailMessageOptionsParams { + o.SetTimeout(timeout) + return o +} + +// SetTimeout adds the timeout to the email message options params +func (o *EmailMessageOptionsParams) SetTimeout(timeout time.Duration) { + o.timeout = timeout +} + +// WithContext adds the context to the email message options params +func (o *EmailMessageOptionsParams) WithContext(ctx context.Context) *EmailMessageOptionsParams { + o.SetContext(ctx) + return o +} + +// SetContext adds the context to the email message options params +func (o *EmailMessageOptionsParams) SetContext(ctx context.Context) { + o.Context = ctx +} + +// WithHTTPClient adds the HTTPClient to the email message options params +func (o *EmailMessageOptionsParams) WithHTTPClient(client *http.Client) *EmailMessageOptionsParams { + o.SetHTTPClient(client) + return o +} + +// SetHTTPClient adds the HTTPClient to the email message options params +func (o *EmailMessageOptionsParams) SetHTTPClient(client *http.Client) { + o.HTTPClient = client +} + +// WriteToRequest writes these params to a swagger request +func (o *EmailMessageOptionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { + + if err := r.SetTimeout(o.timeout); err != nil { + return err + } + var res []error + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} diff --git a/api/workflow/workflow_client/cors/email_message_options_responses.go b/api/workflow/workflow_client/cors/email_message_options_responses.go new file mode 100644 index 0000000..ac2fa52 --- /dev/null +++ b/api/workflow/workflow_client/cors/email_message_options_responses.go @@ -0,0 +1,148 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package cors + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" +) + +// EmailMessageOptionsReader is a Reader for the EmailMessageOptions structure. +type EmailMessageOptionsReader struct { + formats strfmt.Registry +} + +// ReadResponse reads a server response into the received o. +func (o *EmailMessageOptionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error) { + switch response.Code() { + case 200: + result := NewEmailMessageOptionsOK() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return result, nil + default: + return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + } +} + +// NewEmailMessageOptionsOK creates a EmailMessageOptionsOK with default headers values +func NewEmailMessageOptionsOK() *EmailMessageOptionsOK { + return &EmailMessageOptionsOK{} +} + +/* +EmailMessageOptionsOK describes a response with status code 200, with default header values. + +CORS OPTIONS response +*/ +type EmailMessageOptionsOK struct { + AccessControlAllowCredentials string + AccessControlAllowHeaders string + AccessControlAllowMethods string + AccessControlAllowOrigin string + AccessControlExposeHeaders string + AccessControlMaxAge string + CacheControl string +} + +// IsSuccess returns true when this email message options o k response has a 2xx status code +func (o *EmailMessageOptionsOK) IsSuccess() bool { + return true +} + +// IsRedirect returns true when this email message options o k response has a 3xx status code +func (o *EmailMessageOptionsOK) IsRedirect() bool { + return false +} + +// IsClientError returns true when this email message options o k response has a 4xx status code +func (o *EmailMessageOptionsOK) IsClientError() bool { + return false +} + +// IsServerError returns true when this email message options o k response has a 5xx status code +func (o *EmailMessageOptionsOK) IsServerError() bool { + return false +} + +// IsCode returns true when this email message options o k response a status code equal to that given +func (o *EmailMessageOptionsOK) IsCode(code int) bool { + return code == 200 +} + +// Code gets the status code for the email message options o k response +func (o *EmailMessageOptionsOK) Code() int { + return 200 +} + +func (o *EmailMessageOptionsOK) Error() string { + return fmt.Sprintf("[OPTIONS /emailmessages][%d] emailMessageOptionsOK ", 200) +} + +func (o *EmailMessageOptionsOK) String() string { + return fmt.Sprintf("[OPTIONS /emailmessages][%d] emailMessageOptionsOK ", 200) +} + +func (o *EmailMessageOptionsOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Credentials + hdrAccessControlAllowCredentials := response.GetHeader("Access-Control-Allow-Credentials") + + if hdrAccessControlAllowCredentials != "" { + o.AccessControlAllowCredentials = hdrAccessControlAllowCredentials + } + + // hydrates response header Access-Control-Allow-Headers + hdrAccessControlAllowHeaders := response.GetHeader("Access-Control-Allow-Headers") + + if hdrAccessControlAllowHeaders != "" { + o.AccessControlAllowHeaders = hdrAccessControlAllowHeaders + } + + // hydrates response header Access-Control-Allow-Methods + hdrAccessControlAllowMethods := response.GetHeader("Access-Control-Allow-Methods") + + if hdrAccessControlAllowMethods != "" { + o.AccessControlAllowMethods = hdrAccessControlAllowMethods + } + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + // hydrates response header Access-Control-Expose-Headers + hdrAccessControlExposeHeaders := response.GetHeader("Access-Control-Expose-Headers") + + if hdrAccessControlExposeHeaders != "" { + o.AccessControlExposeHeaders = hdrAccessControlExposeHeaders + } + + // hydrates response header Access-Control-Max-Age + hdrAccessControlMaxAge := response.GetHeader("Access-Control-Max-Age") + + if hdrAccessControlMaxAge != "" { + o.AccessControlMaxAge = hdrAccessControlMaxAge + } + + // hydrates response header Cache-Control + hdrCacheControl := response.GetHeader("Cache-Control") + + if hdrCacheControl != "" { + o.CacheControl = hdrCacheControl + } + + return nil +} diff --git a/api/workflow/workflow_client/cors/outgoing_email_message_options_parameters.go b/api/workflow/workflow_client/cors/outgoing_email_message_options_parameters.go new file mode 100644 index 0000000..7ae9470 --- /dev/null +++ b/api/workflow/workflow_client/cors/outgoing_email_message_options_parameters.go @@ -0,0 +1,132 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package cors + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "net/http" + "time" + + "github.com/go-openapi/errors" + "github.com/go-openapi/runtime" + cr "github.com/go-openapi/runtime/client" + "github.com/go-openapi/strfmt" +) + +// NewOutgoingEmailMessageOptionsParams creates a new OutgoingEmailMessageOptionsParams object, +// with the default timeout for this client. +// +// Default values are not hydrated, since defaults are normally applied by the API server side. +// +// To enforce default values in parameter, use SetDefaults or WithDefaults. +func NewOutgoingEmailMessageOptionsParams() *OutgoingEmailMessageOptionsParams { + return &OutgoingEmailMessageOptionsParams{ + timeout: cr.DefaultTimeout, + } +} + +// NewOutgoingEmailMessageOptionsParamsWithTimeout creates a new OutgoingEmailMessageOptionsParams object +// with the ability to set a timeout on a request. +func NewOutgoingEmailMessageOptionsParamsWithTimeout(timeout time.Duration) *OutgoingEmailMessageOptionsParams { + return &OutgoingEmailMessageOptionsParams{ + timeout: timeout, + } +} + +// NewOutgoingEmailMessageOptionsParamsWithContext creates a new OutgoingEmailMessageOptionsParams object +// with the ability to set a context for a request. +func NewOutgoingEmailMessageOptionsParamsWithContext(ctx context.Context) *OutgoingEmailMessageOptionsParams { + return &OutgoingEmailMessageOptionsParams{ + Context: ctx, + } +} + +// NewOutgoingEmailMessageOptionsParamsWithHTTPClient creates a new OutgoingEmailMessageOptionsParams object +// with the ability to set a custom HTTPClient for a request. +func NewOutgoingEmailMessageOptionsParamsWithHTTPClient(client *http.Client) *OutgoingEmailMessageOptionsParams { + return &OutgoingEmailMessageOptionsParams{ + HTTPClient: client, + } +} + +/* +OutgoingEmailMessageOptionsParams contains all the parameters to send to the API endpoint + + for the outgoing email message options operation. + + Typically these are written to a http.Request. +*/ +type OutgoingEmailMessageOptionsParams struct { + timeout time.Duration + Context context.Context + HTTPClient *http.Client +} + +// WithDefaults hydrates default values in the outgoing email message options params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *OutgoingEmailMessageOptionsParams) WithDefaults() *OutgoingEmailMessageOptionsParams { + o.SetDefaults() + return o +} + +// SetDefaults hydrates default values in the outgoing email message options params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *OutgoingEmailMessageOptionsParams) SetDefaults() { + // no default values defined for this parameter +} + +// WithTimeout adds the timeout to the outgoing email message options params +func (o *OutgoingEmailMessageOptionsParams) WithTimeout(timeout time.Duration) *OutgoingEmailMessageOptionsParams { + o.SetTimeout(timeout) + return o +} + +// SetTimeout adds the timeout to the outgoing email message options params +func (o *OutgoingEmailMessageOptionsParams) SetTimeout(timeout time.Duration) { + o.timeout = timeout +} + +// WithContext adds the context to the outgoing email message options params +func (o *OutgoingEmailMessageOptionsParams) WithContext(ctx context.Context) *OutgoingEmailMessageOptionsParams { + o.SetContext(ctx) + return o +} + +// SetContext adds the context to the outgoing email message options params +func (o *OutgoingEmailMessageOptionsParams) SetContext(ctx context.Context) { + o.Context = ctx +} + +// WithHTTPClient adds the HTTPClient to the outgoing email message options params +func (o *OutgoingEmailMessageOptionsParams) WithHTTPClient(client *http.Client) *OutgoingEmailMessageOptionsParams { + o.SetHTTPClient(client) + return o +} + +// SetHTTPClient adds the HTTPClient to the outgoing email message options params +func (o *OutgoingEmailMessageOptionsParams) SetHTTPClient(client *http.Client) { + o.HTTPClient = client +} + +// WriteToRequest writes these params to a swagger request +func (o *OutgoingEmailMessageOptionsParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { + + if err := r.SetTimeout(o.timeout); err != nil { + return err + } + var res []error + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} diff --git a/api/workflow/workflow_client/cors/outgoing_email_message_options_responses.go b/api/workflow/workflow_client/cors/outgoing_email_message_options_responses.go new file mode 100644 index 0000000..f9459d8 --- /dev/null +++ b/api/workflow/workflow_client/cors/outgoing_email_message_options_responses.go @@ -0,0 +1,148 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package cors + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" +) + +// OutgoingEmailMessageOptionsReader is a Reader for the OutgoingEmailMessageOptions structure. +type OutgoingEmailMessageOptionsReader struct { + formats strfmt.Registry +} + +// ReadResponse reads a server response into the received o. +func (o *OutgoingEmailMessageOptionsReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error) { + switch response.Code() { + case 200: + result := NewOutgoingEmailMessageOptionsOK() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return result, nil + default: + return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + } +} + +// NewOutgoingEmailMessageOptionsOK creates a OutgoingEmailMessageOptionsOK with default headers values +func NewOutgoingEmailMessageOptionsOK() *OutgoingEmailMessageOptionsOK { + return &OutgoingEmailMessageOptionsOK{} +} + +/* +OutgoingEmailMessageOptionsOK describes a response with status code 200, with default header values. + +CORS OPTIONS response +*/ +type OutgoingEmailMessageOptionsOK struct { + AccessControlAllowCredentials string + AccessControlAllowHeaders string + AccessControlAllowMethods string + AccessControlAllowOrigin string + AccessControlExposeHeaders string + AccessControlMaxAge string + CacheControl string +} + +// IsSuccess returns true when this outgoing email message options o k response has a 2xx status code +func (o *OutgoingEmailMessageOptionsOK) IsSuccess() bool { + return true +} + +// IsRedirect returns true when this outgoing email message options o k response has a 3xx status code +func (o *OutgoingEmailMessageOptionsOK) IsRedirect() bool { + return false +} + +// IsClientError returns true when this outgoing email message options o k response has a 4xx status code +func (o *OutgoingEmailMessageOptionsOK) IsClientError() bool { + return false +} + +// IsServerError returns true when this outgoing email message options o k response has a 5xx status code +func (o *OutgoingEmailMessageOptionsOK) IsServerError() bool { + return false +} + +// IsCode returns true when this outgoing email message options o k response a status code equal to that given +func (o *OutgoingEmailMessageOptionsOK) IsCode(code int) bool { + return code == 200 +} + +// Code gets the status code for the outgoing email message options o k response +func (o *OutgoingEmailMessageOptionsOK) Code() int { + return 200 +} + +func (o *OutgoingEmailMessageOptionsOK) Error() string { + return fmt.Sprintf("[OPTIONS /outgoingemailmessages][%d] outgoingEmailMessageOptionsOK ", 200) +} + +func (o *OutgoingEmailMessageOptionsOK) String() string { + return fmt.Sprintf("[OPTIONS /outgoingemailmessages][%d] outgoingEmailMessageOptionsOK ", 200) +} + +func (o *OutgoingEmailMessageOptionsOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Credentials + hdrAccessControlAllowCredentials := response.GetHeader("Access-Control-Allow-Credentials") + + if hdrAccessControlAllowCredentials != "" { + o.AccessControlAllowCredentials = hdrAccessControlAllowCredentials + } + + // hydrates response header Access-Control-Allow-Headers + hdrAccessControlAllowHeaders := response.GetHeader("Access-Control-Allow-Headers") + + if hdrAccessControlAllowHeaders != "" { + o.AccessControlAllowHeaders = hdrAccessControlAllowHeaders + } + + // hydrates response header Access-Control-Allow-Methods + hdrAccessControlAllowMethods := response.GetHeader("Access-Control-Allow-Methods") + + if hdrAccessControlAllowMethods != "" { + o.AccessControlAllowMethods = hdrAccessControlAllowMethods + } + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + // hydrates response header Access-Control-Expose-Headers + hdrAccessControlExposeHeaders := response.GetHeader("Access-Control-Expose-Headers") + + if hdrAccessControlExposeHeaders != "" { + o.AccessControlExposeHeaders = hdrAccessControlExposeHeaders + } + + // hydrates response header Access-Control-Max-Age + hdrAccessControlMaxAge := response.GetHeader("Access-Control-Max-Age") + + if hdrAccessControlMaxAge != "" { + o.AccessControlMaxAge = hdrAccessControlMaxAge + } + + // hydrates response header Cache-Control + hdrCacheControl := response.GetHeader("Cache-Control") + + if hdrCacheControl != "" { + o.CacheControl = hdrCacheControl + } + + return nil +} diff --git a/api/workflow/workflow_client/email_message/email_message_client.go b/api/workflow/workflow_client/email_message/email_message_client.go new file mode 100644 index 0000000..45cca6f --- /dev/null +++ b/api/workflow/workflow_client/email_message/email_message_client.go @@ -0,0 +1,86 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package email_message + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" +) + +// New creates a new email message API client. +func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService { + return &Client{transport: transport, formats: formats} +} + +/* +Client for email message API +*/ +type Client struct { + transport runtime.ClientTransport + formats strfmt.Registry +} + +// ClientOption is the option for Client methods +type ClientOption func(*runtime.ClientOperation) + +// ClientService is the interface for Client methods +type ClientService interface { + GetEmailMessages(params *GetEmailMessagesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEmailMessagesOK, error) + + SetTransport(transport runtime.ClientTransport) +} + +/* +GetEmailMessages gets email messages from data store + +Retrieves email messages from workflow storage +*/ +func (a *Client) GetEmailMessages(params *GetEmailMessagesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*GetEmailMessagesOK, error) { + // TODO: Validate the params before sending + if params == nil { + params = NewGetEmailMessagesParams() + } + op := &runtime.ClientOperation{ + ID: "getEmailMessages", + Method: "GET", + PathPattern: "/emailmessages", + ProducesMediaTypes: []string{"application/json"}, + ConsumesMediaTypes: []string{"application/json"}, + Schemes: []string{"http"}, + Params: params, + Reader: &GetEmailMessagesReader{formats: a.formats}, + AuthInfo: authInfo, + Context: params.Context, + Client: params.HTTPClient, + } + for _, opt := range opts { + opt(op) + } + + result, err := a.transport.Submit(op) + if err != nil { + return nil, err + } + success, ok := result.(*GetEmailMessagesOK) + if ok { + return success, nil + } + // unexpected success response + // safeguard: normally, absent a default response, unknown success responses return an error above: so this is a codegen issue + msg := fmt.Sprintf("unexpected success response for getEmailMessages: API contract not enforced by server. Client expected to get an error, but got: %T", result) + panic(msg) +} + +// SetTransport changes the transport on the client +func (a *Client) SetTransport(transport runtime.ClientTransport) { + a.transport = transport +} diff --git a/api/workflow/workflow_client/email_message/get_email_messages_parameters.go b/api/workflow/workflow_client/email_message/get_email_messages_parameters.go new file mode 100644 index 0000000..d274d9d --- /dev/null +++ b/api/workflow/workflow_client/email_message/get_email_messages_parameters.go @@ -0,0 +1,167 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package email_message + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "net/http" + "time" + + "github.com/go-openapi/errors" + "github.com/go-openapi/runtime" + cr "github.com/go-openapi/runtime/client" + "github.com/go-openapi/strfmt" +) + +// NewGetEmailMessagesParams creates a new GetEmailMessagesParams object, +// with the default timeout for this client. +// +// Default values are not hydrated, since defaults are normally applied by the API server side. +// +// To enforce default values in parameter, use SetDefaults or WithDefaults. +func NewGetEmailMessagesParams() *GetEmailMessagesParams { + return &GetEmailMessagesParams{ + timeout: cr.DefaultTimeout, + } +} + +// NewGetEmailMessagesParamsWithTimeout creates a new GetEmailMessagesParams object +// with the ability to set a timeout on a request. +func NewGetEmailMessagesParamsWithTimeout(timeout time.Duration) *GetEmailMessagesParams { + return &GetEmailMessagesParams{ + timeout: timeout, + } +} + +// NewGetEmailMessagesParamsWithContext creates a new GetEmailMessagesParams object +// with the ability to set a context for a request. +func NewGetEmailMessagesParamsWithContext(ctx context.Context) *GetEmailMessagesParams { + return &GetEmailMessagesParams{ + Context: ctx, + } +} + +// NewGetEmailMessagesParamsWithHTTPClient creates a new GetEmailMessagesParams object +// with the ability to set a custom HTTPClient for a request. +func NewGetEmailMessagesParamsWithHTTPClient(client *http.Client) *GetEmailMessagesParams { + return &GetEmailMessagesParams{ + HTTPClient: client, + } +} + +/* +GetEmailMessagesParams contains all the parameters to send to the API endpoint + + for the get email messages operation. + + Typically these are written to a http.Request. +*/ +type GetEmailMessagesParams struct { + + /* EmailMessageID. + + Email Message ID + */ + EmailMessageID *string + + timeout time.Duration + Context context.Context + HTTPClient *http.Client +} + +// WithDefaults hydrates default values in the get email messages params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *GetEmailMessagesParams) WithDefaults() *GetEmailMessagesParams { + o.SetDefaults() + return o +} + +// SetDefaults hydrates default values in the get email messages params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *GetEmailMessagesParams) SetDefaults() { + // no default values defined for this parameter +} + +// WithTimeout adds the timeout to the get email messages params +func (o *GetEmailMessagesParams) WithTimeout(timeout time.Duration) *GetEmailMessagesParams { + o.SetTimeout(timeout) + return o +} + +// SetTimeout adds the timeout to the get email messages params +func (o *GetEmailMessagesParams) SetTimeout(timeout time.Duration) { + o.timeout = timeout +} + +// WithContext adds the context to the get email messages params +func (o *GetEmailMessagesParams) WithContext(ctx context.Context) *GetEmailMessagesParams { + o.SetContext(ctx) + return o +} + +// SetContext adds the context to the get email messages params +func (o *GetEmailMessagesParams) SetContext(ctx context.Context) { + o.Context = ctx +} + +// WithHTTPClient adds the HTTPClient to the get email messages params +func (o *GetEmailMessagesParams) WithHTTPClient(client *http.Client) *GetEmailMessagesParams { + o.SetHTTPClient(client) + return o +} + +// SetHTTPClient adds the HTTPClient to the get email messages params +func (o *GetEmailMessagesParams) SetHTTPClient(client *http.Client) { + o.HTTPClient = client +} + +// WithEmailMessageID adds the emailMessageID to the get email messages params +func (o *GetEmailMessagesParams) WithEmailMessageID(emailMessageID *string) *GetEmailMessagesParams { + o.SetEmailMessageID(emailMessageID) + return o +} + +// SetEmailMessageID adds the emailMessageId to the get email messages params +func (o *GetEmailMessagesParams) SetEmailMessageID(emailMessageID *string) { + o.EmailMessageID = emailMessageID +} + +// WriteToRequest writes these params to a swagger request +func (o *GetEmailMessagesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { + + if err := r.SetTimeout(o.timeout); err != nil { + return err + } + var res []error + + if o.EmailMessageID != nil { + + // query param emailMessageId + var qrEmailMessageID string + + if o.EmailMessageID != nil { + qrEmailMessageID = *o.EmailMessageID + } + qEmailMessageID := qrEmailMessageID + if qEmailMessageID != "" { + + if err := r.SetQueryParam("emailMessageId", qEmailMessageID); err != nil { + return err + } + } + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} diff --git a/api/workflow/workflow_client/email_message/get_email_messages_responses.go b/api/workflow/workflow_client/email_message/get_email_messages_responses.go new file mode 100644 index 0000000..99c6b13 --- /dev/null +++ b/api/workflow/workflow_client/email_message/get_email_messages_responses.go @@ -0,0 +1,531 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package email_message + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + "io" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" + + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_models" +) + +// GetEmailMessagesReader is a Reader for the GetEmailMessages structure. +type GetEmailMessagesReader struct { + formats strfmt.Registry +} + +// ReadResponse reads a server response into the received o. +func (o *GetEmailMessagesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error) { + switch response.Code() { + case 200: + result := NewGetEmailMessagesOK() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return result, nil + case 401: + result := NewGetEmailMessagesUnauthorized() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 403: + result := NewGetEmailMessagesForbidden() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 404: + result := NewGetEmailMessagesNotFound() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 422: + result := NewGetEmailMessagesUnprocessableEntity() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 500: + result := NewGetEmailMessagesInternalServerError() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + default: + return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + } +} + +// NewGetEmailMessagesOK creates a GetEmailMessagesOK with default headers values +func NewGetEmailMessagesOK() *GetEmailMessagesOK { + return &GetEmailMessagesOK{} +} + +/* +GetEmailMessagesOK describes a response with status code 200, with default header values. + +Array of Email Messages +*/ +type GetEmailMessagesOK struct { + AccessControlAllowOrigin string + + Payload *workflow_models.EmailMessagesResponse +} + +// IsSuccess returns true when this get email messages o k response has a 2xx status code +func (o *GetEmailMessagesOK) IsSuccess() bool { + return true +} + +// IsRedirect returns true when this get email messages o k response has a 3xx status code +func (o *GetEmailMessagesOK) IsRedirect() bool { + return false +} + +// IsClientError returns true when this get email messages o k response has a 4xx status code +func (o *GetEmailMessagesOK) IsClientError() bool { + return false +} + +// IsServerError returns true when this get email messages o k response has a 5xx status code +func (o *GetEmailMessagesOK) IsServerError() bool { + return false +} + +// IsCode returns true when this get email messages o k response a status code equal to that given +func (o *GetEmailMessagesOK) IsCode(code int) bool { + return code == 200 +} + +// Code gets the status code for the get email messages o k response +func (o *GetEmailMessagesOK) Code() int { + return 200 +} + +func (o *GetEmailMessagesOK) Error() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesOK %+v", 200, o.Payload) +} + +func (o *GetEmailMessagesOK) String() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesOK %+v", 200, o.Payload) +} + +func (o *GetEmailMessagesOK) GetPayload() *workflow_models.EmailMessagesResponse { + return o.Payload +} + +func (o *GetEmailMessagesOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.EmailMessagesResponse) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewGetEmailMessagesUnauthorized creates a GetEmailMessagesUnauthorized with default headers values +func NewGetEmailMessagesUnauthorized() *GetEmailMessagesUnauthorized { + return &GetEmailMessagesUnauthorized{} +} + +/* +GetEmailMessagesUnauthorized describes a response with status code 401, with default header values. + +Access Unauthorized, invalid API-KEY was used +*/ +type GetEmailMessagesUnauthorized struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this get email messages unauthorized response has a 2xx status code +func (o *GetEmailMessagesUnauthorized) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this get email messages unauthorized response has a 3xx status code +func (o *GetEmailMessagesUnauthorized) IsRedirect() bool { + return false +} + +// IsClientError returns true when this get email messages unauthorized response has a 4xx status code +func (o *GetEmailMessagesUnauthorized) IsClientError() bool { + return true +} + +// IsServerError returns true when this get email messages unauthorized response has a 5xx status code +func (o *GetEmailMessagesUnauthorized) IsServerError() bool { + return false +} + +// IsCode returns true when this get email messages unauthorized response a status code equal to that given +func (o *GetEmailMessagesUnauthorized) IsCode(code int) bool { + return code == 401 +} + +// Code gets the status code for the get email messages unauthorized response +func (o *GetEmailMessagesUnauthorized) Code() int { + return 401 +} + +func (o *GetEmailMessagesUnauthorized) Error() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesUnauthorized %+v", 401, o.Payload) +} + +func (o *GetEmailMessagesUnauthorized) String() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesUnauthorized %+v", 401, o.Payload) +} + +func (o *GetEmailMessagesUnauthorized) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *GetEmailMessagesUnauthorized) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewGetEmailMessagesForbidden creates a GetEmailMessagesForbidden with default headers values +func NewGetEmailMessagesForbidden() *GetEmailMessagesForbidden { + return &GetEmailMessagesForbidden{} +} + +/* +GetEmailMessagesForbidden describes a response with status code 403, with default header values. + +Access forbidden, account lacks access +*/ +type GetEmailMessagesForbidden struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this get email messages forbidden response has a 2xx status code +func (o *GetEmailMessagesForbidden) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this get email messages forbidden response has a 3xx status code +func (o *GetEmailMessagesForbidden) IsRedirect() bool { + return false +} + +// IsClientError returns true when this get email messages forbidden response has a 4xx status code +func (o *GetEmailMessagesForbidden) IsClientError() bool { + return true +} + +// IsServerError returns true when this get email messages forbidden response has a 5xx status code +func (o *GetEmailMessagesForbidden) IsServerError() bool { + return false +} + +// IsCode returns true when this get email messages forbidden response a status code equal to that given +func (o *GetEmailMessagesForbidden) IsCode(code int) bool { + return code == 403 +} + +// Code gets the status code for the get email messages forbidden response +func (o *GetEmailMessagesForbidden) Code() int { + return 403 +} + +func (o *GetEmailMessagesForbidden) Error() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesForbidden %+v", 403, o.Payload) +} + +func (o *GetEmailMessagesForbidden) String() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesForbidden %+v", 403, o.Payload) +} + +func (o *GetEmailMessagesForbidden) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *GetEmailMessagesForbidden) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewGetEmailMessagesNotFound creates a GetEmailMessagesNotFound with default headers values +func NewGetEmailMessagesNotFound() *GetEmailMessagesNotFound { + return &GetEmailMessagesNotFound{} +} + +/* +GetEmailMessagesNotFound describes a response with status code 404, with default header values. + +Resource was not found +*/ +type GetEmailMessagesNotFound struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this get email messages not found response has a 2xx status code +func (o *GetEmailMessagesNotFound) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this get email messages not found response has a 3xx status code +func (o *GetEmailMessagesNotFound) IsRedirect() bool { + return false +} + +// IsClientError returns true when this get email messages not found response has a 4xx status code +func (o *GetEmailMessagesNotFound) IsClientError() bool { + return true +} + +// IsServerError returns true when this get email messages not found response has a 5xx status code +func (o *GetEmailMessagesNotFound) IsServerError() bool { + return false +} + +// IsCode returns true when this get email messages not found response a status code equal to that given +func (o *GetEmailMessagesNotFound) IsCode(code int) bool { + return code == 404 +} + +// Code gets the status code for the get email messages not found response +func (o *GetEmailMessagesNotFound) Code() int { + return 404 +} + +func (o *GetEmailMessagesNotFound) Error() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesNotFound %+v", 404, o.Payload) +} + +func (o *GetEmailMessagesNotFound) String() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesNotFound %+v", 404, o.Payload) +} + +func (o *GetEmailMessagesNotFound) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *GetEmailMessagesNotFound) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewGetEmailMessagesUnprocessableEntity creates a GetEmailMessagesUnprocessableEntity with default headers values +func NewGetEmailMessagesUnprocessableEntity() *GetEmailMessagesUnprocessableEntity { + return &GetEmailMessagesUnprocessableEntity{} +} + +/* +GetEmailMessagesUnprocessableEntity describes a response with status code 422, with default header values. + +Unprocessable Entity, likely a bad parameter +*/ +type GetEmailMessagesUnprocessableEntity struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this get email messages unprocessable entity response has a 2xx status code +func (o *GetEmailMessagesUnprocessableEntity) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this get email messages unprocessable entity response has a 3xx status code +func (o *GetEmailMessagesUnprocessableEntity) IsRedirect() bool { + return false +} + +// IsClientError returns true when this get email messages unprocessable entity response has a 4xx status code +func (o *GetEmailMessagesUnprocessableEntity) IsClientError() bool { + return true +} + +// IsServerError returns true when this get email messages unprocessable entity response has a 5xx status code +func (o *GetEmailMessagesUnprocessableEntity) IsServerError() bool { + return false +} + +// IsCode returns true when this get email messages unprocessable entity response a status code equal to that given +func (o *GetEmailMessagesUnprocessableEntity) IsCode(code int) bool { + return code == 422 +} + +// Code gets the status code for the get email messages unprocessable entity response +func (o *GetEmailMessagesUnprocessableEntity) Code() int { + return 422 +} + +func (o *GetEmailMessagesUnprocessableEntity) Error() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesUnprocessableEntity %+v", 422, o.Payload) +} + +func (o *GetEmailMessagesUnprocessableEntity) String() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesUnprocessableEntity %+v", 422, o.Payload) +} + +func (o *GetEmailMessagesUnprocessableEntity) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *GetEmailMessagesUnprocessableEntity) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewGetEmailMessagesInternalServerError creates a GetEmailMessagesInternalServerError with default headers values +func NewGetEmailMessagesInternalServerError() *GetEmailMessagesInternalServerError { + return &GetEmailMessagesInternalServerError{} +} + +/* +GetEmailMessagesInternalServerError describes a response with status code 500, with default header values. + +Server Internal Error +*/ +type GetEmailMessagesInternalServerError struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this get email messages internal server error response has a 2xx status code +func (o *GetEmailMessagesInternalServerError) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this get email messages internal server error response has a 3xx status code +func (o *GetEmailMessagesInternalServerError) IsRedirect() bool { + return false +} + +// IsClientError returns true when this get email messages internal server error response has a 4xx status code +func (o *GetEmailMessagesInternalServerError) IsClientError() bool { + return false +} + +// IsServerError returns true when this get email messages internal server error response has a 5xx status code +func (o *GetEmailMessagesInternalServerError) IsServerError() bool { + return true +} + +// IsCode returns true when this get email messages internal server error response a status code equal to that given +func (o *GetEmailMessagesInternalServerError) IsCode(code int) bool { + return code == 500 +} + +// Code gets the status code for the get email messages internal server error response +func (o *GetEmailMessagesInternalServerError) Code() int { + return 500 +} + +func (o *GetEmailMessagesInternalServerError) Error() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesInternalServerError %+v", 500, o.Payload) +} + +func (o *GetEmailMessagesInternalServerError) String() string { + return fmt.Sprintf("[GET /emailmessages][%d] getEmailMessagesInternalServerError %+v", 500, o.Payload) +} + +func (o *GetEmailMessagesInternalServerError) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *GetEmailMessagesInternalServerError) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} diff --git a/api/workflow/workflow_client/outgoing_email_message/outgoing_email_message_client.go b/api/workflow/workflow_client/outgoing_email_message/outgoing_email_message_client.go new file mode 100644 index 0000000..bd52ec8 --- /dev/null +++ b/api/workflow/workflow_client/outgoing_email_message/outgoing_email_message_client.go @@ -0,0 +1,86 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package outgoing_email_message + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" +) + +// New creates a new outgoing email message API client. +func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService { + return &Client{transport: transport, formats: formats} +} + +/* +Client for outgoing email message API +*/ +type Client struct { + transport runtime.ClientTransport + formats strfmt.Registry +} + +// ClientOption is the option for Client methods +type ClientOption func(*runtime.ClientOperation) + +// ClientService is the interface for Client methods +type ClientService interface { + PostOutgoingEmailMessages(params *PostOutgoingEmailMessagesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostOutgoingEmailMessagesOK, error) + + SetTransport(transport runtime.ClientTransport) +} + +/* +PostOutgoingEmailMessages adds new email messages to the outgoing queue + +Insert new email messages into workflow storage +*/ +func (a *Client) PostOutgoingEmailMessages(params *PostOutgoingEmailMessagesParams, authInfo runtime.ClientAuthInfoWriter, opts ...ClientOption) (*PostOutgoingEmailMessagesOK, error) { + // TODO: Validate the params before sending + if params == nil { + params = NewPostOutgoingEmailMessagesParams() + } + op := &runtime.ClientOperation{ + ID: "postOutgoingEmailMessages", + Method: "POST", + PathPattern: "/outgoingemailmessages", + ProducesMediaTypes: []string{"application/json"}, + ConsumesMediaTypes: []string{"application/json"}, + Schemes: []string{"http"}, + Params: params, + Reader: &PostOutgoingEmailMessagesReader{formats: a.formats}, + AuthInfo: authInfo, + Context: params.Context, + Client: params.HTTPClient, + } + for _, opt := range opts { + opt(op) + } + + result, err := a.transport.Submit(op) + if err != nil { + return nil, err + } + success, ok := result.(*PostOutgoingEmailMessagesOK) + if ok { + return success, nil + } + // unexpected success response + // safeguard: normally, absent a default response, unknown success responses return an error above: so this is a codegen issue + msg := fmt.Sprintf("unexpected success response for postOutgoingEmailMessages: API contract not enforced by server. Client expected to get an error, but got: %T", result) + panic(msg) +} + +// SetTransport changes the transport on the client +func (a *Client) SetTransport(transport runtime.ClientTransport) { + a.transport = transport +} diff --git a/api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_parameters.go b/api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_parameters.go new file mode 100644 index 0000000..634698c --- /dev/null +++ b/api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_parameters.go @@ -0,0 +1,157 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package outgoing_email_message + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "net/http" + "time" + + "github.com/go-openapi/errors" + "github.com/go-openapi/runtime" + cr "github.com/go-openapi/runtime/client" + "github.com/go-openapi/strfmt" + + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_models" +) + +// NewPostOutgoingEmailMessagesParams creates a new PostOutgoingEmailMessagesParams object, +// with the default timeout for this client. +// +// Default values are not hydrated, since defaults are normally applied by the API server side. +// +// To enforce default values in parameter, use SetDefaults or WithDefaults. +func NewPostOutgoingEmailMessagesParams() *PostOutgoingEmailMessagesParams { + return &PostOutgoingEmailMessagesParams{ + timeout: cr.DefaultTimeout, + } +} + +// NewPostOutgoingEmailMessagesParamsWithTimeout creates a new PostOutgoingEmailMessagesParams object +// with the ability to set a timeout on a request. +func NewPostOutgoingEmailMessagesParamsWithTimeout(timeout time.Duration) *PostOutgoingEmailMessagesParams { + return &PostOutgoingEmailMessagesParams{ + timeout: timeout, + } +} + +// NewPostOutgoingEmailMessagesParamsWithContext creates a new PostOutgoingEmailMessagesParams object +// with the ability to set a context for a request. +func NewPostOutgoingEmailMessagesParamsWithContext(ctx context.Context) *PostOutgoingEmailMessagesParams { + return &PostOutgoingEmailMessagesParams{ + Context: ctx, + } +} + +// NewPostOutgoingEmailMessagesParamsWithHTTPClient creates a new PostOutgoingEmailMessagesParams object +// with the ability to set a custom HTTPClient for a request. +func NewPostOutgoingEmailMessagesParamsWithHTTPClient(client *http.Client) *PostOutgoingEmailMessagesParams { + return &PostOutgoingEmailMessagesParams{ + HTTPClient: client, + } +} + +/* +PostOutgoingEmailMessagesParams contains all the parameters to send to the API endpoint + + for the post outgoing email messages operation. + + Typically these are written to a http.Request. +*/ +type PostOutgoingEmailMessagesParams struct { + + /* OutgoingEmailMessageRequest. + + An array of new Outgoing Email Message records + */ + OutgoingEmailMessageRequest *workflow_models.OutgoingEmailMessageRequest + + timeout time.Duration + Context context.Context + HTTPClient *http.Client +} + +// WithDefaults hydrates default values in the post outgoing email messages params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *PostOutgoingEmailMessagesParams) WithDefaults() *PostOutgoingEmailMessagesParams { + o.SetDefaults() + return o +} + +// SetDefaults hydrates default values in the post outgoing email messages params (not the query body). +// +// All values with no default are reset to their zero value. +func (o *PostOutgoingEmailMessagesParams) SetDefaults() { + // no default values defined for this parameter +} + +// WithTimeout adds the timeout to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) WithTimeout(timeout time.Duration) *PostOutgoingEmailMessagesParams { + o.SetTimeout(timeout) + return o +} + +// SetTimeout adds the timeout to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) SetTimeout(timeout time.Duration) { + o.timeout = timeout +} + +// WithContext adds the context to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) WithContext(ctx context.Context) *PostOutgoingEmailMessagesParams { + o.SetContext(ctx) + return o +} + +// SetContext adds the context to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) SetContext(ctx context.Context) { + o.Context = ctx +} + +// WithHTTPClient adds the HTTPClient to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) WithHTTPClient(client *http.Client) *PostOutgoingEmailMessagesParams { + o.SetHTTPClient(client) + return o +} + +// SetHTTPClient adds the HTTPClient to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) SetHTTPClient(client *http.Client) { + o.HTTPClient = client +} + +// WithOutgoingEmailMessageRequest adds the outgoingEmailMessageRequest to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) WithOutgoingEmailMessageRequest(outgoingEmailMessageRequest *workflow_models.OutgoingEmailMessageRequest) *PostOutgoingEmailMessagesParams { + o.SetOutgoingEmailMessageRequest(outgoingEmailMessageRequest) + return o +} + +// SetOutgoingEmailMessageRequest adds the outgoingEmailMessageRequest to the post outgoing email messages params +func (o *PostOutgoingEmailMessagesParams) SetOutgoingEmailMessageRequest(outgoingEmailMessageRequest *workflow_models.OutgoingEmailMessageRequest) { + o.OutgoingEmailMessageRequest = outgoingEmailMessageRequest +} + +// WriteToRequest writes these params to a swagger request +func (o *PostOutgoingEmailMessagesParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error { + + if err := r.SetTimeout(o.timeout); err != nil { + return err + } + var res []error + if o.OutgoingEmailMessageRequest != nil { + if err := r.SetBodyParam(o.OutgoingEmailMessageRequest); err != nil { + return err + } + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} diff --git a/api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_responses.go b/api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_responses.go new file mode 100644 index 0000000..f6f3152 --- /dev/null +++ b/api/workflow/workflow_client/outgoing_email_message/post_outgoing_email_messages_responses.go @@ -0,0 +1,531 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package outgoing_email_message + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "fmt" + "io" + + "github.com/go-openapi/runtime" + "github.com/go-openapi/strfmt" + + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_models" +) + +// PostOutgoingEmailMessagesReader is a Reader for the PostOutgoingEmailMessages structure. +type PostOutgoingEmailMessagesReader struct { + formats strfmt.Registry +} + +// ReadResponse reads a server response into the received o. +func (o *PostOutgoingEmailMessagesReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error) { + switch response.Code() { + case 200: + result := NewPostOutgoingEmailMessagesOK() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return result, nil + case 401: + result := NewPostOutgoingEmailMessagesUnauthorized() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 403: + result := NewPostOutgoingEmailMessagesForbidden() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 404: + result := NewPostOutgoingEmailMessagesNotFound() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 422: + result := NewPostOutgoingEmailMessagesUnprocessableEntity() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + case 500: + result := NewPostOutgoingEmailMessagesInternalServerError() + if err := result.readResponse(response, consumer, o.formats); err != nil { + return nil, err + } + return nil, result + default: + return nil, runtime.NewAPIError("response status code does not match any response statuses defined for this endpoint in the swagger spec", response, response.Code()) + } +} + +// NewPostOutgoingEmailMessagesOK creates a PostOutgoingEmailMessagesOK with default headers values +func NewPostOutgoingEmailMessagesOK() *PostOutgoingEmailMessagesOK { + return &PostOutgoingEmailMessagesOK{} +} + +/* +PostOutgoingEmailMessagesOK describes a response with status code 200, with default header values. + +Array of Email Messages +*/ +type PostOutgoingEmailMessagesOK struct { + AccessControlAllowOrigin string + + Payload *workflow_models.EmailMessagesResponse +} + +// IsSuccess returns true when this post outgoing email messages o k response has a 2xx status code +func (o *PostOutgoingEmailMessagesOK) IsSuccess() bool { + return true +} + +// IsRedirect returns true when this post outgoing email messages o k response has a 3xx status code +func (o *PostOutgoingEmailMessagesOK) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post outgoing email messages o k response has a 4xx status code +func (o *PostOutgoingEmailMessagesOK) IsClientError() bool { + return false +} + +// IsServerError returns true when this post outgoing email messages o k response has a 5xx status code +func (o *PostOutgoingEmailMessagesOK) IsServerError() bool { + return false +} + +// IsCode returns true when this post outgoing email messages o k response a status code equal to that given +func (o *PostOutgoingEmailMessagesOK) IsCode(code int) bool { + return code == 200 +} + +// Code gets the status code for the post outgoing email messages o k response +func (o *PostOutgoingEmailMessagesOK) Code() int { + return 200 +} + +func (o *PostOutgoingEmailMessagesOK) Error() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesOK %+v", 200, o.Payload) +} + +func (o *PostOutgoingEmailMessagesOK) String() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesOK %+v", 200, o.Payload) +} + +func (o *PostOutgoingEmailMessagesOK) GetPayload() *workflow_models.EmailMessagesResponse { + return o.Payload +} + +func (o *PostOutgoingEmailMessagesOK) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.EmailMessagesResponse) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostOutgoingEmailMessagesUnauthorized creates a PostOutgoingEmailMessagesUnauthorized with default headers values +func NewPostOutgoingEmailMessagesUnauthorized() *PostOutgoingEmailMessagesUnauthorized { + return &PostOutgoingEmailMessagesUnauthorized{} +} + +/* +PostOutgoingEmailMessagesUnauthorized describes a response with status code 401, with default header values. + +Access Unauthorized, invalid API-KEY was used +*/ +type PostOutgoingEmailMessagesUnauthorized struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post outgoing email messages unauthorized response has a 2xx status code +func (o *PostOutgoingEmailMessagesUnauthorized) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post outgoing email messages unauthorized response has a 3xx status code +func (o *PostOutgoingEmailMessagesUnauthorized) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post outgoing email messages unauthorized response has a 4xx status code +func (o *PostOutgoingEmailMessagesUnauthorized) IsClientError() bool { + return true +} + +// IsServerError returns true when this post outgoing email messages unauthorized response has a 5xx status code +func (o *PostOutgoingEmailMessagesUnauthorized) IsServerError() bool { + return false +} + +// IsCode returns true when this post outgoing email messages unauthorized response a status code equal to that given +func (o *PostOutgoingEmailMessagesUnauthorized) IsCode(code int) bool { + return code == 401 +} + +// Code gets the status code for the post outgoing email messages unauthorized response +func (o *PostOutgoingEmailMessagesUnauthorized) Code() int { + return 401 +} + +func (o *PostOutgoingEmailMessagesUnauthorized) Error() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesUnauthorized %+v", 401, o.Payload) +} + +func (o *PostOutgoingEmailMessagesUnauthorized) String() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesUnauthorized %+v", 401, o.Payload) +} + +func (o *PostOutgoingEmailMessagesUnauthorized) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostOutgoingEmailMessagesUnauthorized) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostOutgoingEmailMessagesForbidden creates a PostOutgoingEmailMessagesForbidden with default headers values +func NewPostOutgoingEmailMessagesForbidden() *PostOutgoingEmailMessagesForbidden { + return &PostOutgoingEmailMessagesForbidden{} +} + +/* +PostOutgoingEmailMessagesForbidden describes a response with status code 403, with default header values. + +Access forbidden, account lacks access +*/ +type PostOutgoingEmailMessagesForbidden struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post outgoing email messages forbidden response has a 2xx status code +func (o *PostOutgoingEmailMessagesForbidden) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post outgoing email messages forbidden response has a 3xx status code +func (o *PostOutgoingEmailMessagesForbidden) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post outgoing email messages forbidden response has a 4xx status code +func (o *PostOutgoingEmailMessagesForbidden) IsClientError() bool { + return true +} + +// IsServerError returns true when this post outgoing email messages forbidden response has a 5xx status code +func (o *PostOutgoingEmailMessagesForbidden) IsServerError() bool { + return false +} + +// IsCode returns true when this post outgoing email messages forbidden response a status code equal to that given +func (o *PostOutgoingEmailMessagesForbidden) IsCode(code int) bool { + return code == 403 +} + +// Code gets the status code for the post outgoing email messages forbidden response +func (o *PostOutgoingEmailMessagesForbidden) Code() int { + return 403 +} + +func (o *PostOutgoingEmailMessagesForbidden) Error() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesForbidden %+v", 403, o.Payload) +} + +func (o *PostOutgoingEmailMessagesForbidden) String() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesForbidden %+v", 403, o.Payload) +} + +func (o *PostOutgoingEmailMessagesForbidden) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostOutgoingEmailMessagesForbidden) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostOutgoingEmailMessagesNotFound creates a PostOutgoingEmailMessagesNotFound with default headers values +func NewPostOutgoingEmailMessagesNotFound() *PostOutgoingEmailMessagesNotFound { + return &PostOutgoingEmailMessagesNotFound{} +} + +/* +PostOutgoingEmailMessagesNotFound describes a response with status code 404, with default header values. + +Resource was not found +*/ +type PostOutgoingEmailMessagesNotFound struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post outgoing email messages not found response has a 2xx status code +func (o *PostOutgoingEmailMessagesNotFound) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post outgoing email messages not found response has a 3xx status code +func (o *PostOutgoingEmailMessagesNotFound) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post outgoing email messages not found response has a 4xx status code +func (o *PostOutgoingEmailMessagesNotFound) IsClientError() bool { + return true +} + +// IsServerError returns true when this post outgoing email messages not found response has a 5xx status code +func (o *PostOutgoingEmailMessagesNotFound) IsServerError() bool { + return false +} + +// IsCode returns true when this post outgoing email messages not found response a status code equal to that given +func (o *PostOutgoingEmailMessagesNotFound) IsCode(code int) bool { + return code == 404 +} + +// Code gets the status code for the post outgoing email messages not found response +func (o *PostOutgoingEmailMessagesNotFound) Code() int { + return 404 +} + +func (o *PostOutgoingEmailMessagesNotFound) Error() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesNotFound %+v", 404, o.Payload) +} + +func (o *PostOutgoingEmailMessagesNotFound) String() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesNotFound %+v", 404, o.Payload) +} + +func (o *PostOutgoingEmailMessagesNotFound) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostOutgoingEmailMessagesNotFound) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostOutgoingEmailMessagesUnprocessableEntity creates a PostOutgoingEmailMessagesUnprocessableEntity with default headers values +func NewPostOutgoingEmailMessagesUnprocessableEntity() *PostOutgoingEmailMessagesUnprocessableEntity { + return &PostOutgoingEmailMessagesUnprocessableEntity{} +} + +/* +PostOutgoingEmailMessagesUnprocessableEntity describes a response with status code 422, with default header values. + +Unprocessable Entity, likely a bad parameter +*/ +type PostOutgoingEmailMessagesUnprocessableEntity struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post outgoing email messages unprocessable entity response has a 2xx status code +func (o *PostOutgoingEmailMessagesUnprocessableEntity) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post outgoing email messages unprocessable entity response has a 3xx status code +func (o *PostOutgoingEmailMessagesUnprocessableEntity) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post outgoing email messages unprocessable entity response has a 4xx status code +func (o *PostOutgoingEmailMessagesUnprocessableEntity) IsClientError() bool { + return true +} + +// IsServerError returns true when this post outgoing email messages unprocessable entity response has a 5xx status code +func (o *PostOutgoingEmailMessagesUnprocessableEntity) IsServerError() bool { + return false +} + +// IsCode returns true when this post outgoing email messages unprocessable entity response a status code equal to that given +func (o *PostOutgoingEmailMessagesUnprocessableEntity) IsCode(code int) bool { + return code == 422 +} + +// Code gets the status code for the post outgoing email messages unprocessable entity response +func (o *PostOutgoingEmailMessagesUnprocessableEntity) Code() int { + return 422 +} + +func (o *PostOutgoingEmailMessagesUnprocessableEntity) Error() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesUnprocessableEntity %+v", 422, o.Payload) +} + +func (o *PostOutgoingEmailMessagesUnprocessableEntity) String() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesUnprocessableEntity %+v", 422, o.Payload) +} + +func (o *PostOutgoingEmailMessagesUnprocessableEntity) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostOutgoingEmailMessagesUnprocessableEntity) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} + +// NewPostOutgoingEmailMessagesInternalServerError creates a PostOutgoingEmailMessagesInternalServerError with default headers values +func NewPostOutgoingEmailMessagesInternalServerError() *PostOutgoingEmailMessagesInternalServerError { + return &PostOutgoingEmailMessagesInternalServerError{} +} + +/* +PostOutgoingEmailMessagesInternalServerError describes a response with status code 500, with default header values. + +Server Internal Error +*/ +type PostOutgoingEmailMessagesInternalServerError struct { + AccessControlAllowOrigin string + + Payload *workflow_models.Error +} + +// IsSuccess returns true when this post outgoing email messages internal server error response has a 2xx status code +func (o *PostOutgoingEmailMessagesInternalServerError) IsSuccess() bool { + return false +} + +// IsRedirect returns true when this post outgoing email messages internal server error response has a 3xx status code +func (o *PostOutgoingEmailMessagesInternalServerError) IsRedirect() bool { + return false +} + +// IsClientError returns true when this post outgoing email messages internal server error response has a 4xx status code +func (o *PostOutgoingEmailMessagesInternalServerError) IsClientError() bool { + return false +} + +// IsServerError returns true when this post outgoing email messages internal server error response has a 5xx status code +func (o *PostOutgoingEmailMessagesInternalServerError) IsServerError() bool { + return true +} + +// IsCode returns true when this post outgoing email messages internal server error response a status code equal to that given +func (o *PostOutgoingEmailMessagesInternalServerError) IsCode(code int) bool { + return code == 500 +} + +// Code gets the status code for the post outgoing email messages internal server error response +func (o *PostOutgoingEmailMessagesInternalServerError) Code() int { + return 500 +} + +func (o *PostOutgoingEmailMessagesInternalServerError) Error() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesInternalServerError %+v", 500, o.Payload) +} + +func (o *PostOutgoingEmailMessagesInternalServerError) String() string { + return fmt.Sprintf("[POST /outgoingemailmessages][%d] postOutgoingEmailMessagesInternalServerError %+v", 500, o.Payload) +} + +func (o *PostOutgoingEmailMessagesInternalServerError) GetPayload() *workflow_models.Error { + return o.Payload +} + +func (o *PostOutgoingEmailMessagesInternalServerError) readResponse(response runtime.ClientResponse, consumer runtime.Consumer, formats strfmt.Registry) error { + + // hydrates response header Access-Control-Allow-Origin + hdrAccessControlAllowOrigin := response.GetHeader("Access-Control-Allow-Origin") + + if hdrAccessControlAllowOrigin != "" { + o.AccessControlAllowOrigin = hdrAccessControlAllowOrigin + } + + o.Payload = new(workflow_models.Error) + + // response payload + if err := consumer.Consume(response.Body(), o.Payload); err != nil && err != io.EOF { + return err + } + + return nil +} diff --git a/api/workflow/workflow_client/workflow_client.go b/api/workflow/workflow_client/workflow_client.go new file mode 100644 index 0000000..aa5667b --- /dev/null +++ b/api/workflow/workflow_client/workflow_client.go @@ -0,0 +1,131 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_client + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "github.com/go-openapi/runtime" + httptransport "github.com/go-openapi/runtime/client" + "github.com/go-openapi/strfmt" + + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_client/app_log" + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_client/cors" + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_client/email_message" + "code.tnxs.net/vernonkeenan/lib/api/workflow/workflow_client/outgoing_email_message" +) + +// Default workflow HTTP client. +var Default = NewHTTPClient(nil) + +const ( + // DefaultHost is the default Host + // found in Meta (info) section of spec file + DefaultHost string = "workflow.work.tnxs.net:8080" + // DefaultBasePath is the default BasePath + // found in Meta (info) section of spec file + DefaultBasePath string = "/v1" +) + +// DefaultSchemes are the default schemes found in Meta (info) section of spec file +var DefaultSchemes = []string{"http"} + +// NewHTTPClient creates a new workflow HTTP client. +func NewHTTPClient(formats strfmt.Registry) *Workflow { + return NewHTTPClientWithConfig(formats, nil) +} + +// NewHTTPClientWithConfig creates a new workflow HTTP client, +// using a customizable transport config. +func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *Workflow { + // ensure nullable parameters have default + if cfg == nil { + cfg = DefaultTransportConfig() + } + + // create transport and client + transport := httptransport.New(cfg.Host, cfg.BasePath, cfg.Schemes) + return New(transport, formats) +} + +// New creates a new workflow client +func New(transport runtime.ClientTransport, formats strfmt.Registry) *Workflow { + // ensure nullable parameters have default + if formats == nil { + formats = strfmt.Default + } + + cli := new(Workflow) + cli.Transport = transport + cli.AppLog = app_log.New(transport, formats) + cli.Cors = cors.New(transport, formats) + cli.EmailMessage = email_message.New(transport, formats) + cli.OutgoingEmailMessage = outgoing_email_message.New(transport, formats) + return cli +} + +// DefaultTransportConfig creates a TransportConfig with the +// default settings taken from the meta section of the spec file. +func DefaultTransportConfig() *TransportConfig { + return &TransportConfig{ + Host: DefaultHost, + BasePath: DefaultBasePath, + Schemes: DefaultSchemes, + } +} + +// TransportConfig contains the transport related info, +// found in the meta section of the spec file. +type TransportConfig struct { + Host string + BasePath string + Schemes []string +} + +// WithHost overrides the default host, +// provided by the meta section of the spec file. +func (cfg *TransportConfig) WithHost(host string) *TransportConfig { + cfg.Host = host + return cfg +} + +// WithBasePath overrides the default basePath, +// provided by the meta section of the spec file. +func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig { + cfg.BasePath = basePath + return cfg +} + +// WithSchemes overrides the default schemes, +// provided by the meta section of the spec file. +func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig { + cfg.Schemes = schemes + return cfg +} + +// Workflow is a client for workflow +type Workflow struct { + AppLog app_log.ClientService + + Cors cors.ClientService + + EmailMessage email_message.ClientService + + OutgoingEmailMessage outgoing_email_message.ClientService + + Transport runtime.ClientTransport +} + +// SetTransport changes the transport on the client and all its subresources +func (c *Workflow) SetTransport(transport runtime.ClientTransport) { + c.Transport = transport + c.AppLog.SetTransport(transport) + c.Cors.SetTransport(transport) + c.EmailMessage.SetTransport(transport) + c.OutgoingEmailMessage.SetTransport(transport) +} diff --git a/api/workflow/workflow_models/app_log.go b/api/workflow/workflow_models/app_log.go new file mode 100644 index 0000000..3be64e9 --- /dev/null +++ b/api/workflow/workflow_models/app_log.go @@ -0,0 +1,84 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// AppLog Application Log for human consumption +// +// swagger:model AppLog +type AppLog struct { + + // account ID + AccountID string `json:"AccountID,omitempty"` + + // company ID + CompanyID string `json:"CompanyID,omitempty"` + + // created by ID + CreatedByID string `json:"CreatedByID,omitempty"` + + // created date + CreatedDate string `json:"CreatedDate,omitempty"` + + // ID + ID string `json:"ID,omitempty"` + + // message + Message string `json:"Message,omitempty"` + + // object ID + ObjectID string `json:"ObjectID,omitempty"` + + // object type + ObjectType string `json:"ObjectType,omitempty"` + + // severity + Severity string `json:"Severity,omitempty"` + + // source + Source string `json:"Source,omitempty"` + + // source timestamp + SourceTimestamp string `json:"SourceTimestamp,omitempty"` +} + +// Validate validates this app log +func (m *AppLog) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this app log based on context it is used +func (m *AppLog) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *AppLog) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *AppLog) UnmarshalBinary(b []byte) error { + var res AppLog + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/app_log_request.go b/api/workflow/workflow_models/app_log_request.go new file mode 100644 index 0000000..4613e53 --- /dev/null +++ b/api/workflow/workflow_models/app_log_request.go @@ -0,0 +1,166 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "strconv" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// AppLogRequest An array Application Log objects +// +// swagger:model AppLogRequest +type AppLogRequest struct { + + // data + Data []*AppLog `json:"data"` + + // meta + Meta *RequestMeta `json:"meta,omitempty"` +} + +// Validate validates this app log request +func (m *AppLogRequest) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateData(formats); err != nil { + res = append(res, err) + } + + if err := m.validateMeta(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *AppLogRequest) validateData(formats strfmt.Registry) error { + if swag.IsZero(m.Data) { // not required + return nil + } + + for i := 0; i < len(m.Data); i++ { + if swag.IsZero(m.Data[i]) { // not required + continue + } + + if m.Data[i] != nil { + if err := m.Data[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *AppLogRequest) validateMeta(formats strfmt.Registry) error { + if swag.IsZero(m.Meta) { // not required + return nil + } + + if m.Meta != nil { + if err := m.Meta.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// ContextValidate validate this app log request based on the context it is used +func (m *AppLogRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + var res []error + + if err := m.contextValidateData(ctx, formats); err != nil { + res = append(res, err) + } + + if err := m.contextValidateMeta(ctx, formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *AppLogRequest) contextValidateData(ctx context.Context, formats strfmt.Registry) error { + + for i := 0; i < len(m.Data); i++ { + + if m.Data[i] != nil { + if err := m.Data[i].ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *AppLogRequest) contextValidateMeta(ctx context.Context, formats strfmt.Registry) error { + + if m.Meta != nil { + if err := m.Meta.ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// MarshalBinary interface implementation +func (m *AppLogRequest) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *AppLogRequest) UnmarshalBinary(b []byte) error { + var res AppLogRequest + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/app_log_response.go b/api/workflow/workflow_models/app_log_response.go new file mode 100644 index 0000000..da0f4a9 --- /dev/null +++ b/api/workflow/workflow_models/app_log_response.go @@ -0,0 +1,166 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "strconv" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// AppLogResponse An array Application Log objects +// +// swagger:model AppLogResponse +type AppLogResponse struct { + + // data + Data []*AppLog `json:"data"` + + // meta + Meta *ResponseMeta `json:"meta,omitempty"` +} + +// Validate validates this app log response +func (m *AppLogResponse) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateData(formats); err != nil { + res = append(res, err) + } + + if err := m.validateMeta(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *AppLogResponse) validateData(formats strfmt.Registry) error { + if swag.IsZero(m.Data) { // not required + return nil + } + + for i := 0; i < len(m.Data); i++ { + if swag.IsZero(m.Data[i]) { // not required + continue + } + + if m.Data[i] != nil { + if err := m.Data[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *AppLogResponse) validateMeta(formats strfmt.Registry) error { + if swag.IsZero(m.Meta) { // not required + return nil + } + + if m.Meta != nil { + if err := m.Meta.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// ContextValidate validate this app log response based on the context it is used +func (m *AppLogResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + var res []error + + if err := m.contextValidateData(ctx, formats); err != nil { + res = append(res, err) + } + + if err := m.contextValidateMeta(ctx, formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *AppLogResponse) contextValidateData(ctx context.Context, formats strfmt.Registry) error { + + for i := 0; i < len(m.Data); i++ { + + if m.Data[i] != nil { + if err := m.Data[i].ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *AppLogResponse) contextValidateMeta(ctx context.Context, formats strfmt.Registry) error { + + if m.Meta != nil { + if err := m.Meta.ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// MarshalBinary interface implementation +func (m *AppLogResponse) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *AppLogResponse) UnmarshalBinary(b []byte) error { + var res AppLogResponse + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/document.go b/api/workflow/workflow_models/document.go new file mode 100644 index 0000000..524d55e --- /dev/null +++ b/api/workflow/workflow_models/document.go @@ -0,0 +1,233 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// Document Document +// +// swagger:model Document +type Document struct { + + // archived by ID + ArchivedByID string `json:"ArchivedByID,omitempty"` + + // archived date + ArchivedDate string `json:"ArchivedDate,omitempty"` + + // author ID + AuthorID string `json:"AuthorID,omitempty"` + + // body + // Format: byte + Body strfmt.Base64 `json:"Body,omitempty"` + + // body length + BodyLength int64 `json:"BodyLength,omitempty"` + + // comment count + CommentCount int64 `json:"CommentCount,omitempty"` + + // connection ID + ConnectionID string `json:"ConnectionID,omitempty"` + + // content asset ID + ContentAssetID string `json:"ContentAssetID,omitempty"` + + // content modification date + ContentModificationDate string `json:"ContentModificationDate,omitempty"` + + // content size + ContentSize int64 `json:"ContentSize,omitempty"` + + // content type + ContentType string `json:"ContentType,omitempty"` + + // content version document ID + ContentVersionDocumentID string `json:"ContentVersionDocumentID,omitempty"` + + // contnet document ID + ContnetDocumentID string `json:"ContnetDocumentID,omitempty"` + + // created by ID + CreatedByID string `json:"CreatedByID,omitempty"` + + // created date + CreatedDate string `json:"CreatedDate,omitempty"` + + // d date + DDate string `json:"DDate,omitempty"` + + // description + Description string `json:"Description,omitempty"` + + // developer name + DeveloperName string `json:"DeveloperName,omitempty"` + + // discount + Discount float64 `json:"Discount,omitempty"` + + // document + // Format: byte + Document strfmt.Base64 `json:"Document,omitempty"` + + // document ID + DocumentID string `json:"DocumentID,omitempty"` + + // document sequence + DocumentSequence int64 `json:"DocumentSequence,omitempty"` + + // field + Field string `json:"Field,omitempty"` + + // file extension + FileExtension string `json:"FileExtension,omitempty"` + + // file type + FileType string `json:"FileType,omitempty"` + + // folder ID + FolderID string `json:"FolderID,omitempty"` + + // grand total + GrandTotal string `json:"GrandTotal,omitempty"` + + // ID + ID string `json:"ID,omitempty"` + + // inserted by ID + InsertedByID string `json:"InsertedByID,omitempty"` + + // is archived + IsArchived bool `json:"IsArchived,omitempty"` + + // is body searchable + IsBodySearchable bool `json:"IsBodySearchable,omitempty"` + + // is comment sub + IsCommentSub bool `json:"IsCommentSub,omitempty"` + + // is document sub + IsDocumentSub bool `json:"IsDocumentSub,omitempty"` + + // is internal use only + IsInternalUseOnly bool `json:"IsInternalUseOnly,omitempty"` + + // is public + IsPublic bool `json:"IsPublic,omitempty"` + + // is rich text + IsRichText bool `json:"IsRichText,omitempty"` + + // keywords + Keywords string `json:"Keywords,omitempty"` + + // last modified by ID + LastModifiedByID string `json:"LastModifiedByID,omitempty"` + + // last modified date + LastModifiedDate string `json:"LastModifiedDate,omitempty"` + + // last viewed date + LastViewedDate string `json:"LastViewedDate,omitempty"` + + // latst published version ID + LatstPublishedVersionID string `json:"LatstPublishedVersionID,omitempty"` + + // like count + LikeCount int64 `json:"LikeCount,omitempty"` + + // link URL + LinkURL string `json:"LinkURL,omitempty"` + + // linked entity ID + LinkedEntityID string `json:"LinkedEntityID,omitempty"` + + // name + Name string `json:"Name,omitempty"` + + // namespace prefix + NamespacePrefix string `json:"NamespacePrefix,omitempty"` + + // network scope + NetworkScope string `json:"NetworkScope,omitempty"` + + // owner ID + OwnerID string `json:"OwnerID,omitempty"` + + // parent ID + ParentID string `json:"ParentID,omitempty"` + + // publishstatus + Publishstatus string `json:"Publishstatus,omitempty"` + + // quote ID + QuoteID string `json:"QuoteID,omitempty"` + + // related record ID + RelatedRecordID string `json:"RelatedRecordID,omitempty"` + + // share type + ShareType string `json:"ShareType,omitempty"` + + // sharing option + SharingOption string `json:"SharingOption,omitempty"` + + // sharing privacy + SharingPrivacy string `json:"SharingPrivacy,omitempty"` + + // title + Title string `json:"Title,omitempty"` + + // type + Type string `json:"Type,omitempty"` + + // URL + URL string `json:"URL,omitempty"` + + // user ID + UserID string `json:"UserID,omitempty"` + + // visibility + Visibility string `json:"Visibility,omitempty"` +} + +// Validate validates this document +func (m *Document) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this document based on context it is used +func (m *Document) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *Document) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *Document) UnmarshalBinary(b []byte) error { + var res Document + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/email_message.go b/api/workflow/workflow_models/email_message.go new file mode 100644 index 0000000..2ad9cee --- /dev/null +++ b/api/workflow/workflow_models/email_message.go @@ -0,0 +1,203 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// EmailMessage email message +// +// swagger:model EmailMessage +type EmailMessage struct { + + // activity ID + ActivityID string `json:"ActivityID,omitempty"` + + // b c c address + BCCAddress string `json:"BCCAddress,omitempty"` + + // c c address + CCAddress string `json:"CCAddress,omitempty"` + + // created by ID + CreatedByID string `json:"CreatedByID,omitempty"` + + // created date + CreatedDate string `json:"CreatedDate,omitempty"` + + // email message ID + EmailMessageID string `json:"EmailMessageID,omitempty"` + + // from address + FromAddress string `json:"FromAddress,omitempty"` + + // from name + FromName string `json:"FromName,omitempty"` + + // HTML + // Format: byte + HTML strfmt.Base64 `json:"HTML,omitempty"` + + // has attachment + HasAttachment bool `json:"HasAttachment,omitempty"` + + // headers + Headers *Headers `json:"Headers,omitempty"` + + // ID + ID string `json:"ID,omitempty"` + + // incoming + Incoming bool `json:"Incoming,omitempty"` + + // is client managed + IsClientManaged bool `json:"IsClientManaged,omitempty"` + + // is externally managed + IsExternallyManaged bool `json:"IsExternallyManaged,omitempty"` + + // last modified by ID + LastModifiedByID string `json:"LastModifiedByID,omitempty"` + + // last modified date + LastModifiedDate string `json:"LastModifiedDate,omitempty"` + + // message date + MessageDate string `json:"MessageDate,omitempty"` + + // message identifier + MessageIdentifier string `json:"MessageIdentifier,omitempty"` + + // parent ID + ParentID string `json:"ParentID,omitempty"` + + // related to ID + RelatedToID string `json:"RelatedToID,omitempty"` + + // relation address + RelationAddress string `json:"RelationAddress,omitempty"` + + // relation ID + RelationID string `json:"RelationID,omitempty"` + + // relation object type + RelationObjectType string `json:"RelationObjectType,omitempty"` + + // relation type + RelationType string `json:"RelationType,omitempty"` + + // reply to email message ID + ReplyToEmailMessageID string `json:"ReplyToEmailMessageID,omitempty"` + + // status + Status string `json:"Status,omitempty"` + + // subject + Subject string `json:"Subject,omitempty"` + + // text + // Format: byte + Text strfmt.Base64 `json:"Text,omitempty"` + + // thread identifier + ThreadIdentifier string `json:"ThreadIdentifier,omitempty"` + + // to address + ToAddress string `json:"ToAddress,omitempty"` + + // validated from address + ValidatedFromAddress string `json:"ValidatedFromAddress,omitempty"` +} + +// Validate validates this email message +func (m *EmailMessage) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateHeaders(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *EmailMessage) validateHeaders(formats strfmt.Registry) error { + if swag.IsZero(m.Headers) { // not required + return nil + } + + if m.Headers != nil { + if err := m.Headers.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("Headers") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("Headers") + } + return err + } + } + + return nil +} + +// ContextValidate validate this email message based on the context it is used +func (m *EmailMessage) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + var res []error + + if err := m.contextValidateHeaders(ctx, formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *EmailMessage) contextValidateHeaders(ctx context.Context, formats strfmt.Registry) error { + + if m.Headers != nil { + if err := m.Headers.ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("Headers") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("Headers") + } + return err + } + } + + return nil +} + +// MarshalBinary interface implementation +func (m *EmailMessage) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *EmailMessage) UnmarshalBinary(b []byte) error { + var res EmailMessage + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/email_message_request.go b/api/workflow/workflow_models/email_message_request.go new file mode 100644 index 0000000..0e196be --- /dev/null +++ b/api/workflow/workflow_models/email_message_request.go @@ -0,0 +1,166 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "strconv" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// EmailMessageRequest An array Send Email Message objects +// +// swagger:model EmailMessageRequest +type EmailMessageRequest struct { + + // data + Data []*EmailMessage `json:"data"` + + // meta + Meta *RequestMeta `json:"meta,omitempty"` +} + +// Validate validates this email message request +func (m *EmailMessageRequest) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateData(formats); err != nil { + res = append(res, err) + } + + if err := m.validateMeta(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *EmailMessageRequest) validateData(formats strfmt.Registry) error { + if swag.IsZero(m.Data) { // not required + return nil + } + + for i := 0; i < len(m.Data); i++ { + if swag.IsZero(m.Data[i]) { // not required + continue + } + + if m.Data[i] != nil { + if err := m.Data[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *EmailMessageRequest) validateMeta(formats strfmt.Registry) error { + if swag.IsZero(m.Meta) { // not required + return nil + } + + if m.Meta != nil { + if err := m.Meta.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// ContextValidate validate this email message request based on the context it is used +func (m *EmailMessageRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + var res []error + + if err := m.contextValidateData(ctx, formats); err != nil { + res = append(res, err) + } + + if err := m.contextValidateMeta(ctx, formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *EmailMessageRequest) contextValidateData(ctx context.Context, formats strfmt.Registry) error { + + for i := 0; i < len(m.Data); i++ { + + if m.Data[i] != nil { + if err := m.Data[i].ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *EmailMessageRequest) contextValidateMeta(ctx context.Context, formats strfmt.Registry) error { + + if m.Meta != nil { + if err := m.Meta.ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// MarshalBinary interface implementation +func (m *EmailMessageRequest) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *EmailMessageRequest) UnmarshalBinary(b []byte) error { + var res EmailMessageRequest + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/email_messages_response.go b/api/workflow/workflow_models/email_messages_response.go new file mode 100644 index 0000000..b13a678 --- /dev/null +++ b/api/workflow/workflow_models/email_messages_response.go @@ -0,0 +1,166 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "strconv" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// EmailMessagesResponse An array user objects +// +// swagger:model EmailMessagesResponse +type EmailMessagesResponse struct { + + // data + Data []*EmailMessage `json:"data"` + + // meta + Meta *ResponseMeta `json:"meta,omitempty"` +} + +// Validate validates this email messages response +func (m *EmailMessagesResponse) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateData(formats); err != nil { + res = append(res, err) + } + + if err := m.validateMeta(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *EmailMessagesResponse) validateData(formats strfmt.Registry) error { + if swag.IsZero(m.Data) { // not required + return nil + } + + for i := 0; i < len(m.Data); i++ { + if swag.IsZero(m.Data[i]) { // not required + continue + } + + if m.Data[i] != nil { + if err := m.Data[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *EmailMessagesResponse) validateMeta(formats strfmt.Registry) error { + if swag.IsZero(m.Meta) { // not required + return nil + } + + if m.Meta != nil { + if err := m.Meta.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// ContextValidate validate this email messages response based on the context it is used +func (m *EmailMessagesResponse) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + var res []error + + if err := m.contextValidateData(ctx, formats); err != nil { + res = append(res, err) + } + + if err := m.contextValidateMeta(ctx, formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *EmailMessagesResponse) contextValidateData(ctx context.Context, formats strfmt.Registry) error { + + for i := 0; i < len(m.Data); i++ { + + if m.Data[i] != nil { + if err := m.Data[i].ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *EmailMessagesResponse) contextValidateMeta(ctx context.Context, formats strfmt.Registry) error { + + if m.Meta != nil { + if err := m.Meta.ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// MarshalBinary interface implementation +func (m *EmailMessagesResponse) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *EmailMessagesResponse) UnmarshalBinary(b []byte) error { + var res EmailMessagesResponse + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/error.go b/api/workflow/workflow_models/error.go new file mode 100644 index 0000000..22342e6 --- /dev/null +++ b/api/workflow/workflow_models/error.go @@ -0,0 +1,60 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// Error error +// +// swagger:model Error +type Error struct { + + // code + Code int32 `json:"Code,omitempty"` + + // fields + Fields string `json:"Fields,omitempty"` + + // message + Message string `json:"Message,omitempty"` +} + +// Validate validates this error +func (m *Error) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this error based on context it is used +func (m *Error) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *Error) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *Error) UnmarshalBinary(b []byte) error { + var res Error + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/headers.go b/api/workflow/workflow_models/headers.go new file mode 100644 index 0000000..17c36d6 --- /dev/null +++ b/api/workflow/workflow_models/headers.go @@ -0,0 +1,57 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// Headers headers +// +// swagger:model Headers +type Headers struct { + + // key + Key string `json:"Key,omitempty"` + + // values + Values [][]string `json:"Values"` +} + +// Validate validates this headers +func (m *Headers) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this headers based on context it is used +func (m *Headers) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *Headers) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *Headers) UnmarshalBinary(b []byte) error { + var res Headers + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/outgoing_email_message.go b/api/workflow/workflow_models/outgoing_email_message.go new file mode 100644 index 0000000..10cf51d --- /dev/null +++ b/api/workflow/workflow_models/outgoing_email_message.go @@ -0,0 +1,153 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// OutgoingEmailMessage A new email message to be sent +// +// swagger:model OutgoingEmailMessage +type OutgoingEmailMessage struct { + + // b c c address + BCCAddress string `json:"BCCAddress,omitempty"` + + // c c address + CCAddress string `json:"CCAddress,omitempty"` + + // email message ID + EmailMessageID string `json:"EmailMessageID,omitempty"` + + // email template ID + EmailTemplateID string `json:"EmailTemplateID,omitempty"` + + // external ID + ExternalID string `json:"ExternalID,omitempty"` + + // from contact ID + FromContactID string `json:"FromContactID,omitempty"` + + // from name + FromName string `json:"FromName,omitempty"` + + // HTML + HTML string `json:"HTML,omitempty"` + + // headers + Headers *Headers `json:"Headers,omitempty"` + + // ID + ID string `json:"ID,omitempty"` + + // subject + Subject string `json:"Subject,omitempty"` + + // text + Text string `json:"Text,omitempty"` + + // to address + ToAddress string `json:"ToAddress,omitempty"` + + // to name + ToName string `json:"ToName,omitempty"` + + // validated from address + ValidatedFromAddress string `json:"ValidatedFromAddress,omitempty"` + + // who ID + WhoID string `json:"WhoID,omitempty"` +} + +// Validate validates this outgoing email message +func (m *OutgoingEmailMessage) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateHeaders(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *OutgoingEmailMessage) validateHeaders(formats strfmt.Registry) error { + if swag.IsZero(m.Headers) { // not required + return nil + } + + if m.Headers != nil { + if err := m.Headers.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("Headers") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("Headers") + } + return err + } + } + + return nil +} + +// ContextValidate validate this outgoing email message based on the context it is used +func (m *OutgoingEmailMessage) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + var res []error + + if err := m.contextValidateHeaders(ctx, formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *OutgoingEmailMessage) contextValidateHeaders(ctx context.Context, formats strfmt.Registry) error { + + if m.Headers != nil { + if err := m.Headers.ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("Headers") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("Headers") + } + return err + } + } + + return nil +} + +// MarshalBinary interface implementation +func (m *OutgoingEmailMessage) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *OutgoingEmailMessage) UnmarshalBinary(b []byte) error { + var res OutgoingEmailMessage + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/outgoing_email_message_request.go b/api/workflow/workflow_models/outgoing_email_message_request.go new file mode 100644 index 0000000..df1c1d1 --- /dev/null +++ b/api/workflow/workflow_models/outgoing_email_message_request.go @@ -0,0 +1,166 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + "strconv" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// OutgoingEmailMessageRequest An array New Email Message objects +// +// swagger:model OutgoingEmailMessageRequest +type OutgoingEmailMessageRequest struct { + + // data + Data []*OutgoingEmailMessage `json:"data"` + + // meta + Meta *RequestMeta `json:"meta,omitempty"` +} + +// Validate validates this outgoing email message request +func (m *OutgoingEmailMessageRequest) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateData(formats); err != nil { + res = append(res, err) + } + + if err := m.validateMeta(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *OutgoingEmailMessageRequest) validateData(formats strfmt.Registry) error { + if swag.IsZero(m.Data) { // not required + return nil + } + + for i := 0; i < len(m.Data); i++ { + if swag.IsZero(m.Data[i]) { // not required + continue + } + + if m.Data[i] != nil { + if err := m.Data[i].Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *OutgoingEmailMessageRequest) validateMeta(formats strfmt.Registry) error { + if swag.IsZero(m.Meta) { // not required + return nil + } + + if m.Meta != nil { + if err := m.Meta.Validate(formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// ContextValidate validate this outgoing email message request based on the context it is used +func (m *OutgoingEmailMessageRequest) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + var res []error + + if err := m.contextValidateData(ctx, formats); err != nil { + res = append(res, err) + } + + if err := m.contextValidateMeta(ctx, formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *OutgoingEmailMessageRequest) contextValidateData(ctx context.Context, formats strfmt.Registry) error { + + for i := 0; i < len(m.Data); i++ { + + if m.Data[i] != nil { + if err := m.Data[i].ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("data" + "." + strconv.Itoa(i)) + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("data" + "." + strconv.Itoa(i)) + } + return err + } + } + + } + + return nil +} + +func (m *OutgoingEmailMessageRequest) contextValidateMeta(ctx context.Context, formats strfmt.Registry) error { + + if m.Meta != nil { + if err := m.Meta.ContextValidate(ctx, formats); err != nil { + if ve, ok := err.(*errors.Validation); ok { + return ve.ValidateName("meta") + } else if ce, ok := err.(*errors.CompositeError); ok { + return ce.ValidateName("meta") + } + return err + } + } + + return nil +} + +// MarshalBinary interface implementation +func (m *OutgoingEmailMessageRequest) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *OutgoingEmailMessageRequest) UnmarshalBinary(b []byte) error { + var res OutgoingEmailMessageRequest + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/request_meta.go b/api/workflow/workflow_models/request_meta.go new file mode 100644 index 0000000..0d9a846 --- /dev/null +++ b/api/workflow/workflow_models/request_meta.go @@ -0,0 +1,75 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/errors" + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" + "github.com/go-openapi/validate" +) + +// RequestMeta request meta +// +// swagger:model RequestMeta +type RequestMeta struct { + + // Account Number of the Reseller or OEM + // Required: true + TaxnexusAccount *string `json:"TaxnexusAccount"` +} + +// Validate validates this request meta +func (m *RequestMeta) Validate(formats strfmt.Registry) error { + var res []error + + if err := m.validateTaxnexusAccount(formats); err != nil { + res = append(res, err) + } + + if len(res) > 0 { + return errors.CompositeValidationError(res...) + } + return nil +} + +func (m *RequestMeta) validateTaxnexusAccount(formats strfmt.Registry) error { + + if err := validate.Required("TaxnexusAccount", "body", m.TaxnexusAccount); err != nil { + return err + } + + return nil +} + +// ContextValidate validates this request meta based on context it is used +func (m *RequestMeta) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *RequestMeta) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *RequestMeta) UnmarshalBinary(b []byte) error { + var res RequestMeta + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/workflow/workflow_models/response_meta.go b/api/workflow/workflow_models/response_meta.go new file mode 100644 index 0000000..5c0346b --- /dev/null +++ b/api/workflow/workflow_models/response_meta.go @@ -0,0 +1,84 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2020 by Taxnexus, Inc. +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package workflow_models + +// This file was generated by the swagger tool. +// Editing this file might prove futile when you re-run the swagger generate command + +import ( + "context" + + "github.com/go-openapi/strfmt" + "github.com/go-openapi/swag" +) + +// ResponseMeta response meta +// +// swagger:model ResponseMeta +type ResponseMeta struct { + + // Microservice Contact Info + Contact string `json:"Contact,omitempty"` + + // Copyright Info + Copyright string `json:"Copyright,omitempty"` + + // License Information and Restrictions + License string `json:"License,omitempty"` + + // Operation ID + OperationID string `json:"OperationID,omitempty"` + + // Request IP Address + RequestIP string `json:"RequestIP,omitempty"` + + // Request Type + RequestType string `json:"RequestType,omitempty"` + + // Request URL + RequestURL string `json:"RequestURL,omitempty"` + + // Data Server Info + ServerInfo string `json:"ServerInfo,omitempty"` + + // Data Server Response Time (ms) + ServerResponseTime string `json:"ServerResponseTime,omitempty"` + + // Backend Server Timestamp + ServerTimestamp string `json:"ServerTimestamp,omitempty"` + + // Account Number used for recording transactions + TaxnexusAccount string `json:"TaxnexusAccount,omitempty"` +} + +// Validate validates this response meta +func (m *ResponseMeta) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this response meta based on context it is used +func (m *ResponseMeta) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *ResponseMeta) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *ResponseMeta) UnmarshalBinary(b []byte) error { + var res ResponseMeta + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/swagger/auth-vernonkeenan.yaml b/swagger/auth-work.yaml similarity index 98% rename from swagger/auth-vernonkeenan.yaml rename to swagger/auth-work.yaml index 83e4bde..2697bb1 100644 --- a/swagger/auth-vernonkeenan.yaml +++ b/swagger/auth-work.yaml @@ -3,9 +3,9 @@ info: version: 0.3.0 title: "auth" description: "Authentication Microservice" - termsOfService: "https://salesforcedevops.net/terms/" + termsOfService: "https://workdifferentwithai.com/terms/" contact: - email: "vern@vernonkeenan.com" + email: "vern@workdifferentwithai.com" license: name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" securityDefinitions: @@ -18,7 +18,7 @@ security: schemes: - "http" basePath: "/v1" -host: "auth.vernonkeenan.com:8080" +host: "auth.work.tnxs.net:8080" consumes: - "application/json" produces: @@ -327,7 +327,7 @@ definitions: type: array type: object UserResponse: - description: An array Taxnexus user objects + description: An array user objects properties: Data: items: diff --git a/swagger/external/auth-vernonkeenan.yaml b/swagger/external/auth-work.yaml similarity index 98% rename from swagger/external/auth-vernonkeenan.yaml rename to swagger/external/auth-work.yaml index 47683d6..5ccef5d 100644 --- a/swagger/external/auth-vernonkeenan.yaml +++ b/swagger/external/auth-work.yaml @@ -3,9 +3,9 @@ info: version: 0.3.0 title: "auth" description: "Authentication Microservice" - termsOfService: "https://salesforcedevops.net/terms/" + termsOfService: "https://workdifferentwithai.com/terms/" contact: - email: "vern@vernonkeenan.com" + email: "vern@workdifferentwithai.com" license: name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" securityDefinitions: @@ -18,7 +18,7 @@ security: schemes: - "https" basePath: "/vk/auth/v1" -host: "gw.tnxs.net" +host: "auth.work.tnxs.net:8080" consumes: - "application/json" produces: @@ -327,7 +327,7 @@ definitions: type: array type: object UserResponse: - description: An array Taxnexus user objects + description: An array user objects properties: Data: items: diff --git a/swagger/external/crm-vernonkeenan.yaml b/swagger/external/crm-vernonkeenan.yaml deleted file mode 100644 index f800c53..0000000 --- a/swagger/external/crm-vernonkeenan.yaml +++ /dev/null @@ -1,822 +0,0 @@ -swagger: "2.0" -info: - version: 0.3.4 - title: "crm" - description: "Customer Information Microservice" - termsOfService: "https://salesforcedevops.net/terms/" - contact: - email: "vern@vernonkeenan.com" - license: - name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" -securityDefinitions: - ApiKeyAuth: - type: "apiKey" - in: "header" - name: "X-API-Key" -schemes: - - "https" -basePath: "/vk/crm/v1" -host: "gw.tnxs.net" -consumes: - - "application/json" -produces: - - "application/json" -parameters: - accountIdQuery: - description: Record Id of an Account - in: query - name: accountId - required: false - type: string - assetIdQuery: - description: Record Id of an Asset - in: query - name: assetId - required: false - type: string - accountRequest: - description: An array of new Account records - in: body - name: accountRequest - required: true - schema: - $ref: "#/definitions/AccountRequest" - assetRequest: - description: An array of new Asset records - in: body - name: assetRequest - required: true - schema: - $ref: "#/definitions/AssetRequest" - activeQuery: - description: Only retrieve active records? - in: query - name: active - required: false - type: boolean - companyIdQuery: - description: Company record ID - in: query - name: companyId - required: false - type: string - leadIdQuery: - description: Lead record ID - in: query - name: leadId - required: false - type: string - contactIdQuery: - description: Contact record ID - in: query - name: contactId - required: false - type: string - contractIdQuery: - description: Contact record ID - in: query - name: contractId - required: false - type: string - emailQuery: - description: Email address used for identity lookup - in: query - name: email - required: false - type: string - contactRequest: - description: An array of new Contact records - in: body - name: contactsRequest - required: true - schema: - $ref: "#/definitions/ContactRequest" - contractRequest: - description: An array of new Contract records - in: body - name: contractsRequest - required: true - schema: - $ref: "#/definitions/ContractRequest" - leadRequest: - description: An array of new Lead records - in: body - name: leadRequest - required: true - schema: - $ref: "#/definitions/LeadRequest" - limitQuery: - description: "How many objects to return at one time" - format: int64 - in: query - name: limit - required: false - type: integer - nameQuery: - description: The Name of this Object - in: query - name: name - required: false - type: string - offsetQuery: - description: How many objects to skip? - format: int64 - in: query - name: offset - required: false - type: integer - slugQuery: - description: The Slug of this Object - in: query - name: slug - required: false - type: string - typeQuery: - description: The Type of this Object - in: query - name: type - required: false - type: string -responses: - AccessForbidden: - description: "Access forbidden, account lacks access" - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - AccountResponse: - description: Response with Account objects with Contacts - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/AccountResponse" - AssetResponse: - description: Response with Asset objects with Contacts - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/AssetResponse" - Conflict: - description: Conflict - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - ContactResponse: - description: Response with an array of Contact objects - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/ContactResponse" - ContractResponse: - description: Response with an array of Contract objects - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/ContractResponse" - LeadResponse: - description: Response with an array of Lead objects - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/LeadResponse" - DeleteResponse: - description: Response with Message Objects with Delete Status - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/DeleteResponse" - InvalidDataError: - headers: - Access-Control-Allow-Origin: - type: string - description: Invalid data was sent - schema: - $ref: "#/definitions/InvalidError" - NotFound: - description: Resource was not found - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - ServerError: - description: Server Internal Error - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - Unauthorized: - description: "Access unauthorized, invalid API-KEY was used" - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - UnprocessableEntity: - description: "Unprocessable Entity, likely a bad parameter" - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" -paths: - /accounts: - delete: - description: Delete SalesforceDevops.net Account record - operationId: deleteAccount - parameters: - - $ref: "#/parameters/accountIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An Account - tags: - - Accounts - get: - description: Return a list of all available Accounts - operationId: getAccounts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/nameQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/accountIdQuery" - - $ref: "#/parameters/slugQuery" - responses: - "200": - $ref: "#/responses/AccountResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of accounts - tags: - - Accounts - post: - description: Account record to be added - operationId: postAccounts - parameters: - - $ref: "#/parameters/accountRequest" - responses: - "200": - $ref: "#/responses/AccountResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new account to SalesforceDevops.net - tags: - - Accounts - put: - description: Update one or more accounts - operationId: putAccounts - parameters: - - $ref: "#/parameters/accountRequest" - responses: - "200": - $ref: "#/responses/AccountResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update a single account - tags: - - Accounts - /assets: - delete: - description: Delete SalesforceDevops.net Asset record - operationId: deleteAsset - parameters: - - $ref: "#/parameters/assetIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An Asset - tags: - - Assets - get: - description: Return a list of all available Assets - operationId: getAssets - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/accountIdQuery" - - $ref: "#/parameters/assetIdQuery" - responses: - "200": - $ref: "#/responses/AssetResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of assets - tags: - - Assets - post: - description: Asset record to be added - operationId: postAssets - parameters: - - $ref: "#/parameters/assetRequest" - responses: - "200": - $ref: "#/responses/AssetResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new asset to SalesforceDevops.net - tags: - - Assets - put: - description: Update a single asset specified by assetId - operationId: putAsset - parameters: - - $ref: "#/parameters/assetRequest" - responses: - "200": - $ref: "#/responses/AssetResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update a single asset - tags: - - Assets - /contracts: - delete: - description: Delete SalesforceDevops.net Contract record - operationId: deleteContract - parameters: - - $ref: "#/parameters/contractIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An Contract - tags: - - Contracts - get: - description: Return a list of all available Contracts - operationId: getContracts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/contractIdQuery" - responses: - "200": - $ref: "#/responses/ContractResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of contracts - tags: - - Contracts - post: - description: Contract record to be added - operationId: postContracts - parameters: - - $ref: "#/parameters/contractRequest" - responses: - "200": - $ref: "#/responses/ContractResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new contract to SalesforceDevops.net - tags: - - Contracts - put: - description: Update a single contract specified by contractId - operationId: putContract - parameters: - - $ref: "#/parameters/contractRequest" - responses: - "200": - $ref: "#/responses/ContractResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update a single contract - tags: - - Contracts - /contacts: - delete: - description: Delete SalesforceDevops.net Contact record - operationId: deleteContact - parameters: - - $ref: "#/parameters/contactIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete a Contact - tags: - - Contacts - get: - description: Return a list of all available Contacts - operationId: getContacts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/contactIdQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/slugQuery" - - $ref: "#/parameters/emailQuery" - responses: - "200": - $ref: "#/responses/ContactResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of contacts - tags: - - Contacts - post: - description: Contact record to be added - operationId: postContacts - parameters: - - $ref: "#/parameters/contactRequest" - responses: - "200": - $ref: "#/responses/ContactResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add new contacts - tags: - - Contacts - put: - description: Update Contact records - operationId: putContacts - parameters: - - $ref: "#/parameters/contactRequest" - responses: - "200": - $ref: "#/responses/ContactResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Contact - tags: - - Contacts - /leads: - delete: - description: Delete SalesforceDevops.net Lead record - operationId: deleteLead - parameters: - - $ref: "#/parameters/leadIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete a Contact - tags: - - Leads - get: - description: Return a list of all available Leads - operationId: getLeads - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/leadIdQuery" - - $ref: "#/parameters/emailQuery" - - $ref: "#/parameters/nameQuery" - responses: - "200": - $ref: "#/responses/LeadResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of contacts - tags: - - Leads - post: - description: Lead records to be added - operationId: postLeads - parameters: - - $ref: "#/parameters/leadRequest" - responses: - "200": - $ref: "#/responses/LeadResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add new Leads - tags: - - Leads - put: - description: Update Lead records - operationId: putLeads - parameters: - - $ref: "#/parameters/leadRequest" - responses: - "200": - $ref: "#/responses/LeadResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Leads - tags: - - Leads -definitions: - AccountRequest: - description: An array of Account objects with Contacts - properties: - Data: - items: - $ref: "../../lib/swagger/defs/account.yaml#/Account" - type: array - type: object - AccountResponse: - description: An array of Account objects with Contacts - properties: - Data: - items: - $ref: "../../lib/swagger/defs/account.yaml#/Account" - type: array - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - type: object - AssetRequest: - description: An array of Asset objects with Contacts - properties: - Data: - items: - $ref: "../../lib/swagger/defs/asset.yaml#/Asset" - type: array - type: object - AssetResponse: - description: An array of Asset objects with Contacts - properties: - Data: - items: - $ref: "../../lib/swagger/defs/asset.yaml#/Asset" - type: array - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - type: object - ContactRequest: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/contact.yaml#/Contact" - type: array - type: object - ContactResponse: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/contact.yaml#/Contact" - type: array - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - type: object - ContractRequest: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/contract.yaml#/Contract" - type: array - type: object - ContractResponse: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/contract.yaml#/Contract" - type: array - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - type: object - DeleteResponse: - $ref: "../../lib/swagger/defs/delete-response.yaml#/DeleteResponse" - Error: - $ref: "../../lib/swagger/defs/error.yaml#/Error" - InvalidError: - $ref: "../../lib/swagger/defs/invalid-error.yaml#/InvalidError" - LeadRequest: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/lead.yaml#/Lead" - type: array - type: object - LeadResponse: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/lead.yaml#/Lead" - type: array - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - type: object - Message: - $ref: "../../lib/swagger/defs/message.yaml#/Message" - RequestMeta: - $ref: "../../lib/swagger/defs/request-meta.yaml#/RequestMeta" diff --git a/swagger/external/devops-vernonkeenan.yaml b/swagger/external/devops-vernonkeenan.yaml deleted file mode 100644 index 5cf05b5..0000000 --- a/swagger/external/devops-vernonkeenan.yaml +++ /dev/null @@ -1,1820 +0,0 @@ -swagger: "2.0" -info: - version: 0.3.0 - title: "devops" - description: "System Operations Microservice" - termsOfService: "https://salesforcedevops.net/terms/" - contact: - email: "vern@vernonkeenan.com" - license: - name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" -securityDefinitions: - ApiKeyAuth: - type: "apiKey" - in: "header" - name: "X-API-Key" -schemes: - - "https" -basePath: "/vk/devops/v1" -host: "gw.tnxs.net" -consumes: - - "application/json" -produces: - - "application/json" -parameters: - databaseIdQuery: - description: Record Id of a Database - in: query - name: databaseId - required: false - type: string - taxnexusAccountQuery: - description: Account of a Tenant - in: query - name: taxnexusAccount - required: false - type: string - tenantIdQuery: - description: Record Id of a Tenant - in: query - name: tenantId - required: false - type: string - tenantRequest: - description: An array of Tenant records - in: body - name: TenantRequest - required: true - schema: - $ref: "#/definitions/TenantRequest" - databaseRequest: - description: An array of Database records - in: body - name: DatabaseRequest - required: true - schema: - $ref: "#/definitions/DatabaseRequest" - X-API-Key: - name: X-API-Key - in: "header" - required: true - type: string - ClusterRequest: - description: An array of Cluster records - in: body - name: ClusterRequest - required: true - schema: - $ref: "#/definitions/ClusterRequest" - TemplateRequest: - description: An array of Template records - in: body - name: TemplateRequest - required: true - schema: - $ref: "#/definitions/TemplateRequest" - UserRequest: - description: An array of User records - in: body - name: UserRequest - required: true - schema: - $ref: "#/definitions/UserRequest" - accountIdQuery: - description: Record Id of an Account - in: query - name: accountId - required: false - type: string - contactIdQuery: - description: Record Id of a Contact - in: query - name: contactId - required: false - type: string - accountNumberQuery: - description: The Taxnexus Account Number of the Account to be used a record - retrieval - in: query - name: accountNumber - required: false - type: string - activeQuery: - description: Retrieve active records only? - in: query - name: active - required: false - type: boolean - apiKeyQuery: - description: Service account or developer API key - in: query - name: apikey - type: string - clusterIdPath: - description: Record Id of a Cluster - in: path - name: clusterIdPath - type: string - required: true - databaseIdPath: - description: Record Id of a Database - in: path - name: databaseIdPath - type: string - required: true - clusterIdQuery: - description: Record Id of a Cluster - in: query - name: clusterId - required: false - type: string - companyIdQuery: - description: Record Id of a Company - in: query - name: companyId - required: false - type: string - ingestIdPath: - description: Record Id of a Ingest - in: path - name: ingestIdPath - type: string - required: true - ingestIdQuery: - description: Record Id of an Ingest - in: query - name: ingestId - required: false - type: string - jobIdPath: - description: Record Id of a Job - in: path - name: jobIdPath - type: string - required: true - jobIdQuery: - description: Record Id of a Job - in: query - name: jobId - required: false - type: string - limitQuery: - description: "How many objects to return at one time" - format: int64 - in: query - name: limit - required: false - type: integer - offsetQuery: - description: How many objects to skip? (default 0) - format: int64 - in: query - name: offset - required: false - type: integer - serviceIdPath: - description: Record Id of a Service - in: path - name: serviceIdPath - type: string - required: true - serviceIdQuery: - description: Service ID - in: query - name: serviceId - type: string - templateIdPath: - description: Record Id of a Template - in: path - name: templateIdPath - type: string - required: true - templateIdQuery: - description: Template ID - in: query - name: templateId - type: string - objectTypeQuery: - description: Object Type Name - in: query - name: objectType - type: string - isMasterQuery: - description: Is Master Template? - in: query - name: isMaster - type: boolean - userIdPath: - description: Record Id of a User - in: path - name: userIdPath - type: string - required: true - tenantIdPath: - description: Record Id of a Tenant - in: path - name: tenantIdPath - type: string - required: true - userIdQuery: - description: User ID (unique) - in: query - name: userId - type: string - emailQuery: - description: Email Address (not unique) - in: query - name: email - type: string - usernameQuery: - description: Username (unique) - in: query - name: username - type: string - userRequest: - description: An array of user records - in: body - name: UserRequest - required: true - schema: - $ref: "#/definitions/UserRequest" -responses: - AccessForbidden: - description: "Access forbidden, account lacks access" - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - ClusterSingletonResponse: - description: Single Cluster record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/Cluster" - ClusterObservableResponse: - description: Single Cluster record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - type: array - items: - $ref: "#/definitions/Cluster" - ClusterResponse: - description: Response with Cluster objects - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/ClusterResponse" - DeveopsDeleteResponse: - description: Response with Message Objects with Delete Status - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/DeleteResponse" - NotFound: - headers: - Access-Control-Allow-Origin: - type: string - description: Resource was not found - schema: - $ref: "#/definitions/Error" - DatabaseResponse: - headers: - Access-Control-Allow-Origin: - type: string - description: Response with Database objects - schema: - $ref: "#/definitions/DatabaseResponse" - DatabaseSingletonResponse: - description: Single Database record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/Database" - DatabaseObservableResponse: - description: Single Database record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - type: array - items: - $ref: "#/definitions/Database" - TenantResponse: - headers: - Access-Control-Allow-Origin: - type: string - description: Response with Tenant objects - schema: - $ref: "#/definitions/TenantResponse" - TenantSingletonResponse: - description: Single Tenant record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/Tenant" - TenantObservableResponse: - description: Single Tenant record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - type: array - items: - $ref: "#/definitions/Tenant" - ServerError: - headers: - Access-Control-Allow-Origin: - type: string - description: Server Internal Error - schema: - $ref: "#/definitions/Error" - TemplateResponse: - description: Response with Template objects - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/TemplateResponse" - TemplateSingletonResponse: - description: Single Template record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/Template" - TemplateObservableResponse: - description: Simple Template record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - type: array - items: - $ref: "#/definitions/Template" - Unauthorized: - description: "Access Unauthorized, invalid API-KEY was used" - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/Error" - UnprocessableEntity: - description: "Unprocessable Entity, likely a bad parameter" - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/Error" - UserResponse: - description: Response with User objects - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/UserResponse" - UserSingletonResponse: - description: Single User record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - $ref: "#/definitions/User" - UserObservableResponse: - description: Simple User record response - headers: - Access-Control-Allow-Origin: - type: string - Cache-Control: - type: string - schema: - type: array - items: - $ref: "#/definitions/User" - CORSResponse: - description: CORS OPTIONS response - headers: - Access-Control-Allow-Origin: - type: string - Access-Control-Allow-Headers: - type: string - Access-Control-Allow-Methods: - type: string - Access-Control-Expose-Headers: - type: string - Access-Control-Max-Age: - type: string - Access-Control-Allow-Credentials: - type: string - Cache-Control: - type: string -paths: - /clusters: - get: - description: Return a list of Cluster records from the datastore - operationId: getClusters - parameters: - - $ref: "#/parameters/clusterIdQuery" - - $ref: "#/parameters/companyIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Clusters - tags: - - Cluster - options: - description: CORS support - operationId: clustersOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - post: - description: Create Clusters in Taxnexus - operationId: postClusters - parameters: - - $ref: "#/parameters/ClusterRequest" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Clusters - tags: - - Cluster - put: - description: Update Cluster in Taxnexus - operationId: putClusters - parameters: - - $ref: "#/parameters/ClusterRequest" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Clustera - tags: - - Cluster - /clusters/observable: - get: - description: Returns a Cluster retrieval in a observable array - operationId: getClustersObservable - responses: - "200": - $ref: "#/responses/ClusterObservableResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Clusters in an observable array - tags: - - Cluster - options: - description: CORS support - operationId: clusterOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - "/clusters/{clusterIdPath}": - get: - description: Return a single Cluster object from datastore as a Singleton - operationId: getCluster - parameters: - - $ref: "#/parameters/clusterIdPath" - responses: - "200": - $ref: "#/responses/ClusterSingletonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a single Cluster object - tags: - - Cluster - /databases: - get: - description: Return a list of Database records from the datastore - operationId: getDatabases - parameters: - - $ref: "#/parameters/databaseIdQuery" - - $ref: "#/parameters/companyIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Databases - tags: - - Database - options: - description: CORS support - operationId: databasesOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - post: - description: Create Databases in Taxnexus - operationId: postDatabases - parameters: - - $ref: "#/parameters/databaseRequest" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Databases - tags: - - Database - put: - description: Update Database in Taxnexus - operationId: putDatabases - parameters: - - $ref: "#/parameters/databaseRequest" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Databases - tags: - - Database - /databases/observable: - get: - description: Returns a Database retrieval in a observable array - operationId: getDatabasesObservable - responses: - "200": - $ref: "#/responses/DatabaseObservableResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Databases in an observable array - tags: - - Database - options: - description: CORS support - operationId: databaseOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - "/databases/{databaseIdPath}": - get: - description: Return a single Database object from datastore as a Singleton - operationId: getDatabase - parameters: - - $ref: "#/parameters/databaseIdPath" - responses: - "200": - $ref: "#/responses/DatabaseSingletonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a single Database object - tags: - - Database - /templates: - get: - description: Return a list of Templates from the datastore - operationId: getTemplates - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/templateIdQuery" - - $ref: "#/parameters/isMasterQuery" - - $ref: "#/parameters/objectTypeQuery" - responses: - "200": - $ref: "#/responses/TemplateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Templates - tags: - - Template - options: - description: CORS support - operationId: templatesOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - post: - description: Create new Templates - operationId: postTemplates - parameters: - - $ref: "#/parameters/TemplateRequest" - responses: - "200": - $ref: "#/responses/TemplateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Templates - tags: - - Template - /templates/observable: - get: - description: Returns a Template retrieval in a observable array - operationId: getTemplatesObservable - responses: - "200": - $ref: "#/responses/TemplateObservableResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Templates in an observable array - tags: - - Template - options: - description: CORS support - operationId: templateOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - "/templates/{templateIdPath}": - get: - description: Return a single Template object from datastore as a Singleton - operationId: getTemplate - parameters: - - $ref: "#/parameters/templateIdPath" - responses: - "200": - $ref: "#/responses/TemplateSingletonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a single Template object - tags: - - Template - /tenants: - get: - description: Return a list of Tenant records from the datastore - operationId: getTenants - parameters: - - $ref: "#/parameters/taxnexusAccountQuery" - - $ref: "#/parameters/tenantIdQuery" - - $ref: "#/parameters/companyIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Tenants - tags: - - Tenant - options: - description: CORS support - operationId: tenantsOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - post: - description: Create Tenants in Taxnexus - operationId: postTenants - parameters: - - $ref: "#/parameters/tenantRequest" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Tenants - tags: - - Tenant - put: - description: Update Tenant in Taxnexus - operationId: putTenants - parameters: - - $ref: "#/parameters/tenantRequest" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Tenants - tags: - - Tenant - /tenants/observable: - get: - description: Returns a Tenant retrieval in a observable array - operationId: getTenantsObservable - responses: - "200": - $ref: "#/responses/TenantObservableResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Tenants in an observable array - tags: - - Tenant - options: - description: CORS support - operationId: tenantOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - "/tenants/{tenantIdPath}": - get: - description: Return a single Tenant object from datastore as a Singleton - operationId: getTenant - parameters: - - $ref: "#/parameters/tenantIdPath" - responses: - "200": - $ref: "#/responses/TenantSingletonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a single Tenant object - tags: - - Tenant - /users: - get: - description: Return a list of User records from the datastore - operationId: getUsers - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/accountIdQuery" - - $ref: "#/parameters/contactIdQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/emailQuery" - - $ref: "#/parameters/userIdQuery" - - $ref: "#/parameters/usernameQuery" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Users - tags: - - User - options: - description: CORS support - operationId: usersOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - post: - description: Create new Users - operationId: postUsers - parameters: - - $ref: "#/parameters/UserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Users - tags: - - User - put: - description: Update existing users - operationId: putUsers - parameters: - - $ref: "#/parameters/UserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update existing users - tags: - - User - /users/observable: - get: - description: Returns a User retrieval in a observable array - operationId: getUsersObservable - responses: - "200": - $ref: "#/responses/UserObservableResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Users in an observable array - tags: - - User - options: - description: CORS support - operationId: userOptions - responses: - "200": - $ref: "#/responses/CORSResponse" - tags: - - cors - "/users/{userIdPath}": - get: - description: Return a single User object from datastore as a Singleton - operationId: getUser - parameters: - - $ref: "#/parameters/userIdPath" - responses: - "200": - $ref: "#/responses/UserSingletonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a single User object - tags: - - User -definitions: - Address: - properties: - City: - description: City - type: string - Country: - description: Country full name - type: string - CountryCode: - description: Country Code - type: string - PostalCode: - description: Postal Code - type: string - State: - description: State full name - type: string - StateCode: - description: State Code - type: string - Street: - description: Street number and name - type: string - type: object - Cluster: - properties: - CreatedByID: - description: Created By - type: string - CreatedDate: - description: Created Date - type: string - Description: - description: Description - type: string - Environment: - description: Environment - type: string - Gateway: - description: Gateway - type: string - ID: - description: Record Id - type: string - IPAddress: - description: IP Address - type: string - LastModifiedByID: - description: Last Modified By - type: string - LastModifiedDate: - description: Last Modified Date - type: string - Name: - description: Cluster Name - type: string - OwnerID: - description: Owner - type: string - Ref: - description: External Reference - type: string - Status: - description: Status - type: string - Subnet: - description: Subnet - type: string - TenantID: - description: The ID of the tenant who owns this Database - type: string - Type: - description: Type - type: string - Zone: - description: Zone - type: string - type: object - ClusterRequest: - properties: - Data: - items: - $ref: "#/definitions/Cluster" - type: array - type: object - ClusterResponse: - description: An array of cluster objects - properties: - Data: - items: - $ref: "#/definitions/Cluster" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Database: - description: A Database provisioned and owned by a Tenant - properties: - Active: - description: Is this database active? - type: boolean - ClusterID: - description: The ID of the Cluster in which this database is deployed - type: string - CreatedByID: - description: Created By - type: string - CreatedDate: - description: Created Date - type: string - DSN: - description: Database connection string - type: string - DatabaseName: - description: The name of the physical database in the cluster - type: string - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By - type: string - LastModifiedDate: - description: Last Modifed Date - type: string - Status: - description: The current status of this Tenant - type: string - TenantID: - description: The ID of the tenant who owns this Database - type: string - Type: - description: The type of Database (mysql, etc) - type: string - type: object - DatabaseRequest: - description: An array of Database objects - properties: - Data: - items: - $ref: "#/definitions/Database" - type: array - type: object - DatabaseResponse: - description: An array of Database objects - properties: - Data: - items: - $ref: "#/definitions/Database" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - DeleteResponse: - properties: - Data: - items: - $ref: "#/definitions/Message" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Error: - properties: - code: - format: int64 - type: integer - fields: - type: string - message: - type: string - type: object - Message: - properties: - Message: - type: string - Ref: - type: string - Status: - type: integer - type: object - Pagination: - properties: - Limit: - format: int64 - type: integer - POffset: - format: int64 - type: integer - PageSize: - format: int64 - type: integer - SetSize: - format: int64 - type: integer - type: object - RequestMeta: - properties: - TaxnexusAccount: - description: Account Number of the Reseller or OEM - type: string - required: - - TaxnexusAccount - type: object - ResponseMeta: - properties: - Contact: - description: Microservice Contact Info - type: string - Copyright: - description: Copyright Info - type: string - License: - description: License Information and Restrictions - type: string - OperationID: - description: Operation ID - type: string - Pagination: - $ref: "#/definitions/Pagination" - RequestIP: - description: Request IP Address - type: string - RequestType: - description: Request Type - type: string - RequestURL: - description: Request URL - type: string - ServerInfo: - description: Data Server Info - type: string - ServerResponseTime: - description: Data Server Response Time (ms) - type: string - ServerTimestamp: - description: Backend Server Timestamp - type: string - TaxnexusAccount: - description: Account Number used for recording transactions - type: string - type: object - Role: - description: A functional role within a Tenant - properties: - Auth0RoleID: - description: The corresponding Auth0 Role - type: string - CreatedByID: - description: Created By - type: string - CreatedDate: - description: Created Date - type: string - Description: - description: Role Description - type: string - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By - type: string - LastModifiedDate: - description: Last Modifed Date - type: string - RoleName: - description: The name of this role - type: string - TenantID: - description: The ID of the Tenant that owns this Role - type: string - type: object - RoleRequest: - description: An array of Role objects - properties: - Date: - items: - $ref: "#/definitions/Role" - type: array - type: object - RoleResponse: - description: An array of Role objects - properties: - Data: - items: - $ref: "#/definitions/Role" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Template: - properties: - CompanyID: - description: Company - type: string - CreatedByID: - type: string - CreatedDate: - type: string - Description: - description: Description - type: string - HTML: - description: HTML Body - format: byte - type: string - ID: - description: Record Id - type: string - IsActive: - description: Active? - type: boolean - IsMaster: - description: Master Template? - type: boolean - LastModifiedByID: - type: string - LastModifiedDate: - type: string - Name: - description: Template Name - type: string - ObjectType: - description: Object - type: string - RecordTypeName: - description: Record Type Name - type: string - TenantID: - description: Tenant that owns this object instance - type: string - Type: - description: Type - type: string - URL: - description: URL - type: string - type: object - TemplateRequest: - description: An array of Templates - properties: - Data: - items: - $ref: "#/definitions/Template" - type: array - type: object - TemplateResponse: - description: An array of Templates - properties: - Data: - items: - $ref: "#/definitions/Template" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Tenant: - description: Account Tenant - properties: - AccountID: - description: The Account that owns this Tenant - type: string - Active: - description: Is this Tenant currently active? - type: boolean - CreatedByID: - description: Created By - type: string - CreatedDate: - description: Created Date - type: string - Databases: - items: - $ref: "#/definitions/Database" - type: array - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By - type: string - LastModifiedDate: - description: Last Modifed Date - type: string - Roles: - items: - $ref: "#/definitions/Role" - type: array - Status: - description: The current status of this Tenant - type: string - TenantName: - description: Name of the Tenant Resource - type: string - TenantUsers: - items: - $ref: "#/definitions/TenantUser" - type: array - Type: - description: The type of Tenant - type: string - Version: - description: The version number of the Tenant Onboarding system used to create this tenant - type: string - type: object - TenantRequest: - description: An array of Tenant objects - properties: - Data: - items: - $ref: "#/definitions/Tenant" - type: array - type: object - TenantResponse: - description: An array of Tenant objects - properties: - Data: - items: - $ref: "#/definitions/Tenant" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - TenantUser: - description: Relationship object that connects users to a tenant - properties: - AccessLevel: - description: The makeTenantUser access level for this User - type: string - AccountID: - description: Account ID - type: string - Auth0UserID: - description: Auth0 User ID - type: string - CompanyName: - description: Account Name - type: string - ContactID: - description: Contact ID - type: string - TaxnexusAccount: - description: Account - type: string - TenantActive: - description: Tenant active? - type: boolean - TenantID: - description: The Tenant ID - type: string - TenantName: - description: Tenant Name - type: string - TenantStatus: - description: Tenant Status - type: string - TenantType: - description: Tenant type - type: string - TenantVersion: - description: Tenant Version - type: string - UserEmail: - description: User Email Address - type: string - UserFullName: - description: User Full Name - type: string - UserID: - description: The User ID - type: string - Username: - description: Username - type: string - type: object - User: - properties: - APIKey: - description: API Key - type: string - AboutMe: - description: About Me - type: string - AccountID: - description: Account ID - type: string - Address: - $ref: "#/definitions/Address" - Alias: - description: Alias - type: string - Auth0UserID: - description: Auth0 User Id - type: string - CommunityNickname: - description: Nickname - type: string - CompanyName: - description: Company Name - type: string - ContactID: - description: Contact - type: string - CreatedByID: - description: Created User ID - type: string - CreatedDate: - description: Date Created - type: string - DelegatedApproverID: - description: Delegated Approver - type: string - Department: - description: Department - type: string - Division: - description: Division - type: string - Email: - description: Email address - type: string - EmployeeNumber: - description: Employee Number - type: string - EndOfDay: - description: Time day ends - type: string - Environment: - description: Environment - type: string - Extension: - description: Extension - type: string - FabricAPIKey: - description: Fabric API Key - type: string - Fax: - description: Fax - type: string - FirstName: - description: The first name - type: string - ForecastEnabled: - description: Allow Forecasting - type: boolean - FullPhotoURL: - description: Full Photo URL - type: string - ID: - description: Record ID - type: string - IsActive: - description: Active - type: boolean - IsPortalEnabled: - description: Is the user enabled for Communities? - type: boolean - IsProphilePhotoActive: - description: Has Profile Photo - type: boolean - IsSystemControlled: - type: boolean - LastIP: - description: IP address of last login - type: string - LastLogin: - description: Last login time - type: string - LastModifiedByID: - description: Last Modified User ID - type: string - LastModifiedDate: - description: Last Modified Date - type: string - LastName: - description: The Last Name - type: string - LoginCount: - description: Number of times user has logged in - format: int64 - type: number - ManagerID: - description: Manager - type: string - MobilePhone: - description: Mobile - type: string - Name: - description: Name - type: string - OutOfOfficeMessage: - description: Out of office message - type: string - Phone: - description: Phone - type: string - PortalRole: - description: Portal Role Level - type: string - ProfileID: - description: Profile - type: string - ReceivesAdminEmails: - description: Info Emails - type: boolean - ReceivesAdminInfoEmails: - description: Admin Info Emails - type: boolean - SenderEmail: - description: Email Sender Address - type: string - SenderName: - description: Email Sender Name - type: string - Signature: - description: Email Signature - type: string - SmallPhotoURL: - description: Small Photo URL - type: string - StartOfDay: - description: The time day starts - type: string - TaxnexusAccount: - description: Account - type: string - TenantID: - description: Tenant ID associated with this user - type: string - TenantUsers: - items: - $ref: "#/definitions/TenantUser" - type: array - TimeZone: - description: Time Zone - type: string - Title: - description: Title - type: string - UserRoleID: - description: Role - type: string - UserRoles: - items: - $ref: "#/definitions/UserRole" - type: array - UserType: - description: User Type - type: string - Username: - description: Username - type: string - type: object - UserRequest: - properties: - Data: - items: - $ref: "#/definitions/User" - type: array - type: object - UserResponse: - description: An array of Print-Ready ingest Objects - properties: - Data: - items: - $ref: "#/definitions/User" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - UserRole: - description: Relationship object that connects user to a role - properties: - AccountID: - description: Account Id - type: string - Auth0RoleID: - description: Linked role ID - type: string - Auth0UserID: - description: Auth0 User ID - type: string - CompanyName: - description: Company Name - type: string - ContactID: - description: Contact ID - type: string - RoleDescription: - description: Role description - type: string - RoleID: - description: The Role ID - type: string - RoleName: - description: Role Name - type: string - TaxnexusAccount: - description: Account Number - type: string - UserEmail: - description: User Email Address - type: string - UserFullName: - description: User Full Name - type: string - UserID: - description: The User ID - type: string - Username: - description: Username - type: string - type: object diff --git a/swagger/external/members-vernonkeenan.yaml b/swagger/external/members-vernonkeenan.yaml deleted file mode 100644 index 92cb895..0000000 --- a/swagger/external/members-vernonkeenan.yaml +++ /dev/null @@ -1,3826 +0,0 @@ -swagger: "2.0" -info: - version: 0.3.0 - title: "members" - description: "Membership Microservice" - termsOfService: "https://salesforcedevops.net/terms/" - contact: - email: "vern@salesforcedevops.net" - license: - name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" -securityDefinitions: - ApiKeyAuth: - type: "apiKey" - in: "header" - name: "X-API-Key" -schemes: - - "https" -basePath: "/vk/members/v1" -host: "gw.tnxs.net" -consumes: - - "application/json" -produces: - - "application/json" -parameters: - Auth0UserIdHeader: - description: Auth0 User Id - in: header - name: X-Auth0-UserId - required: false - type: string - AttendeeRequest: - description: An array of new Attendee records - in: body - name: attendeeRequest - required: true - schema: - $ref: "#/definitions/AttendeeRequest" - CertificateRequest: - description: An array of new Certificate records - in: body - name: certificateRequest - required: true - schema: - $ref: "#/definitions/CertificateRequest" - CourseLessonRequest: - description: An array of new CourseLesson records - in: body - name: courselessonRequest - required: true - schema: - $ref: "#/definitions/CourseLessonRequest" - clusterIdQuery: - description: Record Id of a Cluster - in: query - name: clusterId - required: false - type: string - ClusterRequest: - description: An array of Cluster records - in: body - name: ClusterRequest - required: true - schema: - $ref: "#/definitions/ClusterRequest" - CourseRequest: - description: An array of new Course records - in: body - name: courseRequest - required: true - schema: - $ref: "#/definitions/CourseRequest" - CourseSectionRequest: - description: An array of new CourseSection records - in: body - name: coursesectionRequest - required: true - schema: - $ref: "#/definitions/CourseSectionRequest" - OutgoingEmailMessageRequest: - description: An array of new Outgoing Email Message records - in: body - name: OutgoingEmailMessageRequest - required: true - schema: - $ref: "#/definitions/OutgoingEmailMessageRequest" - EnrollmentRequest: - description: An array of new Enrollment records - in: body - name: enrollmentRequest - required: true - schema: - $ref: "#/definitions/EnrollmentRequest" - EventRequest: - description: An array of new Event records - in: body - name: eventRequest - required: true - schema: - $ref: "#/definitions/EventRequest" - EventCategoryRequest: - description: An array of new Event records - in: body - name: eventCategoryRequest - required: true - schema: - $ref: "#/definitions/EventCategoryRequest" - FavoriteRequest: - description: An array of new Favorite records - in: body - name: favoriteRequest - required: true - schema: - $ref: "#/definitions/FavoriteRequest" - InvoiceRequest: - description: An array of new Invoice records - in: body - name: invoiceRequest - required: true - schema: - $ref: "#/definitions/InvoiceRequest" - IssuedCertificateRequest: - description: An array of new IssuedCertificate records - in: body - name: issuedCertificateRequest - required: true - schema: - $ref: "#/definitions/IssuedCertificateRequest" - LessonProgressRequest: - description: An array of new LessonProgress records - in: body - name: lessonprogressRequest - required: true - schema: - $ref: "#/definitions/LessonProgressRequest" - OrderRequest: - description: An array of new Order records - in: body - name: orderRequest - required: true - schema: - $ref: "#/definitions/OrderRequest" - PaymentMethodRequest: - description: An array of new PaymentMethod records - in: body - name: paymentMethodRequest - required: true - schema: - $ref: "#/definitions/PaymentMethodRequest" - PromptRequest: - description: An array of new Prompt records - in: body - name: promptRequest - required: true - schema: - $ref: "#/definitions/PromptRequest" - PromptCategoryRequest: - description: An array of PromptCategory objects - name: promptCategoryRequest - required: true - in: body - schema: - $ref: "#/definitions/PromptCategoryRequest" - PromptTagRequest: - description: An array of PromptTag objects - name: promptTagRequest - required: true - in: body - schema: - $ref: "#/definitions/PromptTagRequest" - PromptAnswerRequest: - description: An array of PromptAnswer objects - name: promptAnswerRequest - required: true - in: body - schema: - $ref: "#/definitions/PromptAnswerRequest" - ResearchProjectCompanyRequest: - description: An array of new ResearchProjectCompany records - in: body - name: researchProjectCompanyRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectCompanyRequest" - researchProjectProductRequest: - description: An array of new ResearchProjectProduct records - in: body - name: researchProjectProductRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectProductRequest" - ResearchProjectServiceRequest: - description: An array of new ResearchProjectService records - in: body - name: researchProjectServiceRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectServiceRequest" - ResearchProjectDocumentRequest: - description: An array of new ResearchProjectDocument records - in: body - name: researchProjectDocumentRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectDocumentRequest" - ResearchProjectRequest: - description: An array of new ResearchProject records - in: body - name: researchProjectRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectRequest" - ResearchProjectTopicRequest: - description: An array of new ResearchProjectTopic records - in: body - name: researchProjectTopicRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectTopicRequest" - templateIdQuery: - description: Template ID - in: query - name: templateId - type: string - TemplateRequest: - description: An array of Template records - in: body - name: TemplateRequest - required: true - schema: - $ref: "#/definitions/TemplateRequest" - EmailMessageRequest: - description: An array of Email Message records - in: body - name: EmailMessageRequest - required: true - schema: - $ref: "#/definitions/EmailMessageRequest" - TenantRequest: - description: An array of Tenant records - in: body - name: TenantRequest - required: true - schema: - $ref: "#/definitions/TenantRequest" - TicketRequest: - description: An array of new Ticket records - in: body - name: ticketRequest - required: true - schema: - $ref: "#/definitions/TicketRequest" - TransactionRequest: - description: An array of new Transaction records - in: body - name: transactionRequest - required: true - schema: - $ref: "#/definitions/TransactionRequest" - UserRequest: - description: An array of User records - in: body - name: UserRequest - required: true - schema: - $ref: "#/definitions/UserRequest" - WebhookClerkRequest: - description: An array of new WebhookClerk records - in: body - name: webhookclerkRequest - required: true - schema: - $ref: "#/definitions/WebhookClerkRequest" - activeQuery: - description: Retrieve active records only? - in: query - name: active - required: false - type: boolean - auth0UserIdQuery: - description: External Auth0 User ID - in: query - name: auth0UserId - required: false - type: string - userIdQuery: - description: Internal User ID - in: query - name: userId - required: false - type: string - userIdQueryRequired: - description: Internal User ID - in: query - name: userId - required: true - type: string - contactIdQuery: - description: Internal Contact ID (links to Account) - in: query - name: contactId - required: false - type: string - databaseIdQuery: - description: Record Id of a Database - in: query - name: databaseId - type: string - required: true - databaseRequest: - description: An array of Database records - in: body - name: DatabaseRequest - required: true - schema: - $ref: "#/definitions/DatabaseRequest" - documentRequest: - description: An array of Document records - in: body - name: DocumentRequest - required: true - schema: - $ref: "#/definitions/DocumentRequest" - emailMessageIdQuery: - description: Email Message ID - in: query - name: emailMessageId - type: string - emailQuery: - description: Email address - in: query - name: email - required: false - type: string - idQuery: - description: Unique Record ID - in: query - name: id - required: false - type: string - objectTypeQuery: - description: Object Type Name - in: query - name: objectType - type: string - isMasterQuery: - description: Is Master Template? - in: query - name: isMaster - type: boolean - limitQuery: - description: How many objects to return at one time - format: int64 - in: query - name: limit - required: false - type: integer - offsetQuery: - description: How many objects to skip? - format: int64 - in: query - name: offset - required: false - type: integer -responses: - AccessForbidden: - description: Access forbidden, account lacks access - headers: - Access-Control-Allow-Origin: - type: string - x-nullable: true - schema: - $ref: "../../lib/swagger/defs/error.yaml#/Error" - AttendeeResponse: - description: Attendee Response Object - schema: - $ref: "#/definitions/AttendeeResponse" - CertificateResponse: - description: Certificate Response Object - schema: - $ref: "#/definitions/CertificateResponse" - ClusterResponse: - description: Response with Cluster objects - schema: - $ref: "#/definitions/ClusterResponse" - CourseLessonResponse: - description: CourseLesson Response Object - schema: - $ref: "#/definitions/CourseLessonResponse" - CourseResponse: - description: Course Response Object - schema: - $ref: "#/definitions/CourseResponse" - CourseSectionResponse: - description: CourseSection Response Object - schema: - $ref: "#/definitions/CourseSectionResponse" - DatabaseResponse: - description: Response with Database objects - schema: - $ref: "#/definitions/DatabaseResponse" - DocumentResponse: - description: Document Response Object - schema: - $ref: "#/definitions/DocumentResponse" - EmailMessagesResponse: - description: "Array of Email Messages" - schema: - $ref: "#/definitions/EmailMessagesResponse" - OutgoingEmailMessagesResponse: - description: "Array of Outgoing Email Messages" - schema: - $ref: "#/definitions/OutgoingEmailMessagesResponse" - EnrollmentResponse: - description: Enrollment Response Object - schema: - $ref: "#/definitions/EnrollmentResponse" - EventResponse: - description: Event Response Object - schema: - $ref: "#/definitions/EventResponse" - EventCategoryResponse: - description: Event Response Object - schema: - $ref: "#/definitions/EventCategoryResponse" - FavoriteResponse: - description: Favorite Response Object - schema: - $ref: "#/definitions/FavoriteResponse" - InvoiceResponse: - description: Invoice Response Object - schema: - $ref: "#/definitions/InvoiceResponse" - IssuedCertificateResponse: - description: IssuedCertificate Response Object - schema: - $ref: "#/definitions/IssuedCertificateResponse" - LessonProgressResponse: - description: LessonProgress Response Object - schema: - $ref: "#/definitions/LessonProgressResponse" - NotFound: - description: Resource was not found - schema: - $ref: "../../lib/swagger/defs/error.yaml#/Error" - OrderResponse: - description: Order Response Object - schema: - $ref: "#/definitions/OrderResponse" - PaymentMethodResponse: - description: PaymentMethod Response Object - schema: - $ref: "#/definitions/PaymentMethodResponse" - PromptResponse: - description: Response with Prompt objects - schema: - $ref: "#/definitions/PromptResponse" - PromptCategoryResponse: - description: Response with PromptCategory objects - schema: - $ref: "#/definitions/PromptCategoryResponse" - PromptAnswerResponse: - description: Response with PromptAnswer objects - schema: - $ref: "#/definitions/PromptAnswerResponse" - PromptTagResponse: - description: Response with PromptTag objects - schema: - $ref: "#/definitions/PromptTagResponse" - ResearchProjectCompanyResponse: - description: ResearchProjectCompany Response Object - schema: - $ref: "#/definitions/ResearchProjectCompanyResponse" - ResearchProjectDocumentResponse: - description: ResearchProjectDocument Response Object - schema: - $ref: "#/definitions/ResearchProjectDocumentResponse" - ResearchProjectProductResponse: - description: ResearchProjectProduct Response Object - schema: - $ref: "#/definitions/ResearchProjectProductResponse" - ResearchProjectServiceResponse: - description: ResearchProjectService Response Object - schema: - $ref: "#/definitions/ResearchProjectServiceResponse" - ResearchProjectResponse: - description: ResearchProject Response Object - schema: - $ref: "#/definitions/ResearchProjectResponse" - ResearchProjectTopicResponse: - description: ResearchProjectTopic Response Object - schema: - $ref: "#/definitions/ResearchProjectTopicResponse" - ServerError: - description: Server Internal Error - schema: - $ref: "../../lib/swagger/defs/error.yaml#/Error" - TenantResponse: - description: Response with Tenant objects - schema: - $ref: "#/definitions/TenantResponse" - TemplateResponse: - description: Response with Template objects - schema: - $ref: "#/definitions/TemplateResponse" - TicketResponse: - description: Ticket Response Object - schema: - $ref: "#/definitions/TicketResponse" - TransactionResponse: - description: Transaction Response Object - schema: - $ref: "#/definitions/TransactionResponse" - Unauthorized: - description: Access Unauthorized, invalid API-KEY was used - schema: - $ref: "../../lib/swagger/defs/error.yaml#/Error" - UnprocessableEntity: - description: Unprocessable Entity, likely a bad parameter - schema: - $ref: "../../lib/swagger/defs/error.yaml#/Error" - UserResponse: - description: Response with User objects - schema: - $ref: "#/definitions/UserResponse" - WebhookClerkResponse: - description: WebhookClerk Response Object - schema: - $ref: "#/definitions/WebhookClerkResponse" -paths: - /attendees: - get: - description: Return a list of Attendee records from the datastore - operationId: getAttendees - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/AttendeeResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Attendees - tags: - - Attendees - post: - description: Create Attendees - operationId: postAttendees - parameters: - - $ref: "#/parameters/AttendeeRequest" - responses: - "200": - $ref: "#/responses/AttendeeResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Attendees - tags: - - Attendees - put: - description: Update Attendee - operationId: putAttendees - parameters: - - $ref: "#/parameters/AttendeeRequest" - responses: - "200": - $ref: "#/responses/AttendeeResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Attendee - tags: - - Attendees - /certificates: - get: - description: Return a list of Certificate records from the datastore - operationId: getCertificates - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/CertificateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Certificates - tags: - - Certificates - post: - description: Create Certificates - operationId: postCertificates - parameters: - - $ref: "#/parameters/CertificateRequest" - responses: - "200": - $ref: "#/responses/CertificateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Certificates - tags: - - Certificates - put: - description: Update Certificate - operationId: putCertificates - parameters: - - $ref: "#/parameters/CertificateRequest" - responses: - "200": - $ref: "#/responses/CertificateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Certificate - tags: - - Certificates - /clusters: - get: - description: Return a list of Cluster records from the datastore - operationId: getClusters - parameters: - - $ref: "#/parameters/clusterIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Clusters - tags: - - Clusters - post: - description: Create Clusters - operationId: postClusters - parameters: - - $ref: "#/parameters/ClusterRequest" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Clusters - tags: - - Clusters - put: - description: Update Cluster - operationId: putClusters - parameters: - - $ref: "#/parameters/ClusterRequest" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Clustera - tags: - - Clusters - /courselessons: - get: - operationId: getCourseLessons - security: - - ApiKeyAuth: [] - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/CourseLessonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of CourseLessons - tags: - - Courses - post: - operationId: postCourseLessons - security: - - ApiKeyAuth: [] - parameters: - - $ref: "#/parameters/CourseLessonRequest" - responses: - "200": - $ref: "#/responses/CourseLessonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new CourseLesson - tags: - - Courses - put: - security: - - ApiKeyAuth: [] - operationId: updateCourseLessons - parameters: - - $ref: "#/parameters/CourseLessonRequest" - responses: - "200": - $ref: "#/responses/CourseLessonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Update an existing CourseLesson - tags: - - Courses - /courses: - get: - security: - - ApiKeyAuth: [] - operationId: getCourses - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/CourseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of Courses - tags: - - Courses - post: - security: - - ApiKeyAuth: [] - operationId: postCourses - parameters: - - $ref: "#/parameters/CourseRequest" - responses: - "200": - $ref: "#/responses/CourseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new Course - tags: - - Courses - put: - security: - - ApiKeyAuth: [] - operationId: updateCourses - parameters: - - $ref: "#/parameters/CourseRequest" - responses: - "200": - $ref: "#/responses/CourseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Update an existing Course - tags: - - Courses - /coursesections: - get: - security: - - ApiKeyAuth: [] - operationId: getCourseSections - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/CourseSectionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of CourseSections - tags: - - Courses - post: - security: - - ApiKeyAuth: [] - operationId: postCourseSections - parameters: - - $ref: "#/parameters/CourseSectionRequest" - responses: - "200": - $ref: "#/responses/CourseSectionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new CourseSection - tags: - - Courses - put: - security: - - ApiKeyAuth: [] - operationId: updateCourseSections - parameters: - - $ref: "#/parameters/CourseSectionRequest" - responses: - "200": - $ref: "#/responses/CourseSectionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Update an existing CourseSection - tags: - - Courses - /databases: - get: - description: Return a list of Database records from the datastore - operationId: getDatabases - parameters: - - $ref: "#/parameters/databaseIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Databases - tags: - - Databases - post: - description: Create Databases - operationId: postDatabases - parameters: - - $ref: "#/parameters/databaseRequest" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Databases - tags: - - Databases - put: - description: Update Database - operationId: putDatabases - parameters: - - $ref: "#/parameters/databaseRequest" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Databases - tags: - - Databases - /documents: - get: - description: Return a list of Document records from the datastore - operationId: getDocuments - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/DocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Documents - tags: - - Documents - post: - description: Create Documents - operationId: postDocuments - parameters: - - $ref: "#/parameters/documentRequest" - responses: - "200": - $ref: "#/responses/DocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Documents - tags: - - Documents - put: - description: Update Document - operationId: putDocuments - parameters: - - $ref: "#/parameters/documentRequest" - responses: - "200": - $ref: "#/responses/DocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Documents - tags: - - Documents - /emailmessages: - get: - security: - - ApiKeyAuth: [] - summary: "Get email messages from data store" - operationId: getEmailMessages - description: "Retrieves email messages from workflow storage" - parameters: - - $ref: "#/parameters/emailMessageIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - tags: - - Emails - responses: - "200": - $ref: "#/responses/EmailMessagesResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - post: - security: - - ApiKeyAuth: [] - summary: Add new email messages to the outgoing queue - operationId: postEmailMessages - description: Insert new email messages into workflow storage - parameters: - - $ref: "#/parameters/EmailMessageRequest" - responses: - "200": - $ref: "#/responses/EmailMessagesResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - tags: - - Emails - /outgoingemailmessages: - get: - security: - - ApiKeyAuth: [] - summary: "Get email messages from data store" - operationId: getOutgoingEmailMessages - description: "Retrieves email messages from workflow storage" - parameters: - - $ref: "#/parameters/emailMessageIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - tags: - - Emails - responses: - "200": - $ref: "#/responses/OutgoingEmailMessagesResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - post: - security: - - ApiKeyAuth: [] - summary: Add new email messages to the outgoing queue - operationId: postOutgoingEmailMessages - description: Insert new email messages into workflow storage - parameters: - - $ref: "#/parameters/OutgoingEmailMessageRequest" - responses: - "200": - $ref: "#/responses/OutgoingEmailMessagesResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - tags: - - Emails - /enrollments: - get: - description: Return a list of Enrollment records from the datastore - operationId: getEnrollments - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/EnrollmentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Enrollments - tags: - - Enrollments - post: - description: Create Enrollments - operationId: postEnrollments - parameters: - - $ref: "#/parameters/EnrollmentRequest" - responses: - "200": - $ref: "#/responses/EnrollmentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Enrollments - tags: - - Enrollments - put: - description: Update Enrollment - operationId: putEnrollments - parameters: - - $ref: "#/parameters/EnrollmentRequest" - responses: - "200": - $ref: "#/responses/EnrollmentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Enrollment - tags: - - Enrollments - /eventcategories: - get: - security: - - ApiKeyAuth: [] - operationId: getEventCategories - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/idQuery" - responses: - "200": - $ref: "#/responses/EventCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of Eventcategories - tags: - - Events - post: - security: - - ApiKeyAuth: [] - operationId: postEventCategories - parameters: - - $ref: "#/parameters/EventCategoryRequest" - responses: - "200": - $ref: "#/responses/EventCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new EventCategory - tags: - - Events - /events: - get: - security: - - ApiKeyAuth: [] - operationId: getEvents - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/idQuery" - responses: - "200": - $ref: "#/responses/EventResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of Events - tags: - - Events - post: - security: - - ApiKeyAuth: [] - operationId: postEvents - parameters: - - $ref: "#/parameters/EventRequest" - responses: - "200": - $ref: "#/responses/EventResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new Event - tags: - - Events - /favorites: - get: - description: Return a list of Favorite records from the datastore - operationId: getFavorites - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/FavoriteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Favorites - tags: - - Favorites - post: - description: Create Favorites - operationId: postFavorites - parameters: - - $ref: "#/parameters/FavoriteRequest" - responses: - "200": - $ref: "#/responses/FavoriteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Favorites - tags: - - Favorites - put: - description: Update Favorite - operationId: putFavorites - parameters: - - $ref: "#/parameters/FavoriteRequest" - responses: - "200": - $ref: "#/responses/FavoriteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Favorite - tags: - - Favorites - /invoices: - get: - description: Return a list of Invoice records from the datastore - operationId: getInvoices - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/InvoiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Invoices - tags: - - Invoices - post: - description: Create Invoices - operationId: postInvoices - parameters: - - $ref: "#/parameters/InvoiceRequest" - responses: - "200": - $ref: "#/responses/InvoiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Invoices - tags: - - Invoices - put: - description: Update Invoice - operationId: putInvoices - parameters: - - $ref: "#/parameters/InvoiceRequest" - responses: - "200": - $ref: "#/responses/InvoiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Invoice - tags: - - Invoices - /issuedcertificates: - get: - description: Return a list of IssuedCertificate records from the datastore - operationId: getIssuedCertificates - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/IssuedCertificateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list IssuedCertificates - tags: - - IssuedCertificates - post: - description: Create IssuedCertificates - operationId: postIssuedCertificates - parameters: - - $ref: "#/parameters/IssuedCertificateRequest" - responses: - "200": - $ref: "#/responses/IssuedCertificateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new IssuedCertificates - tags: - - IssuedCertificates - put: - description: Update IssuedCertificate - operationId: putIssuedCertificates - parameters: - - $ref: "#/parameters/IssuedCertificateRequest" - responses: - "200": - $ref: "#/responses/IssuedCertificateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update IssuedCertificate - tags: - - IssuedCertificates - /lessonprogress: - get: - description: Return a list of LessonProgress records from the datastore - operationId: getLessonProgresses - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/LessonProgressResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list LessonProgresses - tags: - - LessonProgress - post: - description: Create LessonProgresses - operationId: postLessonProgresses - parameters: - - $ref: "#/parameters/LessonProgressRequest" - responses: - "200": - $ref: "#/responses/LessonProgressResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new LessonProgresses - tags: - - LessonProgress - put: - description: Update LessonProgress - operationId: putLessonProgresses - parameters: - - $ref: "#/parameters/LessonProgressRequest" - responses: - "200": - $ref: "#/responses/LessonProgressResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update LessonProgress - tags: - - LessonProgress - /orders: - get: - description: Return a list of Order records from the datastore - operationId: getOrders - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/OrderResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Orders - tags: - - Orders - post: - description: Create Orders - operationId: postOrders - parameters: - - $ref: "#/parameters/OrderRequest" - responses: - "200": - $ref: "#/responses/OrderResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Orders - tags: - - Orders - put: - description: Update Order - operationId: putOrders - parameters: - - $ref: "#/parameters/OrderRequest" - responses: - "200": - $ref: "#/responses/OrderResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Order - tags: - - Orders - /paymentmethods: - get: - description: Return a list of PaymentMethod records from the datastore - operationId: getPaymentMethods - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PaymentMethodResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list PaymentMethods - tags: - - PaymentMethods - post: - description: Create PaymentMethods - operationId: postPaymentMethods - parameters: - - $ref: "#/parameters/PaymentMethodRequest" - responses: - "200": - $ref: "#/responses/PaymentMethodResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new PaymentMethods - tags: - - PaymentMethods - put: - description: Update PaymentMethod - operationId: putPaymentMethods - parameters: - - $ref: "#/parameters/PaymentMethodRequest" - responses: - "200": - $ref: "#/responses/PaymentMethodResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update PaymentMethod - tags: - - PaymentMethods - /prompts: - get: - description: Return a list of Prompt records from the datastore - operationId: getPrompts - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of Prompts - tags: - - Prompts - post: - description: Create Prompts - operationId: postPrompts - parameters: - - $ref: "#/parameters/PromptRequest" - responses: - "200": - $ref: "#/responses/PromptResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Prompts - tags: - - Prompts - put: - description: Update Prompt - operationId: putPrompts - parameters: - - $ref: "#/parameters/PromptRequest" - responses: - "200": - $ref: "#/responses/PromptResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Prompts - tags: - - Prompts - /promptanswers: - get: - description: Return a list of PromptAnswers records from the datastore - operationId: getPromptAnswers - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptAnswerResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of PromptResponses - tags: - - Prompts - post: - description: Create PromptAnswers - operationId: postPromptAnswers - parameters: - - $ref: "#/parameters/PromptAnswerRequest" - responses: - "200": - $ref: "#/responses/PromptAnswerResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new PromptResponses - tags: - - Prompts - put: - description: Update PromptAnswers - operationId: putPromptAnsweers - parameters: - - $ref: "#/parameters/PromptAnswerRequest" - responses: - "200": - $ref: "#/responses/PromptAnswerResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update PromptResponse - tags: - - Prompts - /promptcategories: - get: - description: Return a list of PromptCategory records from the datastore - operationId: getPromptCategories - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of PromptCategories - tags: - - Prompts - post: - description: Create PromptCategories - operationId: postPromptCategories - parameters: - - $ref: "#/parameters/PromptCategoryRequest" - responses: - "200": - $ref: "#/responses/PromptCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new PromptCategories - tags: - - Prompts - put: - description: Update PromptCategory - operationId: putPromptCategories - parameters: - - $ref: "#/parameters/PromptCategoryRequest" - responses: - "200": - $ref: "#/responses/PromptCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update PromptCategories - tags: - - Prompts - /prompttags: - get: - description: Return a list of PromptTag records from the datastore - operationId: getPromptTags - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptTagResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of PromptTags - tags: - - Prompts - post: - description: Create PromptTags in Taxnexus - operationId: postPromptTags - parameters: - - $ref: "#/parameters/PromptTagRequest" - responses: - "200": - $ref: "#/responses/PromptTagResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new PromptTags - tags: - - Prompts - put: - description: Update PromptTag in Taxnexus - operationId: putPromptTags - parameters: - - $ref: "#/parameters/PromptTagRequest" - responses: - "200": - $ref: "#/responses/PromptTagResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update PromptTags - tags: - - Prompts - /researchprojectcompanies: - get: - description: Return a list of ResearchProjectCompany records from the datastore - operationId: getResearchProjectCompanies - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectCompanies - tags: - - ResearchProjects - post: - description: Create ResearchProjectCompanies in the system - operationId: postResearchProjectCompanies - parameters: - - $ref: "#/parameters/Auth0UserIdHeader" - - $ref: "#/parameters/ResearchProjectCompanyRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectCompanies - tags: - - ResearchProjects - put: - description: Update ResearchProjectCompany in the system - operationId: putResearchProjectCompanies - parameters: - - $ref: "#/parameters/Auth0UserIdHeader" - - $ref: "#/parameters/ResearchProjectCompanyRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectCompanies - tags: - - ResearchProjects - /researchprojectdocuments: - get: - description: Return a list of ResearchProjectDocument records from the datastore - operationId: getResearchProjectDocuments - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectDocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectDocuments - tags: - - ResearchProjects - post: - description: Create ResearchProjectDocuments in the system - operationId: postResearchProjectDocuments - parameters: - - $ref: "#/parameters/ResearchProjectDocumentRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectDocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectDocuments - tags: - - ResearchProjects - put: - description: Update ResearchProjectDocument in the system - operationId: putResearchProjectDocuments - parameters: - - $ref: "#/parameters/ResearchProjectDocumentRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectDocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectDocuments - tags: - - ResearchProjects - /researchprojectservices: - get: - description: Return a list of ResearchProjectService records from the datastore - operationId: getResearchProjectServices - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectServices - tags: - - ResearchProjects - post: - description: Create ResearchProjectServices in the system - operationId: postResearchProjectServices - parameters: - - $ref: "#/parameters/ResearchProjectServiceRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectServiceResponse" - "201": - $ref: "#/responses/ResearchProjectServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectServices - tags: - - ResearchProjects - put: - description: Update ResearchProjectService in the system - operationId: putResearchProjectServices - parameters: - - $ref: "#/parameters/ResearchProjectServiceRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectServiceResponse" - "201": - $ref: "#/responses/ResearchProjectServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectServices - tags: - - ResearchProjects - - /researchprojectproducts: - get: - description: Return a list of ResearchProjectProduct records from the datastore - operationId: getResearchProjectProducts - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectProducts - tags: - - ResearchProjects - post: - description: Create ResearchProjectProducts in the system - operationId: postResearchProjectProducts - parameters: - - $ref: "#/parameters/researchProjectProductRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectProducts - tags: - - ResearchProjects - put: - description: Update ResearchProjectProduct in the system - operationId: putResearchProjectProducts - parameters: - - $ref: "#/parameters/researchProjectProductRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectProducts - tags: - - ResearchProjects - /researchprojects: - get: - description: Return a list of ResearchProject records from the datastore - operationId: getResearchProjects - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjects - tags: - - ResearchProjects - post: - description: Create ResearchProjects in the system - operationId: postResearchProjects - parameters: - - $ref: "#/parameters/ResearchProjectRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjects - tags: - - ResearchProjects - put: - description: Update ResearchProject in the system - operationId: putResearchProjects - parameters: - - $ref: "#/parameters/ResearchProjectRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjects - tags: - - ResearchProjects - /researchprojecttopics: - get: - description: Return a list of ResearchProjectTopic records from the datastore - operationId: getResearchProjectTopics - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectTopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectTopics - tags: - - ResearchProjects - post: - description: Create ResearchProjectTopics in the system - operationId: postResearchProjectTopics - parameters: - - $ref: "#/parameters/ResearchProjectTopicRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectTopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectTopics - tags: - - ResearchProjects - put: - description: Update ResearchProjectTopic in the system - operationId: putResearchProjectTopics - parameters: - - $ref: "#/parameters/ResearchProjectTopicRequest" - - $ref: "#/parameters/Auth0UserIdHeader" - responses: - "200": - $ref: "#/responses/ResearchProjectTopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectTopics - tags: - - ResearchProjects - /tenants: - get: - description: Return a list of Tenant records from the datastore - operationId: getTenants - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Tenants - tags: - - Tenants - post: - description: Create Tenants - operationId: postTenants - parameters: - - $ref: "#/parameters/TenantRequest" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Tenants - tags: - - Tenants - put: - description: Update Tenant - operationId: putTenants - parameters: - - $ref: "#/parameters/TenantRequest" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Tenants - tags: - - Tenants - /templates: - get: - description: Return a list of Templates from the datastore - operationId: getTemplates - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/templateIdQuery" - - $ref: "#/parameters/isMasterQuery" - - $ref: "#/parameters/objectTypeQuery" - responses: - "200": - $ref: "#/responses/TemplateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Templates - tags: - - Templates - post: - description: Create new Templates - operationId: postTemplates - parameters: - - $ref: "#/parameters/TemplateRequest" - responses: - "200": - $ref: "#/responses/TemplateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Templates - tags: - - Templates - /tickets: - get: - description: Return a list of Ticket records from the datastore - operationId: getTickets - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/TicketResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Tickets - tags: - - Tickets - post: - description: Create Tickets - operationId: postTickets - parameters: - - $ref: "#/parameters/TicketRequest" - responses: - "200": - $ref: "#/responses/TicketResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Tickets - tags: - - Tickets - put: - description: Update Ticket - operationId: putTickets - parameters: - - $ref: "#/parameters/TicketRequest" - responses: - "200": - $ref: "#/responses/TicketResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Ticket - tags: - - Tickets - /transactions: - get: - description: Return a list of Transaction records from the datastore - operationId: getTransactions - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/TransactionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of Transactions - tags: - - Transactions - post: - description: Create Transactions - operationId: postTransactions - parameters: - - $ref: "#/parameters/TransactionRequest" - responses: - "200": - $ref: "#/responses/TransactionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Transactions - tags: - - Transactions - put: - description: Update Transaction - operationId: putTransactions - parameters: - - $ref: "#/parameters/TransactionRequest" - responses: - "200": - $ref: "#/responses/TransactionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Transaction - tags: - - Transactions - /users/onboard: - post: - description: Async onboard new users - operationId: postUsersOnboard - parameters: - - $ref: "#/parameters/UserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Async onboard new users - tags: - - Users - /webhooks/clerk: - post: - description: Clerk webhook - operationId: postWebhooksClerk - parameters: - - $ref: "#/parameters/WebhookClerkRequest" - responses: - "201": - $ref: "#/responses/WebhookClerkResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Clerk webhook - tags: - - Webhooks - /users: - get: - description: Return a list of User records from the datastore - operationId: getUsers - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/emailQuery" - - $ref: "#/parameters/auth0UserIdQuery" - - $ref: "#/parameters/userIdQuery" - - $ref: "#/parameters/contactIdQuery" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Users - tags: - - Users - post: - description: Create new Users - operationId: postUsers - parameters: - - $ref: "#/parameters/UserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Users - tags: - - Users - put: - description: Update existing users - operationId: putUsers - parameters: - - $ref: "#/parameters/UserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update existing users - tags: - - Users -definitions: - AttendeeRequest: - description: An array of Attendee objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/attendee.yaml#/Attendee" - type: array - type: object - AttendeeResponse: - description: An array of Attendee objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/attendee.yaml#/Attendee" - type: array - type: object - CertificateRequest: - description: An array of Certificate objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/certificate.yaml#/Certificate" - type: array - type: object - CertificateResponse: - description: An array of Certificate objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/certificate.yaml#/Certificate" - type: array - type: object - ClusterRequest: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/cluster.yaml#/Cluster" - type: array - type: object - ClusterResponse: - description: An array of cluster objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/cluster.yaml#/Cluster" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CourseLessonRequest: - description: An array of CourseLesson objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course-lesson.yaml#/CourseLesson" - type: array - type: object - CourseLessonResponse: - description: An array of CourseLesson objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course-lesson.yaml#/CourseLesson" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CourseRequest: - description: An array of Course objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course.yaml#/Course" - type: array - type: object - CourseResponse: - description: An array of Course objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/course.yaml#/Course" - type: array - type: object - CourseSectionRequest: - description: An array of CourseSection objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course-section.yaml#/CourseSection" - type: array - type: object - CourseSectionResponse: - description: An array of CourseSection objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/course-section.yaml#/CourseSection" - type: array - type: object - DatabaseRequest: - description: An array of Database objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/database.yaml#/Database" - type: array - type: object - DatabaseResponse: - description: An array of Database objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/database.yaml#/Database" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - DocumentRequest: - description: An array of Document objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/document.yaml#/Document" - type: array - type: object - DocumentResponse: - description: An array of Document objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/document.yaml#/Document" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - EmailMessageRequest: - description: An array Send Email Message objects - properties: - data: - items: - $ref: "../../lib/swagger/defs/email-message.yaml#/EmailMessage" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - EmailMessagesResponse: - description: An array user objects - properties: - data: - items: - $ref: "../../lib/swagger/defs/email-message.yaml#/EmailMessage" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - EnrollmentRequest: - description: An array of Enrollment objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/enrollment.yaml#/Enrollment" - type: array - type: object - EnrollmentResponse: - description: An array of Enrollment objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/enrollment.yaml#/Enrollment" - type: array - type: object - EventRequest: - description: An array of Event objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/event.yaml#/Event" - type: array - type: object - EventResponse: - description: An array of Event objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/event.yaml#/Event" - type: array - type: object - EventCategoryRequest: - description: An array of EventCategory objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/event-category.yaml#/EventCategory" - type: array - type: object - EventCategoryResponse: - description: An array of EventCategory objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/event-category.yaml#/EventCategory" - type: array - type: object - FavoriteRequest: - description: An array of Favorite objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/favorite.yaml#/Favorite" - type: array - type: object - FavoriteResponse: - description: An array of Favorite objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/favorite.yaml#/Favorite" - type: array - type: object - InvoiceRequest: - description: An array of Invoice objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/invoice.yaml#/Invoice" - type: array - type: object - InvoiceResponse: - description: An array of Invoice objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/invoice.yaml#/Invoice" - type: array - type: object - IssuedCertificateRequest: - description: An array of IssuedCertificate objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/issued-certificate.yaml#/IssuedCertificate" - type: array - type: object - IssuedCertificateResponse: - description: An array of IssuedCertificate objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/issued-certificate.yaml#/IssuedCertificate" - type: array - type: object - LessonProgressRequest: - description: An array of LessonProgress objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/lesson-progress.yaml#/LessonProgress" - type: array - type: object - LessonProgressResponse: - description: An array of LessonProgress objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/lesson-progress.yaml#/LessonProgress" - type: array - type: object - OutgoingEmailMessageRequest: - description: An array New Email Message objects - properties: - data: - items: - $ref: "../../lib/swagger/defs/outgoing-email-message.yaml#/OutgoingEmailMessage" - type: array - type: object - OutgoingEmailMessagesResponse: - description: An array New Email Message objects - properties: - data: - items: - $ref: "../../lib/swagger/defs/outgoing-email-message.yaml#/OutgoingEmailMessage" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - OrderRequest: - description: An array of Order objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/order.yaml#/Order" - type: array - type: object - OrderResponse: - description: An array of Order objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/order.yaml#/Order" - type: array - type: object - Pagination: - properties: - Limit: - format: int64 - type: integer - POffset: - format: int64 - type: integer - PageSize: - format: int64 - type: integer - SetSize: - format: int64 - type: integer - type: object - PaymentMethodRequest: - description: An array of PaymentMethod objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/payment-method.yaml#/PaymentMethod" - type: array - type: object - PaymentMethodResponse: - description: An array of PaymentMethod objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/payment-method.yaml#/PaymentMethod" - type: array - type: object - PromptAnswerRequest: - description: An array of Prompt objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-answer.yaml#/PromptAnswer" - type: array - type: object - PromptAnswerResponse: - description: An array of PromptResponse objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-answer.yaml#/PromptAnswer" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - PromptRequest: - description: An array of Prompt objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt.yaml#/Prompt" - type: array - type: object - PromptResponse: - description: An array of Prompt objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt.yaml#/Prompt" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - PromptCategoryRequest: - description: An array of PromptCategory objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-category.yaml#/PromptCategory" - type: array - type: object - PromptCategoryResponse: - description: An array of PromptCategory objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-category.yaml#/PromptCategory" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - PromptTagRequest: - description: An array of PromptTag objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-tag.yaml#/PromptTag" - type: array - type: object - PromptTagResponse: - description: An array of PromptTag objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-tag.yaml#/PromptTag" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - RequestMeta: - properties: - ExternalAccount: - description: Account Number of the Reseller or OEM - type: string - x-nullable: true - required: - - ExternalAccount - type: object - ResearchProjectCompanyRequest: - description: An array of ResearchProjectCompany objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-company.yaml#/ResearchProjectCompany" - type: array - type: object - ResearchProjectCompanyResponse: - description: An array of ResearchProjectCompany objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-company.yaml#/ResearchProjectCompany" - type: array - type: object - ResearchProjectRequest: - description: An array of ResearchProject objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project.yaml#/ResearchProject" - type: array - type: object - ResearchProjectResponse: - description: An array of ResearchProject objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project.yaml#/ResearchProject" - type: array - type: object - ResearchProjectDocumentRequest: - description: An array of ResearchProjectDocumentRequest objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-document.yaml#/ResearchProjectDocument" - type: array - type: object - ResearchProjectDocumentResponse: - description: An array of ResearchProjectDocumentResponse objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-document.yaml#/ResearchProjectDocument" - type: array - type: object - ResearchProjectProductRequest: - description: An array of ResearchProjectProduct objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-product.yaml#/ResearchProjectProduct" - type: array - type: object - ResearchProjectProductResponse: - description: An array of ResearchProjectProduct objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-product.yaml#/ResearchProjectProduct" - type: array - type: object - ResearchProjectServiceResponse: - description: An array of ResearchProjectService objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-service.yaml#/ResearchProjectService" - type: array - type: object - ResearchProjectServiceRequest: - description: An array of ResearchProjectService objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-service.yaml#/ResearchProjectService" - type: array - type: object - ResearchProjectTopicRequest: - description: An array of ResearchProjectTopic objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-topic.yaml#/ResearchProjectTopic" - type: array - type: object - ResearchProjectTopicResponse: - description: An array of ResearchProjectTopic objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-topic.yaml#/ResearchProjectTopic" - type: array - type: object - ResponseMeta: - properties: - Contact: - description: Microservice Contact Info - type: string - Copyright: - description: Copyright Info - type: string - License: - description: License Information and Restrictions - type: string - OperationID: - description: Operation ID - type: string - Pagination: - $ref: "#/definitions/Pagination" - RequestIP: - description: Request IP Address - type: string - RequestType: - description: Request Type - type: string - RequestURL: - description: Request URL - type: string - ServerInfo: - description: Data Server Info - type: string - ServerResponseTime: - description: Data Server Response Time (ms) - type: string - ServerTimestamp: - description: Backend Server Timestamp - type: string - ExternalAccount: - description: Account Number used for recording transactions - type: string - type: object - RoleRequest: - description: An array of Role objects - properties: - Date: - items: - $ref: "../../lib/swagger/defs/role.yaml#/Role" - type: array - type: object - RoleResponse: - description: An array of Role objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/role.yaml#/Role" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - TemplateRequest: - description: An array of Templates - properties: - Data: - items: - $ref: "../../lib/swagger/defs/template.yaml#/Template" - type: array - type: object - TemplateResponse: - description: An array of Templates - properties: - Data: - items: - $ref: "../../lib/swagger/defs/template.yaml#/Template" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - TenantRequest: - description: An array of Tenant objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/tenant.yaml#/Tenant" - type: array - type: object - TenantResponse: - description: An array of Tenant objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/tenant.yaml#/Tenant" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - TicketRequest: - description: An array of Ticket objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/ticket.yaml#/Ticket" - type: array - type: object - TicketResponse: - description: An array of Ticket objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/ticket.yaml#/Ticket" - type: array - type: object - TransactionRequest: - description: An array of Transaction objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/transaction.yaml#/Transaction" - type: array - type: object - TransactionResponse: - description: An array of Transaction objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/transaction.yaml#/Transaction" - type: array - type: object - UserRequest: - properties: - Data: - items: - $ref: "../../lib/swagger/defs/user.yaml#/User" - type: array - type: object - UserResponse: - description: An array of Print-Ready ingest Objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/user.yaml#/User" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - WebhookClerkRequest: - description: Clerk webhook object - properties: - object: - type: string - type: - description: Clerk Name - type: string - data: - type: object - type: object - ClerkUser: - description: Clerk user object - type: object - properties: - external_id: - type: string - x-nullable: true - description: |- - The ID of the user as used in your external systems or your previous authentication solution. - Must be unique across your instance. - first_name: - type: string - x-nullable: true - description: The first name to assign to the user - last_name: - type: string - x-nullable: true - description: The last name to assign to the user - email_address: - type: array - items: - type: string - x-nullable: true - description: |- - Email addresses to add to the user. - Must be unique across your instance. - The first email address will be set as the user's primary email address. - phone_number: - type: array - items: - type: string - x-nullable: true - description: |- - Phone numbers to add to the user. - Must be unique across your instance. - The first phone number will be set as the user's primary phone number. - web3_wallet: - type: array - items: - type: string - x-nullable: true - description: |- - Web3 wallets to add to the user. - Must be unique across your instance. - The first wallet will be set as the user's primary wallet. - username: - type: string - x-nullable: true - description: |- - The username to give to the user. - It must be unique across your instance. - password: - type: string - x-nullable: true - description: |- - The plaintext password to give the user. - Must be at least 8 characters long, and can not be in any list of hacked passwords. - password_digest: - type: string - x-nullable: true - description: |- - In case you already have the password digests and not the passwords, you can use them for the newly created user via this property. - The digests should be generated with one of the supported algorithms. - The hashing algorithm can be specified using the `password_hasher` property. - password_hasher: - type: string - x-nullable: true - description: |- - The hashing algorithm that was used to generate the password digest. - The algorithms we support at the moment are [bcrypt](https://en.wikipedia.org/wiki/Bcrypt), md5, pbkdf2_sha256, [pbkdf2_sha256_django](https://docs.djangoproject.com/en/4.0/topics/auth/passwords/), [scrypt_firebase](https://firebaseopensource.com/projects/firebase/scrypt/) and 2 [argon2](https://argon2.online/) variants, argon2i and argon2id. - Each of the above expects the incoming digest to be of a particular format. - - More specifically: - - **bcrypt:** The digest should be of the following form: - - `$$$` - - **md5:** The digest should follow the regular form e.g.: - - `5f4dcc3b5aa765d61d8327deb882cf99` - - **pbkdf2_sha256:** This is the PBKDF2 algorithm using the SHA256 hashing function. The format should be as follows: - - `pbkdf2_sha256$$$` - - Note: Both the salt and the hash are expected to be base64-encoded. - - **pbkdf2_sha256_django:** This is the Django-specific variant of PBKDF2 and the digest should have the following format (as exported from Django): - - `pbkdf2_sha256$$$` - - Note: The salt is expected to be un-encoded, the hash is expected base64-encoded. - - **pbkdf2_sha1:** This is similar to pkbdf2_sha256_django, but with two differences: - 1. uses sha1 instead of sha256 - 2. accepts the hash as a hex-encoded string - - The format is the following: - - `pbkdf2_sha1$$$` - - - **scrypt_firebase:** The Firebase-specific variant of scrypt. - The value is expected to have 6 segments separated by the $ character and include the following information: - - _hash:_ The actual Base64 hash. This can be retrieved when exporting the user from Firebase. - _salt:_ The salt used to generate the above hash. Again, this is given when exporting the user. - _signer key:_ The base64 encoded signer key. - _salt separator:_ The base64 encoded salt separator. - _rounds:_ The number of rounds the algorithm needs to run. - _memory cost:_ The cost of the algorithm run - - The first 2 (hash and salt) are per user and can be retrieved when exporting the user from Firebase. - The other 4 values (signer key, salt separator, rounds and memory cost) are project-wide settings and can be retrieved from the project's password hash parameters. - - Once you have all these, you can combine it in the following format and send this as the digest in order for Clerk to accept it: - - `$$$$$` - - **argon2i:** Algorithms in the argon2 family generate digests that encode the following information: - - _version (v):_ The argon version, version 19 is assumed - _memory (m):_ The memory used by the algorithm (in kibibytes) - _iterations (t):_ The number of iterations to perform - _parallelism (p):_ The number of threads to use - - Parts are demarcated by the `$` character, with the first part identifying the algorithm variant. - The middle part is a comma-separated list of the encoding options (memory, iterations, parallelism). - The final part is the actual digest. - - `$argon2i$v=19$m=4096,t=3,p=1$4t6CL3P7YiHBtwESXawI8Hm20zJj4cs7/4/G3c187e0$m7RQFczcKr5bIR0IIxbpO2P0tyrLjf3eUW3M3QSwnLc` - - **argon2id:** See the previous algorithm for an explanation of the formatting. - - For the argon2id case, the value of the algorithm in the first part of the digest is `argon2id`: - - `$argon2id$v=19$m=64,t=4,p=8$Z2liZXJyaXNo$iGXEpMBTDYQ8G/71tF0qGjxRHEmR3gpGULcE93zUJVU` - - If you need support for any particular hashing algorithm, [please let us know](https://clerk.com/support). - enum: - - bcrypt - - md5 - - pbkdf2_sha256 - - pbkdf2_sha256_django - - pbkdf2_sha1 - - scrypt_firebase - - argon2i - - argon2id - skip_password_checks: - type: boolean - description: |- - When set to `true` all password checks are skipped. - It is recommended to use this method only when migrating plaintext passwords to Clerk. - Upon migration the user base should be prompted to pick stronger password. - skip_password_requirement: - type: boolean - description: |- - When set to `true`, `password` is not required anymore when creating the user and can be omitted. - This is useful when you are trying to create a user that doesn't have a password, in an instance that is using passwords. - Please note that you cannot use this flag if password is the only way for a user to sign into your instance. - totp_secret: - type: string - x-nullable: true - description: |- - In case TOTP is configured on the instance, you can provide the secret to enable it on the newly created user without the need to reset it. - Please note that currently the supported options are: - * Period: 30 seconds - * Code length: 6 digits - * Algorithm: SHA1 - backup_codes: - type: array - items: - type: string - x-nullable: true - description: |- - If Backup Codes are configured on the instance, you can provide them to enable it on the newly created user without the need to reset them. - You must provide the backup codes in plain format or the corresponding bcrypt digest. - public_metadata: - type: object - description: Metadata saved on the user, that is visible to both - your Frontend and Backend APIs - private_metadata: - type: object - description: Metadata saved on the user, that is only visible to - your Backend API - unsafe_metadata: - type: object - description: |- - Metadata saved on the user, that can be updated from both the Frontend and Backend APIs. - Note: Since this data can be modified from the frontend, it is not guaranteed to be safe. - created_at: - type: string - x-nullable: true - description: A custom date/time denoting _when_ the user signed - up to the application, specified in RFC3339 format (e.g. `2012-10-20T07:15:20.902Z`). - WebhookClerkResponse: - description: Clerk webhook object - properties: - object: - type: string - x-nullable: true - type: - description: Clerk Name - type: string - x-nullable: true - data: - type: object - type: object diff --git a/swagger/external/plex-vernonkeenan.yaml b/swagger/external/plex-vernonkeenan.yaml deleted file mode 100644 index f5ce3ca..0000000 --- a/swagger/external/plex-vernonkeenan.yaml +++ /dev/null @@ -1,596 +0,0 @@ -swagger: "2.0" -info: - version: 0.3.4 - title: "plex" - description: "Cross-Schema Retrieval Microservice" - termsOfService: "https://salesforcedevops.net/terms/" - contact: - email: "vern@vernonkeenan.com" - license: - name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" -securityDefinitions: - ApiKeyAuth: - type: "apiKey" - in: "header" - name: "X-API-Key" -schemes: - - "https" -basePath: "/vk/plex/v1" -host: "gw.tnxs.net" -consumes: - - "application/json" -produces: - - "application/json" -parameters: - slugQuery: - description: The slug of the item to retrieve - in: query - name: slug - required: false - type: string - CompanyIdQuery: - description: Record Id of an Company - in: query - name: companyId - required: false - type: string - limitQuery: - description: "How many objects to return at one time" - format: int64 - in: query - name: limit - required: false - type: integer - offsetQuery: - description: How many objects to skip? - format: int64 - in: query - name: offset - required: false - type: integer -responses: - AccessForbidden: - description: "Access forbidden, Company lacks access" - schema: - $ref: "#/definitions/Error" - InvalidDataError: - description: Invalid data was sent - schema: - $ref: "#/definitions/InvalidError" - NotFound: - description: Resource was not found - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - ServerError: - description: Server Internal Error - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - Unauthorized: - description: "Access unauthorized, invalid API-KEY was used" - schema: - $ref: "#/definitions/Error" - UnprocessableEntity: - description: "Unprocessable Entity, likely a bad parameter" - schema: - $ref: "#/definitions/Error" - CompanyResponse: - description: The SalesforceDevops.net Company Object - schema: - $ref: "#/definitions/CompanyResponse" -paths: - /companies: - get: - description: Return all or a single company fully hydrated object - operationId: getCompanies - parameters: - - $ref: "#/parameters/CompanyIdQuery" - - $ref: "#/parameters/slugQuery" - responses: - "200": - $ref: "#/responses/CompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of companies - tags: - - Companies -definitions: - Address: - properties: - City: - description: City - type: string - x-nullable: true - Country: - description: Country full name - type: string - x-nullable: true - CountryCode: - description: Country Code - type: string - x-nullable: true - PostalCode: - description: Postal Code - type: string - x-nullable: true - State: - description: State full name - type: string - x-nullable: true - StateCode: - description: State Code - type: string - x-nullable: true - Street: - description: Street number and name - type: string - x-nullable: true - type: object - Company: - properties: - ID: - description: Company Id - type: string - AccountID: - description: Account Id - type: string - x-nullable: true - AccountNumber: - description: Company Number - type: string - x-nullable: true - AccountSource: - description: The marketing origin of this Company - type: string - x-nullable: true - Active: - type: boolean - x-nullable: true - AnnualRevenue: - x-nullable: true - description: Annual Revenue Estimate - format: double - type: number - CloudRevenueTotal: - x-nullable: true - type: number - CloudType: - x-nullable: true - description: The type of cloud company - type: string - CloudYear: - description: The year company started cloud revenue - type: string - x-nullable: true - CrunchbaseURL: - description: Company Crunchbase URL - type: string - x-nullable: true - Description: - description: Description of the Company - type: string - x-nullable: true - EarningsCall: - description: Earnings Call Date - type: string - x-nullable: true - Email: - description: Main Company Email - type: string - x-nullable: true - EquityFunding: - description: The amount of equity EquityFunding - type: number - x-nullable: true - Facebook: - description: Company Facebook URL - type: string - x-nullable: true - Fax: - description: Fax number - type: string - x-nullable: true - FoundedDate: - description: Date company founded - type: string - x-nullable: true - IPODate: - description: IPO Date - type: string - x-nullable: true - ImageAltText: - type: string - x-nullable: true - ImageURL: - x-nullable: true - type: string - Industries: - x-nullable: true - description: Industries - type: string - Industry: - x-nullable: true - description: Industry - type: string - LinkedIn: - x-nullable: true - description: Company LinkedIn URL - type: string - ListingAddress: - x-nullable: true - $ref: "#/definitions/Address" - Location: - x-nullable: true - description: Headquarters Location Description - type: string - Logo: - x-nullable: true - description: Company Logo URL - type: string - MarketCapitalization: - x-nullable: true - description: Market Capitalization - type: number - Name: - x-nullable: true - description: Company Name - type: string - NumberInvestments: - x-nullable: true - description: Number of Investments - type: number - NumberOfEmployees: - x-nullable: true - description: Employee Count Estimate - format: int64 - type: number - Ownership: - x-nullable: true - description: Ownership - type: string - ParentID: - x-nullable: true - description: Parent Company - type: string - Phone: - x-nullable: true - description: Phone - type: string - Publish: - x-nullable: true - description: Publish this record? - type: boolean - SalesforceFirst: - x-nullable: true - description: A Salesforce-First company? - type: boolean - Slug: - x-nullable: true - description: Slug - type: string - TagLine: - x-nullable: true - description: Company tagline - type: string - TickerSymbol: - x-nullable: true - description: Ticker Symbol - type: string - Twitter: - x-nullable: true - description: Twitter URL - type: string - Type: - x-nullable: true - description: Type - type: string - Website: - x-nullable: true - description: Website - type: string - YearStarted: - x-nullable: true - description: Year Started - type: string - CompanyProducts: - description: Company Products - x-nullable: true - type: array - items: - $ref: "#/definitions/CompanyProduct" - FinancialStatements: - description: Financial Statements - x-nullable: true - type: array - items: - $ref: "#/definitions/FinancialStatement" - IndustryCompanies: - description: Similar Companies - x-nullable: true - type: array - items: - $ref: "#/definitions/IndustryCompany" - type: object - FinancialStatement: - type: object - description: A financial statement for a company - properties: - ID: - description: Record Id - type: string - AccessNumber: - description: EDGAR Access Number - type: string - AccountID: - description: Account ID - type: string - CloudRevenue: - description: Cloud Revenue - type: number - CreatedByID: - description: Created By User ID - type: string - CreatedDate: - description: Created Date - type: string - Description: - description: Description - type: string - EdgarURL: - description: EDGAR URL - type: string - FilingType: - description: Filing Type - type: string - GrossProfit: - description: Gross Profit - type: number - LastModifiedByID: - description: Last Modified By User ID - type: string - LastModifiedDate: - description: Last Modified Date - type: string - NetIncome: - description: Net Income - type: number - PeriodEndDate: - description: Period End Date - type: string - TotalRevenue: - description: Total Revenue - type: number - Year: - description: Year - type: string - CompanyProduct: - description: A software product or service vended by a Company - properties: - ID: - description: Record Id - type: string - AccountID: - description: ID of the Company that owns this Product - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description of product - type: string - x-nullable: true - FullDescription: - description: Full Description of product - type: string - x-nullable: true - ImageAltText: - description: Image Alt Text - type: string - x-nullable: true - ImageURL: - description: Image URL - type: string - x-nullable: true - Industries: - x-nullable: true - description: Industries - type: array - items: - $ref: "#/definitions/Industry" - LastModifiedByID: - x-nullable: true - description: Last Modified By User ID - type: string - LastModifiedDate: - x-nullable: true - description: Last Modified Date - type: string - Logo: - x-nullable: true - description: Logo - type: string - Name: - x-nullable: true - description: Product Name - type: string - ProductVideoID: - x-nullable: true - description: Product Video ID - type: string - Published: - x-nullable: true - description: Published - type: boolean - SalesforceSpecific: - x-nullable: true - description: Salesforce Specific - type: boolean - Slug: - x-nullable: true - description: Slug - type: string - TagLine: - x-nullable: true - description: TagLine - type: string - URL: - x-nullable: true - description: Website - type: string - type: object - Industry: - description: An industry that is being researched - properties: - ID: - description: Record Id - type: string - Companies: - x-nullable: true - description: The AccountIDs of the Companies in this Industry - type: array - items: - type: string - CompanyProducts: - x-nullable: true - description: The list of Products in this industry - type: array - items: - $ref: "#/definitions/CompanyProduct" - CreatedByID: - x-nullable: true - description: Created By User ID - type: string - CreatedDate: - x-nullable: true - description: Created Date - type: string - Description: - x-nullable: true - description: Industry Description - type: string - ImageAltText: - x-nullable: true - description: Image Alt Text - type: string - ImageURL: - x-nullable: true - description: Image URL - type: string - LastModifiedByID: - x-nullable: true - description: Last Modified By User ID - type: string - LastModifiedDate: - x-nullable: true - description: Last Modified Date - type: string - Level: - x-nullable: true - description: The hierarchical level of this Industry - type: string - Logo: - x-nullable: true - description: Logo - type: string - Name: - x-nullable: true - description: Industry Name - type: string - ParentIndustryID: - x-nullable: true - description: The ID of the Parent Industry - type: string - Path: - x-nullable: true - description: The full path of this industry, including Parent - type: string - Slug: - x-nullable: true - description: The CMS Slug for this Industry - type: string - TagLine: - x-nullable: true - description: TagLine - type: string - type: object - IndustryCompany: - description: Junction object between Industry and Company - properties: - ID: - description: Record Id - type: string - CompanyID: - type: string - CompanyName: - type: string - CompanySlug: - type: string - CompanyWebsite: - type: string - IndustryID: - type: string - IndustryName: - type: string - IndustrySlug: - type: string - IndustryTagLine: - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - LastModifiedDate: - description: Last Modified Date - type: string - Path: - type: string - type: object - CompanyRequest: - description: An array of Company objects with Contacts - properties: - Data: - items: - $ref: "#/definitions/Company" - type: array - type: object - CompanyResponse: - description: An array of Company objects with Contacts - properties: - Data: - items: - $ref: "#/definitions/Company" - type: array - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - type: object - Error: - $ref: "../../lib/swagger/defs/error.yaml#/Error" - InvalidError: - allOf: - - $ref: "#/definitions/Error" - - properties: - details: - items: - type: string - type: array - type: object diff --git a/swagger/external/research-vernonkeenan.yaml b/swagger/external/research-vernonkeenan.yaml deleted file mode 100644 index 0293721..0000000 --- a/swagger/external/research-vernonkeenan.yaml +++ /dev/null @@ -1,2019 +0,0 @@ -swagger: "2.0" -info: - version: 0.3.0 - title: "research" - description: "Customer Information Microservice" - termsOfService: "https://salesforcedevops.net/terms/" - contact: - email: "vern@vernonkeenan.com" - license: - name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" -securityDefinitions: - ApiKeyAuth: - type: "apiKey" - in: "header" - name: "X-API-Key" -schemes: - - "https" -basePath: "/vk/research/v1" -host: "gw.tnxs.net" -consumes: - - "application/json" -produces: - - "application/json" -parameters: - accountIdQuery: - description: Record Id of an Account - in: query - name: accountId - required: false - type: string - activeQuery: - description: Only retrieve active records? - in: query - name: active - required: false - type: boolean - companyProductIdQuery: - description: CompanyProduct record ID - in: query - name: companyProductId - required: false - type: string - companyServiceIdQuery: - description: CompanyService record ID - in: query - name: companyServiceId - required: false - type: string - companyProductRequest: - description: An array of new CompanyProduct records - in: body - name: companyProductRequest - required: true - schema: - $ref: "#/definitions/CompanyProductRequest" - companyServiceRequest: - description: An array of new CompanyService records - in: body - name: companyServiceRequest - required: true - schema: - $ref: "#/definitions/CompanyServiceRequest" - contactIdQuery: - description: Contact record ID - in: query - name: contactId - required: false - type: string - emailQuery: - description: Email address used for identity lookup - in: query - name: email - required: false - type: string - factorIdQuery: - description: Factor record ID - in: query - name: factorId - required: false - type: string - financialStatementIdQuery: - description: Financial Statement record ID - in: query - name: financialStatementId - required: false - type: string - factorRequest: - description: An array of new Factor records - in: body - name: factorRequest - required: true - schema: - $ref: "#/definitions/FactorRequest" - financialStatementRequest: - description: An array of new FinancialStatement records - in: body - name: financialStatementRequest - required: true - schema: - $ref: "#/definitions/FinancialStatementRequest" - industryCompanyIdQuery: - description: IndustryCompany record ID - in: query - name: industryCompanyId - required: false - type: string - industryCompanyRequest: - description: An array of new IndustryCompany records - in: body - name: industryCompanyRequest - required: true - schema: - $ref: "#/definitions/IndustryCompanyRequest" - industryIdQuery: - description: Industry record ID - in: query - name: industryId - required: false - type: string - productCategoryQuery: - description: Is this industry a product category? - in: query - name: productCategory - required: false - type: boolean - serviceCategoryQuery: - description: Is this industry a service category? - in: query - name: serviceCategory - required: false - type: boolean - industryProductIdQuery: - description: IndustryProduct record ID - in: query - name: industryProductId - required: false - type: string - industryProductRequest: - description: An array of new IndustryProduct records - in: body - name: industryProductRequest - required: true - schema: - $ref: "#/definitions/IndustryProductRequest" - industryServiceIdQuery: - description: IndustryService record ID - in: query - name: industryServiceId - required: false - type: string - industryServiceRequest: - description: An array of new IndustryService records - in: body - name: industryServiceRequest - required: true - schema: - $ref: "#/definitions/IndustryServiceRequest" - industryRequest: - description: An array of new Industry records - in: body - name: industryRequest - required: true - schema: - $ref: "#/definitions/IndustryRequest" - leadIdQuery: - description: Lead record ID - in: query - name: leadId - required: false - type: string - limitQuery: - description: How many objects to return at one time - format: int64 - in: query - name: limit - required: false - type: integer - nameQuery: - description: The Name of this Object - in: query - name: name - required: false - type: string - slugQuery: - description: The Slug of this Object - in: query - name: slug - required: false - type: string - observationIdQuery: - description: Observation record ID - in: query - name: observationId - required: false - type: string - observationRequest: - description: An array of new Observation records - in: body - name: observationRequest - required: true - schema: - $ref: "#/definitions/ObservationRequest" - offsetQuery: - description: How many objects to skip? - format: int64 - in: query - name: offset - required: false - type: integer - topicIdQuery: - description: Topic record ID - in: query - name: topicId - required: false - type: string - topicRequest: - description: An array of new Topic records - in: body - name: topicRequest - required: true - schema: - $ref: "#/definitions/TopicRequest" - typeQuery: - description: The Type of this Object - in: query - name: type - required: false - type: string - -responses: - AccessForbidden: - description: Access forbidden, account lacks access - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - CompanyProductResponse: - description: Response with CompanyProduct objects - schema: - $ref: "#/definitions/CompanyProductResponse" - CompanyServiceResponse: - description: Response with CompanyService objects - schema: - $ref: "#/definitions/CompanyServiceResponse" - Conflict: - description: Conflict - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - DeleteResponse: - description: Response with Message Objects with Delete Status - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/DeleteResponse" - FactorResponse: - description: Response with Factor objects - schema: - $ref: "#/definitions/FactorResponse" - FinancialStatementResponse: - description: Response with FinancialStatement objects - schema: - $ref: "#/definitions/FinancialStatementResponse" - IndustryCompanyResponse: - description: Response with IndustryCompany objects - schema: - $ref: "#/definitions/IndustryCompanyResponse" - IndustryProductResponse: - description: Response with IndustryProduct objects - schema: - $ref: "#/definitions/IndustryProductResponse" - IndustryServiceResponse: - description: Response with IndustryService objects - schema: - $ref: "#/definitions/IndustryServiceResponse" - IndustryResponse: - description: Response with Industry objects - schema: - $ref: "#/definitions/IndustryResponse" - InvalidDataError: - description: Invalid data was sent - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/InvalidError" - NotFound: - description: Resource was not found - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - ObservationResponse: - description: Response with Observation objects - schema: - $ref: "#/definitions/ObservationResponse" - ServerError: - description: Server Internal Error - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - TopicResponse: - description: Response with Topic objects - schema: - $ref: "#/definitions/TopicResponse" - Unauthorized: - description: Access unauthorized, invalid API-KEY was used - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - UnprocessableEntity: - description: Unprocessable Entity, likely a bad parameter - headers: - Access-Control-Allow-Origin: - type: string - schema: - $ref: "#/definitions/Error" - CompanyCategoryResponse: - description: The SalesforceDevops.net CompanyCategory Object - schema: - $ref: "#/definitions/CompanyCategoryResponse" - -paths: - /companycategories: - get: - description: Return all or a single company category fully hydrated object - operationId: getCompanyCategories - responses: - "200": - $ref: "#/responses/CompanyCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of company categories - tags: - - CompanyCategories - /companyservices: - delete: - description: Delete CompanyService record - operationId: deleteCompanyService - parameters: - - $ref: "#/parameters/companyServiceIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete a CompanyService - tags: - - CompanyServices - get: - description: Return a list of all available CompanyServices - operationId: getCompanyServices - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/slugQuery" - - $ref: "#/parameters/companyServiceIdQuery" - responses: - "200": - $ref: "#/responses/CompanyServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of company services - tags: - - CompanyServices - post: - description: Create a new CompanyService record - operationId: postCompanyServices - parameters: - - $ref: "#/parameters/companyServiceRequest" - responses: - "200": - $ref: "#/responses/CompanyServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "409": - $ref: "#/responses/Conflict" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create a new CompanyService - tags: - - CompanyServices - /companyproducts: - delete: - description: Delete CompanyProduct record - operationId: deleteCompanyProduct - parameters: - - $ref: "#/parameters/companyProductIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete a CompanyProduct - tags: - - CompanyProducts - get: - description: Return a list of all available CompanyProducts - operationId: getCompanyProducts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/slugQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/accountIdQuery" - - $ref: "#/parameters/companyProductIdQuery" - responses: - "200": - $ref: "#/responses/CompanyProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of companyproducts - tags: - - CompanyProducts - post: - description: CompanyProduct record to be added - operationId: postCompanyProducts - parameters: - - $ref: "#/parameters/companyProductRequest" - responses: - "200": - $ref: "#/responses/CompanyProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new companyproduct to SalesforceDevops.net - tags: - - CompanyProducts - put: - description: Update companyproduct records - operationId: putCompanyProduct - parameters: - - $ref: "#/parameters/companyProductRequest" - responses: - "200": - $ref: "#/responses/CompanyProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update a single companyproduct - tags: - - CompanyProducts - /factors: - delete: - description: Delete Factor record - operationId: deleteFactor - parameters: - - $ref: "#/parameters/factorIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An Factor - tags: - - Factors - get: - description: Return a list of all available Factors - operationId: getFactors - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/nameQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/factorIdQuery" - responses: - "200": - $ref: "#/responses/FactorResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of factors - tags: - - Factors - post: - description: Factor records to be added - operationId: postFactors - parameters: - - $ref: "#/parameters/factorRequest" - responses: - "200": - $ref: "#/responses/FactorResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new factor to SalesforceDevops.net - tags: - - Factors - put: - description: Update factor records - operationId: putFactor - parameters: - - $ref: "#/parameters/factorRequest" - responses: - "200": - $ref: "#/responses/FactorResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update factor records - tags: - - Factors - /financialstatements: - delete: - description: Delete FinancialStatement record - operationId: deleteFinancialStatement - parameters: - - $ref: "#/parameters/financialStatementIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An FinancialStatement - tags: - - FinancialStatements - get: - description: Return a list of all available FinancialStatements - operationId: getFinancialStatements - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/accountIdQuery" - - $ref: "#/parameters/financialStatementIdQuery" - responses: - "200": - $ref: "#/responses/FinancialStatementResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of financialStatements - tags: - - FinancialStatements - post: - description: FinancialStatement records to be added - operationId: postFinancialStatements - parameters: - - $ref: "#/parameters/financialStatementRequest" - responses: - "200": - $ref: "#/responses/FinancialStatementResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new financialStatement to SalesforceDevops.net - tags: - - FinancialStatements - put: - description: Update financialStatement records - operationId: putFinancialStatement - parameters: - - $ref: "#/parameters/financialStatementRequest" - responses: - "200": - $ref: "#/responses/FinancialStatementResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update financialStatement records - tags: - - FinancialStatements - /industries: - get: - description: Retrieve Industry records from the microservice - operationId: getIndustries - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/slugQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/industryIdQuery" - - $ref: "#/parameters/productCategoryQuery" - - $ref: "#/parameters/serviceCategoryQuery" - responses: - "200": - $ref: "#/responses/IndustryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Industry records - tags: - - Industry - post: - description: Add new industries - operationId: postIndustries - parameters: - - $ref: "#/parameters/industryRequest" - responses: - "200": - $ref: "#/responses/IndustryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add new companies - tags: - - Industry - /industrycompanies: - delete: - description: Delete IndustryCompany record - operationId: deleteIndustryCompany - parameters: - - $ref: "#/parameters/industryCompanyIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An IndustryCompany - tags: - - IndustryCompanies - get: - description: Return a list of all available IndustryCompanies - operationId: getIndustryCompanies - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/nameQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/industryCompanyIdQuery" - - $ref: "#/parameters/emailQuery" - responses: - "200": - $ref: "#/responses/IndustryCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of industrycompanies - tags: - - IndustryCompanies - post: - description: IndustryCompany record to be added - operationId: postIndustryCompanies - parameters: - - $ref: "#/parameters/industryCompanyRequest" - responses: - "200": - $ref: "#/responses/IndustryCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new industryCompany to SalesforceDevops.net - tags: - - IndustryCompanies - /industryservices: - delete: - description: Delete IndustryService record - operationId: deleteIndustryService - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/industryServiceIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An IndustryService - tags: - - IndustryServices - get: - description: Return a list of all available IndustryServices - operationId: getIndustryServices - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/industryServiceIdQuery" - responses: - "200": - $ref: "#/responses/IndustryServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of industryservices - tags: - - IndustryServices - post: - description: IndustryService record to be added - operationId: postIndustryServices - parameters: - - $ref: "#/parameters/industryServiceRequest" - responses: - "200": - $ref: "#/responses/IndustryServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new industryService to SalesforceDevops.net - tags: - - IndustryServices - /industryproducts: - delete: - description: Delete IndustryProduct record - operationId: deleteIndustryProduct - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/industryProductIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An IndustryProduct - tags: - - IndustryProducts - get: - description: Return a list of all available IndustryProducts - operationId: getIndustryProducts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/nameQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/industryProductIdQuery" - responses: - "200": - $ref: "#/responses/IndustryProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of industryProducts - tags: - - IndustryProducts - post: - description: IndustryProduct record to be added - operationId: postIndustryProducts - parameters: - - $ref: "#/parameters/industryProductRequest" - responses: - "200": - $ref: "#/responses/IndustryProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new industryProduct to SalesforceDevops.net - tags: - - IndustryProducts - /observations: - delete: - description: Delete Observation record - operationId: deleteObservation - parameters: - - $ref: "#/parameters/observationIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An Observation - tags: - - Observations - get: - description: Return a list of all available Observations - operationId: getObservations - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/observationIdQuery" - responses: - "200": - $ref: "#/responses/ObservationResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of observations - tags: - - Observations - post: - description: Observation record to be added - operationId: postObservations - parameters: - - $ref: "#/parameters/observationRequest" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ObservationResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new observation to SalesforceDevops.net - tags: - - Observations - put: - description: Update a single observation specified by observationId - operationId: putObservation - parameters: - - $ref: "#/parameters/observationRequest" - responses: - "200": - $ref: "#/responses/ObservationResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update a single observation - tags: - - Observations - /topics: - get: - description: Retrieve Topic records from the microservice - operationId: getTopics - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/topicIdQuery" - responses: - "200": - $ref: "#/responses/TopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Topic records - tags: - - Topics - post: - description: Add new topics - operationId: postTopics - parameters: - - $ref: "#/parameters/topicRequest" - responses: - "200": - $ref: "#/responses/TopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add new topics - tags: - - Topics - -definitions: - Address: - properties: - City: - description: City - type: string - x-nullable: true - Country: - description: Country full name - type: string - x-nullable: true - CountryCode: - description: Country Code - type: string - x-nullable: true - PostalCode: - description: Postal Code - type: string - x-nullable: true - State: - description: State full name - type: string - x-nullable: true - StateCode: - description: State Code - type: string - x-nullable: true - Street: - description: Street number and name - type: string - x-nullable: true - type: object - CompanyCategory: - properties: - CloudType: - description: The Type of Cloud Company - type: string - Count: - description: The number of companies - type: number - type: object - CompanyCategoryResponse: - description: An array of CompanyCategory objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/CompanyCategory" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CompanyProduct: - description: A software product or service vended by a Company - properties: - AccountID: - description: ID of the Company that owns this Product - type: string - x-nullable: true - AppExchange: - description: Salesforce AppExchange URL - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description of product - type: string - x-nullable: true - FullDescription: - description: Full Description of product - type: string - x-nullable: true - ID: - description: Record Id - type: string - ImageAltText: - description: Image Alt Text - type: string - x-nullable: true - ImageURL: - description: Image URL - type: string - x-nullable: true - Industries: - description: Industries - items: - $ref: "#/definitions/Industry" - type: array - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Logo: - description: Logo - type: string - x-nullable: true - Name: - description: Product Name - type: string - x-nullable: true - ProductVideoID: - description: Product Video ID - type: string - x-nullable: true - Published: - description: Published - type: boolean - x-nullable: true - SalesforceSpecific: - description: Salesforce Specific - type: boolean - x-nullable: true - Slug: - description: Slug - type: string - x-nullable: true - TagLine: - description: TagLine - type: string - x-nullable: true - URL: - description: Website - type: string - x-nullable: true - type: object - CompanyProductRequest: - description: An array of CompanyProduct objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/CompanyProduct" - type: array - type: object - CompanyProductResponse: - description: An array of CompanyProduct objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/CompanyProduct" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CompanyService: - description: A service performed by a Company - properties: - ID: - description: Record Id - type: string - AccountID: - description: ID of the Company that owns this Service - type: string - AppExchange: - description: Salesforce AppExchange URL - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description of service - type: string - x-nullable: true - FullDescription: - description: Full Description of service - type: string - x-nullable: true - ImageAltText: - description: Image Alt Text - type: string - x-nullable: true - ImageURL: - description: Image URL - type: string - x-nullable: true - Industries: - description: Industries - items: - $ref: "#/definitions/Industry" - type: array - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Logo: - description: Logo - type: string - x-nullable: true - Name: - description: Service Name - type: string - x-nullable: true - Published: - description: Published - type: boolean - x-nullable: true - SalesforceSpecific: - description: Salesforce Specific - type: boolean - x-nullable: true - ServiceVideoID: - description: Service Video ID - type: string - x-nullable: true - Slug: - description: Slug - type: string - x-nullable: true - TagLine: - description: Tag Line - type: string - x-nullable: true - URL: - description: URL - type: string - x-nullable: true - type: object - CompanyServiceRequest: - description: An array of CompanyService objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/CompanyService" - type: array - type: object - CompanyServiceResponse: - description: An array of CompanyService objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/CompanyService" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - DeleteResponse: - properties: - Data: - items: - $ref: "#/definitions/Message" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Error: - $ref: ../../lib/swagger/defs/error.yaml#/Error - Factor: - description: A Factor of analysis within a research topic - properties: - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Topic Description - type: string - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Name: - description: Factor Name - type: string - x-nullable: true - Observations: - description: The list of Observations used to analyze this industry - items: - $ref: "#/definitions/Observation" - type: array - x-nullable: true - Slug: - description: The slug of the corresponding page on the CMS - type: string - x-nullable: true - TopicID: - description: The ID of the Topic that owns this Factor - type: string - x-nullable: true - type: object - FactorRequest: - description: An array of Factor objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/Factor" - type: array - type: object - FactorResponse: - description: An array of Factor objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/Factor" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - FinancialStatement: - description: A financial statement for a company - properties: - AccessNumber: - description: EDGAR Access Number - type: string - x-nullable: true - AccountID: - description: Account ID - type: string - x-nullable: true - CloudRevenue: - description: Cloud Revenue - type: number - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description - type: string - x-nullable: true - EdgarURL: - description: EDGAR URL - type: string - x-nullable: true - FilingType: - description: Filing Type - type: string - x-nullable: true - GrossProfit: - description: Gross Profit - type: number - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - NetIncome: - description: Net Income - type: number - x-nullable: true - PeriodEndDate: - description: Period End Date - type: string - x-nullable: true - TotalRevenue: - description: Total Revenue - type: number - x-nullable: true - Year: - description: Year - type: string - x-nullable: true - type: object - FinancialStatementRequest: - description: An array of FinancialStatement objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/FinancialStatement" - type: array - type: object - FinancialStatementResponse: - description: An array of FinancialStatement objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/FinancialStatement" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Industry: - description: An industry that is being researched - properties: - ID: - description: Record Id - type: string - CompanyProducts: - description: The list of Products in this industry - items: - $ref: "#/definitions/CompanyProduct" - type: array - x-nullable: true - CompanyServices: - description: The list of Services in this industry - items: - $ref: "#/definitions/CompanyService" - type: array - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Industry Description - type: string - x-nullable: true - ImageAltText: - description: Image Alt Text - type: string - x-nullable: true - ImageURL: - description: Image URL - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Level: - description: The hierarchical level of this Industry - type: string - x-nullable: true - Logo: - description: Logo - type: string - x-nullable: true - Name: - description: Industry Name - type: string - x-nullable: true - ParentIndustryID: - description: The ID of the Parent Industry - type: string - x-nullable: true - Path: - description: The full path of this industry, including Parent - type: string - x-nullable: true - ProductCategory: - description: Is this industry a product category? - type: boolean - x-nullable: true - ServiceCategory: - description: Is this industry a service category? - type: boolean - x-nullable: true - Slug: - description: The CMS Slug for this Industry - type: string - x-nullable: true - TagLine: - description: TagLine - type: string - x-nullable: true - type: object - IndustryCompany: - description: Junction object between Industry and Company - properties: - AccountID: - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - ID: - description: Record Id - type: string - IndustryID: - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Path: - type: string - x-nullable: true - type: object - IndustryCompanyRequest: - description: An array of IndustryCompany objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/IndustryCompany" - type: array - type: object - IndustryCompanyResponse: - description: An array of IndustryCompany objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/IndustryCompany" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - IndustryProduct: - description: Junction object between Industry and CompanyProduct - properties: - CompanyProductID: - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - HTML: - type: string - x-nullable: true - ID: - description: Record Id - type: string - IndustryID: - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - type: object - IndustryProductRequest: - description: An array of IndustryProduct objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/IndustryProduct" - type: array - type: object - IndustryProductResponse: - description: An array of IndustryProduct objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/IndustryProduct" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - IndustryService: - description: Junction Object bewtwen Industry and CompanyService - properties: - ID: - description: Record Id - type: string - CompanyService: - $ref: "#/definitions/CompanyService" - CompanyServiceID: - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Industry: - $ref: "#/definitions/Industry" - IndustryID: - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - type: object - IndustryServiceRequest: - description: An array of IndustryService objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/IndustryService" - type: array - type: object - IndustryServiceResponse: - description: An array of IndustryService objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/IndustryService" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - IndustryRequest: - description: An array of Industry objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/Industry" - type: array - type: object - IndustryResponse: - description: An array of Industry objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/Industry" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - InvalidError: - allOf: - - $ref: "#/definitions/Error" - - properties: - details: - items: - type: string - type: array - type: object - Message: - properties: - message: - type: string - ref: - type: string - status: - format: int64 - type: number - type: object - Observation: - description: A data point collected while analyzing a Factor - properties: - AccountID: - description: The ID of the Company being analyzed - type: string - x-nullable: true - CompanyProductID: - description: The ID of the Product being analyzed - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Notes concerning data collection - type: string - x-nullable: true - FactorID: - description: The ID of the Factor that owns this Observation - type: string - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - SubjectType: - description: Is the subject a Company or a Product? - type: string - x-nullable: true - Value: - description: The data point collected - type: string - x-nullable: true - type: object - ObservationRequest: - description: An array of Observation objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/Observation" - type: array - type: object - ObservationResponse: - description: An array of Observation objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/Observation" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Pagination: - properties: - limit: - format: int64 - type: number - pagesize: - format: int64 - type: number - poffset: - format: int64 - type: integer - setsize: - format: int64 - type: number - type: object - RequestMeta: - properties: - ExternalAccount: - description: Account Number of the Reseller or OEM - type: string - required: - - ExternalAccount - type: object - ResponseMeta: - properties: - Contact: - description: Microservice Contact Info - type: string - Copyright: - description: Copyright Info - type: string - License: - description: License Information and Restrictions - type: string - OperationID: - description: Operation ID - type: string - Pagination: - $ref: "#/definitions/Pagination" - RequestIP: - description: Request IP Address - type: string - RequestType: - description: Request Type - type: string - RequestURL: - description: Request URL - type: string - ServerInfo: - description: Data Server Info - type: string - ServerResponseTime: - description: Data Server Response Time (ms) - type: string - ServerTimestamp: - description: Backend Server Timestamp - type: string - ExternalAccount: - description: Account Number used for recording transactions - type: string - type: object - Topic: - description: A research topic that collects data - properties: - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Topic Description - type: string - x-nullable: true - Factors: - description: The list of Factors used to analyze this industry - items: - $ref: "#/definitions/Factor" - type: array - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Name: - description: Topic Name - type: string - x-nullable: true - ParentTopicID: - description: The ID of the Parent Topic - type: string - x-nullable: true - Slug: - description: The CMS Slug for this Topic - type: string - x-nullable: true - type: object - TopicRequest: - description: An array of Topic objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/Topic" - type: array - type: object - TopicResponse: - description: An array of Topic objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/Topic" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object diff --git a/swagger/external/sf-gate-vernonkeenan.yaml b/swagger/external/sf-gate-vernonkeenan.yaml deleted file mode 100644 index 4349b29..0000000 --- a/swagger/external/sf-gate-vernonkeenan.yaml +++ /dev/null @@ -1,5552 +0,0 @@ -swagger: "2.0" -info: - version: 0.2.0 - title: "sf-gate" - description: "Salesforce Gateway Microservice" - termsOfService: "https://salesforcedevops.net/terms/" - contact: - email: "vern@salesforcedevops.net" - license: - name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" -securityDefinitions: - ApiKeyAuth: - type: "apiKey" - in: "header" - name: "X-API-Key" -schemes: - - "https" -basePath: "/vk/sf-gate/v1" -host: "gw.tnxs.net" -consumes: - - "application/json" -produces: - - "application/json" -parameters: - accountIdQuery: - description: Record Id of an Account - in: query - name: accountId - required: false - type: string - idQuery: - description: Unique Record ID - in: query - name: id - required: false - type: string - industryCompanyIdQuery: - description: Record Id of an IndustryCompany - in: query - name: industryCompanyId - required: false - type: string - accountRequest: - description: A request with an array of Account Objects - in: body - name: accountRequest - required: true - schema: - $ref: "#/definitions/AccountRequest" - CourseRequest: - description: An array of new Course records - in: body - name: courseRequest - required: true - schema: - $ref: "#/definitions/CourseRequest" - CourseSectionRequest: - description: An array of new CourseSection records - in: body - name: coursesectionRequest - required: true - schema: - $ref: "#/definitions/CourseSectionRequest" - industryCompanyRequest: - description: A request with an array of IndustryCompany Objects - in: body - name: industryCompanyRequest - required: true - schema: - $ref: "#/definitions/IndustryCompanyRequest" - topicRequest: - description: A request with an array of Topic Objects - in: body - name: topicRequest - required: true - schema: - $ref: "#/definitions/TopicRequest" - activeQuery: - description: Only retrieve active records? - in: query - name: active - required: false - type: boolean - apiKeyQuery: - description: Id of the User to be retrieved - in: query - name: apikey - required: false - type: string - assetIdQuery: - description: Record Id of an Asset - in: query - name: assetId - required: false - type: string - assetRequest: - description: An array of new Asset records - in: body - name: assetRequest - required: true - schema: - $ref: "#/definitions/AssetRequest" - companyServiceIdQuery: - description: CompanyService record ID - in: query - name: companyServiceId - required: false - type: string - companyServiceRequest: - description: An array of new CompanyService records - in: body - name: companyServiceRequest - required: true - schema: - $ref: "#/definitions/CompanyServiceRequest" - industryServiceIdQuery: - description: IndustryService record ID - in: query - name: industryServiceId - required: false - type: string - industryServiceRequest: - description: An array of new IndustryService records - in: body - name: industryServiceRequest - required: true - schema: - $ref: "#/definitions/IndustryServiceRequest" - clusterIdQuery: - description: Record Id of a Cluster - in: query - name: clusterId - required: false - type: string - CourseLessonRequest: - description: An array of new CourseLesson records - in: body - name: courselessonRequest - required: true - schema: - $ref: "#/definitions/CourseLessonRequest" - clusterRequest: - description: An array of Cluster records - in: body - name: ClusterRequest - required: true - schema: - $ref: "#/definitions/ClusterRequest" - companyProductIdQuery: - description: CompanyProduct record ID - in: query - name: companyProductId - required: false - type: string - companyProductRequest: - description: An array of new Contact records - in: body - name: contactRequest - required: true - schema: - $ref: "#/definitions/CompanyProductRequest" - contactIdQuery: - description: Record Id of a Contact - in: query - name: contactId - required: false - type: string - contactRequest: - description: An array of new Contact records - in: body - name: contactRequest - required: true - schema: - $ref: "#/definitions/ContactRequest" - documentRequest: - description: An array of new Document records - in: body - name: documentRequest - required: true - schema: - $ref: "#/definitions/DocumentRequest" - contractIdQuery: - description: Contact record ID - in: query - name: contractId - required: false - type: string - contractRequest: - description: An array of new Contract records - in: body - name: contractsRequest - required: true - schema: - $ref: "#/definitions/ContractRequest" - databaseIdQuery: - description: Record Id of a Database - in: query - name: databaseId - required: false - type: string - databaseRequest: - description: An array of Database records - in: body - name: DatabaseRequest - required: true - schema: - $ref: "#/definitions/DatabaseRequest" - emailQuery: - description: Email address used for identity lookup - in: query - name: email - required: false - type: string - EventRequest: - description: An array of new Event records - in: body - name: eventRequest - required: true - schema: - $ref: "#/definitions/EventRequest" - EventCategoryRequest: - description: An array of new Event records - in: body - name: eventCategoryRequest - required: true - schema: - $ref: "#/definitions/EventCategoryRequest" - factorIdQuery: - description: Record Id of a Factor - in: query - name: factorId - required: false - type: string - factorRequest: - description: A request with an array of Factor Objects - in: body - name: factorRequest - required: true - schema: - $ref: "#/definitions/FactorRequest" - financialStatementIdQuery: - description: Record Id of a FinancialStatement - in: query - name: financialStatementId - required: false - type: string - financialStatementRequest: - description: A request with an array of FinancialStatement Objects - in: body - name: financialStatementRequest - required: true - schema: - $ref: "#/definitions/FinancialStatement" - industryIdQuery: - description: Industry record ID - in: query - name: industryId - required: false - type: string - industryProductIdQuery: - description: IndustryProduct record ID - in: query - name: industryProductId - required: false - type: string - industryProductRequest: - description: An array of new Industry records - in: body - name: industryRequest - required: true - schema: - $ref: "#/definitions/IndustryProductRequest" - industryRequest: - description: An array of new Industry records - in: body - name: industryRequest - required: true - schema: - $ref: "#/definitions/IndustryRequest" - limitQuery: - description: How many objects to return at one time - format: int64 - in: query - name: limit - required: false - type: integer - nameQuery: - description: The Name of this Object - in: query - name: name - required: false - type: string - newUserRequest: - description: A single new user record - in: body - name: UserRequest - required: true - schema: - $ref: "#/definitions/UserRequest" - observationIdQuery: - description: Record Id of an Observation - in: query - name: observationId - required: false - type: string - observationRequest: - description: A request with an array of Observation Objects - in: body - name: accountRequest - required: true - schema: - $ref: "#/definitions/ObservationRequest" - offsetQuery: - description: How many objects to skip? - format: int64 - in: query - name: offset - required: false - type: integer - roleIdQuery: - description: Id of the Role to be retrieved - in: query - name: roleId - required: false - type: string - PromptRequest: - description: An array of new Prompt records - in: body - name: promptRequest - required: true - schema: - $ref: "#/definitions/PromptRequest" - PromptCategoryRequest: - description: An array of PromptCategory objects - name: promptCategoryRequest - required: true - in: body - schema: - $ref: "#/definitions/PromptCategoryRequest" - PromptAnswerRequest: - description: An array of PromptAnswer objects - name: promptAnswerRequest - required: true - in: body - schema: - $ref: "#/definitions/PromptAnswerRequest" - PromptTagRequest: - description: An array of PromptTag objects - name: promptTagRequest - required: true - in: body - schema: - $ref: "#/definitions/PromptTagRequest" - ResearchProjectCompanyRequest: - description: An array of new ResearchProjectCompany records - in: body - name: researchProjectCompanyRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectCompanyRequest" - ResearchProjectDocumentRequest: - description: An array of new ResearchProjectDocument records - in: body - name: researchProjectDocumentRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectDocumentRequest" - researchProjectProductRequest: - description: An array of new ResearchProjectProduct records - in: body - name: researchProjectProductRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectProductRequest" - ResearchProjectServiceRequest: - description: An array of new ResearchProjectService records - in: body - name: researchProjectServiceRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectServiceRequest" - ResearchProjectRequest: - description: An array of new ResearchProject records - in: body - name: researchProjectRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectRequest" - ResearchProjectTopicRequest: - description: An array of new ResearchProjectTopic records - in: body - name: researchProjectTopicRequest - required: true - schema: - $ref: "#/definitions/ResearchProjectTopicRequest" - templateIdQuery: - description: Record Id of a Template - in: query - name: templateId - required: false - type: string - tenantIdQuery: - description: Record Id of a Tenant - in: query - name: tenantId - required: false - type: string - tenantRequest: - description: An array of Tenant records - in: body - name: CTenantRequest - required: true - schema: - $ref: "#/definitions/TenantRequest" - toipicRequest: - description: A request with an array of Topic Objects - in: body - name: topicRequest - required: true - schema: - $ref: "#/definitions/TopicRequest" - topicIdQuery: - description: Record Id of a Topic - in: query - name: topicId - required: false - type: string - userIdQuery: - description: Id of the User to be retrieved - in: query - name: userId - required: false - type: string -responses: - AccessForbidden: - description: Access forbidden, account lacks access - schema: - $ref: "#/definitions/Error" - AccountResponse: - description: Response with Account objects - schema: - $ref: "#/definitions/AccountResponse" - EventResponse: - description: Event Response Object - schema: - $ref: "#/definitions/EventResponse" - EventCategoryResponse: - description: Event Response Object - schema: - $ref: "#/definitions/EventCategoryResponse" - IndustryCompanyResponse: - description: Response with IndustryCompany objects - schema: - $ref: "#/definitions/IndustryCompanyResponse" - AssetResponse: - description: Response with Asset objects - schema: - $ref: "#/definitions/AssetResponse" - ClusterResponse: - description: Response with Cluster objects - schema: - $ref: "#/definitions/ClusterResponse" - CompanyProductResponse: - description: Response with an array of CompanyProduct objects - schema: - $ref: "#/definitions/CompanyProductResponse" - CompanyServiceResponse: - description: Response with CompanyService objects - schema: - $ref: "#/definitions/CompanyServiceResponse" - ContactResponse: - description: Response with Contact objects - schema: - $ref: "#/definitions/ContactResponse" - ContractResponse: - description: Response with an array of Contract objects - schema: - $ref: "#/definitions/ContractResponse" - DatabaseResponse: - description: Response with Database objects - schema: - $ref: "#/definitions/DatabaseResponse" - DocumentResponse: - description: Response with Document objects - schema: - $ref: "#/definitions/DocumentResponse" - DeleteResponse: - description: Response with Message Objects with Delete Status - schema: - $ref: "#/definitions/DeleteResponse" - CourseResponse: - description: Course Response Object - schema: - $ref: "#/definitions/CourseResponse" - FactorResponse: - description: Response with Factor objects - schema: - $ref: "#/definitions/FactorResponse" - FavoriteResponse: - description: Favorite Response Object - schema: - $ref: "#/definitions/FavoriteResponse" - FinancialStatementResponse: - description: Response with FinancialStatement objects - schema: - $ref: "#/definitions/FinancialStatementResponse" - IndustryProductResponse: - description: Response with Industry objects - schema: - $ref: "#/definitions/IndustryProductResponse" - CourseSectionResponse: - description: CourseSection Response Object - schema: - $ref: "#/definitions/CourseSectionResponse" - CourseLessonResponse: - description: CourseLesson Response Object - schema: - $ref: "#/definitions/CourseLessonResponse" - IndustryResponse: - description: Response with Industry objects - schema: - $ref: "#/definitions/IndustryResponse" - IndustryServiceResponse: - description: Response with IndustryService objects - schema: - $ref: "#/definitions/IndustryServiceResponse" - InvalidDataError: - description: Invalid data was sent - schema: - $ref: "#/definitions/InvalidError" - NotFound: - description: Resource was not found - schema: - $ref: "#/definitions/Error" - PromptResponse: - description: Response with Prompt objects - schema: - $ref: "#/definitions/PromptResponse" - PromptCategoryResponse: - description: Response with PromptCategory objects - schema: - $ref: "#/definitions/PromptCategoryResponse" - PromptAnswerResponse: - description: Response with PromptAnswer objects - schema: - $ref: "#/definitions/PromptAnswerResponse" - PromptTagResponse: - description: Response with PromptTag objects - schema: - $ref: "#/definitions/PromptTagResponse" - ObservationResponse: - description: Response with Observation objects - schema: - $ref: "#/definitions/ObservationResponse" - ResearchProjectCompanyResponse: - description: ResearchProjectCompany Response Object - schema: - $ref: "#/definitions/ResearchProjectCompanyResponse" - ResearchProjectDocumentResponse: - description: ResearchProjectDocument Response Object - schema: - $ref: "#/definitions/ResearchProjectDocumentResponse" - ResearchProjectProductResponse: - description: ResearchProjectProduct Response Object - schema: - $ref: "#/definitions/ResearchProjectProductResponse" - ResearchProjectServiceResponse: - description: ResearchProjectService Response Object - schema: - $ref: "#/definitions/ResearchProjectServiceResponse" - ResearchProjectResponse: - description: ResearchProject Response Object - schema: - $ref: "#/definitions/ResearchProjectResponse" - ResearchProjectTopicResponse: - description: ResearchProjectTopic Response Object - schema: - $ref: "#/definitions/ResearchProjectTopicResponse" - RoleResponse: - description: Response with Role objects - schema: - $ref: "#/definitions/RoleResponse" - SalesforcePostResponse: - description: Response from Salesforce - schema: - $ref: "#/definitions/SalesforcePostResponse" - ServerError: - description: Server Internal Error - schema: - $ref: "#/definitions/Error" - TemplateResponse: - description: Response with Template objects - schema: - $ref: "#/definitions/TemplateResponse" - TenantResponse: - description: Response with Tenant objects - schema: - $ref: "#/definitions/TenantResponse" - TopicResponse: - description: Response with Topic objects - schema: - $ref: "#/definitions/TopicResponse" - Unauthorized: - description: Access unauthorized, invalid API-KEY was used - schema: - $ref: "#/definitions/Error" - UnprocessableEntity: - description: Unprocessable Entity, likely a bad parameter - schema: - $ref: "#/definitions/Error" - UserResponse: - description: Response with User objects - schema: - $ref: "#/definitions/UserResponse" -paths: - /accounts: - delete: - description: Delete Account record - operationId: deleteAccount - parameters: - - $ref: "#/parameters/accountIdQuery" - responses: - "200": - $ref: "#/responses/DeleteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete An Account - tags: - - Accounts - get: - description: Return a list of all available Accounts - operationId: getAccounts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/nameQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/accountIdQuery" - - $ref: "#/parameters/emailQuery" - responses: - "200": - $ref: "#/responses/AccountResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of accounts - tags: - - Accounts - post: - description: Account record to be added - operationId: postAccounts - parameters: - - $ref: "#/parameters/accountRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new account - tags: - - Accounts - put: - description: Update one or more accounts specified by accountId - operationId: putAccounts - parameters: - - $ref: "#/parameters/accountRequest" - responses: - "200": - $ref: "#/responses/AccountResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update a single account - tags: - - Accounts - /assets: - get: - description: Return a list of all available Assets - operationId: getAssets - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/assetIdQuery" - responses: - "200": - $ref: "#/responses/AssetResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of assets - tags: - - Assets - post: - description: Industry record to be added - operationId: postAssets - parameters: - - $ref: "#/parameters/assetRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new asset - tags: - - Assets - /clusters: - get: - description: Return a list of Cluster records from the datastore - operationId: getClusters - parameters: - - $ref: "#/parameters/clusterIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Clusters - tags: - - Clusters - post: - description: Create Clusters in Salesforce - operationId: postClusters - parameters: - - $ref: "#/parameters/clusterRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Clusters - tags: - - Clusters - put: - description: Update Cluster in Salesforce - operationId: putClusters - parameters: - - $ref: "#/parameters/clusterRequest" - responses: - "200": - $ref: "#/responses/ClusterResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Clusters - tags: - - Clusters - /companyproducts: - get: - description: Return a list of all available CompanyProducts - operationId: getCompanyProducts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/companyProductIdQuery" - responses: - "200": - $ref: "#/responses/CompanyProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of companyproducts - tags: - - CompanyProducts - post: - description: Industry record to be added - operationId: postCompanyProducts - parameters: - - $ref: "#/parameters/companyProductRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new companyproduct - tags: - - CompanyProducts - /companyservices: - get: - description: Return a list of all available CompanyServices - operationId: getCompanyServices - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/companyServiceIdQuery" - responses: - "200": - $ref: "#/responses/CompanyServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of companyservices - tags: - - CompanyServices - post: - description: Industry record to be added - operationId: postCompanyServices - parameters: - - $ref: "#/parameters/companyServiceRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new companyservice - tags: - - CompanyServices - /contacts: - delete: - description: Delete Contact record from Salesforce - operationId: deleteContacts - parameters: - - $ref: "#/parameters/contactIdQuery" - responses: - "200": - $ref: "#/responses/ContactResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Delete a Contact record - tags: - - Contacts - get: - description: Retrieve Contact records from Salesforce - operationId: getContacts - parameters: - - $ref: "#/parameters/contactIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/nameQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/accountIdQuery" - - $ref: "#/parameters/emailQuery" - responses: - "200": - $ref: "#/responses/ContactResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a Contact record - tags: - - Contacts - post: - description: Contacts record to be added - operationId: postContacts - parameters: - - $ref: "#/parameters/contactRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new Contacts - tags: - - Contacts - put: - description: Update Contact records in Salesforce - operationId: putContacts - parameters: - - $ref: "#/parameters/contactRequest" - responses: - "200": - $ref: "#/responses/ContactResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update a Contact record - tags: - - Contacts - /contracts: - get: - description: Return a list of all available Contracts - operationId: getContracts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/contractIdQuery" - responses: - "200": - $ref: "#/responses/ContractResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of contracts - tags: - - Contracts - /courselessons: - get: - operationId: getCourseLessons - security: - - ApiKeyAuth: [] - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/CourseLessonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of CourseLessons - tags: - - Courses - post: - operationId: postCourseLesson - security: - - ApiKeyAuth: [] - parameters: - - $ref: "#/parameters/CourseLessonRequest" - responses: - "200": - $ref: "#/responses/CourseLessonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new CourseLesson - tags: - - Courses - put: - security: - - ApiKeyAuth: [] - operationId: updateCourseLesson - parameters: - - $ref: "#/parameters/CourseLessonRequest" - responses: - "200": - $ref: "#/responses/CourseLessonResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Update an existing CourseLesson - tags: - - Courses - /courses: - get: - description: Return a list of Course records from the datastore - operationId: getCourses - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/CourseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Courses - tags: - - Courses - post: - description: Create Courses in Salesforce - operationId: postCourses - parameters: - - $ref: "#/parameters/CourseRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Courses - tags: - - Courses - put: - description: Update Course in Salesforce - operationId: putCourses - parameters: - - $ref: "#/parameters/CourseRequest" - responses: - "200": - $ref: "#/responses/CourseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Courses - tags: - - Courses - /coursesections: - get: - security: - - ApiKeyAuth: [] - operationId: getCourseSections - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/CourseSectionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of CourseSections - tags: - - Courses - post: - security: - - ApiKeyAuth: [] - operationId: postCourseSection - parameters: - - $ref: "#/parameters/CourseSectionRequest" - responses: - "200": - $ref: "#/responses/CourseSectionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new CourseSection - tags: - - Courses - put: - security: - - ApiKeyAuth: [] - operationId: updateCourseSection - parameters: - - $ref: "#/parameters/CourseSectionRequest" - responses: - "200": - $ref: "#/responses/CourseSectionResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Update an existing CourseSection - tags: - - Courses - /databases: - get: - description: Return a list of Database records from the datastore - operationId: getDatabases - parameters: - - $ref: "#/parameters/databaseIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Databases - tags: - - Databases - post: - description: Create Databases in Salesforce - operationId: postDatabases - parameters: - - $ref: "#/parameters/databaseRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Databases - tags: - - Databases - put: - description: Update Database in Salesforce - operationId: putDatabases - parameters: - - $ref: "#/parameters/databaseRequest" - responses: - "200": - $ref: "#/responses/DatabaseResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Databases - tags: - - Databases - /documents: - get: - description: Return a list of Document records from the datastore - operationId: getDocuments - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/DocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Documents - tags: - - Documents - post: - description: Create Documents in Salesforce - operationId: postDocuments - parameters: - - $ref: "#/parameters/documentRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Documents - tags: - - Documents - put: - description: Update Document in Salesforce - operationId: putDocuments - parameters: - - $ref: "#/parameters/documentRequest" - responses: - "200": - $ref: "#/responses/DocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Documents - tags: - - Documents - /eventcategories: - get: - security: - - ApiKeyAuth: [] - operationId: getEventCategories - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/idQuery" - responses: - "200": - $ref: "#/responses/EventCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of Eventcategories - tags: - - Events - post: - security: - - ApiKeyAuth: [] - operationId: postEventCategories - parameters: - - $ref: "#/parameters/EventCategoryRequest" - responses: - "200": - $ref: "#/responses/EventCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create a new EventCategory - tags: - - Events - /events: - delete: - security: - - ApiKeyAuth: [] - operationId: deleteEvent - parameters: - - $ref: "#/parameters/idQuery" - responses: - "204": - description: No Content - summary: Delete a Event - tags: - - Events - get: - security: - - ApiKeyAuth: [] - operationId: getEvents - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/idQuery" - responses: - "200": - $ref: "#/responses/EventResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Get a list of Events - tags: - - Events - put: - security: - - ApiKeyAuth: [] - operationId: updateEvent - parameters: - - $ref: "#/parameters/idQuery" - responses: - "200": - $ref: "#/responses/EventResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Update an existing Event - tags: - - Events - /factors: - get: - description: Return a list of all available Factors - operationId: getFactors - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/factorIdQuery" - responses: - "200": - $ref: "#/responses/FactorResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of factors - tags: - - Factors - post: - description: Factor record to be added - operationId: postFactors - parameters: - - $ref: "#/parameters/factorRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new Factor - tags: - - Factors - /favorites: - get: - description: Return a list of Favorite records from the datastore - operationId: getFavorites - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/FavoriteResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Favorites - tags: - - Favorites - /financialstatements: - get: - description: Return a list of all available FinancialStatements - operationId: getFinancialStatements - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/financialStatementIdQuery" - responses: - "200": - $ref: "#/responses/FinancialStatementResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of financialStatements - tags: - - FinancialStatements - post: - description: FinancialStatement record to be added - operationId: postFinancialStatements - parameters: - - $ref: "#/parameters/financialStatementRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new FinancialStatement - tags: - - FinancialStatements - /industries: - get: - description: Return a list of all available Industries - operationId: getIndustries - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/industryIdQuery" - responses: - "200": - $ref: "#/responses/IndustryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of industries - tags: - - Industries - post: - description: Industry record to be added - operationId: postIndustries - parameters: - - $ref: "#/parameters/industryRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new industry - tags: - - Industries - /industrycompanies: - get: - description: Return a list of all available IndustryCompanies - operationId: getIndustryCompanies - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/industryCompanyIdQuery" - responses: - "200": - $ref: "#/responses/IndustryCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of industryCompanies - tags: - - IndustryCompanies - post: - description: IndustryCompany record to be added - operationId: postIndustryCompanies - parameters: - - $ref: "#/parameters/industryCompanyRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new IndustryCompany - tags: - - IndustryCompanies - /industryservices: - get: - description: Return a list of all available IndustryServices - operationId: getIndustryServices - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/industryServiceIdQuery" - responses: - "200": - $ref: "#/responses/IndustryServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of industryServices - tags: - - IndustryServices - post: - description: IndustryService record to be added - operationId: postIndustryServices - parameters: - - $ref: "#/parameters/industryServiceRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new IndustryService - tags: - - IndustryServices - /industryproducts: - get: - description: Return a list of all available IndustryProducts - operationId: getIndustryProducts - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/industryProductIdQuery" - responses: - "200": - $ref: "#/responses/IndustryProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of industryProducts - tags: - - IndustryProducts - post: - description: Industry record to be added - operationId: postIndustryproducts - parameters: - - $ref: "#/parameters/industryProductRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new industryproduct - tags: - - IndustryProducts - /observations: - get: - description: Return a list of all available Observations - operationId: getObservations - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/observationIdQuery" - responses: - "200": - $ref: "#/responses/ObservationResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of observations - tags: - - Observations - post: - description: Observation record to be added - operationId: postObservations - parameters: - - $ref: "#/parameters/observationRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add a new Observation - tags: - - Observations - /promptanswers: - get: - description: Return a list of PromptAnswers records from the datastore - operationId: getPromptAnswers - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptAnswerResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of PromptResponses - tags: - - Prompts - post: - description: Create PromptAnswers - operationId: postPromptAnswers - parameters: - - $ref: "#/parameters/PromptAnswerRequest" - responses: - "200": - $ref: "#/responses/PromptAnswerResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new PromptResponses - tags: - - Prompts - put: - description: Update PromptAnswers - operationId: putPromptAnsweers - parameters: - - $ref: "#/parameters/PromptAnswerRequest" - responses: - "200": - $ref: "#/responses/PromptAnswerResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update PromptResponse - tags: - - Prompts - /prompts: - get: - description: Return a list of Prompt records from the datastore - operationId: getPrompts - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of Prompts - tags: - - Prompts - post: - description: Create Prompts - operationId: postPrompts - parameters: - - $ref: "#/parameters/PromptRequest" - responses: - "200": - $ref: "#/responses/PromptResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Prompts - tags: - - Prompts - put: - description: Update Prompt - operationId: putPrompts - parameters: - - $ref: "#/parameters/PromptRequest" - responses: - "200": - $ref: "#/responses/PromptResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Prompts - tags: - - Prompts - /promptcategories: - get: - description: Return a list of PromptCategory records from the datastore - operationId: getPromptCategories - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of PromptCategories - tags: - - Prompts - post: - description: Create PromptCategories - operationId: postPromptCategories - parameters: - - $ref: "#/parameters/PromptCategoryRequest" - responses: - "200": - $ref: "#/responses/PromptCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new PromptCategories - tags: - - Prompts - put: - description: Update PromptCategory - operationId: putPromptCategories - parameters: - - $ref: "#/parameters/PromptCategoryRequest" - responses: - "200": - $ref: "#/responses/PromptCategoryResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update PromptCategories - tags: - - Prompts - /prompttags: - get: - description: Return a list of PromptTag records from the datastore - operationId: getPromptTags - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/PromptTagResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of PromptTags - tags: - - Prompts - post: - description: Create PromptTags in Taxnexus - operationId: postPromptTags - parameters: - - $ref: "#/parameters/PromptTagRequest" - responses: - "200": - $ref: "#/responses/PromptTagResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new PromptTags - tags: - - Prompts - put: - description: Update PromptTag in Taxnexus - operationId: putPromptTags - parameters: - - $ref: "#/parameters/PromptTagRequest" - responses: - "200": - $ref: "#/responses/PromptTagResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update PromptTags - tags: - - Prompts - /researchprojectcompanies: - get: - description: Return a list of ResearchProjectCompany records from the datastore - operationId: getResearchProjectCompanies - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ResearchProjectCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectCompanies - tags: - - ResearchProjects - post: - description: Create ResearchProjectCompanies in the system - operationId: postResearchProjectCompanies - parameters: - - $ref: "#/parameters/ResearchProjectCompanyRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectCompanies - tags: - - ResearchProjects - put: - description: Update ResearchProjectCompany in the system - operationId: putResearchProjectCompanies - parameters: - - $ref: "#/parameters/ResearchProjectCompanyRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectCompanyResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectCompanies - tags: - - ResearchProjects - /researchprojectservices: - get: - description: Return a list of ResearchProjectService records from the datastore - operationId: getResearchProjectServices - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ResearchProjectServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectServices - tags: - - ResearchProjects - post: - description: Create ResearchProjectServices in the system - operationId: postResearchProjectServices - parameters: - - $ref: "#/parameters/ResearchProjectServiceRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectServiceResponse" - "201": - $ref: "#/responses/ResearchProjectServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectServices - tags: - - ResearchProjects - put: - description: Update ResearchProjectService in the system - operationId: putResearchProjectServices - parameters: - - $ref: "#/parameters/ResearchProjectServiceRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectServiceResponse" - "201": - $ref: "#/responses/ResearchProjectServiceResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - /researchprojectdocuments: - get: - description: Return a list of ResearchProjectDocument records from the datastore - operationId: getResearchProjectDocuments - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ResearchProjectDocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectDocuments - tags: - - ResearchProjects - post: - description: Create ResearchProjectDocuments in the system - operationId: postResearchProjectDocuments - parameters: - - $ref: "#/parameters/ResearchProjectDocumentRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectDocumentResponse" - "201": - $ref: "#/responses/ResearchProjectDocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectDocuments - tags: - - ResearchProjects - put: - description: Update ResearchProjectDocument in the system - operationId: putResearchProjectDocuments - parameters: - - $ref: "#/parameters/ResearchProjectDocumentRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectDocumentResponse" - "201": - $ref: "#/responses/ResearchProjectDocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectDocuments - tags: - - ResearchProjects - /researchprojectproducts: - get: - description: Return a list of ResearchProjectProduct records from the datastore - operationId: getResearchProjectProducts - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ResearchProjectProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectProducts - tags: - - ResearchProjects - post: - description: Create ResearchProjectProducts in the system - operationId: postResearchProjectProducts - parameters: - - $ref: "#/parameters/researchProjectProductRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectProducts - tags: - - ResearchProjects - put: - description: Update ResearchProjectProduct in the system - operationId: putResearchProjectProducts - parameters: - - $ref: "#/parameters/researchProjectProductRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectProductResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectProducts - tags: - - ResearchProjects - /researchprojects: - get: - description: Return a list of ResearchProject records from the datastore - operationId: getResearchProjects - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ResearchProjectResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjects - tags: - - ResearchProjects - post: - description: Create ResearchProjects in the system - operationId: postResearchProjects - parameters: - - $ref: "#/parameters/ResearchProjectRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjects - tags: - - ResearchProjects - put: - description: Update ResearchProject in the system - operationId: putResearchProjects - parameters: - - $ref: "#/parameters/ResearchProjectRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjects - tags: - - ResearchProjects - /researchprojecttopics: - get: - description: Return a list of ResearchProjectTopic records from the datastore - operationId: getResearchProjectTopics - parameters: - - $ref: "#/parameters/idQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/ResearchProjectTopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of ResearchProjectTopics - tags: - - ResearchProjects - post: - description: Create ResearchProjectTopics in the system - operationId: postResearchProjectTopics - parameters: - - $ref: "#/parameters/ResearchProjectTopicRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectTopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new ResearchProjectTopics - tags: - - ResearchProjects - put: - description: Update ResearchProjectTopic in the system - operationId: putResearchProjectTopics - parameters: - - $ref: "#/parameters/ResearchProjectTopicRequest" - responses: - "200": - $ref: "#/responses/ResearchProjectTopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update ResearchProjectTopics - tags: - - ResearchProjects - /roles: - get: - description: Return a list of Roles - operationId: getRoles - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/roleIdQuery" - responses: - "200": - $ref: "#/responses/RoleResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list of Roles - tags: - - Roles - /templates: - get: - description: Returns the PDF rendering template, or a link to where to get the template - operationId: getTemplates - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/templateIdQuery" - responses: - "200": - $ref: "#/responses/TemplateResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get PDF Rendering Templates - tags: - - Templates - /tenants: - get: - description: Return a list of Tenant records from the datastore - operationId: getTenants - parameters: - - $ref: "#/parameters/tenantIdQuery" - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Tenants - tags: - - Tenants - post: - description: Create Tenants in Salesforce - operationId: Tenants - parameters: - - $ref: "#/parameters/tenantRequest" - responses: - "201": - $ref: "#/responses/SalesforcePostResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create new Tenants - tags: - - Tenants - put: - description: Update Tenant in Salesforce - operationId: putTenants - parameters: - - $ref: "#/parameters/tenantRequest" - responses: - "200": - $ref: "#/responses/TenantResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update Tenants - tags: - - Tenants - /topics: - get: - description: Retrieve Topic records from the microservice - operationId: getTopics - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/topicIdQuery" - responses: - "200": - $ref: "#/responses/TopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get Topic records - tags: - - Topics - post: - description: Add new topics - operationId: postTopics - parameters: - - $ref: "#/parameters/topicRequest" - responses: - "200": - $ref: "#/responses/TopicResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Add new topics - tags: - - Topics - /users: - get: - description: Return a list of User records from the datastore - operationId: getUsers - parameters: - - $ref: "#/parameters/limitQuery" - - $ref: "#/parameters/offsetQuery" - - $ref: "#/parameters/userIdQuery" - - $ref: "#/parameters/activeQuery" - - $ref: "#/parameters/apiKeyQuery" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Get a list Users - tags: - - Users - post: - description: Create user records in Salesforce - operationId: postUsers - parameters: - - $ref: "#/parameters/newUserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Create new Salesforce User - tags: - - Users - put: - description: Update existing user records in Salesforce - operationId: putUsers - parameters: - - $ref: "#/parameters/newUserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update existing user records in Salesforce - tags: - - Users - /users/sessions: - put: - description: Update user records session data in Salesforce - operationId: putUsersSessions - parameters: - - $ref: "#/parameters/newUserRequest" - responses: - "200": - $ref: "#/responses/UserResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - security: - - ApiKeyAuth: [] - summary: Update user records session data in Salesforce - tags: - - Users -definitions: - Account: - properties: - AccountNumber: - description: Account Number - type: string - x-nullable: true - AccountSource: - description: The marketing origin of this account - type: string - x-nullable: true - Active: - type: boolean - x-nullable: true - AnnualRevenue: - description: Annual Revenue Estimate - format: double - type: number - x-nullable: true - BillingAddress: - $ref: "#/definitions/Address" - x-nullable: true - BillingContactID: - description: Contact ID - type: string - x-nullable: true - ClosedDate: - description: Closed Date - type: string - x-nullable: true - CloudRevenueTotal: - type: number - x-nullable: true - CloudType: - description: The type of cloud company - type: string - x-nullable: true - CloudYear: - description: The year company started cloud revenue - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - CrunchbaseURL: - description: Crunchbase URL - type: string - x-nullable: true - Description: - description: Description of the account - type: string - x-nullable: true - EIN: - type: string - x-nullable: true - EarningsCall: - description: Earnings Call Date - type: string - x-nullable: true - Email: - description: Main Account Email - type: string - x-nullable: true - EquityFunding: - description: The amount of equity EquityFunding - type: number - x-nullable: true - Facebook: - description: Company Facebook URL - type: string - x-nullable: true - Fax: - description: Fax number - type: string - x-nullable: true - FoundedDate: - description: Date company founded - type: string - x-nullable: true - ID: - description: Account Id - type: string - IPODate: - description: IPO Date - type: string - x-nullable: true - ImageAltText: - type: string - x-nullable: true - ImageURL: - type: string - x-nullable: true - Industries: - description: Industries - type: string - x-nullable: true - Industry: - description: Industry - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - LinkedIn: - description: Company LinkedIn URL - type: string - x-nullable: true - Location: - description: Headquarters Location Description - type: string - x-nullable: true - Logo: - description: Company Logo URL - type: string - x-nullable: true - MarketCapitalization: - description: Market Capitalization - type: number - x-nullable: true - Name: - description: Account Name - type: string - x-nullable: true - NumberInvestments: - description: Number of Investments - type: number - x-nullable: true - NumberOfEmployees: - description: Employee Count Estimate - format: int64 - type: number - x-nullable: true - OwnerID: - description: Account Owner User ID - type: string - x-nullable: true - Ownership: - description: Ownership - type: string - x-nullable: true - ParentID: - description: Parent Account - type: string - x-nullable: true - Phone: - description: Phone - type: string - x-nullable: true - Publish: - description: Publish this record? - type: boolean - x-nullable: true - SIC: - description: SIC Code - type: string - x-nullable: true - SICDesc: - description: SIC Description - type: string - x-nullable: true - SalesforceFirst: - description: A Salesforce-First company? - type: boolean - x-nullable: true - ShippingAddress: - $ref: "#/definitions/Address" - x-nullable: true - ShippingContactID: - description: Shipping Contact ID - type: string - x-nullable: true - Site: - description: Account Site - type: string - x-nullable: true - Slug: - description: Slug - type: string - x-nullable: true - TagLine: - description: Company tagline - type: string - x-nullable: true - TenantID: - description: Tenant Identifier - type: string - x-nullable: true - TickerSymbol: - description: Ticker Symbol - type: string - x-nullable: true - Twitter: - description: Twitter URL - type: string - x-nullable: true - Type: - description: Type - type: string - x-nullable: true - Website: - description: Website - type: string - x-nullable: true - YearStarted: - description: Year Started - type: string - x-nullable: true - type: object - AccountRequest: - properties: - data: - items: - $ref: "#/definitions/Account" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - AccountResponse: - description: An array of Account objects - properties: - data: - items: - $ref: "#/definitions/Account" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - Address: - properties: - City: - description: City - type: string - x-nullable: true - Country: - description: Country full name - type: string - x-nullable: true - CountryCode: - description: Country Code - type: string - x-nullable: true - PostalCode: - description: Postal Code - type: string - x-nullable: true - State: - description: State full name - type: string - x-nullable: true - StateCode: - description: State Code - type: string - x-nullable: true - Street: - description: Street number and name - type: string - x-nullable: true - type: object - Asset: - properties: - AccountID: - description: Account - type: string - x-nullable: true - Address: - $ref: "#/definitions/Address" - x-nullable: true - AssetLevel: - description: Asset Level - type: number - x-nullable: true - AssetProvidedByID: - description: Asset Provided By - type: string - x-nullable: true - AssetServicedByID: - description: Asset Serviced By - type: string - x-nullable: true - CompanyProductID: - description: Company Product - type: string - x-nullable: true - ConsequenceOfFailure: - description: Consequence Of Failure - type: string - x-nullable: true - ContactID: - description: Contact - type: string - x-nullable: true - CreatedByID: - description: Created By - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - CurrentAmount: - description: Current Amount - type: number - x-nullable: true - CurrentLifecycleEndDate: - description: Current Lifecycle End Date - type: string - x-nullable: true - CurrentMrr: - description: Current Monthly Recurring Revenue - type: number - x-nullable: true - CurrentQuantity: - description: Current Quantity - type: number - x-nullable: true - Description: - description: Description - type: string - x-nullable: true - DigitalAssetStatus: - description: Digital Asset Status - type: string - x-nullable: true - ExternalIdentifier: - description: External Id - type: string - x-nullable: true - HasLifecycleManagement: - description: Has Lifecycle Management - type: boolean - x-nullable: true - ID: - description: Record Id - type: string - InstallDate: - description: Install Date - type: string - x-nullable: true - IsCompetitorProduct: - description: Competitor Asset - type: boolean - x-nullable: true - IsInternal: - description: Internal Asset - type: boolean - x-nullable: true - LastModifiedByID: - description: Last Modified By - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - LocationID: - description: Location - type: string - x-nullable: true - MIMEType: - description: MIME Type - type: string - x-nullable: true - ManufactureDate: - description: Manufacture Date - type: string - x-nullable: true - Name: - description: Asset Name - type: string - x-nullable: true - ParentID: - description: Parent Asset - type: string - x-nullable: true - Price: - description: Price - type: number - x-nullable: true - Product2ID: - description: Product - type: string - x-nullable: true - ProductCode: - description: Product Code - type: string - x-nullable: true - ProductDescription: - description: Product Description - type: string - x-nullable: true - ProductFamily: - description: Product Family - type: string - x-nullable: true - PurchaseDate: - description: Purchase Date - type: string - x-nullable: true - Quantity: - description: Quantity - type: number - x-nullable: true - RootAssetID: - description: Root Asset - type: string - x-nullable: true - SerialNumber: - description: Serial Number - type: string - x-nullable: true - Status: - description: Status - type: string - x-nullable: true - StatusReason: - description: Status Reason - type: string - x-nullable: true - StockKeepingUnit: - description: Product SKU - type: string - x-nullable: true - TenantID: - description: Tenant ID - type: string - x-nullable: true - TotalLifecycleAmount: - description: Total Lifecycle Amount - type: number - x-nullable: true - Type: - description: Type - type: string - x-nullable: true - URL: - description: URL - type: string - x-nullable: true - UsageEndDate: - description: Usage End Date - type: string - x-nullable: true - type: object - AssetRequest: - description: An array of Asset objects - properties: - Data: - items: - $ref: "#/definitions/Asset" - type: array - type: object - AssetResponse: - description: An array of Asset objects - properties: - Data: - items: - $ref: "#/definitions/Asset" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Cluster: - properties: - CreatedByID: - description: Created By - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description - type: string - x-nullable: true - Environment: - description: Environment - type: string - x-nullable: true - Gateway: - description: Gateway - type: string - x-nullable: true - ID: - description: Record Id - type: string - IpAddress: - description: IP Address - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Name: - description: Cluster Name - type: string - x-nullable: true - OwnerID: - description: Owner - type: string - x-nullable: true - Ref: - description: External Reference - type: string - x-nullable: true - Status: - description: Status - type: string - x-nullable: true - Subnet: - description: Subnet - type: string - x-nullable: true - TenantID: - description: tenantid - type: string - x-nullable: true - Type: - description: Type - type: string - x-nullable: true - Zone: - description: Zone - type: string - x-nullable: true - type: object - ClusterRequest: - properties: - data: - items: - $ref: "#/definitions/Cluster" - type: array - meta: - $ref: "#/definitions/RequestMeta" - required: - - data - type: object - ClusterResponse: - description: An array of cluster objects - properties: - data: - items: - $ref: "#/definitions/Cluster" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - CompanyProduct: - description: A software product or service vended by a Company - properties: - AccountID: - description: ID of the Company that owns this Product - type: string - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description of product - type: string - x-nullable: true - FullDescription: - description: Full Description of product - type: string - x-nullable: true - ID: - description: Record Id - type: string - ImageAltText: - description: Image Alt Text - type: string - x-nullable: true - ImageURL: - description: Image URL - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Logo: - description: Logo - type: string - x-nullable: true - Name: - description: Product Name - type: string - x-nullable: true - ProductVideoID: - description: Product Video ID - type: string - x-nullable: true - Published: - description: Published - type: boolean - x-nullable: true - SalesforceSpecific: - description: Salesforce Specific - type: boolean - x-nullable: true - Slug: - description: Slug - type: string - x-nullable: true - TagLine: - description: TagLine - type: string - x-nullable: true - URL: - description: Website - type: string - x-nullable: true - type: object - CompanyProductRequest: - properties: - data: - items: - $ref: "#/definitions/CompanyProduct" - type: array - meta: - $ref: "#/definitions/RequestMeta" - required: - - data - type: object - CompanyProductResponse: - properties: - data: - items: - $ref: "#/definitions/CompanyProduct" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - CompanyService: - description: A service performed by a Company - properties: - ID: - description: Record Id - type: string - AccountID: - description: ID of the Company that owns this Service - type: string - AppExchange: - description: Salesforce AppExchange URL - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description of service - type: string - x-nullable: true - FullDescription: - description: Full Description of service - type: string - x-nullable: true - ImageAltText: - description: Image Alt Text - type: string - x-nullable: true - ImageURL: - description: Image URL - type: string - x-nullable: true - Industries: - description: Industries - items: - $ref: "../../lib/swagger/defs/industry.yaml#/Industry" - type: array - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Logo: - description: Logo - type: string - x-nullable: true - Name: - description: Service Name - type: string - x-nullable: true - Published: - description: Published - type: boolean - x-nullable: true - SalesforceSpecific: - description: Salesforce Specific - type: boolean - x-nullable: true - ServiceVideoID: - description: Service Video ID - type: string - x-nullable: true - Slug: - description: Slug - type: string - x-nullable: true - TagLine: - description: Tag Line - type: string - x-nullable: true - URL: - description: URL - type: string - x-nullable: true - type: object - CompanyServiceRequest: - description: An array of CompanyService objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/CompanyService" - type: array - type: object - CompanyServiceResponse: - description: An array of CompanyService objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/CompanyService" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Contact: - properties: - AccountID: - description: The primary account ID of this contact - type: string - x-nullable: true - AssistantName: - description: Assistant Name - type: string - x-nullable: true - AssistantPhone: - description: Asst. Phone - type: string - x-nullable: true - BirthDate: - description: Birthdate - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - CrunchbaseURL: - description: Crunchbase URL - type: string - x-nullable: true - Department: - description: Department - type: string - x-nullable: true - Description: - description: Description - type: string - x-nullable: true - DoNotCall: - description: Do Not Call? - type: boolean - x-nullable: true - Email: - description: Email address - type: string - x-nullable: true - EmailBounceDate: - description: Email Bounce Date - type: string - x-nullable: true - EmailBounceReason: - description: Email Bounce Reason - type: string - x-nullable: true - Facebook: - description: Fax Number - type: string - x-nullable: true - Fax: - type: string - x-nullable: true - FirstName: - description: First Name - type: string - x-nullable: true - HasOptedOutOfEmail: - description: Email Opt Out - type: boolean - x-nullable: true - HasOptedOutOfFax: - description: Fax Opt Out - type: boolean - x-nullable: true - HomePhone: - description: Home Phone - type: string - x-nullable: true - ID: - description: Record Id - type: string - IsEmailBounced: - description: Does this contact have bounced emails? - type: boolean - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - LastName: - description: Last Name - type: string - x-nullable: true - LeadSource: - description: Lead Source - type: string - x-nullable: true - LinkedIn: - description: LinkedIn Page - type: string - x-nullable: true - MailingAddress: - $ref: "#/definitions/Address" - MobilePhone: - description: Mobile Phone - type: string - x-nullable: true - Name: - description: Full Name - type: string - x-nullable: true - NumberInvestments: - description: Number of Investments - type: number - x-nullable: true - OtherAddress: - $ref: "#/definitions/Address" - OtherPhone: - description: Other Phone - type: string - x-nullable: true - OwnerID: - description: The User ID of the user who owns this Contact - type: string - x-nullable: true - PersonalEmail: - description: Personal Email Address for this Contact - type: string - x-nullable: true - Phone: - description: Phone Number - type: string - x-nullable: true - PhotoURL: - description: URL of a photograph of this User - type: string - x-nullable: true - ReportsToID: - description: Reports To User ID - type: string - x-nullable: true - Salutation: - description: Salutation - type: string - x-nullable: true - Slug: - description: Slug - type: string - x-nullable: true - TenantID: - description: tenant identifier - type: string - x-nullable: true - Title: - description: Contact Title - type: string - x-nullable: true - Twitter: - type: string - x-nullable: true - type: object - ContactRequest: - properties: - data: - items: - $ref: "#/definitions/Contact" - type: array - meta: - $ref: "#/definitions/RequestMeta" - required: - - data - type: object - ContactResponse: - properties: - data: - items: - $ref: "#/definitions/Contact" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - Contract: - properties: - AccountID: - description: Account - type: string - x-nullable: true - ActivatedByID: - description: Activated By - type: string - x-nullable: true - ActivatedDate: - description: Activated Date - type: string - x-nullable: true - BillingAddress: - $ref: "#/definitions/Address" - description: Billing Address - BillingContactID: - description: Billing Contact - type: string - x-nullable: true - CompanySignedDate: - description: Company Signed Date - type: string - x-nullable: true - CompanySignedID: - description: Company Signed By - type: string - x-nullable: true - ContractNumber: - description: Contract Number - type: string - x-nullable: true - ContractTerm: - description: Contract Term (months) - type: number - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - CustomerSignedDate: - description: Customer Signed Date - type: string - x-nullable: true - CustomerSignedID: - description: Customer Signed By - type: string - x-nullable: true - CustomerSignedTitle: - description: Customer Signed Title - type: string - x-nullable: true - DefaultEndUserID: - description: End User - type: string - x-nullable: true - Description: - description: Description - type: string - x-nullable: true - EndDate: - description: Contract End Date - type: string - x-nullable: true - EndUserID: - description: End User - type: string - x-nullable: true - HourlyRate: - description: Hourly Rate - type: number - x-nullable: true - ID: - description: Telnexus Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Name: - description: Contract Name - type: string - x-nullable: true - PaymentMethodID: - description: Payment Method - type: string - x-nullable: true - PaymentTerms: - description: Payment Terms - type: string - x-nullable: true - Perpetual: - description: Perpetual Agreement? - type: boolean - x-nullable: true - ShippingAddress: - $ref: "#/definitions/Address" - description: Shipping Address - ShippingContactID: - description: Shipping Contact - type: string - x-nullable: true - StartDate: - description: Contract Start Date - type: string - x-nullable: true - Status: - description: Status - type: string - x-nullable: true - TenantID: - description: Tenant Identifier - type: string - x-nullable: true - type: object - ContractRequest: - properties: - Data: - items: - $ref: "#/definitions/Contract" - type: array - type: object - ContractResponse: - properties: - Data: - items: - $ref: "#/definitions/Contract" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Database: - description: A Database provisioned and owned by a Tenant - properties: - Active: - description: Is this database active? - type: boolean - x-nullable: true - ClusterID: - description: The ID of the Cluster in which this database is deployed - type: string - x-nullable: true - CreatedByID: - description: Created By - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - DSN: - description: Database connection string - type: string - x-nullable: true - DatabaseName: - description: The name of the physical database in the cluster - type: string - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By - type: string - x-nullable: true - LastModifiedDate: - description: Last Modifed Date - type: string - x-nullable: true - Microservices: - description: List of microservices implemented by this Database - type: string - x-nullable: true - Status: - description: The current status of this Tenant - type: string - x-nullable: true - TenantID: - description: The ID of the tenant who owns this Database - type: string - x-nullable: true - Type: - description: The type of Database (mysql, etc) - type: string - x-nullable: true - type: object - DocumentRequest: - description: An array of Document objects - properties: - data: - items: - $ref: "../../lib/swagger/defs/document.yaml#/Document" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - DocumentResponse: - description: An array of Document objects - properties: - data: - items: - $ref: "../../lib/swagger/defs/document.yaml#/Document" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - DatabaseRequest: - description: An array of Database objects - properties: - data: - items: - $ref: "#/definitions/Database" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - DatabaseResponse: - description: An array of Database objects - properties: - data: - items: - $ref: "#/definitions/Database" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - DeleteResponse: - properties: - Data: - items: - $ref: "#/definitions/Message" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Error: - properties: - Code: - format: int64 - type: integer - Fields: - type: string - Message: - type: string - type: object - Factor: - description: A Factor of analysis within a research topic - properties: - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Topic Description - type: string - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Name: - description: Factor Name - type: string - x-nullable: true - Observations: - description: The list of Observations used to analyze this industry - items: - $ref: "#/definitions/Observation" - type: array - x-nullable: true - Slug: - description: The slug of the corresponding page on the CMS - type: string - x-nullable: true - TopicID: - description: The ID of the Topic that owns this Factor - type: string - x-nullable: true - type: object - FactorRequest: - description: An array of Factor objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/Factor" - type: array - type: object - FactorResponse: - description: An array of Factor objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/Factor" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - FavoriteRequest: - description: An array of Favorite objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/favorite.yaml#/Favorite" - type: array - type: object - FavoriteResponse: - description: An array of Favorite objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/favorite.yaml#/Favorite" - type: array - type: object - FinancialStatement: - description: A financial statement for a company - properties: - AccessNumber: - description: EDGAR Access Number - type: string - x-nullable: true - AccountID: - description: Account ID - type: string - x-nullable: true - CloudRevenue: - description: Cloud Revenue - type: number - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Description - type: string - x-nullable: true - EdgarURL: - description: EDGAR URL - type: string - x-nullable: true - FilingType: - description: Filing Type - type: string - x-nullable: true - GrossProfit: - description: Gross Profit - type: number - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - NetIncome: - description: Net Income - type: number - x-nullable: true - PeriodEndDate: - description: Period End Date - type: string - x-nullable: true - TotalRevenue: - description: Total Revenue - type: number - x-nullable: true - Year: - description: Year - type: string - x-nullable: true - type: object - FinancialStatementRequest: - description: An array of FinancialStatement objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/FinancialStatement" - type: array - type: object - FinancialStatementResponse: - description: An array of FinancialStatement objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/FinancialStatement" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - IndustryCompany: - description: Junction object between Industry and Company - properties: - CompanyID: - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - ID: - description: Record Id - type: string - IndustryID: - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Path: - type: string - x-nullable: true - type: object - IndustryCompanyRequest: - description: An array of IndustryCompany objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/IndustryCompany" - type: array - type: object - IndustryCompanyResponse: - description: An array of IndustryCompany objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/IndustryCompany" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - IndustryProduct: - description: Junction object between Industry and CompanyProduct - properties: - CompanyProduct: - $ref: "#/definitions/CompanyProduct" - CompanyProductID: - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - ID: - description: Record Id - type: string - Industry: - $ref: "../../lib/swagger/defs/industry.yaml#/Industry" - IndustryID: - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - type: object - IndustryProductRequest: - description: An array of IndustryProduct objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/IndustryProduct" - type: array - type: object - IndustryProductResponse: - description: An array of IndustryProduct objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/IndustryProduct" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - IndustryService: - description: Junction Object bewtwen Industry and CompanyService - properties: - ID: - description: Record Id - type: string - CompanyService: - $ref: "#/definitions/CompanyService" - CompanyServiceID: - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Industry: - $ref: "../../lib/swagger/defs/industry.yaml#/Industry" - IndustryID: - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - type: object - IndustryServiceRequest: - description: An array of IndustryService objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/IndustryService" - type: array - type: object - IndustryServiceResponse: - description: An array of IndustryService objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/IndustryService" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - IndustryRequest: - description: An array of Industry objects submitted for processing - properties: - Data: - items: - $ref: "../../lib/swagger/defs/industry.yaml#/Industry" - type: array - type: object - IndustryResponse: - description: An array of Industry objects produced in response to a request - properties: - Data: - items: - $ref: "../../lib/swagger/defs/industry.yaml#/Industry" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - InvalidError: - allOf: - - $ref: "#/definitions/Error" - - properties: - details: - items: - type: string - type: array - type: object - Message: - properties: - message: - type: string - ref: - type: string - x-nullable: true - status: - format: int64 - type: number - type: object - Observation: - description: A data point collected while analyzing a Factor - properties: - AccountID: - description: The ID of the Company being analyzed - type: string - x-nullable: true - CompanyProductID: - description: The ID of the Product being analyzed - type: string - x-nullable: true - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Notes concerning data collection - type: string - x-nullable: true - FactorID: - description: The ID of the Factor that owns this Observation - type: string - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - SubjectType: - description: Is the subject a Company or a Product? - type: string - x-nullable: true - Value: - description: The data point collected - type: string - x-nullable: true - type: object - ObservationRequest: - description: An array of Observation objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/Observation" - type: array - type: object - ObservationResponse: - description: An array of Observation objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/Observation" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Pagination: - properties: - limit: - format: int64 - type: number - pagesize: - format: int64 - type: number - poffset: - format: int64 - type: integer - setsize: - format: int64 - type: number - type: object - PromptAnswerRequest: - description: An array of Prompt objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-answer.yaml#/PromptAnswer" - type: array - type: object - PromptAnswerResponse: - description: An array of PromptResponse objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-answer.yaml#/PromptAnswer" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - RequestMeta: - properties: - ExternalAccount: - description: Account Number of the Reseller or OEM - type: string - type: object - ResponseMeta: - properties: - Contact: - description: Microservice Contact Info - type: string - Copyright: - description: Copyright Info - type: string - License: - description: License Information and Restrictions - type: string - OperationID: - description: Operation ID - type: string - Pagination: - $ref: "#/definitions/Pagination" - RequestIP: - description: Request IP Address - type: string - RequestType: - description: Request Type - type: string - RequestURL: - description: Request URL - type: string - ServerInfo: - description: Data Server Info - type: string - ServerResponseTime: - description: Data Server Response Time (ms) - type: string - ServerTimestamp: - description: Backend Server Timestamp - type: string - ExternalAccount: - description: Account Number used for recording transactions - type: string - type: object - Role: - description: A functional role within a Tenant - properties: - Auth0RoleID: - description: the corresponding auth0 role - type: string - x-nullable: true - CreatedByID: - description: created by - type: string - x-nullable: true - CreatedDate: - description: created date - type: string - x-nullable: true - Description: - description: role description - type: string - x-nullable: true - ID: - description: record id - type: string - LastModifiedByID: - description: last modified by - type: string - x-nullable: true - LastModifiedDate: - description: last modifed date - type: string - x-nullable: true - RoleName: - description: the name of this role - type: string - x-nullable: true - TenantID: - description: the id of the tenant that owns this role - type: string - x-nullable: true - type: object - RoleRequest: - description: An array of Role objects - properties: - data: - items: - $ref: "#/definitions/Role" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - RoleResponse: - description: An array of Role objects - properties: - data: - items: - $ref: "#/definitions/Role" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - SalesforcePost: - description: Relationship object that connects user to a role - properties: - ID: - type: string - type: object - SalesforcePostResponse: - description: An array of Print-Ready ingest Objects - properties: - data: - items: - $ref: "#/definitions/SalesforcePost" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - Template: - properties: - CreatedByID: - type: string - x-nullable: true - CreatedDate: - type: string - x-nullable: true - Description: - description: Description - type: string - x-nullable: true - HTML: - description: HTML Body - type: string - x-nullable: true - ID: - description: Record Id - type: string - IsActive: - description: Active? - type: boolean - x-nullable: true - IsMaster: - description: Master Template? - type: boolean - x-nullable: true - LastModifiedByID: - type: string - x-nullable: true - LastModifiedDate: - type: string - x-nullable: true - Name: - description: Template Name - type: string - x-nullable: true - ObjectType: - description: Object - type: string - x-nullable: true - RecordTypeName: - description: Record Type Name - type: string - x-nullable: true - TenantID: - description: tenant identifier - type: string - x-nullable: true - Type: - description: Type - type: string - x-nullable: true - URL: - description: URL - type: string - x-nullable: true - type: object - TemplateResponse: - properties: - data: - items: - $ref: "#/definitions/Template" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - Tenant: - description: Account Tenant - properties: - AccountID: - description: The Account that owns this Tenant - type: string - x-nullable: true - Active: - description: Is this Tenant currently active? - type: boolean - x-nullable: true - CreatedByID: - description: Created By - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Databases: - items: - $ref: "#/definitions/Database" - type: array - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By - type: string - x-nullable: true - LastModifiedDate: - description: Last Modifed Date - type: string - x-nullable: true - Roles: - items: - $ref: "#/definitions/Role" - type: array - Status: - description: The current status of this Tenant - type: string - x-nullable: true - TenantName: - description: Name of the Tenant Resource - type: string - x-nullable: true - TenantUsers: - items: - $ref: "#/definitions/TenantUser" - type: array - Type: - description: Type of tenant - type: string - x-nullable: true - Version: - description: The version number of the Tenant Onboarding system used to create this tenant - type: string - x-nullable: true - type: object - TenantRequest: - description: An array of Tenant objects - properties: - data: - items: - $ref: "#/definitions/Tenant" - type: array - meta: - $ref: "#/definitions/RequestMeta" - type: object - TenantResponse: - description: An array of Tenant objects - properties: - data: - items: - $ref: "#/definitions/Tenant" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - TenantUser: - description: Relationship object that connects users to a tenant - properties: - AccessLevel: - description: The Tenant access level for this User - type: string - TenantID: - description: The Tenant ID - type: string - UserID: - description: The User ID - type: string - type: object - Topic: - description: A research topic that collects data - properties: - CreatedByID: - description: Created By User ID - type: string - x-nullable: true - CreatedDate: - description: Created Date - type: string - x-nullable: true - Description: - description: Topic Description - type: string - x-nullable: true - Factors: - description: The list of Factors used to analyze this industry - items: - $ref: "#/definitions/Factor" - type: array - x-nullable: true - ID: - description: Record Id - type: string - LastModifiedByID: - description: Last Modified By User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - Name: - description: Topic Name - type: string - x-nullable: true - ParentTopicID: - description: The ID of the Parent Topic - type: string - x-nullable: true - Slug: - description: The CMS Slug for this Topic - type: string - x-nullable: true - type: object - TopicRequest: - description: An array of Topic objects submitted for processing - properties: - Data: - items: - $ref: "#/definitions/Topic" - type: array - type: object - TopicResponse: - description: An array of Topic objects produced in response to a request - properties: - Data: - items: - $ref: "#/definitions/Topic" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - User: - properties: - APIGatewayURL: - description: API Gateway URL - type: string - x-nullable: true - APIGatewayUser: - description: API Gateway User - type: string - x-nullable: true - APIKey: - description: API Key - type: string - x-nullable: true - AboutMe: - description: About Me - type: string - x-nullable: true - AccountID: - description: Account ID - type: string - x-nullable: true - Address: - $ref: "#/definitions/Address" - x-nullable: true - Alias: - description: Alias - type: string - x-nullable: true - Auth0UserID: - description: Auth0 User Id - type: string - x-nullable: true - CommunityNickname: - description: Nickname - type: string - x-nullable: true - CompanyName: - description: Company Name - type: string - x-nullable: true - ContactID: - description: Contact - type: string - x-nullable: true - CreatedByID: - description: Created User ID - type: string - x-nullable: true - CreatedDate: - description: Date Created - type: string - x-nullable: true - DelegatedApproverID: - description: Delegated Approver - type: string - x-nullable: true - Department: - description: Department - type: string - x-nullable: true - Division: - description: Division - type: string - x-nullable: true - Email: - description: Email address - type: string - x-nullable: true - EmployeeNumber: - description: Employee Number - type: string - x-nullable: true - EndOfDay: - description: Time day ends - type: string - x-nullable: true - Environment: - description: Environment - type: string - x-nullable: true - Extension: - description: Extension - type: string - x-nullable: true - FabricAPIKey: - description: Fabric API Key - type: string - x-nullable: true - Fax: - description: Fax - type: string - x-nullable: true - FirstName: - description: The first name - type: string - x-nullable: true - ForecastEnabled: - description: Allow Forecasting - type: boolean - x-nullable: true - FullPhotoURL: - description: Full Photo URL - type: string - x-nullable: true - GitHub: - description: GitHub - type: string - x-nullable: true - ID: - description: Record ID - type: string - IsActive: - description: Active - type: boolean - x-nullable: true - IsPortalEnabled: - description: Is the user enabled for Communities? - type: boolean - x-nullable: true - IsProfilePhotoActive: - description: Has Profile Photo - type: boolean - x-nullable: true - IsSystemControlled: - type: boolean - x-nullable: true - LastIP: - description: IP address of last login - type: string - x-nullable: true - LastLogin: - description: Last login time - type: string - x-nullable: true - LastModifiedByID: - description: Last Modified User ID - type: string - x-nullable: true - LastModifiedDate: - description: Last Modified Date - type: string - x-nullable: true - LastName: - description: The Last Name - type: string - x-nullable: true - LinkedIn: - description: LinkedIn - type: string - x-nullable: true - LoginCount: - description: Number of times user has logged in - format: int64 - type: number - x-nullable: true - ManagerID: - description: Manager - type: string - x-nullable: true - MobilePhone: - description: Mobile - type: string - x-nullable: true - Name: - description: Name - type: string - x-nullable: true - OutOfOfficeMessage: - description: Out of office message - type: string - x-nullable: true - Phone: - description: Phone - type: string - x-nullable: true - PortalRole: - description: Portal Role Level - type: string - x-nullable: true - ProfileID: - description: Profile - type: string - x-nullable: true - ReceivesAdminEmails: - description: Info Emails - type: boolean - x-nullable: true - ReceivesAdminInfoEmails: - description: Admin Info Emails - type: boolean - x-nullable: true - ReceivesInfoEmails: - description: Info Emails - type: boolean - x-nullable: true - SenderEmail: - description: Email Sender Address - type: string - x-nullable: true - SenderName: - description: Email Sender Name - type: string - x-nullable: true - Signature: - description: Email Signature - type: string - x-nullable: true - SmallPhotoURL: - description: Small Photo URL - type: string - x-nullable: true - StartOfDay: - description: The time day starts - type: string - x-nullable: true - Status: - description: Status - type: string - x-nullable: true - ExternalAccount: - description: Account - type: string - x-nullable: true - TenantID: - description: Tenant ID associated with this user - type: string - x-nullable: true - TenantUsers: - items: - $ref: "#/definitions/TenantUser" - type: array - x-nullable: true - TimeZone: - description: Time Zone - type: string - x-nullable: true - Title: - description: Title - type: string - x-nullable: true - Twitter: - description: Twitter - type: string - x-nullable: true - UserRoleID: - description: Role - type: string - x-nullable: true - UserRoles: - items: - $ref: "#/definitions/UserRole" - type: array - x-nullable: true - UserType: - description: User Type - type: string - x-nullable: true - Username: - description: Username - type: string - x-nullable: true - type: object - UserRequest: - description: An array of User Objects to post - properties: - data: - items: - $ref: "#/definitions/User" - type: array - type: object - UserResponse: - description: An array of Print-Ready ingest Objects - properties: - data: - items: - $ref: "#/definitions/User" - type: array - meta: - $ref: "#/definitions/ResponseMeta" - type: object - UserRole: - description: Relationship object that connects user to a role - properties: - Auth0roleID: - type: string - x-nullable: true - CreatedByID: - type: string - x-nullable: true - CreatedDate: - type: string - x-nullable: true - Description: - type: string - x-nullable: true - ID: - type: string - # Industries: - # description: Industries - # properties: - # items: - # $ref: "#/definitions/Industry" - LastModifiedByID: - type: string - x-nullable: true - LastModifiedDate: - type: string - x-nullable: true - Name: - type: string - x-nullable: true - RoleID: - type: string - x-nullable: true - UserID: - type: string - x-nullable: true - type: object - EventRequest: - description: An array of Event objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/event.yaml#/Event" - type: array - type: object - EventResponse: - description: An array of Event objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/event.yaml#/Event" - type: array - type: object - EventCategoryRequest: - description: An array of EventCategory objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/event-category.yaml#/EventCategory" - type: array - type: object - EventCategoryResponse: - description: An array of EventCategory objects - properties: - Meta: - $ref: "#/definitions/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/event-category.yaml#/EventCategory" - type: array - type: object - CourseLessonRequest: - description: An array of CourseLesson objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course-lesson.yaml#/CourseLesson" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CourseLessonResponse: - description: An array of CourseLesson objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course-lesson.yaml#/CourseLesson" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CourseRequest: - description: An array of Course objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course.yaml#/Course" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CourseResponse: - description: An array of Course objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course.yaml#/Course" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CourseSectionRequest: - description: An array of CourseSection objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course-section.yaml#/CourseSection" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - CourseSectionResponse: - description: An array of CourseSection objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/course-section.yaml#/CourseSection" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - ResearchProjectCompanyResponse: - description: An array of ResearchProjectCompany objects - properties: - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-company.yaml#/ResearchProjectCompany" - type: array - type: object - ResearchProjectRequest: - description: An array of ResearchProject objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project.yaml#/ResearchProject" - type: array - type: object - ResearchProjectResponse: - description: An array of ResearchProject objects - properties: - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project.yaml#/ResearchProject" - type: array - type: object - ResearchProjectDocumentRequest: - description: An array of ResearchProjectDocument objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-document.yaml#/ResearchProjectDocument" - type: array - type: object - ResearchProjectDocumentResponse: - description: An array of ResearchProjectDocument objects - properties: - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-document.yaml#/ResearchProjectDocument" - type: array - type: object - ResearchProjectProductRequest: - description: An array of ResearchProjectProduct objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-product.yaml#/ResearchProjectProduct" - type: array - type: object - ResearchProjectProductResponse: - description: An array of ResearchProjectProduct objects - properties: - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-product.yaml#/ResearchProjectProduct" - type: array - type: object - ResearchProjectTopicRequest: - description: An array of ResearchProjectTopic objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-topic.yaml#/ResearchProjectTopic" - type: array - type: object - ResearchProjectTopicResponse: - description: An array of ResearchProjectTopic objects - properties: - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-topic.yaml#/ResearchProjectTopic" - type: array - type: object - ResearchProjectCompanyRequest: - description: An array of ResearchProjectCompany objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-company.yaml#/ResearchProjectCompany" - type: array - type: object - ResearchProjectServiceRequest: - description: An array of ResearchProjectService objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/research-project-service.yaml#/ResearchProjectService" - type: array - type: object - ResearchProjectServiceResponse: - description: An array of ResearchProjectService objects - properties: - Meta: - $ref: "../../lib/swagger/defs/response-meta.yaml#/ResponseMeta" - Data: - items: - $ref: "../../lib/swagger/defs/research-project-service.yaml#/ResearchProjectService" - type: array - type: object - PromptRequest: - description: An array of Prompt objects - properties: - Data: - items: - $ref: "#/definitions/Prompt" - type: array - type: object - PromptResponse: - description: An array of Prompt objects - properties: - Data: - items: - $ref: "#/definitions/Prompt" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - PromptCategoryRequest: - description: An array of PromptCategory objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-category.yaml#/PromptCategory" - type: array - type: object - PromptCategoryResponse: - description: An array of PromptCategory objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-category.yaml#/PromptCategory" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - PromptTagRequest: - description: An array of PromptTag objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-tag.yaml#/PromptTag" - type: array - type: object - PromptTagResponse: - description: An array of PromptTag objects - properties: - Data: - items: - $ref: "../../lib/swagger/defs/prompt-tag.yaml#/PromptTag" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Prompt: - description: A prompt - properties: - ID: - description: Record Id - type: string - CreatedByID: - description: The ID of the user who created the prompt - type: string - x-nullable: true - CreatedDate: - description: The date the prompt was created - type: string - x-nullable: true - Icon: - description: The icon for the prompt - type: string - x-nullable: true - ImageAltText: - description: The alt text for the prompt image - type: string - x-nullable: true - ImageURL: - description: The URL of the prompt image - type: string - x-nullable: true - LastModifiedByID: - description: The ID of the user who last modified the prompt - type: string - x-nullable: true - LastModifiedDate: - description: The date the prompt was last modified - type: string - x-nullable: true - Logo: - description: The logo for the prompt - type: string - x-nullable: true - Model: - description: The model for the prompt - type: string - x-nullable: true - Name: - description: The name of the prompt - type: string - x-nullable: true - Order: - description: The order of the prompt - type: number - x-nullable: true - Parameters: - description: A list of parameters encoded as JSON - type: string - x-nullable: true - Prompt: - description: The prompt text - type: string - x-nullable: true - PromptCategoryID: - description: The ID of the prompt category - type: string - x-nullable: true - ResearchProjectIDs: - description: A list of research project IDs - items: - type: string - type: array - x-nullable: true - Slug: - description: The slug for the prompt - type: string - x-nullable: true - SystemPrompt: - description: The System prompt to be used - type: string - x-nullable: true - Tags: - description: A list of tags (from salesforce newline separated) - type: string - x-nullable: true - Temperature: - description: The temperature of the prompt - type: number - x-nullable: true - TenantID: - description: The ID of the tenant - type: string - x-nullable: true - Title: - description: The title of the prompt - type: string - x-nullable: true - UsedCount: - description: The number of times the prompt has been used - type: number - x-nullable: true - UserID: - description: The ID of the user who created the prompt - type: string - x-nullable: true - type: object diff --git a/swagger/external/stash-vernonkeenan.yaml b/swagger/external/stash-vernonkeenan.yaml deleted file mode 100644 index e58828c..0000000 --- a/swagger/external/stash-vernonkeenan.yaml +++ /dev/null @@ -1,215 +0,0 @@ -swagger: "2.0" -info: - version: 0.3.0 - title: "stash" - description: "PDF Storage Microservice" - termsOfService: "https://salesforcedevops.net/terms/" - contact: - email: "vern@vernonkeenan.com" - license: - name: "Proprietary - Copyright (c) 2018-2023 by Vernon Keenan" -securityDefinitions: - ApiKeyAuth: - type: "apiKey" - in: "header" - name: "X-API-Key" -security: - - ApiKeyAuth: [] -schemes: - - "https" -basePath: "/vk/stash/v1" -host: "gw.tnxs.net" -consumes: - - "application/json" -produces: - - "application/json" -parameters: - X-API-Key: - name: X-API-Key - in: "header" - required: true - type: string - PDFRequest: - description: An array of new PDF records - in: body - name: PDFRequest - required: true - schema: - $ref: "#/definitions/PDFRequest" - pdfIdQueryRequired: - description: PDF record ID - in: query - name: pdfId - required: true - type: string -responses: - AccessForbidden: - description: "Access forbidden, account lacks access" - schema: - $ref: "#/definitions/Error" - NotFound: - description: Resource was not found - schema: - $ref: "#/definitions/Error" - PdfResponse: - description: Response with an array of pdfs - schema: - $ref: "#/definitions/DocumentResponse" - ServerError: - description: Server Internal Error - schema: - $ref: "#/definitions/Error" - Unauthorized: - description: "Access Unauthorized, invalid API-KEY was used" - schema: - $ref: "#/definitions/Error" - UnprocessableEntity: - description: "Unprocessable Entity, likely a bad parameter" - schema: - $ref: "#/definitions/Error" - DocumentResponse: - description: Rendered documents response - schema: - $ref: "#/definitions/DocumentResponse" -paths: - /pdfs: - post: - description: Store new PDFs - operationId: postPdfs - parameters: - - $ref: "#/parameters/PDFRequest" - responses: - "200": - $ref: "#/responses/DocumentResponse" - "401": - $ref: "#/responses/Unauthorized" - "403": - $ref: "#/responses/AccessForbidden" - "404": - $ref: "#/responses/NotFound" - "422": - $ref: "#/responses/UnprocessableEntity" - "500": - $ref: "#/responses/ServerError" - summary: Create new PDFs - tags: - - StashPdf -definitions: - Document: - properties: - Filename: - type: string - ID: - type: string - SagaType: - type: string - ParentID: - type: string - Title: - type: string - URI: - type: string - type: object - DocumentResponse: - description: An array of rendered documents - properties: - Data: - items: - $ref: "#/definitions/Document" - type: array - Meta: - $ref: "#/definitions/ResponseMeta" - type: object - Error: - properties: - Code: - format: int64 - type: number - Fields: - type: string - Message: - type: string - type: object - NewPDF: - properties: - Description: - description: Description - type: string - Filename: - description: Filename only - type: string - HTML: - description: The HTML data in text format - type: string - LastAccessedByID: - description: Last Accessed By - type: string - ObjectType: - description: This document's financial object origination - type: string - OwnerID: - description: User who created the PDF - type: string - ParentID: - description: ID of the record that owns this PDF - type: string - Ref: - description: External reference if any - type: string - Title: - description: Document descriptive title - type: string - type: object - PDFRequest: - properties: - Data: - items: - $ref: "#/definitions/NewPDF" - type: array - Meta: - $ref: "#/definitions/RequestMeta" - type: object - RequestMeta: - properties: - ExternalAccount: - description: Account Number of the Reseller or OEM - type: string - required: - - ExternalAccount - type: object - ResponseMeta: - properties: - Contact: - description: Microservice Contact Info - type: string - Copyright: - description: Copyright Info - type: string - License: - description: License Information and Restrictions - type: string - OperationID: - description: Operation ID - type: string - RequestIP: - description: Request IP Address - type: string - RequestType: - description: Request Type - type: string - RequestURL: - description: Request URL - type: string - ServerInfo: - description: Data Server Info - type: string - ServerResponseTime: - description: Data Server Response Time (ms) - type: string - ServerTimestamp: - description: Backend Server Timestamp - type: string - ExternalAccount: - description: Account Number used for recording transactions - type: string - type: object diff --git a/swagger/external/workflow-work.yaml b/swagger/external/workflow-work.yaml new file mode 100644 index 0000000..7569445 --- /dev/null +++ b/swagger/external/workflow-work.yaml @@ -0,0 +1,585 @@ +swagger: "2.0" +info: + version: 1.3.0 + title: "workflow" + description: "Workflow Microservice" + termsOfService: "http://workdifferentwithai.com/terms/" + contact: + email: "noc@workdifferentwithai.com" + license: + name: "Proprietary - Copyright (c) 2023 by WorkDifferentWithAI.com" +securityDefinitions: + ApiKeyAuth: + type: "apiKey" + in: "header" + name: "X-API-Key" +schemes: + - "https" +basePath: "/vk/workflow/v1" +host: "workflow.work.tnxs.net:8080" +consumes: + - "application/json" +produces: + - "application/json" +parameters: + emailMessageIdQuery: + description: Email Message ID + in: query + name: emailMessageId + type: string + OutgoingEmailMessageRequest: + description: An array of new Outgoing Email Message records + in: body + name: OutgoingEmailMessageRequest + required: true + schema: + $ref: "#/definitions/OutgoingEmailMessageRequest" + AppLogRequest: + description: An array of new AppLog records + in: body + name: AppLogRequest + required: true + schema: + $ref: "#/definitions/AppLogRequest" +responses: + AppLogResponse: + description: "Array of AppLogs" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/AppLogResponse" + EmailMessagesResponse: + description: "Array of Email Messages" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/EmailMessagesResponse" + AccessForbidden: + description: "Access forbidden, account lacks access" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + NotFound: + description: Resource was not found + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + ServerError: + headers: + Access-Control-Allow-Origin: + type: string + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + Unauthorized: + headers: + Access-Control-Allow-Origin: + type: string + description: "Access Unauthorized, invalid API-KEY was used" + schema: + $ref: "#/definitions/Error" + UnprocessableEntity: + headers: + Access-Control-Allow-Origin: + type: string + description: "Unprocessable Entity, likely a bad parameter" + schema: + $ref: "#/definitions/Error" + CORSResponse: + description: CORS OPTIONS response + headers: + Access-Control-Allow-Origin: + type: string + Access-Control-Allow-Headers: + type: string + Access-Control-Allow-Methods: + type: string + Access-Control-Expose-Headers: + type: string + Access-Control-Max-Age: + type: string + Access-Control-Allow-Credentials: + type: string + Cache-Control: + type: string +paths: + /applogs: + options: + operationId: appLogOptions + description: CORS support + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + security: + - ApiKeyAuth: [] + summary: Post app log messages + operationId: postAppLogs + description: Insert app log messages into workflow storage + parameters: + - $ref: "#/parameters/AppLogRequest" + responses: + "200": + $ref: "#/responses/AppLogResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + tags: + - AppLog + /emailmessages: + options: + operationId: emailMessageOptions + description: CORS support + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + get: + security: + - ApiKeyAuth: [] + summary: "Get email messages from data store" + operationId: getEmailMessages + description: "Retrieves email messages from workflow storage" + parameters: + - $ref: "#/parameters/emailMessageIdQuery" + tags: + - "EmailMessage" + responses: + "200": + $ref: "#/responses/EmailMessagesResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + /outgoingemailmessages: + options: + operationId: outgoingEmailMessageOptions + description: CORS support + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + security: + - ApiKeyAuth: [] + summary: Add new email messages to the outgoing queue + operationId: postOutgoingEmailMessages + description: Insert new email messages into workflow storage + parameters: + - $ref: "#/parameters/OutgoingEmailMessageRequest" + responses: + "200": + $ref: "#/responses/EmailMessagesResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + tags: + - OutgoingEmailMessage +definitions: + AppLog: + description: Application Log for human consumption + properties: + AccountID: + type: string + CompanyID: + type: string + CreatedByID: + type: string + CreatedDate: + type: string + ID: + type: string + Message: + type: string + ObjectID: + type: string + ObjectType: + type: string + Severity: + type: string + Source: + type: string + SourceTimestamp: + type: string + type: object + AppLogRequest: + description: An array Application Log objects + properties: + data: + items: + $ref: "#/definitions/AppLog" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + AppLogResponse: + description: An array Application Log objects + properties: + data: + items: + $ref: "#/definitions/AppLog" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Document: + description: Document + properties: + ArchivedByID: + type: string + ArchivedDate: + type: string + AuthorID: + type: string + Body: + format: byte + type: string + BodyLength: + format: int64 + type: number + CommentCount: + format: int64 + type: number + ConnectionID: + type: string + ContentAssetID: + type: string + ContentModificationDate: + type: string + ContentSize: + format: int64 + type: number + ContentType: + type: string + ContentVersionDocumentID: + type: string + ContnetDocumentID: + type: string + CreatedByID: + type: string + CreatedDate: + type: string + DDate: + type: string + Description: + type: string + DeveloperName: + type: string + Discount: + type: number + Document: + format: byte + type: string + DocumentID: + type: string + DocumentSequence: + format: int64 + type: number + Field: + type: string + FileExtension: + type: string + FileType: + type: string + FolderID: + type: string + GrandTotal: + type: string + ID: + type: string + InsertedByID: + type: string + IsArchived: + type: boolean + IsBodySearchable: + type: boolean + IsCommentSub: + type: boolean + IsDocumentSub: + type: boolean + IsInternalUseOnly: + type: boolean + IsPublic: + type: boolean + IsRichText: + type: boolean + Keywords: + type: string + LastModifiedByID: + type: string + LastModifiedDate: + type: string + LastViewedDate: + type: string + LatstPublishedVersionID: + type: string + LikeCount: + format: int64 + type: number + LinkURL: + type: string + LinkedEntityID: + type: string + Name: + type: string + NamespacePrefix: + type: string + NetworkScope: + type: string + OwnerID: + type: string + ParentID: + type: string + Publishstatus: + type: string + QuoteID: + type: string + RelatedRecordID: + type: string + ShareType: + type: string + SharingOption: + type: string + SharingPrivacy: + type: string + Title: + type: string + Type: + type: string + URL: + type: string + UserID: + type: string + Visibility: + type: string + type: object + EmailMessage: + properties: + ActivityID: + type: string + BCCAddress: + type: string + CCAddress: + type: string + CreatedByID: + type: string + CreatedDate: + type: string + EmailMessageID: + type: string + FromAddress: + type: string + FromName: + type: string + HTML: + format: byte + type: string + HasAttachment: + type: boolean + Headers: + $ref: "#/definitions/Headers" + ID: + type: string + Incoming: + type: boolean + IsClientManaged: + type: boolean + IsExternallyManaged: + type: boolean + LastModifiedByID: + type: string + LastModifiedDate: + type: string + MessageDate: + type: string + MessageIdentifier: + type: string + ParentID: + type: string + RelatedToID: + type: string + RelationAddress: + type: string + RelationID: + type: string + RelationObjectType: + type: string + RelationType: + type: string + ReplyToEmailMessageID: + type: string + Status: + type: string + Subject: + type: string + Text: + format: byte + type: string + ThreadIdentifier: + type: string + ToAddress: + type: string + ValidatedFromAddress: + type: string + type: object + EmailMessageRequest: + description: An array Send Email Message objects + properties: + data: + items: + $ref: "#/definitions/EmailMessage" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + EmailMessagesResponse: + description: An array user objects + properties: + data: + items: + $ref: "#/definitions/EmailMessage" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Error: + properties: + Code: + format: int32 + type: integer + Fields: + type: string + Message: + type: string + type: object + Headers: + type: object + properties: + Key: + type: string + Values: + items: + items: + type: string + type: array + type: array + OutgoingEmailMessage: + description: A new email message to be sent + properties: + BCCAddress: + type: string + CCAddress: + type: string + EmailMessageID: + type: string + EmailTemplateID: + type: string + ExternalID: + type: string + FromContactID: + type: string + FromName: + type: string + Headers: + $ref: "#/definitions/Headers" + HTML: + type: string + ID: + type: string + Subject: + type: string + Text: + type: string + ToAddress: + type: string + ToName: + type: string + ValidatedFromAddress: + type: string + WhoID: + type: string + type: object + OutgoingEmailMessageRequest: + description: An array New Email Message objects + properties: + data: + items: + $ref: "#/definitions/OutgoingEmailMessage" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + RequestMeta: + properties: + TaxnexusAccount: + description: Account Number of the Reseller or OEM + type: string + required: + - TaxnexusAccount + type: object + ResponseMeta: + properties: + Contact: + description: Microservice Contact Info + type: string + Copyright: + description: Copyright Info + type: string + License: + description: License Information and Restrictions + type: string + OperationID: + description: Operation ID + type: string + RequestIP: + description: Request IP Address + type: string + RequestType: + description: Request Type + type: string + RequestURL: + description: Request URL + type: string + ServerInfo: + description: Data Server Info + type: string + ServerResponseTime: + description: Data Server Response Time (ms) + type: string + ServerTimestamp: + description: Backend Server Timestamp + type: string + TaxnexusAccount: + description: Account Number used for recording transactions + type: string + type: object diff --git a/swagger/workflow-work.yaml b/swagger/workflow-work.yaml new file mode 100644 index 0000000..773c08e --- /dev/null +++ b/swagger/workflow-work.yaml @@ -0,0 +1,585 @@ +swagger: "2.0" +info: + version: 1.3.0 + title: "workflow" + description: "Workflow Microservice" + termsOfService: "http://workdifferentwithai.com/terms/" + contact: + email: "noc@workdifferentwithai.com" + license: + name: "Proprietary - Copyright (c) 2023 by WorkDifferentWithAI.com" +securityDefinitions: + ApiKeyAuth: + type: "apiKey" + in: "header" + name: "X-API-Key" +schemes: + - "http" +basePath: "/v1" +host: "workflow.work.tnxs.net:8080" +consumes: + - "application/json" +produces: + - "application/json" +parameters: + emailMessageIdQuery: + description: Email Message ID + in: query + name: emailMessageId + type: string + OutgoingEmailMessageRequest: + description: An array of new Outgoing Email Message records + in: body + name: OutgoingEmailMessageRequest + required: true + schema: + $ref: "#/definitions/OutgoingEmailMessageRequest" + AppLogRequest: + description: An array of new AppLog records + in: body + name: AppLogRequest + required: true + schema: + $ref: "#/definitions/AppLogRequest" +responses: + AppLogResponse: + description: "Array of AppLogs" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/AppLogResponse" + EmailMessagesResponse: + description: "Array of Email Messages" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/EmailMessagesResponse" + AccessForbidden: + description: "Access forbidden, account lacks access" + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + NotFound: + description: Resource was not found + headers: + Access-Control-Allow-Origin: + type: string + schema: + $ref: "#/definitions/Error" + ServerError: + headers: + Access-Control-Allow-Origin: + type: string + description: Server Internal Error + schema: + $ref: "#/definitions/Error" + Unauthorized: + headers: + Access-Control-Allow-Origin: + type: string + description: "Access Unauthorized, invalid API-KEY was used" + schema: + $ref: "#/definitions/Error" + UnprocessableEntity: + headers: + Access-Control-Allow-Origin: + type: string + description: "Unprocessable Entity, likely a bad parameter" + schema: + $ref: "#/definitions/Error" + CORSResponse: + description: CORS OPTIONS response + headers: + Access-Control-Allow-Origin: + type: string + Access-Control-Allow-Headers: + type: string + Access-Control-Allow-Methods: + type: string + Access-Control-Expose-Headers: + type: string + Access-Control-Max-Age: + type: string + Access-Control-Allow-Credentials: + type: string + Cache-Control: + type: string +paths: + /applogs: + options: + operationId: appLogOptions + description: CORS support + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + security: + - ApiKeyAuth: [] + summary: Post app log messages + operationId: postAppLogs + description: Insert app log messages into workflow storage + parameters: + - $ref: "#/parameters/AppLogRequest" + responses: + "200": + $ref: "#/responses/AppLogResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + tags: + - AppLog + /emailmessages: + options: + operationId: emailMessageOptions + description: CORS support + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + get: + security: + - ApiKeyAuth: [] + summary: "Get email messages from data store" + operationId: getEmailMessages + description: "Retrieves email messages from workflow storage" + parameters: + - $ref: "#/parameters/emailMessageIdQuery" + tags: + - "EmailMessage" + responses: + "200": + $ref: "#/responses/EmailMessagesResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + /outgoingemailmessages: + options: + operationId: outgoingEmailMessageOptions + description: CORS support + responses: + "200": + $ref: "#/responses/CORSResponse" + tags: + - cors + post: + security: + - ApiKeyAuth: [] + summary: Add new email messages to the outgoing queue + operationId: postOutgoingEmailMessages + description: Insert new email messages into workflow storage + parameters: + - $ref: "#/parameters/OutgoingEmailMessageRequest" + responses: + "200": + $ref: "#/responses/EmailMessagesResponse" + "401": + $ref: "#/responses/Unauthorized" + "403": + $ref: "#/responses/AccessForbidden" + "404": + $ref: "#/responses/NotFound" + "422": + $ref: "#/responses/UnprocessableEntity" + "500": + $ref: "#/responses/ServerError" + tags: + - OutgoingEmailMessage +definitions: + AppLog: + description: Application Log for human consumption + properties: + AccountID: + type: string + CompanyID: + type: string + CreatedByID: + type: string + CreatedDate: + type: string + ID: + type: string + Message: + type: string + ObjectID: + type: string + ObjectType: + type: string + Severity: + type: string + Source: + type: string + SourceTimestamp: + type: string + type: object + AppLogRequest: + description: An array Application Log objects + properties: + data: + items: + $ref: "#/definitions/AppLog" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + AppLogResponse: + description: An array Application Log objects + properties: + data: + items: + $ref: "#/definitions/AppLog" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Document: + description: Document + properties: + ArchivedByID: + type: string + ArchivedDate: + type: string + AuthorID: + type: string + Body: + format: byte + type: string + BodyLength: + format: int64 + type: number + CommentCount: + format: int64 + type: number + ConnectionID: + type: string + ContentAssetID: + type: string + ContentModificationDate: + type: string + ContentSize: + format: int64 + type: number + ContentType: + type: string + ContentVersionDocumentID: + type: string + ContnetDocumentID: + type: string + CreatedByID: + type: string + CreatedDate: + type: string + DDate: + type: string + Description: + type: string + DeveloperName: + type: string + Discount: + type: number + Document: + format: byte + type: string + DocumentID: + type: string + DocumentSequence: + format: int64 + type: number + Field: + type: string + FileExtension: + type: string + FileType: + type: string + FolderID: + type: string + GrandTotal: + type: string + ID: + type: string + InsertedByID: + type: string + IsArchived: + type: boolean + IsBodySearchable: + type: boolean + IsCommentSub: + type: boolean + IsDocumentSub: + type: boolean + IsInternalUseOnly: + type: boolean + IsPublic: + type: boolean + IsRichText: + type: boolean + Keywords: + type: string + LastModifiedByID: + type: string + LastModifiedDate: + type: string + LastViewedDate: + type: string + LatstPublishedVersionID: + type: string + LikeCount: + format: int64 + type: number + LinkURL: + type: string + LinkedEntityID: + type: string + Name: + type: string + NamespacePrefix: + type: string + NetworkScope: + type: string + OwnerID: + type: string + ParentID: + type: string + Publishstatus: + type: string + QuoteID: + type: string + RelatedRecordID: + type: string + ShareType: + type: string + SharingOption: + type: string + SharingPrivacy: + type: string + Title: + type: string + Type: + type: string + URL: + type: string + UserID: + type: string + Visibility: + type: string + type: object + EmailMessage: + properties: + ActivityID: + type: string + BCCAddress: + type: string + CCAddress: + type: string + CreatedByID: + type: string + CreatedDate: + type: string + EmailMessageID: + type: string + FromAddress: + type: string + FromName: + type: string + HTML: + format: byte + type: string + HasAttachment: + type: boolean + Headers: + $ref: "#/definitions/Headers" + ID: + type: string + Incoming: + type: boolean + IsClientManaged: + type: boolean + IsExternallyManaged: + type: boolean + LastModifiedByID: + type: string + LastModifiedDate: + type: string + MessageDate: + type: string + MessageIdentifier: + type: string + ParentID: + type: string + RelatedToID: + type: string + RelationAddress: + type: string + RelationID: + type: string + RelationObjectType: + type: string + RelationType: + type: string + ReplyToEmailMessageID: + type: string + Status: + type: string + Subject: + type: string + Text: + format: byte + type: string + ThreadIdentifier: + type: string + ToAddress: + type: string + ValidatedFromAddress: + type: string + type: object + EmailMessageRequest: + description: An array Send Email Message objects + properties: + data: + items: + $ref: "#/definitions/EmailMessage" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + EmailMessagesResponse: + description: An array user objects + properties: + data: + items: + $ref: "#/definitions/EmailMessage" + type: array + meta: + $ref: "#/definitions/ResponseMeta" + type: object + Error: + properties: + Code: + format: int32 + type: integer + Fields: + type: string + Message: + type: string + type: object + Headers: + type: object + properties: + Key: + type: string + Values: + items: + items: + type: string + type: array + type: array + OutgoingEmailMessage: + description: A new email message to be sent + properties: + BCCAddress: + type: string + CCAddress: + type: string + EmailMessageID: + type: string + EmailTemplateID: + type: string + ExternalID: + type: string + FromContactID: + type: string + FromName: + type: string + Headers: + $ref: "#/definitions/Headers" + HTML: + type: string + ID: + type: string + Subject: + type: string + Text: + type: string + ToAddress: + type: string + ToName: + type: string + ValidatedFromAddress: + type: string + WhoID: + type: string + type: object + OutgoingEmailMessageRequest: + description: An array New Email Message objects + properties: + data: + items: + $ref: "#/definitions/OutgoingEmailMessage" + type: array + meta: + $ref: "#/definitions/RequestMeta" + type: object + RequestMeta: + properties: + TaxnexusAccount: + description: Account Number of the Reseller or OEM + type: string + required: + - TaxnexusAccount + type: object + ResponseMeta: + properties: + Contact: + description: Microservice Contact Info + type: string + Copyright: + description: Copyright Info + type: string + License: + description: License Information and Restrictions + type: string + OperationID: + description: Operation ID + type: string + RequestIP: + description: Request IP Address + type: string + RequestType: + description: Request Type + type: string + RequestURL: + description: Request URL + type: string + ServerInfo: + description: Data Server Info + type: string + ServerResponseTime: + description: Data Server Response Time (ms) + type: string + ServerTimestamp: + description: Backend Server Timestamp + type: string + TaxnexusAccount: + description: Account Number used for recording transactions + type: string + type: object