From 2dd452bbb2cacec98b94240a4b5791dcaab829d9 Mon Sep 17 00:00:00 2001 From: Vernon Keenan Date: Fri, 27 Oct 2023 00:49:26 +0000 Subject: [PATCH] fix account channels --- api/sfgate/sfgate_models/account.go | 12 +- .../sfgate_models/account_billing_address.go | 72 ++ api/sfgate/sfgate_models/cluster.go | 6 +- api/sfgate/sfgate_models/contact.go | 25 +- api/sfgate/sfgate_models/contract.go | 12 +- api/sfgate/sfgate_models/database.go | 2 +- api/sfgate/sfgate_models/role.go | 2 +- api/sfgate/sfgate_models/template.go | 7 +- api/sfgate/sfgate_models/tenant.go | 6 +- .../tenant_tenant_users_items.go | 99 ++ api/sfgate/sfgate_models/topic.go | 5 +- api/sfgate/sfgate_models/user.go | 103 +- swagger/external/sf-gate-work.yaml | 1136 +---------------- swagger/sf-gate-work.yaml | 1136 +---------------- 14 files changed, 337 insertions(+), 2286 deletions(-) create mode 100644 api/sfgate/sfgate_models/account_billing_address.go create mode 100644 api/sfgate/sfgate_models/tenant_tenant_users_items.go diff --git a/api/sfgate/sfgate_models/account.go b/api/sfgate/sfgate_models/account.go index 0aff089..4e26509 100644 --- a/api/sfgate/sfgate_models/account.go +++ b/api/sfgate/sfgate_models/account.go @@ -19,7 +19,7 @@ import ( // Account account // -// swagger:model Account +// swagger:model account type Account struct { // Account Number @@ -34,12 +34,18 @@ type Account struct { // Annual Revenue Estimate AnnualRevenue *float64 `json:"AnnualRevenue,omitempty"` + // Salesforce AppExchange URL + AppExchange *string `json:"AppExchange,omitempty"` + // billing address - BillingAddress *Address `json:"BillingAddress,omitempty"` + BillingAddress *AccountBillingAddress `json:"BillingAddress,omitempty"` // Contact ID BillingContactID *string `json:"BillingContactID,omitempty"` + // The channels associated with the track (Multiselect Picklist). + Channels *string `json:"Channels,omitempty"` + // Closed Date ClosedDate *string `json:"ClosedDate,omitempty"` @@ -155,7 +161,7 @@ type Account struct { SalesforceFirst *bool `json:"SalesforceFirst,omitempty"` // shipping address - ShippingAddress *Address `json:"ShippingAddress,omitempty"` + ShippingAddress *AccountBillingAddress `json:"ShippingAddress,omitempty"` // Shipping Contact ID ShippingContactID *string `json:"ShippingContactID,omitempty"` diff --git a/api/sfgate/sfgate_models/account_billing_address.go b/api/sfgate/sfgate_models/account_billing_address.go new file mode 100644 index 0000000..5562d51 --- /dev/null +++ b/api/sfgate/sfgate_models/account_billing_address.go @@ -0,0 +1,72 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2023 by Vernon Keenan +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package sfgate_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" +) + +// AccountBillingAddress account billing address +// +// swagger:model accountBillingAddress +type AccountBillingAddress struct { + + // City + City *string `json:"City,omitempty"` + + // Country full name + Country *string `json:"Country,omitempty"` + + // Country Code + CountryCode *string `json:"CountryCode,omitempty"` + + // Postal Code + PostalCode *string `json:"PostalCode,omitempty"` + + // State full name + State *string `json:"State,omitempty"` + + // State Code + StateCode *string `json:"StateCode,omitempty"` + + // Street number and name + Street *string `json:"Street,omitempty"` +} + +// Validate validates this account billing address +func (m *AccountBillingAddress) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this account billing address based on context it is used +func (m *AccountBillingAddress) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *AccountBillingAddress) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *AccountBillingAddress) UnmarshalBinary(b []byte) error { + var res AccountBillingAddress + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/sfgate/sfgate_models/cluster.go b/api/sfgate/sfgate_models/cluster.go index fc69a00..a5a68ae 100644 --- a/api/sfgate/sfgate_models/cluster.go +++ b/api/sfgate/sfgate_models/cluster.go @@ -18,7 +18,7 @@ import ( // Cluster cluster // -// swagger:model Cluster +// swagger:model cluster type Cluster struct { // Created By @@ -40,7 +40,7 @@ type Cluster struct { ID string `json:"ID,omitempty"` // IP Address - IPAddress *string `json:"IpAddress,omitempty"` + IPAddress *string `json:"IPAddress,omitempty"` // Last Modified By LastModifiedByID *string `json:"LastModifiedByID,omitempty"` @@ -63,7 +63,7 @@ type Cluster struct { // Subnet Subnet *string `json:"Subnet,omitempty"` - // tenantid + // The ID of the tenant who owns this Database TenantID *string `json:"TenantID,omitempty"` // Type diff --git a/api/sfgate/sfgate_models/contact.go b/api/sfgate/sfgate_models/contact.go index adf52be..913ef63 100644 --- a/api/sfgate/sfgate_models/contact.go +++ b/api/sfgate/sfgate_models/contact.go @@ -19,7 +19,7 @@ import ( // Contact contact // -// swagger:model Contact +// swagger:model contact type Contact struct { // The primary account ID of this contact @@ -34,13 +34,16 @@ type Contact struct { // Birthdate BirthDate *string `json:"BirthDate,omitempty"` + // The channels associated with the track (Multiselect Picklist). + Channels *string `json:"Channels,omitempty"` + // Created By User ID CreatedByID *string `json:"CreatedByID,omitempty"` // Created Date CreatedDate *string `json:"CreatedDate,omitempty"` - // Crunchbase URL + // crunchbase URL CrunchbaseURL *string `json:"CrunchbaseURL,omitempty"` // Department @@ -59,12 +62,12 @@ type Contact struct { EmailBounceDate *string `json:"EmailBounceDate,omitempty"` // Email Bounce Reason - EmailBounceReason *string `json:"EmailBounceReason,omitempty"` + EmailBouncedReason *string `json:"EmailBouncedReason,omitempty"` - // Fax Number + // Facebook Page Facebook *string `json:"Facebook,omitempty"` - // fax + // Fax Number Fax *string `json:"Fax,omitempty"` // First Name @@ -101,7 +104,7 @@ type Contact struct { LinkedIn *string `json:"LinkedIn,omitempty"` // mailing address - MailingAddress *Address `json:"MailingAddress,omitempty"` + MailingAddress *AccountBillingAddress `json:"MailingAddress,omitempty"` // Mobile Phone MobilePhone *string `json:"MobilePhone,omitempty"` @@ -109,11 +112,11 @@ type Contact struct { // Full Name Name *string `json:"Name,omitempty"` - // Number of Investments + // number investments NumberInvestments *float64 `json:"NumberInvestments,omitempty"` // other address - OtherAddress *Address `json:"OtherAddress,omitempty"` + OtherAddress *AccountBillingAddress `json:"OtherAddress,omitempty"` // Other Phone OtherPhone *string `json:"OtherPhone,omitempty"` @@ -130,7 +133,7 @@ type Contact struct { // URL of a photograph of this User PhotoURL *string `json:"PhotoURL,omitempty"` - // Reports To User ID + // Reports To ReportsToID *string `json:"ReportsToID,omitempty"` // Salutation @@ -139,13 +142,13 @@ type Contact struct { // Slug Slug *string `json:"Slug,omitempty"` - // tenant identifier + // Tenant Identifier TenantID *string `json:"TenantID,omitempty"` // Contact Title Title *string `json:"Title,omitempty"` - // twitter + // Twitter URL Twitter *string `json:"Twitter,omitempty"` } diff --git a/api/sfgate/sfgate_models/contract.go b/api/sfgate/sfgate_models/contract.go index cf65895..46eb11f 100644 --- a/api/sfgate/sfgate_models/contract.go +++ b/api/sfgate/sfgate_models/contract.go @@ -19,7 +19,7 @@ import ( // Contract contract // -// swagger:model Contract +// swagger:model contract type Contract struct { // Account @@ -31,8 +31,8 @@ type Contract struct { // Activated Date ActivatedDate *string `json:"ActivatedDate,omitempty"` - // Billing Address - BillingAddress *Address `json:"BillingAddress,omitempty"` + // billing address + BillingAddress *AccountBillingAddress `json:"BillingAddress,omitempty"` // Billing Contact BillingContactID *string `json:"BillingContactID,omitempty"` @@ -79,7 +79,7 @@ type Contract struct { // Hourly Rate HourlyRate *float64 `json:"HourlyRate,omitempty"` - // Telnexus Record Id + // Record Id ID string `json:"ID,omitempty"` // Last Modified By User ID @@ -100,8 +100,8 @@ type Contract struct { // Perpetual Agreement? Perpetual *bool `json:"Perpetual,omitempty"` - // Shipping Address - ShippingAddress *Address `json:"ShippingAddress,omitempty"` + // shipping address + ShippingAddress *AccountBillingAddress `json:"ShippingAddress,omitempty"` // Shipping Contact ShippingContactID *string `json:"ShippingContactID,omitempty"` diff --git a/api/sfgate/sfgate_models/database.go b/api/sfgate/sfgate_models/database.go index 5653743..637f98e 100644 --- a/api/sfgate/sfgate_models/database.go +++ b/api/sfgate/sfgate_models/database.go @@ -18,7 +18,7 @@ import ( // Database A Database provisioned and owned by a Tenant // -// swagger:model Database +// swagger:model database type Database struct { // Is this database active? diff --git a/api/sfgate/sfgate_models/role.go b/api/sfgate/sfgate_models/role.go index da55a43..0098602 100644 --- a/api/sfgate/sfgate_models/role.go +++ b/api/sfgate/sfgate_models/role.go @@ -18,7 +18,7 @@ import ( // Role A functional role within a Tenant // -// swagger:model Role +// swagger:model role type Role struct { // the corresponding auth0 role diff --git a/api/sfgate/sfgate_models/template.go b/api/sfgate/sfgate_models/template.go index a1466ff..ec37cf0 100644 --- a/api/sfgate/sfgate_models/template.go +++ b/api/sfgate/sfgate_models/template.go @@ -18,9 +18,12 @@ import ( // Template template // -// swagger:model Template +// swagger:model template type Template struct { + // Company + CompanyID *string `json:"CompanyID,omitempty"` + // created by ID CreatedByID *string `json:"CreatedByID,omitempty"` @@ -57,7 +60,7 @@ type Template struct { // Record Type Name RecordTypeName *string `json:"RecordTypeName,omitempty"` - // tenant identifier + // Tenant that owns this object instance TenantID *string `json:"TenantID,omitempty"` // Type diff --git a/api/sfgate/sfgate_models/tenant.go b/api/sfgate/sfgate_models/tenant.go index bfc6bd3..7382c3b 100644 --- a/api/sfgate/sfgate_models/tenant.go +++ b/api/sfgate/sfgate_models/tenant.go @@ -20,7 +20,7 @@ import ( // Tenant Account Tenant // -// swagger:model Tenant +// swagger:model tenant type Tenant struct { // The Account that owns this Tenant @@ -57,9 +57,9 @@ type Tenant struct { TenantName *string `json:"TenantName,omitempty"` // tenant users - TenantUsers []*TenantUser `json:"TenantUsers"` + TenantUsers []*TenantTenantUsersItems `json:"TenantUsers"` - // Type of tenant + // The type of Tenant Type *string `json:"Type,omitempty"` // The version number of the Tenant Onboarding system used to create this tenant diff --git a/api/sfgate/sfgate_models/tenant_tenant_users_items.go b/api/sfgate/sfgate_models/tenant_tenant_users_items.go new file mode 100644 index 0000000..ab0f83c --- /dev/null +++ b/api/sfgate/sfgate_models/tenant_tenant_users_items.go @@ -0,0 +1,99 @@ +// Code generated by go-swagger; DO NOT EDIT. + +// (c) 2012-2023 by Vernon Keenan +// All rights reserved worldwide. +// Proprietary product; unlicensed use is not allowed + +package sfgate_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" +) + +// TenantTenantUsersItems Relationship object that connects users to a tenant +// +// swagger:model tenantTenantUsersItems +type TenantTenantUsersItems struct { + + // The makeTenantUser access level for this User + AccessLevel *string `json:"AccessLevel,omitempty"` + + // Account ID + AccountID *string `json:"AccountID,omitempty"` + + // Auth0 User ID + Auth0UserID *string `json:"Auth0UserID,omitempty"` + + // Account Name + CompanyName *string `json:"CompanyName,omitempty"` + + // Contact ID + ContactID *string `json:"ContactID,omitempty"` + + // Account + ExternalAccount *string `json:"ExternalAccount,omitempty"` + + // Tenant active? + TenantActive *bool `json:"TenantActive,omitempty"` + + // The Tenant ID + TenantID *string `json:"TenantID,omitempty"` + + // Tenant Name + TenantName *string `json:"TenantName,omitempty"` + + // Tenant Status + TenantStatus *string `json:"TenantStatus,omitempty"` + + // Tenant type + TenantType *string `json:"TenantType,omitempty"` + + // Tenant Version + TenantVersion *string `json:"TenantVersion,omitempty"` + + // User Email Address + UserEmail *string `json:"UserEmail,omitempty"` + + // User Full Name + UserFullName *string `json:"UserFullName,omitempty"` + + // The User ID + UserID *string `json:"UserID,omitempty"` + + // Username + Username *string `json:"Username,omitempty"` +} + +// Validate validates this tenant tenant users items +func (m *TenantTenantUsersItems) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this tenant tenant users items based on context it is used +func (m *TenantTenantUsersItems) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *TenantTenantUsersItems) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *TenantTenantUsersItems) UnmarshalBinary(b []byte) error { + var res TenantTenantUsersItems + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/api/sfgate/sfgate_models/topic.go b/api/sfgate/sfgate_models/topic.go index 61fb961..7fdde72 100644 --- a/api/sfgate/sfgate_models/topic.go +++ b/api/sfgate/sfgate_models/topic.go @@ -20,9 +20,12 @@ import ( // Topic A research topic that collects data // -// swagger:model Topic +// swagger:model topic type Topic struct { + // The channels associated with the track (Multiselect Picklist). + Channels *string `json:"Channels,omitempty"` + // Created By User ID CreatedByID *string `json:"CreatedByID,omitempty"` diff --git a/api/sfgate/sfgate_models/user.go b/api/sfgate/sfgate_models/user.go index dc713cf..d3bf394 100644 --- a/api/sfgate/sfgate_models/user.go +++ b/api/sfgate/sfgate_models/user.go @@ -20,7 +20,7 @@ import ( // User user // -// swagger:model User +// swagger:model user type User struct { // API Gateway URL @@ -39,7 +39,7 @@ type User struct { AccountID *string `json:"AccountID,omitempty"` // address - Address *Address `json:"Address,omitempty"` + Address *AccountBillingAddress `json:"Address,omitempty"` // Alias Alias *string `json:"Alias,omitempty"` @@ -89,9 +89,6 @@ type User struct { // Account ExternalAccount *string `json:"ExternalAccount,omitempty"` - // Fabric API Key - FabricAPIKey *string `json:"FabricAPIKey,omitempty"` - // Fax Fax *string `json:"Fax,omitempty"` @@ -116,9 +113,6 @@ type User struct { // Is the user enabled for Communities? IsPortalEnabled *bool `json:"IsPortalEnabled,omitempty"` - // Has Profile Photo - IsProfilePhotoActive *bool `json:"IsProfilePhotoActive,omitempty"` - // is system controlled IsSystemControlled *bool `json:"IsSystemControlled,omitempty"` @@ -155,6 +149,9 @@ type User struct { // Out of office message OutOfOfficeMessage *string `json:"OutOfOfficeMessage,omitempty"` + // Password (encrypted) + Password *string `json:"Password,omitempty"` + // Phone Phone *string `json:"Phone,omitempty"` @@ -164,41 +161,32 @@ type User struct { // Profile ProfileID *string `json:"ProfileID,omitempty"` - // Provider + // Login Provider Provider *string `json:"Provider,omitempty"` // Info Emails ReceivesAdminEmails *bool `json:"ReceivesAdminEmails,omitempty"` - // Admin Info Emails - ReceivesAdminInfoEmails *bool `json:"ReceivesAdminInfoEmails,omitempty"` - - // Info Emails - ReceivesInfoEmails *bool `json:"ReceivesInfoEmails,omitempty"` - // Email Sender Address SenderEmail *string `json:"SenderEmail,omitempty"` // Email Sender Name SenderName *string `json:"SenderName,omitempty"` - // Email Signature - Signature *string `json:"Signature,omitempty"` - // Small Photo URL SmallPhotoURL *string `json:"SmallPhotoURL,omitempty"` // The time day starts StartOfDay *string `json:"StartOfDay,omitempty"` - // Status + // Onboarding Status Status *string `json:"Status,omitempty"` // Tenant ID associated with this user TenantID *string `json:"TenantID,omitempty"` // tenant users - TenantUsers []*TenantUser `json:"TenantUsers"` + TenantUsers []*TenantTenantUsersItems `json:"TenantUsers"` // Time Zone TimeZone *string `json:"TimeZone,omitempty"` @@ -213,7 +201,7 @@ type User struct { UserRoleID *string `json:"UserRoleID,omitempty"` // user roles - UserRoles []*UserRole `json:"UserRoles"` + UserRoles []*UserUserRolesItems0 `json:"UserRoles"` // User Type UserType *string `json:"UserType,omitempty"` @@ -410,3 +398,76 @@ func (m *User) UnmarshalBinary(b []byte) error { *m = res return nil } + +// UserUserRolesItems0 Relationship object that connects user to a role +// +// swagger:model UserUserRolesItems0 +type UserUserRolesItems0 struct { + + // Account Id + AccountID *string `json:"AccountID,omitempty"` + + // Linked role ID + Auth0RoleID *string `json:"Auth0RoleID,omitempty"` + + // Auth0 User ID + Auth0UserID *string `json:"Auth0UserID,omitempty"` + + // Company Name + CompanyName *string `json:"CompanyName,omitempty"` + + // Contact ID + ContactID *string `json:"ContactID,omitempty"` + + // Account Number + ExternalAccount *string `json:"ExternalAccount,omitempty"` + + // Role description + RoleDescription *string `json:"RoleDescription,omitempty"` + + // The Role ID + RoleID *string `json:"RoleID,omitempty"` + + // Role Name + RoleName *string `json:"RoleName,omitempty"` + + // User Email Address + UserEmail *string `json:"UserEmail,omitempty"` + + // User Full Name + UserFullName *string `json:"UserFullName,omitempty"` + + // The User ID + UserID *string `json:"UserID,omitempty"` + + // Username + Username *string `json:"Username,omitempty"` +} + +// Validate validates this user user roles items0 +func (m *UserUserRolesItems0) Validate(formats strfmt.Registry) error { + return nil +} + +// ContextValidate validates this user user roles items0 based on context it is used +func (m *UserUserRolesItems0) ContextValidate(ctx context.Context, formats strfmt.Registry) error { + return nil +} + +// MarshalBinary interface implementation +func (m *UserUserRolesItems0) MarshalBinary() ([]byte, error) { + if m == nil { + return nil, nil + } + return swag.WriteJSON(m) +} + +// UnmarshalBinary interface implementation +func (m *UserUserRolesItems0) UnmarshalBinary(b []byte) error { + var res UserUserRolesItems0 + if err := swag.ReadJSON(b, &res); err != nil { + return err + } + *m = res + return nil +} diff --git a/swagger/external/sf-gate-work.yaml b/swagger/external/sf-gate-work.yaml index 23acfd0..55085a9 100644 --- a/swagger/external/sf-gate-work.yaml +++ b/swagger/external/sf-gate-work.yaml @@ -3120,228 +3120,11 @@ paths: 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" + $ref: "../../lib/swagger/defs/account.yaml#/Account" type: array meta: $ref: "#/definitions/RequestMeta" @@ -3351,7 +3134,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Account" + $ref: "../../lib/swagger/defs/account.yaml#/Account" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -3590,81 +3373,11 @@ definitions: 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" + $ref: "../../lib/swagger/defs/cluster.yaml#/Cluster" type: array meta: $ref: "#/definitions/RequestMeta" @@ -3676,7 +3389,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Cluster" + $ref: "../../lib/swagger/defs/cluster.yaml#/Cluster" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -3719,175 +3432,11 @@ definitions: 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" + $ref: "../../lib/swagger/defs/contact.yaml#/Contact" type: array meta: $ref: "#/definitions/RequestMeta" @@ -3898,206 +3447,27 @@ definitions: properties: data: items: - $ref: "#/definitions/Contact" + $ref: "../../lib/swagger/defs/contact.yaml#/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" + $ref: "../../lib/swagger/defs/contract.yaml#/Contract" type: array type: object ContractResponse: properties: Data: items: - $ref: "#/definitions/Contract" + $ref: "../../lib/swagger/defs/contract.yaml#/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: @@ -4123,7 +3493,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Database" + $ref: "../../lib/swagger/defs/database.yaml#/Database" type: array meta: $ref: "#/definitions/RequestMeta" @@ -4133,7 +3503,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Database" + $ref: "../../lib/swagger/defs/database.yaml#/Database" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -4398,51 +3768,12 @@ definitions: 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" + $ref: "../../lib/swagger/defs/role.yaml#/Role" type: array meta: $ref: "#/definitions/RequestMeta" @@ -4452,7 +3783,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Role" + $ref: "../../lib/swagger/defs/role.yaml#/Role" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -4473,138 +3804,21 @@ definitions: 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" + $ref: "../../lib/swagger/defs/template.yaml#/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" + $ref: "../../lib/swagger/defs/tenant.yaml#/Tenant" type: array meta: $ref: "#/definitions/RequestMeta" @@ -4614,7 +3828,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Tenant" + $ref: "../../lib/swagger/defs/tenant.yaml#/Tenant" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -4704,57 +3918,12 @@ definitions: $ref: "../../lib/swagger/defs/track-user.yaml#/TrackUser" type: array 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: "../../lib/swagger/defs/factor.yaml#/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" + $ref: "../../lib/swagger/defs/topic.yaml#/Topic" type: array type: object TopicResponse: @@ -4762,284 +3931,17 @@ definitions: properties: Data: items: - $ref: "#/definitions/Topic" + $ref: "../../lib/swagger/defs/topic.yaml#/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 - Provider: - description: Provider - 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" + $ref: "../../lib/swagger/defs/user.yaml#/User" type: array type: object UserResponse: @@ -5047,7 +3949,7 @@ definitions: properties: data: items: - $ref: "#/definitions/User" + $ref: "../../lib/swagger/defs/user.yaml#/User" type: array meta: $ref: "#/definitions/ResponseMeta" diff --git a/swagger/sf-gate-work.yaml b/swagger/sf-gate-work.yaml index 7967cbf..e384f20 100644 --- a/swagger/sf-gate-work.yaml +++ b/swagger/sf-gate-work.yaml @@ -3120,228 +3120,11 @@ paths: 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" + $ref: "../../lib/swagger/defs/account.yaml#/Account" type: array meta: $ref: "#/definitions/RequestMeta" @@ -3351,7 +3134,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Account" + $ref: "../../lib/swagger/defs/account.yaml#/Account" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -3590,81 +3373,11 @@ definitions: 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" + $ref: "../../lib/swagger/defs/cluster.yaml#/Cluster" type: array meta: $ref: "#/definitions/RequestMeta" @@ -3676,7 +3389,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Cluster" + $ref: "../../lib/swagger/defs/cluster.yaml#/Cluster" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -3719,175 +3432,11 @@ definitions: 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" + $ref: "../../lib/swagger/defs/contact.yaml#/Contact" type: array meta: $ref: "#/definitions/RequestMeta" @@ -3898,206 +3447,27 @@ definitions: properties: data: items: - $ref: "#/definitions/Contact" + $ref: "../../lib/swagger/defs/contact.yaml#/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" + $ref: "../../lib/swagger/defs/contract.yaml#/Contract" type: array type: object ContractResponse: properties: Data: items: - $ref: "#/definitions/Contract" + $ref: "../../lib/swagger/defs/contract.yaml#/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: @@ -4123,7 +3493,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Database" + $ref: "../../lib/swagger/defs/database.yaml#/Database" type: array meta: $ref: "#/definitions/RequestMeta" @@ -4133,7 +3503,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Database" + $ref: "../../lib/swagger/defs/database.yaml#/Database" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -4398,51 +3768,12 @@ definitions: 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" + $ref: "../../lib/swagger/defs/role.yaml#/Role" type: array meta: $ref: "#/definitions/RequestMeta" @@ -4452,7 +3783,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Role" + $ref: "../../lib/swagger/defs/role.yaml#/Role" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -4473,138 +3804,21 @@ definitions: 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" + $ref: "../../lib/swagger/defs/template.yaml#/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" + $ref: "../../lib/swagger/defs/tenant.yaml#/Tenant" type: array meta: $ref: "#/definitions/RequestMeta" @@ -4614,7 +3828,7 @@ definitions: properties: data: items: - $ref: "#/definitions/Tenant" + $ref: "../../lib/swagger/defs/tenant.yaml#/Tenant" type: array meta: $ref: "#/definitions/ResponseMeta" @@ -4704,57 +3918,12 @@ definitions: $ref: "../../lib/swagger/defs/track-user.yaml#/TrackUser" type: array 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: "../../lib/swagger/defs/factor.yaml#/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" + $ref: "../../lib/swagger/defs/topic.yaml#/Topic" type: array type: object TopicResponse: @@ -4762,284 +3931,17 @@ definitions: properties: Data: items: - $ref: "#/definitions/Topic" + $ref: "../../lib/swagger/defs/topic.yaml#/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 - Provider: - description: Provider - 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" + $ref: "../../lib/swagger/defs/user.yaml#/User" type: array type: object UserResponse: @@ -5047,7 +3949,7 @@ definitions: properties: data: items: - $ref: "#/definitions/User" + $ref: "../../lib/swagger/defs/user.yaml#/User" type: array meta: $ref: "#/definitions/ResponseMeta"